FB2Actor

Overview

No description available.

Metadata

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

Properties (22)

Name	Type	Description
`AnimInstances`	`any[]`	UPROPERTY(Transient)
`BoundRadius`	`number`
`BoxExtent`	`FVector`
`CheatRecommendedActivities`	`table<string, boolean>`
`FakeObjectLocatedSiteId`	`FB1EntityId`
`FloorLevel`	`integer`
`HouseholdEntityId`	`FB1EntityId`
`InventoryEntityId`	`FB1EntityId`
`LocatedSiteId`	`FB1EntityId`
`LocationCheckSum`	`integer`
`OldLocation`	`FVector`
`OriginOffset`	`FVector`
`RelativeTransform`	`FTransform`
`SimulationPriorityFlags`	`integer`	Flags marking that this actor has priority and should be shown at SLOD0.
`SnappedCoord2D`	`FIntVector2`
`Tags`	`string[]`
`WorldTransform`	`FTransform`
`bCollisionEnabled`	`boolean`
`bLocationChanged`	`boolean`	True on location change; reset to false after the Site is updated in OnTick.
`bRelativeTransformDirty`	`boolean`
`bRescuing`	`boolean`
`bShowSimulationTransform`	`boolean`

Functions (53)

Function	Parameters	Returns	Description
`AddHowling`	InHowlingDtId: `string`, InHowlingEntityId: `FB1EntityId`	`-`	Manages AttachedHowling.
`AddSimulationPriorityFlag`	InFlag: `EB1SimulationPriority`	`-`	SLOD Priority
`ApplyDeferredChildRelativeTransform`	`-`	`-`	Applies Deferred Child Relative Transform.
`CalculateCheckSum`	`-`	`integer`	Computes a CRC.
`ClearSimulationPriorityFlags`	`-`	`-`	Clears Simulation Priority Flags.
`GenerateAnimInstance`	InPlayingComponentName: `string`	`-`	Generates Anim Instance.
`GetAnimInstance`	InPlayingComponentName: `string`	`FB2AnimInstance`	Returns Anim Instance.
`GetCityMovePolicyMap`	InCityMoveDataPolicyType: `EB1CityMoveDataPolicyType`	`table<string, EB1CityMoveDataPolicy>`	Returns City Move Policy Map.
`GetDetailType`	`-`	`integer`	Returns Detail Type.
`GetFakeObjectLocatedSiteId`	`-`	`FB1EntityId`	Returns Fake Object Located Site Id.
`GetFloorLevel`	`-`	`integer`	Returns Floor Level.
`GetHouseholdEntityId`	`-`	`FB1EntityId`	Returns Household Entity Id.
`GetInventoryEntityId`	`-`	`FB1EntityId`	Returns Inventory Entity Id.
`GetLocatedSiteDtId`	`-`	`string`	Returns Located Site Dt Id.
`GetLocatedSiteId`	`-`	`FB1EntityId`	Returns Located Site Id.
`GetLocation`	`-`	`FVector`	Returns Location.
`GetMajorType`	`-`	`integer`	Returns Major Type.
`GetOldLocation`	`-`	`FVector`	Returns Old Location.
`GetRelativeTransform`	`-`	`FTransform`	Returns Relative Transform.
`GetRotation`	`-`	`FRotator`	Returns Rotation.
`GetSimulationPriorityFlags`	`-`	`integer`	Returns Simulation Priority Flags.
`GetType`	`-`	`EB2EntityType`	Returns Type.
`GetWorldTransform`	`-`	`FTransform`	Returns World Transform.
`HasAnySimulationPriorityFlag`	`-`	`boolean`	Returns whether it has Any Simulation Priority Flag.
`IsAutonomyEnable`	`-`	`boolean`	Returns whether autonomy is enabled.
`IsCollisionEnabled`	`-`	`boolean`	Returns whether Collision Enabled.
`IsContainTags`	InTags: `string[]`	`boolean`	Returns whether Contain Tags.
`IsContainsAOI`	`-`	`boolean`	Returns whether Contains AOI.
`IsFullBodyMontagePlaying`	`-`	`boolean`	Returns whether Full Body Montage Playing.
`IsPlayingAnimation`	`-`	`boolean`	Returns whether Playing Animation.
`IsRescuing`	`-`	`boolean`	Returns whether Rescuing.
`OnBeginOverlap`	OtherEntityId: `FB1EntityId`	`-`	Callback invoked on Begin Overlap.
`OnEndOverlap`	OtherEntityId: `FB1EntityId`	`-`	Callback invoked on End Overlap.
`RemoveHowling`	InHowlingDtId: `string`	`-`	Removes Howling.
`RemoveSimulationPriorityFlag`	InFlag: `EB1SimulationPriority`	`-`	Removes Simulation Priority Flag.
`RequestAddChildEntity`	InEntityId: `FB1EntityId`, InAttachRule: `EB1EntityAttachRule`, InExtraRelativeTransform: `FTransform`	`boolean`	Requests Add Child Entity.
`RequestRemoveChildEntity`	InEntityId: `FB1EntityId`	`boolean`	Requests Remove Child Entity.
`SetBoxOffsetAndExtent`	Offset: `FVector`, Extent: `FVector`, ObjectBoundRadius: `number`	`-`	Sets Box Offset And Extent.
`SetCollisionEnabled`	bEnabled: `boolean`	`-`	Sets Collision Enabled.
`SetFakeObjectLocatedSiteId`	LocationSiteId: `FB1EntityId`	`-`	Sets Fake Object Located Site Id.
`SetFloorLevel`	InFloorLevel: `integer`	`-`	Sets Floor Level.
`SetHouseholdEntityId`	InEntityId: `FB1EntityId`	`-`	Sets Household Entity Id.
`SetInventoryEntityId`	InEntityId: `FB1EntityId`	`-`	Sets Inventory Entity Id.
`SetLocatedSiteId`	LocationSiteId: `FB1EntityId`	`-`	Sets Located Site Id.
`SetLocationAndRotationOnlySimul`	InLocation: `FVector`, InRotation: `FRotator`, bDeferredRelativeUpdate: `boolean`	`-`	Sets Location And Rotation Only Simul.
`SetLocationAndRotationOnlySimulQuat`	InLocation: `FVector`, InQuaternion: `FQuat`, bDeferredRelativeUpdate: `boolean`	`-`	Sets Location And Rotation Only Simul Quat.
`SetLocationOnlySimul`	InLocation: `FVector`	`-`	Moves only on the B2 side; to also notify B1, see Teleport().
`SetOldLocation`	InLocation: `FVector`	`-`	Sets Old Location.
`SetRelativeTransformOnlySimul`	InTransform: `FTransform`, bRefreshWorldTransform: `boolean`	`-`	Sets Relative Transform Only Simul.
`SetRescuing`	bInRescuing: `boolean`	`-`	Sets Rescuing.
`SetRotationOnlySimul`	InRotation: `FRotator`	`-`	Sets Rotation Only Simul.
`StopAllAnimInstance`	`-`	`-`	Stops All Anim Instance.
`UdpateAnimInstance`	DeltaTime: `number`	`-`

Override points (8)

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

Function	Parameters	Returns	Description
`Override_AddHowling`	InHowlingDtId: `string`, InHowlingEntityId: `FB1EntityId`	`-`	Manages AttachedHowling.
`Override_ApplyDeferredChildRelativeTransform`	`-`	`-`	Applies Deferred Child Relative Transform.
`Override_GenerateAnimInstance`	InPlayingComponentName: `string`	`-`	Generates Anim Instance.
`Override_RemoveHowling`	InHowlingDtId: `string`	`-`	Removes Howling.
`Override_RequestAddChildEntity`	InEntityId: `FB1EntityId`, InAttachRule: `EB1EntityAttachRule`, InExtraRelativeTransform: `FTransform`	`boolean`	Requests Add Child Entity.
`Override_RequestRemoveChildEntity`	InEntityId: `FB1EntityId`	`boolean`	Requests Remove Child Entity.
`Override_StopAllAnimInstance`	`-`	`-`	Stops All Anim Instance.
`Override_UdpateAnimInstance`	DeltaTime: `number`	`-`