FB2SiteEventManager

Overview

Manages events that occur at sites.

Metadata

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

Properties (4)

Name	Type	Description
`CachedPendingRandomEventParamMap`	`table<FB1EntityId, FB1SiteEventSettingParam>`
`PlayingZoiSiteEventMap`	`table<FB1EntityId, FB1SiteEventIdList>`
`SiteEventIdGenerator`	`any`
`SiteEventMap`	`table<FB1SiteEventId, any>`

Functions (35)

Function	Parameters	Returns	Description
`ClearCachedPendingRandomEventParam`	InHostEntityId: `FB1EntityId`	`-`	Clears Cached Pending Random Event Param.
`Get`	`-`	`-`
`GetAllSiteEvents`	Self: `FB2SiteEventManager`	`-`	Returns All Site Events.
`GetCachedPendingRandomEventParam`	InHostEntityId: `FB1EntityId`	`FB1SiteEventSettingParam`	Returns Cached Pending Random Event Param.
`GetCurrentLocatedSiteEvent`	Self: `FB2SiteEventManager`, LocatedSiteId: `string`	`-`	Returns Current Located Site Event.
`GetCurrentSiteEvent`	Self: `FB2SiteEventManager`, MemberId: `FB1EntityId`	`-`	Returns Current Site Event.
`GetJoinedSiteEvents`	Self: `FB2SiteEventManager`, MemberId: `FB1EntityId`	`-`	Returns Joined Site Events.
`GetSiteEvent`	Self: `FB2SiteEventManager`, SiteEventId: `FB1SiteEventId`	`-`	Returns Site Event.
`GetSiteEventTimeRangeList`	InEventCategory: `string`	`FB1SiteEventTimeRange[]`	Returns Site Event Time Range List.
`GetType`	`-`	`EB2ManagerType`	Returns Type.
`HasPendingCreateRequest`	InRequestId: `integer`	`boolean`	Returns whether it has Pending Create Request.
`HasSiteEventPlannedInSite`	InSiteId: `string`, InType: `EB1SiteEventType`	`boolean`	Returns whether it has Site Event Planned In Site.
`IsPendingHostRandomEvent`	InHostEntityId: `FB1EntityId`	`boolean`	Returns whether Pending Host Random Event.
`IsPlayingSiteEvent`	InSiteId: `string`	`boolean`	Returns whether Playing Site Event.
`IsTickable`	`-`	`boolean`	Returns whether Tickable.
`JoinSiteEventMember`	InSiteEventId: `FB1SiteEventId`, InMemberId: `FB1EntityId`	`-`
`LeftSiteEventMember`	InSiteEventId: `FB1SiteEventId`, InMemberId: `FB1EntityId`	`-`
`OnAddAutonomyRoleCacheData`	InSiteId: `string`, InInteractionTags: `string[]`, InStatId: `string`, InAddRewardScore: `integer`	`-`	Callback invoked on Add Autonomy Role Cache Data.
`OnArrivedSiteEvent`	InMemberId: `FB1EntityId`, InSiteEventId: `FB1SiteEventId`	`-`	Callback invoked on Arrived Site Event.
`OnBreakEngagement`	InMemberId: `FB1EntityId`	`-`	Callback invoked on Break Engagement.
`OnCancelSocialEvent`	InSiteEventId: `FB1SiteEventId`, InMemberId: `FB1EntityId`	`-`	Callback invoked on Cancel Social Event.
`OnChangePossessEntityId`	InPrevEntityId: `FB1EntityId`, InCurrentEntityId: `FB1EntityId`	`-`	Callback invoked on Change Possess Entity Id.
`OnDeathCharacter`	InMemberId: `FB1EntityId`	`-`	Callback invoked on Death Character.
`OnPreCreateConflictConfirmed`	InRequestId: `integer`, bConfirmed: `boolean`	`-`	Callback invoked on Pre Create Conflict Confirmed.
`OnRemoveAutonomyRoleCacheData`	InSiteId: `string`, InInteractionTags: `string[]`, InStatId: `string`, InRemoveRewardScore: `integer`	`-`	Callback invoked on Remove Autonomy Role Cache Data.
`OnRenewalSchedule`	InMemberId: `FB1EntityId`	`-`	Callback invoked on Renewal Schedule.
`SetCachedPendingRandomEventParam`	InHostEntityId: `FB1EntityId`, InParam: `FB1SiteEventSettingParam`	`-`	Sets Cached Pending Random Event Param.
`StaticGetCurrentSiteEvent`	MemberId: `FB1EntityId`	`-`
`StaticGetSiteEvent`	SiteEventId: `FB1SiteEventId`	`-`
`StaticIsPlayingSiteEvent` (static)	InMemberId: `FB1EntityId`	`boolean`
`TryAddEventMember`	InSiteEventId: `FB1SiteEventId`, InMemberId: `FB1EntityId`	`boolean`
`TryCancelSiteEvent`	InSiteEventId: `FB1SiteEventId`	`-`
`TryCreatePendingRandomEvent`	InHostEntityId: `FB1EntityId`	`boolean`
`TryDestroySiteEvent`	InSiteEventId: `FB1SiteEventId`	`-`
`TrySiteEventAutonomyPickedStatId` (static)	InMemberId: `FB1EntityId`	`string`

Override points (19)

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

Function	Parameters	Returns	Description
`Override_ClearCachedPendingRandomEventParam`	InHostEntityId: `FB1EntityId`	`-`	Clears Cached Pending Random Event Param.
`Override_HasPendingCreateRequest`	InRequestId: `integer`	`boolean`	Returns whether it has Pending Create Request.
`Override_HasSiteEventPlannedInSite`	InSiteId: `string`, InType: `EB1SiteEventType`	`boolean`	Returns whether it has Site Event Planned In Site.
`Override_JoinSiteEventMember`	InSiteEventId: `FB1SiteEventId`, InMemberId: `FB1EntityId`	`-`
`Override_LeftSiteEventMember`	InSiteEventId: `FB1SiteEventId`, InMemberId: `FB1EntityId`	`-`
`Override_OnAddAutonomyRoleCacheData`	InSiteId: `string`, InInteractionTags: `string[]`, InStatId: `string`, InAddRewardScore: `integer`	`-`	Callback invoked on Add Autonomy Role Cache Data.
`Override_OnArrivedSiteEvent`	InMemberId: `FB1EntityId`, InSiteEventId: `FB1SiteEventId`	`-`	Callback invoked on Arrived Site Event.
`Override_OnBreakEngagement`	InMemberId: `FB1EntityId`	`-`	Callback invoked on Break Engagement.
`Override_OnCancelSocialEvent`	InSiteEventId: `FB1SiteEventId`, InMemberId: `FB1EntityId`	`-`	Callback invoked on Cancel Social Event.
`Override_OnChangePossessEntityId`	InPrevEntityId: `FB1EntityId`, InCurrentEntityId: `FB1EntityId`	`-`	Callback invoked on Change Possess Entity Id.
`Override_OnDeathCharacter`	InMemberId: `FB1EntityId`	`-`	Callback invoked on Death Character.
`Override_OnPreCreateConflictConfirmed`	InRequestId: `integer`, bConfirmed: `boolean`	`-`	Callback invoked on Pre Create Conflict Confirmed.
`Override_OnRemoveAutonomyRoleCacheData`	InSiteId: `string`, InInteractionTags: `string[]`, InStatId: `string`, InRemoveRewardScore: `integer`	`-`	Callback invoked on Remove Autonomy Role Cache Data.
`Override_OnRenewalSchedule`	InMemberId: `FB1EntityId`	`-`	Callback invoked on Renewal Schedule.
`Override_TryAddEventMember`	InSiteEventId: `FB1SiteEventId`, InMemberId: `FB1EntityId`	`boolean`
`Override_TryCancelSiteEvent`	InSiteEventId: `FB1SiteEventId`	`-`
`Override_TryCreatePendingRandomEvent`	InHostEntityId: `FB1EntityId`	`boolean`
`Override_TryDestroySiteEvent`	InSiteEventId: `FB1SiteEventId`	`-`
`Override_TrySiteEventAutonomyPickedStatId` (static)	InMemberId: `FB1EntityId`	`string`