FB2SlotComponent

Overview

Component that manages placement slots.

Metadata

Field	Value
Kind	`component`
Environment	B2 - Simulation
Category	`components`
Extends	`FB2Component`
Require	`require('Components.B2SlotComponent')`

Properties (12)

Name	Type	Description
`AutoGeneratedCraftingSlotDatas`	`FB1ObjectBpSlotData[]`	Stores auto-generated HandCraftSlot data. Since FB2SlotStateInfo references it by raw pointer, modify it only through GenerateCraftingSlots().
`CanSpawnInvisibleObject`	`boolean`
`ManuallyAssignedOwners`	`table<FB1EntityId, boolean>`
`OccupiedSlotOwner`	`FB1EntityId`	Owner EntityId of the ObjectType slot I am occupying.
`OwnershipInfo`	`table<FB1EntityId, string>`	Ownership (assigning my own seat).
`SitSlotCount`	`integer`	Number of Sit-tagged slots.
`SlotStateInfos`	`FB2SlotStateInfo[]`
`UseSlotCompanyIdOnly`	`FB1EntityId`	All slots of this object can be used only if the company id matches.
`UseSlotEmployeeObjectIdOnly`	`FB1EntityId`	A company's assigned seat for staff.
`UseSlotSchedulerIdOnly`	`FB1EntityId`	An object reserved by the CoopScheduler for cooperative behavior; usable only by co-op participants.
`UsedSlotOwnershipTags`	`table<string, boolean>`
`bInitializeSlotStateInfos`	`boolean`

Functions (76)

Function	Parameters	Returns	Description
`AddOccupyingReasonByEntityId`	InOccupyEntityId: `FB1EntityId`, InOccupyingReason: `EB1SlotOccupyingReason`	`-`	Adds Occupying Reason By Entity Id.
`AddOccupyingReasonBySlotStateInfo`	InSlotStateInfo: `FB2SlotStateInfo`, InOccupyingReason: `EB1SlotOccupyingReason`	`-`	Adds Occupying Reason By Slot State Info.
`CanOccupySlot`	InSlotType: `EB1SlotType`, InTargetSlotParam: `FB2TargetSlotParam`, InCheckOnlyTarget: `boolean`	`boolean`	Returns whether it can Occupy Slot.
`CanOccupySlotCheckOnlyEntity`	InSlotType: `EB1SlotType`, InEntityId: `FB1EntityId`	`boolean`	Returns whether it can Occupy Slot Check Only Entity.
`CanOccupySlotWithComponentNameInfo`	InSlotType: `EB1SlotType`, InTargetSlotParam: `FB2TargetSlotParam`, OutNameInfo: `FB2SlotComponentNameInfo`	`boolean`	Returns whether it can Occupy Slot With Component Name Info.
`ConvertWorldLocation`	InRelativeLocation: `FVector`	`FVector`
`ConvertWorldRotator`	InRelativeRotator: `FRotator`	`FRotator`
`DestroyInvisibleChairObjects`	Reason: `EB2EntityDestroyReason`	`-`
`DestroyInvisibleObjectInSlot`	InSlotName: `string`	`-`
`FindClosestEnableEatDiningSlot`	InLocation: `FVector`, InOptionalParentEntityId: `FB1EntityId`, InOutTargetSlotParam: `FB2TargetSlotParam`	`boolean`	Finds and returns Closest Enable Eat Dining Slot.
`FindClosestOccupiableSlot`	InSlotType: `EB1SlotType`, InLocation: `FVector`, InOutTargetSlotParam: `FB2TargetSlotParam`, InFilterObjectSlotId: `string`	`boolean`	If InFilterObjectSlotId is specified, searches only slots with that ObjectSlotId as candidates.
`FindEnableOnlyInteractionTagSlot`	InSlotType: `EB1SlotType`, InInteractionTags: `string[]`, InOutTargetSlotParam: `FB2TargetSlotParam`	`boolean`	Finds and returns Enable Only Interaction Tag Slot.
`FindSlotStateInfoBySlotName`	InSlotName: `string`	`FB2SlotStateInfo`	Finds and returns Slot State Info By Slot Name.
`FindSlotStateInfoBySlotParam`	InSlotType: `EB1SlotType`, InSlotParam: `FB2TargetSlotParam`	`FB2SlotStateInfo`	Finds and returns Slot State Info By Slot Param.
`FixSlotDirection`	InSlotType: `EB1SlotType`, InOutTargetSlotParam: `FB2TargetSlotParam`	`boolean`
`GenerateCraftingSlots`	`-`	`-`	Generates Crafting Slots.
`GetCanSpawnInvisibleObject`	`-`	`boolean`	Returns Can Spawn Invisible Object.
`GetDefaultCityMoveDataPolicy`	`-`	`EB1CityMoveDataPolicy`	Returns Default City Move Data Policy.
`GetEmptyObjectSlotCountById`	InObjectSlotId: `string`	`integer`	Returns Empty Object Slot Count By Id.
`GetEmptySlotCount`	InObjectCategoryId: `string`	`integer`	Returns Empty Slot Count.
`GetEmptySlotNameByObjectCategory`	InObjectCategory: `string`, InGameObject: `FB2GameObject`, OutSlotName: `string`	`-`	Returns Empty Slot Name By Object Category.
`GetEmptySlotNameBySlotId`	InSlotId: `string`, InGameObject: `FB2GameObject`, OutSlotName: `string`	`-`	Returns Empty Slot Name By Slot Id.
`GetEmptySlotNamesByObjectCategory`	InObjectCategory: `string`, OutSlotNames: `string[]`	`-`	Returns Empty Slot Names By Object Category.
`GetEmptySlotNamesByObjectCategoryWithObject`	InObjectCategory: `string`, InGameObject: `FB2GameObject`, OutSlotNames: `string[]`	`-`	Returns Empty Slot Names By Object Category With Object.
`GetEmptySlotStateInfo`	InSlotType: `EB1SlotType`	`FB2SlotStateInfo`	Returns Empty Slot State Info.
`GetFirstNonBlockedSlotLocation`	InSlotType: `EB1SlotType`, OutLocation: `FVector`	`boolean`	Returns First Non Blocked Slot Location.
`GetFirstSlotLocation`	InSlotType: `EB1SlotType`, OutLocation: `FVector`	`boolean`	Returns First Slot Location.
`GetFirstSlotRotation`	InSlotType: `EB1SlotType`, OutRotation: `FRotator`	`boolean`	Returns First Slot Rotation.
`GetObjectSlotCountById`	InObjectSlotId: `string`	`integer`	Returns Object Slot Count By Id.
`GetObjectSlotEmployeeObjectId`	`-`	`FB1EntityId`	Returns Object Slot Employee Object Id.
`GetOccupiedSlotOwner`	`-`	`FB1EntityId`	Returns Occupied Slot Owner.
`GetOccupySlotLocation`	InOccupyCharacterEntityId: `FB1EntityId`, InSlotType: `EB1SlotType`, OutLocation: `FVector`	`boolean`	Returns Occupy Slot Location.
`GetSitSlotCount`	`-`	`integer`	Returns Sit Slot Count.
`GetSlotLocationBySlotName`	InSlotName: `string`, OutLocation: `FVector`	`boolean`	Returns Slot Location By Slot Name.
`GetSlotLocationBySlotParam`	InSlotType: `EB1SlotType`, InSlotParam: `FB2TargetSlotParam`, OutLocation: `FVector`	`boolean`	Returns Slot Location By Slot Param.
`GetSlotLocationBySlotStateInfo`	InSlotStateInfo: `FB2SlotStateInfo`, OutLocation: `FVector`	`boolean`	Returns Slot Location By Slot State Info.
`GetSlotOwnershipInfos`	`-`	`table<FB1EntityId, string>`	Returns Slot Ownership Infos.
`GetSlotRotationBySlotName`	InSlotName: `string`, OutRotation: `FRotator`	`boolean`	Returns Slot Rotation By Slot Name.
`GetSlotRotationBySlotParam`	InSlotType: `EB1SlotType`, InSlotParam: `FB2TargetSlotParam`, OutRotation: `FRotator`	`boolean`	Returns Slot Rotation By Slot Param.
`GetSlotRotationBySlotStateInfo`	InSlotStateInfo: `FB2SlotStateInfo`, OutRotation: `FRotator`	`boolean`	Returns Slot Rotation By Slot State Info.
`GetSlotStateInfoByComponentName`	InSlotType: `EB1SlotType`, InComponentName: `string`	`FB2SlotStateInfo`	Searches by the BP SceneComponent name rather than the SlotName, for ComponentName-based reverse lookup such as ConnectedChair.
`GetSlotStateInfoBySlotName`	InSlotType: `EB1SlotType`, InSlotName: `string`	`FB2SlotStateInfo`	Returns Slot State Info By Slot Name.
`GetSlotStateInfoBySlotParam`	InSlotType: `EB1SlotType`, InSlotParam: `FB2TargetSlotParam`	`FB2SlotStateInfo`	Returns Slot State Info By Slot Param.
`GetSlotStateInfoFromOccupyingEntity`	InSlotType: `EB1SlotType`, InOccupyingEntity: `FB1EntityId`, SpecificReason: `EB1SlotOccupyingReason`	`FB2SlotStateInfo`	Returns Slot State Info From Occupying Entity.
`GetSlotStateInfos`	`-`	`FB2SlotStateInfo[]`	Returns Slot State Infos.
`GetSlotStateInfosByObjectSlotId`	InObjectSlotId: `string`, OutSlots: `FB2SlotStateInfo[]`	`-`	Returns all Object slots matching the given ObjectSlotId, for searching auto-generated slot groups.
`HasAnyCompatibleSlot`	InSlotType: `EB1SlotType`, InTargetSlotParam: `FB2TargetSlotParam`	`boolean`	Returns whether it has Any Compatible Slot.
`HasOccupiedSlotOwner`	`-`	`boolean`	Returns whether it has Occupied Slot Owner.
`IsAutoGenSlot`	InSlot: `FB2SlotStateInfo`	`boolean`	Determines whether a slot is auto-generated by checking whether its SlotData pointer falls within the AutoGeneratedCraftingSlotDatas range.
`IsOccupiableEntity`	OccupyEntityId: `FB1EntityId`	`boolean`	Returns whether Occupiable Entity.
`IsOccupiableEntityWithResult`	OccupyEntityId: `FB1EntityId`, OutResult: `EB1AddInteractionQueueResult`	`boolean`	Returns whether Occupiable Entity With Result.
`IsOccupiableSlot`	InSlotType: `EB1SlotType`, InTargetSlotParam: `FB2TargetSlotParam`	`boolean`	Returns whether Occupiable Slot.
`IsSlotOccupied`	InSlotType: `EB1SlotType`	`boolean`	Returns whether Slot Occupied.
`IsSlotOccupiedWithEntity`	InSlotType: `EB1SlotType`, InTargetSlotParam: `FB2TargetSlotParam`, InCheckOnlyTarget: `boolean`	`boolean`	Returns whether Slot Occupied With Entity.
`IsSlotStateInfosInitialized`	`-`	`boolean`	Returns whether Slot State Infos Initialized.
`IsSpecificSlotOccupiable`	InSlotType: `EB1SlotType`, InSlotName: `string`, InTargetSlotParam: `FB2TargetSlotParam`	`boolean`	Returns whether Specific Slot Occupiable.
`OccupySlot`	InSlotType: `EB1SlotType`, InTargetSlotParam: `FB2TargetSlotParam`	`-`
`RebuildSlotData`	OutRescueEntityIds: `FB1EntityId[]`, OutDetachEntityIds: `FB1EntityId[]`	`-`
`RecacheSlotData`	`-`	`-`
`RecreatePrintedObjectSlotStateInfos`	`-`	`-`
`ReleaseSlotOwnership`	InOwnershipEntityId: `FB1EntityId`	`-`
`RemoveOccupiedObjectSlotReason`	`-`	`-`	Removes Occupied Object Slot Reason.
`RemoveOccupyingAllReason`	InOccupyEntityId: `FB1EntityId`	`-`	Removes Occupying All Reason.
`RemoveOccupyingReasonByEntityId`	InOccupyEntityId: `FB1EntityId`, InOccupyingReason: `EB1SlotOccupyingReason`	`-`	Removes Occupying Reason By Entity Id.
`RemoveOccupyingReasonBySlotName`	InSlotName: `string`, InOccupyingReason: `EB1SlotOccupyingReason`	`-`	Removes Occupying Reason By Slot Name.
`SetObjectSlotCompanyId`	InCompanyId: `FB1EntityId`	`-`	Sets Object Slot Company Id.
`SetObjectSlotEmployeeObjectId`	InEmployeeObjectId: `FB1EntityId`	`-`	Sets Object Slot Employee Object Id.
`SetObjectSlotSchedulerId`	InSchedulerId: `FB1EntityId`	`-`	Sets Object Slot Scheduler Id.
`SetOccupiedSlotOwner`	InOccupiedSlotOwner: `FB1EntityId`	`-`	Sets Occupied Slot Owner.
`SpawnInvisibleChairObjects`	`-`	`-`	Spawns Invisible Chair Objects.
`TryOccupyAnyAvailableSlot`	InSlotType: `EB1SlotType`, InLocation: `FVector`, InOutTargetSlotParam: `FB2TargetSlotParam`, InbSortByNearestFirst: `boolean`	`boolean`
`TryOccupyClosestSlot`	InSlotType: `EB1SlotType`, InLocation: `FVector`, InOutTargetSlotParam: `FB2TargetSlotParam`	`boolean`
`TryOccupySlot`	InSlotType: `EB1SlotType`, InTargetSlotParam: `FB2TargetSlotParam`	`boolean`
`TryRequestSlotOwnership`	InOwnershipEntityId: `FB1EntityId`, InSlotOwnershipTag: `string`	`boolean`
`UpdateInteractionSlotBlockState`	bBuildModeOrVersionChange: `boolean`	`-`	Updates Interaction Slot Block State.
`UpdateSitSlotCache`	`-`	`-`	Updates Sit Slot Cache.

Override points (20)

Implement these in Lua as FB2SlotComponent.Override_Name = function(...) end.

Function	Parameters	Returns	Description
`Override_CanOccupySlot`	InSlotType: `EB1SlotType`, InTargetSlotParam: `FB2TargetSlotParam`, InCheckOnlyTarget: `boolean`	`boolean`	Returns whether it can Occupy Slot.
`Override_CanOccupySlotCheckOnlyEntity`	InSlotType: `EB1SlotType`, InEntityId: `FB1EntityId`	`boolean`	Returns whether it can Occupy Slot Check Only Entity.
`Override_ConvertWorldLocation`	InRelativeLocation: `FVector`	`FVector`
`Override_ConvertWorldRotator`	InRelativeRotator: `FRotator`	`FRotator`
`Override_DestroyInvisibleChairObjects`	Reason: `EB2EntityDestroyReason`	`-`
`Override_DestroyInvisibleObjectInSlot`	InSlotName: `string`	`-`
`Override_GenerateCraftingSlots`	`-`	`-`	Generates Crafting Slots.
`Override_HasAnyCompatibleSlot`	InSlotType: `EB1SlotType`, InTargetSlotParam: `FB2TargetSlotParam`	`boolean`	Returns whether it has Any Compatible Slot.
`Override_HasOccupiedSlotOwner`	`-`	`boolean`	Returns whether it has Occupied Slot Owner.
`Override_OccupySlot`	InSlotType: `EB1SlotType`, InTargetSlotParam: `FB2TargetSlotParam`	`-`
`Override_RecacheSlotData`	`-`	`-`
`Override_RecreatePrintedObjectSlotStateInfos`	`-`	`-`
`Override_ReleaseSlotOwnership`	InOwnershipEntityId: `FB1EntityId`	`-`
`Override_RemoveOccupiedObjectSlotReason`	`-`	`-`	Removes Occupied Object Slot Reason.
`Override_RemoveOccupyingAllReason`	InOccupyEntityId: `FB1EntityId`	`-`	Removes Occupying All Reason.
`Override_SpawnInvisibleChairObjects`	`-`	`-`	Spawns Invisible Chair Objects.
`Override_TryOccupySlot`	InSlotType: `EB1SlotType`, InTargetSlotParam: `FB2TargetSlotParam`	`boolean`
`Override_TryRequestSlotOwnership`	InOwnershipEntityId: `FB1EntityId`, InSlotOwnershipTag: `string`	`boolean`
`Override_UpdateInteractionSlotBlockState`	bBuildModeOrVersionChange: `boolean`	`-`	Updates Interaction Slot Block State.
`Override_UpdateSitSlotCache`	`-`	`-`	Updates Sit Slot Cache.