FB2ZoiGroupManager

Overview

Manages Zoi groups (families, dates, and other clusters).

Metadata

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

Properties (4)

Name	Type	Description
`ZoiGroupIdGenerator`	`any`
`ZoiGroups`	`FB1ZoiGroup[]`
`bActNearGroup`	`boolean`
`bEnableLeaderAutonomyOnly`	`boolean`

Functions (20)

Function	Parameters	Returns	Description
`AddZoiGroupMember`	InGroupId: `FB1ZoiGroupId`, InCharacter: `FB2Character`, bInSendToastMessage: `boolean`	`-`	Adds Zoi Group Member.
`BreakZoiGroup`	InGroupId: `FB1ZoiGroupId`, bInSendToastMessage: `boolean`	`-`
`ChangeZoiGroupLeader`	InCharacter: `FB2Character`	`-`
`CleanInvalidZoiGroup`	`-`	`-`
`ClearForCityMove`	`-`	`-`	Clears For City Move.
`CreateZoiGroup`	InType: `EB1ZoiGroupType`, InLeaderId: `FB1EntityId`, InCharacters: `FB2Character[]`, bInSendToastMessage: `boolean`	`FB1ZoiGroupId`	Creates Zoi Group.
`FindZoiGroup`	InGroupId: `FB1ZoiGroupId`	`FB1ZoiGroup`	Finds and returns Zoi Group.
`GetType`	`-`	`EB2ManagerType`	Returns Type.
`HasCapacity`	InGroupId: `FB1ZoiGroupId`	`boolean`	Returns whether it has Capacity.
`IsActNearGroupEnabled`	`-`	`boolean`	Returns whether Act Near Group Enabled.
`IsLeaderAutonomyOnlyEnabled`	`-`	`boolean`	Returns whether Leader Autonomy Only Enabled.
`IsSameGroup`	InBaseId: `FB1EntityId`, InTargetId: `FB1EntityId`	`boolean`	Returns whether Same Group.
`IsTickable`	`-`	`boolean`	Returns whether Tickable.
`IsZoiGroupLeader`	InCharacter: `FB2Character`	`boolean`	Returns whether Zoi Group Leader.
`IsZoiGroupNonLeaderMember`	InCharacter: `FB2Character`	`boolean`	Returns whether Zoi Group Non Leader Member.
`RemoveZoiGroupMember`	InGroupId: `FB1ZoiGroupId`, InCharacter: `FB2Character`, InReason: `EB1ZoiGroupLeaveReason`, bDisableToastMessage: `boolean`	`-`	Removes Zoi Group Member.
`RequestOpenZoiGroupCreateWidget`	InRequester: `FB2Character`, InReason: `EB1ZoiGroupEditReason`, InAdditionalCandidate: `FB2Character`	`-`	Requests Open Zoi Group Create Widget.
`RequestOpenZoiGroupEditWidget`	InRequester: `FB2Character`, InAdditionalCandidate: `FB2Character`	`-`	Requests Open Zoi Group Edit Widget.
`SetActNearGroupEnabled`	bInEnable: `boolean`	`-`	Sets Act Near Group Enabled.
`SetLeaderAutonomyOnlyEnabled`	bInEnable: `boolean`	`-`	Sets Leader Autonomy Only Enabled.

Override points (11)

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

Function	Parameters	Returns	Description
`Override_AddZoiGroupMember`	InGroupId: `FB1ZoiGroupId`, InCharacter: `FB2Character`, bInSendToastMessage: `boolean`	`-`	Adds Zoi Group Member.
`Override_BreakZoiGroup`	InGroupId: `FB1ZoiGroupId`, bInSendToastMessage: `boolean`	`-`
`Override_ChangeZoiGroupLeader`	InCharacter: `FB2Character`	`-`
`Override_CleanInvalidZoiGroup`	`-`	`-`
`Override_ClearForCityMove`	`-`	`-`	Clears For City Move.
`Override_CreateZoiGroup`	InType: `EB1ZoiGroupType`, InLeaderId: `FB1EntityId`, InCharacters: `FB2Character[]`, bInSendToastMessage: `boolean`	`FB1ZoiGroupId`	Creates Zoi Group.
`Override_FindZoiGroup`	InGroupId: `FB1ZoiGroupId`	`FB1ZoiGroup`	Finds and returns Zoi Group.
`Override_HasCapacity`	InGroupId: `FB1ZoiGroupId`	`boolean`	Returns whether it has Capacity.
`Override_RemoveZoiGroupMember`	InGroupId: `FB1ZoiGroupId`, InCharacter: `FB2Character`, InReason: `EB1ZoiGroupLeaveReason`, bDisableToastMessage: `boolean`	`-`	Removes Zoi Group Member.
`Override_RequestOpenZoiGroupCreateWidget`	InRequester: `FB2Character`, InReason: `EB1ZoiGroupEditReason`, InAdditionalCandidate: `FB2Character`	`-`	Requests Open Zoi Group Create Widget.
`Override_RequestOpenZoiGroupEditWidget`	InRequester: `FB2Character`, InAdditionalCandidate: `FB2Character`	`-`	Requests Open Zoi Group Edit Widget.