FB2ServiceManager

Overview

Manages facility services.

Metadata

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

Properties (8)

Name	Type	Description
`ExecuteContextMap`	`table<string, FB2ExecuteContextList>`
`NextCheckTimeOutTicks`	`integer`
`SelectContextMap`	`table<string, FB2SelectContextList>`
`SelectExecuteConnections`	`FB1ServiceSelectExecuteConnection[]`	Connection between the selection context and the execution context.
`ServiceJobLookupTable`	`table<FB1EntityId, string>`	Job info of service Zois.
`ServiceJobPool`	`table<string, FB2JobEntityPool>`	Zoi info per service job group [JobId, list of service Zois].
`ServiceRoleTable`	`table<FB1EntityId, string>`	Role info of service Zois. Elements are added when a service starts and removed when it ends.
`SpawnContexts`	`table<FB1ServiceContextId, FB2ServiceSpawnContext>`

Functions (24)

Function	Parameters	Returns	Description
`AddService`	InRequestContext: `FB1ServiceRequestContext`, OutSelectContext: `FB1ServiceSelectContext`	`boolean`	Function called when an external system requests a service.
`CanExecuteServiceTimeCheck`	InServiceId: `string`, OutExpireOrNextExecuteTicks: `integer`	`boolean`	Checks whether the service-execution time condition is satisfied.
`DoesServiceAlreadyExist`	InRequestContext: `FB1ServiceRequestContext`	`boolean`	Checks whether the service is currently running.
`FinishServiceExceptionalOccasion`	InServiceTargetEntityId: `FB1EntityId`, bIsForSite: `boolean`	`-`	Used when a service must be ended in an exceptional situation.
`GetExecuteContextByContextId`	InExecuteContextId: `FB1ServiceContextId`, OutExecuteContext: `FB1ServiceExecuteContext`	`boolean`	Returns Execute Context By Context Id.
`GetExecuteContextByServiceId`	InServiceId: `string`, InExecuteContextId: `FB1ServiceContextId`, OutExecuteContext: `FB1ServiceExecuteContext`	`boolean`	Returns Execute Context By Service Id.
`GetExecuteContextFromTriggerEntityId`	InServiceId: `string`, InTriggerEntityId: `FB1EntityId`, OutExecuteContext: `FB1ServiceExecuteContext`	`boolean`	Returns Execute Context From Trigger Entity Id.
`GetExecuteContextId`	InSelectContextId: `FB1ServiceContextId`	`FB1ServiceContextId`	Returns Execute Context Id.
`GetExecutingServiceContext`	InServiceEntityId: `FB1EntityId`, OutContext: `FB1ServiceExecuteContext`	`boolean`	Helper. Returns the context of the service that the executing ServiceNpc is specifically performing.
`GetExecutingServiceEntityIdsByGroupId`	InGroupId: `string`, InSearchEntityId: `FB1EntityId`, OutEntityIds: `FB1EntityId[]`	`boolean`	Returns the list of ServiceNpc EntityIds currently executing a service at the given SiteEntityId.
`GetSelectContextByContextId`	InSelectId: `FB1ServiceContextId`, OutSelectContext: `FB1ServiceSelectContext`	`boolean`	Returns Select Context By Context Id.
`GetSelectContextByServiceId`	InServiceId: `string`, InSelectContextId: `FB1ServiceContextId`, OutSelectContext: `FB1ServiceSelectContext`	`boolean`	Returns Select Context By Service Id.
`GetSelectContextId`	InExecuteContextId: `FB1ServiceContextId`	`FB1ServiceContextId`	Returns Select Context Id.
`GetSelectExecuteConnection`	InSelectContextId: `FB1ServiceContextId`, OutConnection: `FB1ServiceSelectExecuteConnection`	`boolean`	Context Getters
`GetServiceJobId`	InServiceEntityId: `FB1EntityId`, OutServiceJobId: `string`	`boolean`	Returns the service Zoi's job ID.
`GetServiceRoleId`	InServiceEntityId: `FB1EntityId`, OutServiceRoleId: `string`	`boolean`	Returns the service Zoi's role ID.
`GetSpawnContext`	InContextId: `FB1ServiceContextId`, OutSpawnContext: `FB2ServiceSpawnContext`	`boolean`	Returns the service spawn context.
`IsExecutingService`	InServiceEntityId: `FB1EntityId`	`boolean`	Returns whether the ServiceNpc is currently performing a service.
`IsForSiteType` (static)	InType: `EB1ServiceVisitType`	`boolean`	Returns whether For Site Type.
`OnApplyPlanByEntityJob`	InEntityId: `FB1EntityId`, InJobId: `string`	`-`	Callback invoked on Apply Plan By Entity Job.
`OnApplyPlanByGeneratedList`	InGeneratedList: `any[]`	`-`	Manages the service-Zoi pool.
`OnFinishService`	InEntityId: `FB1EntityId`	`-`	Called when a service Zoi has reached its despawn point and despawned after the service timeline ends.
`OnLeaveCompany`	InEntityId: `FB1EntityId`	`-`	Callback invoked on Leave Company.
`ScriptFinishService`	InSubjectEntityId: `FB1EntityId`, InServiceSubjectType: `EB1ServiceSubjectType`, InServiceGroupId: `string`	`-`	Used to end a service NPC's service via script.

Override points (3)

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

Function	Parameters	Returns	Description
`Override_FinishServiceExceptionalOccasion`	InServiceTargetEntityId: `FB1EntityId`, bIsForSite: `boolean`	`-`	Used when a service must be ended in an exceptional situation.
`Override_OnLeaveCompany`	InEntityId: `FB1EntityId`	`-`	Callback invoked on Leave Company.
`Override_ScriptFinishService`	InSubjectEntityId: `FB1EntityId`, InServiceSubjectType: `EB1ServiceSubjectType`, InServiceGroupId: `string`	`-`	Used to end a service NPC's service via script.