FB2GameObject

Overview

No description available.

Metadata

Field	Value
Kind	`struct`
Environment	B2 - Simulation
Category	`structs`
Extends	`FB2Actor`
Require	`require('Objects.B2GameObject')`

Properties (47)

Name	Type	Description
`ActivePhysics`	`FB2ActivePhysicsRuntimeState`	Active Physics
`Appendix`	`FB1VariantDataMap`
`AppliedMaterialParamContexts`	`table<FB2MaterialParameterContext, boolean>`
`AssembledAssetHash`	`integer`
`AuthorName`	`string`
`CachedPrice`	`integer`
`CraftingQualityBoostState`	`EB2CraftingQualityBoostState`
`CreatePurpose`	`EB1ObjectCreatePurpose`
`CurrentInteracteeEntityIdSet`	`table<FB1EntityId, boolean>`
`CustomizedData`	`FB1ObjectCustomizeSaveData[]`
`DebuggingSocialClusterIndex`	`integer`
`GalleryPathKey`	`string`
`HasWeatherObjectEffectApplied`	`boolean`
`HideMeshComponentTag`	`string`
`InventoryPutInTicks`	`integer`
`InvisibleObjectDuringInteraction`	`boolean`
`IsDevLocked`	`boolean`
`KickSuppressed`	`boolean`	Kick-suppressed state (a runtime value derived from IsInUse, not serialized). A packet is sent to B1 only on change.
`LinkedCharacterId`	`FB1EntityId`
`ObjectIdForStatTagMap`	`string`
`ObjectTableId`	`string`
`ObjectTags`	`string[]`
`ObjectType`	`EB2GameObjectDetailType`
`OwnershipData`	`FB1OwnershipData`
`PlacementFlags`	`EB1PlacementFlag`
`PrintedMeshId`	`string`
`PrintedMeshOffset`	`FVector`
`PropertyOwnedHouseholdEntityId`	`FB1EntityId`
`Quality`	`EB1Quality`
`QualityId`	`string`
`RelatedProps`	`table<integer, integer>`
`RuntimeObjectTags`	`string[]`
`SalePrice`	`integer`
`Scale`	`FVector`
`SellerEntityId`	`FB1EntityId`
`Size`	`FVector`
`SocialClusters`	`FB2SocialCluster[]`
`SpaceAttribute`	`integer`
`TaxId`	`string`
`TickEnabledBeforeActivePhysics`	`boolean?`
`ZoneGraphNodeIndex`	`integer`
`ZoneIndex`	`integer`
`bB1Spawned`	`boolean`
`bIsContainsAOI`	`boolean`
`bIsNonSiteObject`	`boolean`
`bSpaceAttributeCached`	`boolean`
`bZoneResolveAttempted`	`boolean`	Flag for cases where the Zone could not be computed at spawn (e.g. Location (0,0,0)), to do a one-time deferred recompute on the next GetZoneIndex() call. Prevents repeated retries after one recompute (avoids repeated computation for truly Outside objects). Reset on Site change.

Functions (148)

Function	Parameters	Returns	Description
`AddInteracteeEntityId`	InEntityId: `FB1EntityId`	`-`	Adds Interactee Entity Id.
`ApplyOwnershipToCharacterCache`	`-`	`-`	Applies Ownership To Character Cache.
`AttachCharacter`	InEntityId: `FB1EntityId`, InSlotName: `string`	`boolean`
`BeginActivePhysics`	InMaxLifetimeDeadline: `FDateTime`, InThrowInstigatorEntityId: `FB1EntityId`	`-`	Begins Active Physics.
`CacheSpaceAttribute`	`-`	`-`
`CanBeDusty`	`-`	`boolean`	Returns whether it can Be Dusty.
`CanSelectGroupedInteraction`	`-`	`boolean`	Returns whether it can Select Grouped Interaction.
`ClearOccupiedSlotAndGrouping`	`-`	`-`	Clears Occupied Slot And Grouping.
`ClearSpaceAttributeCache`	`-`	`-`	Clears Space Attribute Cache.
`CloseSale`	`-`	`-`
`DetachCharacter`	InEntityId: `FB1EntityId`	`boolean`
`ExcludeFromAOI`	`-`	`-`
`FindMutableSocialCluster`	InSocialClusterType: `EB1SocialClusterType`	`FB2SocialCluster`	Finds and returns Mutable Social Cluster.
`FindSocialCluster`	InSocialClusterType: `EB1SocialClusterType`	`FB2SocialCluster`	Finds and returns Social Cluster.
`GetAppendix`	`-`	`FB1VariantDataMap`	Returns Appendix.
`GetAssembledAssetHash`	`-`	`integer`	Returns Assembled Asset Hash.
`GetAttachedCharacterId`	`-`	`FB1EntityId`	Returns Attached Character Id.
`GetAuthorName`	`-`	`string`	Returns Author Name.
`GetAvailableLocation`	InSocialClusterType: `EB1SocialClusterType`, InRequesterId: `FB1EntityId`, InIgnoreOverlapEntityIds: `FB1EntityId[]`	`FVector`	Returns Available Location.
`GetBoxCollisionScale`	`-`	`FVector`	Returns Box Collision Scale.
`GetCanPopUpDescription`	`-`	`boolean`	Returns Can Pop Up Description.
`GetCanSpawnInvisibleObject`	`-`	`boolean`	Returns Can Spawn Invisible Object.
`GetCityMovePolicyMap`	InCityMoveDataPolicyType: `EB1CityMoveDataPolicyType`	`table<string, EB1CityMoveDataPolicy>`	Returns City Move Policy Map.
`GetCreatePurpose`	`-`	`EB1ObjectCreatePurpose`	Returns Create Purpose.
`GetCustomDescription`	`-`	`string`	Returns Custom Description.
`GetCustomName`	`-`	`string`	Returns Custom Name.
`GetCustomizedData`	`-`	`FB1ObjectCustomizeSaveData[]`	Returns Customized Data.
`GetDefaultCityMoveDataPolicy`	`-`	`EB1CityMoveDataPolicy`	Returns Default City Move Data Policy.
`GetDevLock`	`-`	`boolean`	Returns Dev Lock.
`GetExchangeCost`	`-`	`integer`	Returns Exchange Cost.
`GetGalleryPathKey`	`-`	`string`	Returns Gallery Path Key.
`GetGroupObjectParentEntityId`	`-`	`FB1EntityId`	Returns Group Object Parent Entity Id.
`GetHideMeshComponentTag`	`-`	`string`	Returns Hide Mesh Component Tag.
`GetInteracteeEntityIdSet`	`-`	`table<FB1EntityId, boolean>`	Returns Interactee Entity Id Set.
`GetInventoryDisplayObjectDtId`	`-`	`string`	Returns Inventory Display Object Dt Id.
`GetInventoryMasterEntityId`	`-`	`FB1EntityId`	Returns Inventory Master Entity Id.
`GetInventoryPutInTicks`	`-`	`integer`	Returns Inventory Put In Ticks.
`GetInvisibleObjectDuringInteraction`	`-`	`boolean`	Returns Invisible Object During Interaction.
`GetLinkedCharacterId`	`-`	`FB1EntityId`	Returns Linked Character Id.
`GetObjectId`	`-`	`string`	Returns Object Id.
`GetObjectKey`	`-`	`FB1EntityId`	Returns Object Key.
`GetObjectSelectionSetId`	`-`	`string`	Returns Object Selection Set Id.
`GetObjectTableId`	`-`	`string`	Returns Object Table Id.
`GetObjectTableRow`	`-`	`FB1ObjectTableRow`	Returns Object Table Row.
`GetObjectTags`	`-`	`string[]`	Returns Object Tags.
`GetObjectType`	`-`	`EB2GameObjectDetailType`	Returns Object Type.
`GetOccupiedSlotName`	`-`	`string`	Returns Occupied Slot Name.
`GetOriginalPrice`	`-`	`integer`	Returns Original Price.
`GetOwnership`	`-`	`FB1OwnershipData`	Returns Ownership.
`GetPrice`	InIsForceRecalculate: `boolean`	`integer`	Returns Price.
`GetPriceInSite`	InIsForceRecalculate: `boolean`	`integer`	Returns Price In Site.
`GetPropertyOwnedHouseholdEntityId`	`-`	`FB1EntityId`	Returns Property Owned Household Entity Id.
`GetQuality`	`-`	`EB1Quality`	Returns Quality.
`GetQualityId`	`-`	`string`	Returns Quality Id.
`GetRelatedProps`	`-`	`table<integer, integer>`	Returns Related Props.
`GetRelativeLocation`	`-`	`FVector`	Returns Relative Location.
`GetSalePrice`	`-`	`integer`	Returns Sale Price.
`GetSalvageValue`	`-`	`integer`	Returns Salvage Value.
`GetScale`	`-`	`FVector`	Returns Scale.
`GetSellerEntityId`	`-`	`FB1EntityId`	Returns Seller Entity Id.
`GetSize`	`-`	`FVector`	Returns Size.
`GetSocialClusterCenter`	InSocialClusterType: `EB1SocialClusterType`, InSlotName: `string`	`FVector`	Returns Social Cluster Center.
`GetSocialClusterMaxCount`	InSocialClusterType: `EB1SocialClusterType`	`integer`	Returns Social Cluster Max Count.
`GetSpaceAttribute`	`-`	`integer`	Returns Space Attribute.
`GetTaxId`	`-`	`string`	Returns Tax Id.
`GetType`	`-`	`EB2EntityType`	Returns Type.
`GetZoneGraphNodeIndex`	`-`	`integer`	Returns Zone Graph Node Index.
`GetZoneIndex`	`-`	`integer`	Returns Zone Index.
`HandleReceiveByHandOver`	InReceiverId: `FB1EntityId`	`-`
`HasGalleryPathKey`	`-`	`boolean`	Returns whether it has Gallery Path Key.
`HasObjectTag`	InTag: `string`	`boolean`	Returns whether it has Object Tag.
`HasOwnership`	InOwnershipType: `EB1OwnershipType`, InOwnerId: `FB1EntityId`	`boolean`	Returns whether it has Ownership.
`HasPlacementFlag`	InFlag: `EB1PlacementFlag`	`boolean`	Returns whether it has Placement Flag.
`HasPrintedMesh`	`-`	`boolean`	Returns whether it has Printed Mesh.
`HasSpaceAttributeCache`	`-`	`boolean`	Returns whether it has Space Attribute Cache.
`HasStatTag`	StatTag: `string`	`boolean`	Returns whether it has Stat Tag.
`HasTPOBagId`	InCandidateBagIds: `table<string, boolean>`	`boolean`	Returns whether it has TPOBag Id.
`InitBoxComponent`	`-`	`-`	Initializes Box Component.
`IsActivePhysics`	`-`	`boolean`	Active Physics
`IsActivePhysicsRestoreEnabled`	`-`	`boolean`	Returns whether Active Physics Restore Enabled.
`IsAvailableInteractionBags`	InteractionBagId: `string`	`boolean`	Returns whether Available Interaction Bags.
`IsAvailableInteractionCategory`	InteractionBagCategory: `string`	`boolean`	Returns whether Available Interaction Category.
`IsB1Spawned`	`-`	`boolean`	Returns whether B1 Spawned.
`IsBeingInteracted`	`-`	`boolean`	Returns whether this object is currently the target of someone's interaction (regardless of slot occupancy, including multi-interactors).
`IsCleanUpTarget`	InCleanUpTarget: `EB1CleanUpObjectType`	`boolean`	Returns whether Clean Up Target.
`IsContainsAOI`	`-`	`boolean`	Returns whether Contains AOI.
`IsEmployeeFixedObject`	InOwnerEntityId: `FB1EntityId`	`boolean`	Returns whether Employee Fixed Object.
`IsInUse`	`-`	`boolean`	Returns whether a character is using/occupying this object. Union of the interactee set (slotless active interactions) and slot occupancy (persistent states like sitting/posture). Used to gate Kick (physics) blocking: if either is true the object is considered in use and Kick is blocked.
`IsIndoor`	`-`	`boolean`	Returns whether Indoor.
`IsInvisibleObject`	`-`	`boolean`	Returns whether Invisible Object.
`IsNeedSpawnUpdate`	`-`	`boolean`	Returns whether Need Spawn Update.
`IsNonSiteObject`	`-`	`boolean`	Returns whether Non Site Object.
`IsOccupiableEntity`	InRequesterId: `FB1EntityId`	`boolean`	Returns whether Occupiable Entity.
`IsOwnedByCharacter`	InOwnerId: `FB1EntityId`	`boolean`	Returns whether Owned By Character.
`IsPriceable`	`-`	`boolean`	Returns whether Priceable.
`IsSitAvailableInteractionCategory`	InteractionBagCategory: `string`	`boolean`	Returns whether Sit Available Interaction Category.
`IsSoldOut`	`-`	`boolean`	Returns whether Sold Out.
`IsUnderRoof`	`-`	`boolean`	Returns whether Under Roof.
`IsValidOwnership`	InOwnershipType: `EB1OwnershipType`, InOwnerId: `FB1EntityId`	`boolean`	Returns whether Valid Ownership.
`IsWeatherObjectEffectApplied`	`-`	`boolean`	Returns whether Weather Object Effect Applied.
`NotifyKickRequestRejected`	`-`	`-`
`OnApplyGlobalMaterialParameter`	InMaterialParamMappingId: `string`	`-`	Callback invoked on Apply Global Material Parameter.
`OnObjectBpDataRebuilt`	InIsChangedObject: `boolean`	`-`	Callback invoked on Object Bp Data Rebuilt.
`OnSpawnedGameObject`	InSpawnedTransform: `FTransform`	`-`	Callback invoked on Spawned Game Object.
`OnUpdateGameObjectInfo`	`-`	`-`	Callback invoked on Update Game Object Info.
`PauseSale`	`-`	`-`
`ReCalculatePrice`	`-`	`boolean`
`RemoveInteracteeEntityId`	InEntityId: `FB1EntityId`	`-`	Removes Interactee Entity Id.
`RequestRemoveChildEntity`	InEntityId: `FB1EntityId`	`boolean`	Requests Remove Child Entity.
`SendObjectGrouping`	`-`	`-`	Sends Object Grouping.
`SetAppendix`	InAppendix: `FB1VariantDataMap`	`-`	Sets Appendix.
`SetAssembledAssetHash`	InHash: `integer`	`-`	Sets Assembled Asset Hash.
`SetAuthorName`	InAuthorName: `string`	`-`	Sets Author Name.
`SetB1Spawned`	bInSpawned: `boolean`	`-`	Sets B1 Spawned.
`SetCanWeathering`	bInCanWeathering: `boolean`	`-`	Sets Can Weathering.
`SetCreatePurpose`	InPurpose: `EB1ObjectCreatePurpose`	`-`	Sets Create Purpose.
`SetCustomizedData`	InCustomizedData: `FB1ObjectCustomizeSaveData[]`	`-`	Sets Customized Data.
`SetCustomizedLightBrightness`	InPartsIndices: `integer[]`, InEmissiveMulti: `number`, InAttenuationMulti: `number`	`-`	Sets Customized Light Brightness.
`SetDevLock`	InLocked: `boolean`	`-`	Sets Dev Lock.
`SetGalleryPathKey`	InGalleryPathKey: `string`	`-`	Sets Gallery Path Key.
`SetHideMeshComponentTag`	InHideMeshComponentTag: `string`	`-`	Sets Hide Mesh Component Tag.
`SetInventoryPutInTicks`	InTicks: `integer`	`-`	Sets Inventory Put In Ticks.
`SetInvisibleObjectDuringInteraction`	InInvisibleObjectDuringInteraction: `boolean`	`-`	Sets Invisible Object During Interaction.
`SetLinkedCharacterId`	InEntityId: `FB1EntityId`	`-`	Sets Linked Character Id.
`SetLocatedSiteId`	LocationSiteId: `FB1EntityId`	`-`	Sets Located Site Id.
`SetNonSiteObject`	bInIsNonSiteObject: `boolean`	`-`	Sets Non Site Object.
`SetObjectId`	InObjectId: `string`	`-`	Sets Object Id.
`SetObjectState`	InStateGroupId: `string`, InStateId: `string`	`-`	Sets Object State.
`SetObjectType`	InType: `EB2GameObjectDetailType`	`-`	Sets Object Type.
`SetOwnershipByData`	InOwneshipData: `FB1OwnershipData`	`boolean`	Sets Ownership By Data.
`SetOwnershipByType`	InOwnershipType: `EB1OwnershipType`, InOwnerId: `FB1EntityId`	`boolean`	Ownership
`SetPrintedMeshId`	InPrintedMeshId: `string`	`-`	Sets Printed Mesh Id.
`SetPrintedMeshOffset`	InMeshOffset: `FVector`	`-`	Sets Printed Mesh Offset.
`SetPropertyOwnedHouseholdEntityId`	InEntityId: `FB1EntityId`	`-`	Sets Property Owned Household Entity Id.
`SetQuality`	InQuality: `EB1Quality`	`-`	Sets Quality.
`SetQualityId`	InQualityId: `string`	`-`	Sets Quality Id.
`SetRelatedProps`	InRelatedProps: `table<integer, integer>`	`-`	Sets Related Props.
`SetSalePrice`	InPrice: `integer`	`-`	Sets Sale Price.
`SetScale`	InScale: `FVector`	`-`	Sets Scale.
`SetSellerEntityId`	InEntityId: `FB1EntityId`	`-`	Sets Seller Entity Id.
`SetSize`	InSize: `FVector`	`-`	Sets Size.
`SetWeatherObjectEffectApplied`	bInApplied: `boolean`	`-`	Sets Weather Object Effect Applied.
`SetZoneIndex`	InZoneIndex: `integer`	`-`	Sets Zone Index.
`SyncKickSuppressedForReject`	`-`	`-`
`ToTraceLog`	`-`	`string`
`UpdateEndBuildModeOccupiedEntitiesLocation`	`-`	`-`	Updates End Build Mode Occupied Entities Location.
`UpdateGameObjectSiteZoneIndex`	`-`	`-`	Updates Game Object Site Zone Index.
`UpdateSocialClusters`	`-`	`-`	Updates Social Clusters.

Override points (26)

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

Function	Parameters	Returns	Description
`Override_ApplyOwnershipToCharacterCache`	`-`	`-`	Applies Ownership To Character Cache.
`Override_AttachCharacter`	InEntityId: `FB1EntityId`, InSlotName: `string`	`boolean`
`Override_BeginActivePhysics`	InMaxLifetimeDeadline: `FDateTime`, InThrowInstigatorEntityId: `FB1EntityId`	`-`	Begins Active Physics.
`Override_CacheSpaceAttribute`	`-`	`-`
`Override_ClearOccupiedSlotAndGrouping`	`-`	`-`	Clears Occupied Slot And Grouping.
`Override_ClearSpaceAttributeCache`	`-`	`-`	Clears Space Attribute Cache.
`Override_CloseSale`	`-`	`-`
`Override_DetachCharacter`	InEntityId: `FB1EntityId`	`boolean`
`Override_ExcludeFromAOI`	`-`	`-`
`Override_HandleReceiveByHandOver`	InReceiverId: `FB1EntityId`	`-`
`Override_InitBoxComponent`	`-`	`-`	Initializes Box Component.
`Override_NotifyKickRequestRejected`	`-`	`-`
`Override_OnActivePhysicsSleepNotified`	InFinalTransform: `InFinalTransform`	`-`	Callback invoked on Active Physics Sleep Notified.
`Override_OnApplyGlobalMaterialParameter`	InMaterialParamMappingId: `string`	`-`	Callback invoked on Apply Global Material Parameter.
`Override_OnObjectBpDataRebuilt`	InIsChangedObject: `boolean`	`-`	Callback invoked on Object Bp Data Rebuilt.
`Override_OnSpawnedGameObject`	InSpawnedTransform: `FTransform`	`-`	Callback invoked on Spawned Game Object.
`Override_OnUpdateGameObjectInfo`	`-`	`-`	Callback invoked on Update Game Object Info.
`Override_PauseSale`	`-`	`-`
`Override_ReCalculatePrice`	`-`	`boolean`
`Override_RequestRemoveChildEntity`	InEntityId: `FB1EntityId`	`boolean`	Requests Remove Child Entity.
`Override_SendObjectGrouping`	`-`	`-`	Sends Object Grouping.
`Override_SyncKickSuppressedForReject`	`-`	`-`
`Override_UpdateEndBuildModeOccupiedEntitiesLocation`	`-`	`-`	Updates End Build Mode Occupied Entities Location.
`Override_UpdateGameObjectSiteZoneIndex`	`-`	`-`	Updates Game Object Site Zone Index.
`Override_UpdateKickSuppressed`	`-`	`-`	Updates Kick Suppressed.
`Override_UpdateSocialClusters`	`-`	`-`	Updates Social Clusters.