FB2EntityManager

Overview

Central manager for the entity (character/object) pool and lifetime.

Metadata

Field	Value
Kind	`system`
Environment	B2 - Simulation
Category	`systems`
Extends	`FB2ManagerBase`
Require	`require('Systems.B2EntityManager')`

Properties (24)

Name	Type	Description
`AccumulateGameTimeDeltaForSOBuffer`	`number[]`
`AccumulateTickForSOBuffer`	`number[]`
`AllEntities`	`any[]`	UPROPERTY(Transient)
`AllEntitiesMap`	`table<FB1EntityId, any>`	UPROPERTY(Transient)
`CachedCityEntityId`	`FB1EntityId`	Cities are loaded one at a time, so there can never be overlapping CityEntities.
`ComponentPoolMap`	`table<string, any>`
`EntityCollectionMap`	`table<EB2EntityType, FB2EntityCollection>`	UPROPERTY(Transient)
`EntityPoolMap`	`table<any, any>`	Object pool
`GhostCount`	`integer`
`IsInViewportCharacterMap`	`table<FB1EntityId, boolean>`
`LazyUpdateEntityStateMap`	`table<FB1EntityId, FB2LazyChangeEntityStateData>`
`ManagedGroup`	`table<FB1EntityId, any[]>`
`OwnerlessGrabEntityList`	`table<FB1EntityId, boolean>`
`PendingDeathEntityIds`	`table<FB1EntityId, boolean>`
`PendingDestroyOnBeginPlay`	`any[]`
`PendingUnregisterEntities`	`table<any, boolean>`
`PriorityEntities`	`any`
`RAWObjectPoolMap`	`table<string, any>`
`SLODChangeInfoList`	`table<EB2EntityType, FB1EntitySLODInfoMap>`
`SpreadOutEntities`	`table<integer, any[]>`	Buffers used to spread tick processing across frames.
`SpreadOutMax`	`integer`	SLOD2 spread-out tick interval, tied to the preset (HIGH/MID/LOW = 60/120/180). SimulationThread-only.
`UpdatePoolIndex`	`integer`
`UsedPathInfoByEntity`	`table<FB1EntityId, table<any, boolean>>`
`bLazyUpdateStateLock`	`boolean`

Functions (75)

Function	Parameters	Returns	Description
`AccumulateSOBufferGameTimeDelta`	GameDeltaMinutes: `number`	`-`
`AccumulateSOBufferTicks`	DeletaTime: `number`	`-`
`AddOwnerlessGrabEntity`	InEntityId: `FB1EntityId`	`-`	Handles grab objects that have lost their OwnerEntityId.
`AddPriorityEntity`	Entity: `any`	`-`	Adds Priority Entity.
`AddTickableComponent`	InEntityType: `EB2EntityType`, InComponent: `FB2Component`	`-`	Adds Tickable Component.
`AddUsedPathInfo`	EntityId: `FB1EntityId`, SitePathFindingCom: `FB2Component`	`-`	Accumulates Entity:PathFollowingCom path-usage info.
`AppendEntityToManagedGroup`	GroupEntityId: `FB1EntityId`, MemberEntity: `FB2Entity`	`-`	Groups actual objects into an Id-managed entity group (like Site), for fast Find lookups.
`BeginDestroy`	`-`	`-`	Begins Destroy.
`ChangeCrowdSpawnCount`	InCrowdSpawnCount: `integer`	`-`
`ClearAccumulateGameDelta`	BufferIndex: `integer`	`-`	Clears Accumulate Game Delta.
`ClearAccumulateTick`	BufferIndex: `integer`	`-`	Clears Accumulate Tick.
`ClearPostProcessTask`	`-`	`-`	Clears Post Process Task.
`DecreaseGhostCount` (static)	`-`	`-`
`DestroyObject`	Entity: `FB2Entity`, InReason: `EB2EntityDestroyReason`	`-`
`FindAvailableEventCrowd`	`-`	`-`	Finds and returns Available Event Crowd.
`FindCharacter`	entityId: `FB1EntityId`	`-`	Finds and returns Character.
`FindCurrentCity`	`-`	`-`	Finds and returns Current City.
`FindGameObject`	entityId: `FB1EntityId`	`-`	Finds and returns Game Object.
`FindHousehold`	entityId: `FB1EntityId`	`-`	Finds and returns Household.
`FindSite`	entityId: `FB1EntityId`	`-`	Finds and returns Site.
`FindSiteByCareerDtId`	CareerDtId: `string`	`-`	Finds and returns Site By Career Dt Id.
`FindSiteBySiteId`	SiteId: `string`	`-`	Finds and returns Site By Site Id.
`FlushLazyUpdateEntityState`	`-`	`-`
`Get`	`-`	`-`
`GetAccumulateGameDelta`	CurrentBufferIndex: `integer`	`number`	Returns Accumulate Game Delta.
`GetAccumulateTick`	CurrentBufferIndex: `integer`	`number`	Returns Accumulate Tick.
`GetAllEntities`	EntityType: `EB2EntityType`	`-`	Returns All Entities.
`GetCityDefaultSiteDatas`	NewGameFolderPath: `string`, OutSiteJsonPath: `string[]`	`-`	Returns City Default Site Datas.
`GetCurrentCrowdCount`	`-`	`integer`	Returns Current Crowd Count.
`GetDeepSize`	`-`	`SIZE_T`	Returns Deep Size.
`GetGhostCount` (static)	`-`	`integer`	Returns Ghost Count.
`GetLastEntityId`	`-`	`integer`	Returns Last Entity Id.
`GetOwnerlessGrabEntityList`	`-`	`table<FB1EntityId, boolean>`	Returns Ownerless Grab Entity List.
`GetSpreadOutMax`	`-`	`integer`	Controls the SLOD2 spread-out tick interval. Allows one of 60/120/180. SimulationThread-only (must not be called from the GameThread).
`GetType`	`-`	`EB2ManagerType`	Returns Type.
`IncreaseGhostCount` (static)	`-`	`-`
`InitializeNewGameEntity`	NewGameFolderPath: `string`	`-`	Initializes New Game Entity.
`IsInViewportCharacter` (static)	InEntityId: `FB1EntityId`	`boolean`	Returns whether In Viewport Character.
`IsNeedSLODPacket`	InInfo: `FB1EntitySLODInfo`	`boolean`	Returns whether Need SLODPacket.
`IsRegisteredInComponentPool`	Component: `FB2Component`	`boolean`	Returns whether Registered In Component Pool.
`IsRegisteredInEntityPool`	Entity: `FB2Entity`	`boolean`	Returns whether Registered In Entity Pool.
`IsRegisteredInRAWObjectPool`	RAWObject: `FB2RawObject`	`boolean`	Returns whether Registered In RAWObject Pool.
`IsReleasedEntity`	Entity: `FB2Entity`	`boolean`	Returns whether Released Entity.
`IsTickable`	`-`	`boolean`	Returns whether Tickable.
`OnObserverForSiteMember`	SiteEntityId: `FB1EntityId`, MemberEntity: `FB2Entity`, IsRegister: `boolean`	`-`	Callback invoked on Observer For Site Member.
`OnRemoveEntityUsedPath`	EntityId: `FB1EntityId`	`-`	Callback invoked on Remove Entity Used Path.
`OnSLODChange` (static)	InEntityId: `FB1EntityId`, InInfo: `FB1EntitySLODInfo`	`-`	Callback invoked on SLODChange.
`OnSetIsInViewportCharacter` (static)	InViewportCharacterMap: `table<FB1EntityId, boolean>`	`-`	Callback invoked on Set Is In Viewport Character.
`PostProcessTasks`	`-`	`-`
`ProcessExpandPoolTask`	`-`	`-`
`ProcessOwnershipDataCompatibility`	InGameObject: `any`	`-`
`ProcessPendingUnregisterEntities`	`-`	`-`
`Register`	Entity: `any`, bPostInit: `boolean`	`FB1EntityId`
`RegisterCharacters`	InCityName: `string`, InHouseholdEntityId: `FB1EntityId`, InCharacterInfoList: `FB1CustomizedCharacterInfo[]`	`boolean`	Registers Characters.
`RegisterHousehold`	InCityName: `string`, InHouseholdInfo: `FB1CustomizedHouseholdInfo`	`FB1EntityId`	Registers Household.
`ReleaseObject`	Entity: `FB2Entity`	`-`
`ReleaseObjectAndComponents`	Entity: `FB2Entity`	`-`
`RemoveEntityFromManagedGroup`	GroupEntityId: `FB1EntityId`, MemberEntity: `FB2Entity`	`-`	Removes Entity From Managed Group.
`RemovePriorityEntity`	Entity: `any`	`-`	Removes Priority Entity.
`RemoveTickableComponent`	InEntityType: `EB2EntityType`, InComponent: `FB2Component`	`-`	Removes Tickable Component.
`RemoveUsedPathInfo`	EntityId: `FB1EntityId`, SitePathFindingCom: `FB2Component`	`-`	Removes Used Path Info.
`RequestCharacterStateChange`	InEntityId: `FB1EntityId`, InState: `EB2CharacterState`, InReason: `EB2EntityStateChangeReason`	`-`	Requests Character State Change.
`RequestPendingDeath`	InEntityId: `FB1EntityId`	`-`	Requests Pending Death.
`RequestPendingDestroyOnBeginPlay`	InEntity: `any`, InReason: `EB2EntityDestroyReason`	`-`	Requests Pending Destroy On Begin Play.
`ResetOnCompletedRegister`	`-`	`-`	Resets On Completed Register.
`ResetOnCompletedStateChanged`	`-`	`-`	Resets On Completed State Changed.
`ResetOnCompletedUnregister`	`-`	`-`	Resets On Completed Unregister.
`ResetOwnerlessGrabEntityList`	`-`	`-`	Resets Ownerless Grab Entity List.
`SetForceSimulationLevelOfDetailTwo` (static)	bIsOn: `boolean`	`-`	Sets Force Simulation Level Of Detail Two.
`SetIsInViewportCharacter`	InViewportCharacterMap: `table<FB1EntityId, boolean>`	`-`	Sets Is In Viewport Character.
`SetLastEntityId`	InLastEntityId: `integer`	`-`	Sets Last Entity Id.
`SetSpreadOutMax`	InNewMax: `integer`	`-`	Sets Spread Out Max.
`Unregister`	Entity: `any`	`-`
`UnregisterInternal`	Entity: `any`	`-`	Unregisters Internal.
`ValidateAllEntityHierarchy`	InValidateEntityType: `EB2EntityType`	`-`

Override points (2)

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

Function	Parameters	Returns	Description
`Override_RegisterCharacters`	InCityName: `string`, InHouseholdEntityId: `FB1EntityId`, InCharacterInfoList: `FB1CustomizedCharacterInfo[]`	`boolean`	Registers Characters.
`Override_RegisterHousehold`	InCityName: `string`, InHouseholdInfo: `FB1CustomizedHouseholdInfo`	`FB1EntityId`	Registers Household.