FB2Entity

Overview

No description available.

Metadata

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

Properties (30)

Name	Type	Description
`AccGameDeltaMinutes`	`number`
`AccTickDelta`	`number`
`Components`	`any[]`
`ComponentsMap`	`table<string, any>`	All components.
`CreateReason`	`EB2EntityCreateReason`
`CurrentTickCount`	`integer`
`EntityId`	`FB1EntityId`
`EntityState`	`integer`
`EntityTags`	`FB2EntityTag[]`
`Hierarchy`	`FB2EntityHierarchy`
`LastPseudoSimulatedTick`	`integer`
`LocatedCityName`	`string`
`LuaModuleStates`	`table<string, string>`
`LuaModules`	`table<string, string>`
`OccupiedEntityId`	`FB1EntityId`
`OptimizeTickCount`	`integer`
`PendingEntityState`	`integer`
`PrevCreateReason`	`EB2EntityCreateReason`
`PrevDestroyReason`	`EB2EntityDestroyReason`	Records the destroy reason when the object pool is in use.
`PriorityPoolFixedIndex`	`integer`
`SignificanceBucket`	`EB2EntitySigBucket`
`SignificanceState`	`EB2EntitySigState`
`SimulationLevel`	`EB1SimulationLevel`
`TickInterval`	`number`
`TickScale`	`number`	Tick scale.
`TickableComponents`	`any[]`
`UpdatePoolIndex`	`integer`
`bForceSimulationLevelOfDetailTwo`	`boolean`
`bForceSimulationLevelOfDetailZero`	`boolean`
`bTickEnabled`	`boolean`

Functions (89)

Function	Parameters	Returns	Description
`AddEntityState`	InState: `EB2EntityState`, InReason: `EB2EntityStateChangeReason`	`boolean`	Adds Entity State.
`AddLuaModule`	InName: `string`, InModulePath: `string`	`-`	Manages dynamic Lua modules; delegates to LuaHost (sim-thread guaranteed).
`AddTag`	InTag: `string`, GameTimeMinute: `integer`	`-`	Adds Tag.
`ArrangeTags_WithLock`	`-`	`-`
`ArrangeTags_WithoutLock`	CurrentTime: `FDateTime`	`-`
`CheckHierarchyFast`	`-`	`boolean`	Hierarchy
`ClearAllChildsOnDestroy`	`-`	`-`	Clears All Childs On Destroy.
`ClearPendingEntityState`	`-`	`-`	Clears Pending Entity State.
`ClearSubscribe`	`-`	`-`	Clears Subscribe.
`ContainsChildEntity`	InEntityId: `FB1EntityId`	`boolean`
`GetChildEntityCount`	`-`	`integer`	Returns Child Entity Count.
`GetChildEntityIds`	`-`	`FB1EntityId[]`	Returns Child Entity Ids.
`GetCityMovePolicyMap`	InCityMoveDataPolicyType: `EB1CityMoveDataPolicyType`	`table<string, EB1CityMoveDataPolicy>`	Returns City Move Policy Map.
`GetComponent`	ComponentType: `EB2ComponentType`	`FB2Component`	Returns Component.
`GetComponentScript`	`-`	`-`	Returns Component Script.
`GetDefaultCityMoveDataPolicy`	`-`	`EB1CityMoveDataPolicy`	Returns Default City Move Data Policy.
`GetDetailType`	`-`	`integer`	Returns Detail Type.
`GetEffectiveEntityState`	`-`	`integer`	Returns Effective Entity State.
`GetEntityCreateReason`	`-`	`EB2EntityCreateReason`	Returns Entity Create Reason.
`GetEntityId`	`-`	`FB1EntityId`	Returns Entity Id.
`GetEntityState`	`-`	`integer`	Returns Entity State.
`GetFName`	`-`	`string`	Returns FName.
`GetGameTimeDeltaMinutes`	`-`	`number`	Returns Game Time Delta Minutes.
`GetHalfHeight`	`-`	`number`	Returns Half Height.
`GetLastPseudoSimulatedTick`	`-`	`integer`	Returns Last Pseudo Simulated Tick.
`GetLocatedCityId`	`-`	`string`	Returns Located City Id.
`GetLuaScript`	`-`	`-`	Returns Lua Script.
`GetMajorType`	`-`	`integer`	Returns Major Type.
`GetOccupiedEntityId`	`-`	`FB1EntityId`	Returns Occupied Entity Id.
`GetParentEntityId`	`-`	`FB1EntityId`	Returns Parent Entity Id.
`GetPriorityPoolFixedIndex`	`-`	`integer`	Returns Priority Pool Fixed Index.
`GetProcessedTickCount`	`-`	`integer`	Returns Processed Tick Count.
`GetRadius`	`-`	`number`	Returns Radius.
`GetSignificanceBucket`	`-`	`EB2EntitySigBucket`	Returns Significance Bucket.
`GetSignificanceState`	`-`	`EB2EntitySigState`	Returns Significance State.
`GetSimulationLOD`	`-`	`EB1SimulationLevel`	Returns Simulation LOD.
`GetTickScale`	`-`	`number`	Returns the tick scale.
`GetType`	`-`	`EB2EntityType`	Returns Type.
`GetUpdatePoolIndex`	`-`	`integer`	Returns Update Pool Index.
`GetVelocity`	`-`	`FVector`	Returns Velocity.
`HasAnySimulationPriorityFlag`	`-`	`boolean`	Returns whether it has Any Simulation Priority Flag.
`HasEffectiveEntityState`	InState: `EB2EntityState`	`boolean`	Returns whether it has Effective Entity State.
`HasEntityState`	InState: `EB2EntityState`	`boolean`	Returns whether it has Entity State.
`HasLuaModule`	InName: `string`	`boolean`	Returns whether it has Lua Module.
`HasPendingEntityState`	`-`	`boolean`	Returns whether it has Pending Entity State.
`HasTag`	InTag: `string`	`boolean`	Returns whether it has Tag.
`IsAvailableTick`	tickCount: `integer`	`boolean`	Checks whether ticking is allowed.
`IsCleared`	`-`	`boolean`	Returns whether Cleared.
`IsEqualEntityState`	InState: `EB2EntityState`	`boolean`	Returns whether Equal Entity State.
`IsForceSimulationLevelOfDetailTwo`	`-`	`boolean`	Returns whether Force Simulation Level Of Detail Two.
`IsForceSimulationLevelOfDetailZero`	`-`	`boolean`	Returns whether Force Simulation Level Of Detail Zero.
`IsHierarchyValid`	`-`	`boolean`	Returns whether Hierarchy Valid.
`IsInvalid`	`-`	`boolean`	Returns whether Invalid.
`IsNeedSpawnUpdate`	`-`	`boolean`	Returns whether Need Spawn Update.
`IsRegistered`	`-`	`boolean`	Returns whether Registered.
`IsSimulated`	`-`	`boolean`	Returns whether Simulated.
`IsSpawned`	`-`	`boolean`	Returns whether Spawned.
`IsTickEnabled`	`-`	`boolean`	Returns whether Tick Enabled.
`IsTickEnabledRaw`	`-`	`boolean`	The raw bTickEnabled value without IsTickEnabled()'s composite conditions (Simulate/DebugActive). For pre-checks by debug cheats.
`OnTickRestore`	`-`	`-`	Restore entry point for the B2DebugDisableTickForSLOD2(false) / SLOD2-exit hook. The default implementation is SetTickEnabled(true). Derived classes may augment it (e.g. catch-up) and need not call Super (to avoid a double SetTickEnabled(true)). No manager lock is held at call time and the tracking-map update is already done, so hook re-entry is safe. InDisabledAtGameTicks: game-time ticks when it was disabled (per FB2TimeManager::StaticGetCurrentTicks()).
`RefreshB1Spawn`	bImmediate: `boolean`	`-`
`RemoveEntityState`	InState: `EB2EntityState`, InReason: `EB2EntityStateChangeReason`	`boolean`	Removes Entity State.
`RemoveLuaModule`	InName: `string`	`-`	Removes Lua Module.
`RemoveTag_WithLock`	InTag: `string`	`-`	Removes Tag_With Lock.
`RemoveTag_WithoutLock`	InTag: `string`	`-`	Removes Tag_Without Lock.
`RequestAddChildEntity`	InEntityId: `FB1EntityId`, InAttachRule: `EB1EntityAttachRule`, InExtraRelativeTransform: `FTransform`	`boolean`	Requests Add Child Entity.
`RequestRemoveChildEntity`	InEntityId: `FB1EntityId`	`boolean`	Requests Remove Child Entity.
`RequestRemoveFromHierarchy`	`-`	`boolean`	Requests Remove From Hierarchy.
`SendSLODInfo`	`-`	`-`	Sends SLODInfo.
`SetComponentTickEnable`	Enabled: `boolean`, Component: `FB2Component`	`-`	Sets Component Tick Enable.
`SetEntityCreateReason`	InReason: `EB2EntityCreateReason`	`-`	Sets Entity Create Reason.
`SetEntityState`	InState: `EB2EntityState`, InReason: `EB2EntityStateChangeReason`	`boolean`	Sets Entity State.
`SetForceSimulationLevelOfDetailTwo`	bInForceSimulationLevelOfDetailTwo: `boolean`	`-`	Sets Force Simulation Level Of Detail Two.
`SetForceSimulationLevelOfDetailZero`	bInForceSimulationLevelOfDetailZero: `boolean`	`-`	Sets Force Simulation Level Of Detail Zero.
`SetLastPseudoSimulatedTick`	InTick: `integer`	`-`	Sets Last Pseudo Simulated Tick.
`SetLocatedCityId`	InLocatedCityId: `string`	`-`	Sets Located City Id.
`SetOccupiedEntityId`	InEntityId: `FB1EntityId`	`-`	Sets Occupied Entity Id.
`SetPendingEntityState`	InState: `EB2EntityState`	`-`	Records the planned state in advance when registering LazyUpdateEntityState, so that asynchronous systems (e.g. SignificanceManager) reference the correct state when processing an entity from a stale bucket.
`SetPriorityPoolFixedIndex`	fixedIndex: `integer`	`-`	Sets Priority Pool Fixed Index.
`SetProcessedTickCount`	tickCount: `integer`	`-`	Synchronizes with the simulation tick count.
`SetSignificanceBucket`	InBucket: `EB2EntitySigBucket`	`-`	Sets Significance Bucket.
`SetSignificanceState`	InState: `EB2EntitySigState`	`-`	Sets Significance State.
`SetSimulationLevel`	InSimulationLevel: `EB1SimulationLevel`	`-`	Sets Simulation Level.
`SetTickEnabled`	bEnabled: `boolean`	`-`	Intentionally non-virtual: the debug hook's SLOD2-entry path calls this during tracking-map updates, so a derived side effect (callback/re-entry) would risk map inconsistency. The restore path is separated (OnTickRestore) and called after the map update.
`SetTickInterval`	interval: `number`	`-`	Sets Tick Interval.
`SetTickScale`	scale: `number`	`-`	Sets Tick Scale.
`SetUpdatePoolIndex`	index: `integer`	`-`	Sets Update Pool Index.
`ShouldProcessTick`	`-`	`boolean`	Returns whether it should Process Tick.
`Unsubscribe`	Channel: `string`	`-`

Override points (14)

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

Function	Parameters	Returns	Description
`Override_AddEntityState`	InState: `EB2EntityState`, InReason: `EB2EntityStateChangeReason`	`boolean`	Adds Entity State.
`Override_AddTag`	InTag: `string`, InGameTimeMinute: `integer`	`-`	Adds Tag.
`Override_ArrangeTags_WithLock`	`-`	`-`
`Override_ArrangeTags_WithoutLock`	CurrentTime: `FDateTime`	`-`
`Override_ClearSubscribe`	`-`	`-`	Clears Subscribe.
`Override_RefreshB1Spawn`	bImmediate: `boolean`	`-`
`Override_RemoveEntityState`	InState: `EB2EntityState`, InReason: `EB2EntityStateChangeReason`	`boolean`	Removes Entity State.
`Override_RemoveTag_WithLock`	InTag: `string`	`-`	Removes Tag_With Lock.
`Override_RemoveTag_WithoutLock`	InTag: `string`	`-`	Removes Tag_Without Lock.
`Override_RequestAddChildEntity`	InEntityId: `FB1EntityId`, InAttachRule: `EB1EntityAttachRule`, InExtraRelativeTransform: `FTransform`	`boolean`	Requests Add Child Entity.
`Override_RequestRemoveChildEntity`	InEntityId: `FB1EntityId`	`boolean`	Requests Remove Child Entity.
`Override_RequestRemoveFromHierarchy`	`-`	`boolean`	Requests Remove From Hierarchy.
`Override_SendSLODInfo`	`-`	`-`	Sends SLODInfo.
`Override_Unsubscribe`	Channel: `string`	`-`