Skip to main content

FB2FamilyTreeManager

Overview

Manages the family tree (family relationships).

Metadata

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

Properties (2)

Name	Type	Description
`dummyParentIdCounter`	`integer`
`idToMemberMap`	`table<FB1FamilyTreeMemberId, FB1FamilyTreeMemberData>`

Functions (17)

Function	Parameters	Returns	Description
`AddMember`	InMemberId: `FB1FamilyTreeMemberId`	`boolean`	Adds Member.
`CanMarry`	InMemberIdA: `FB1FamilyTreeMemberId`, InMemberIdB: `FB1FamilyTreeMemberId`	`boolean`	Returns whether it can Marry.
`ConnectMemberParentChild`	InMemberIdParent: `FB1FamilyTreeMemberId`, InMemberIdChild: `FB1FamilyTreeMemberId`, bIsBiologicalParents: `boolean`	`boolean`
`ConnectMemberSpouse`	InMemberIdA: `FB1FamilyTreeMemberId`, InMemberIdB: `FB1FamilyTreeMemberId`	`boolean`
`ConnectRelation`	InMemberIdA: `FB1FamilyTreeMemberId`, InMemberIdB: `FB1FamilyTreeMemberId`, InRelationshipTypeAToB: `EB1FamilyRelationshipType`	`boolean`
`DisconnectAllMember`	InMemberId: `FB1FamilyTreeMemberId`	`-`
`DisconnectMemberSpouse`	InMemberIdA: `FB1FamilyTreeMemberId`, InMemberIdB: `FB1FamilyTreeMemberId`	`boolean`
`FindSpouse`	InOwnerMemberId: `FB1FamilyTreeMemberId`	`FB1EntityId`	Finds and returns Spouse.
`GetCityMovePolicyMap`	InCityMoveDataPolicyType: `EB1CityMoveDataPolicyType`	`table<string, EB1CityMoveDataPolicy>`	Returns City Move Policy Map.
`GetFamilyTreeMap`	`-`	`table<FB1FamilyTreeMemberId, FB1FamilyTreeMemberData>`	Returns Family Tree Map.
`GetFamilyTreeMemberOne`	InOwnerMemberId: `FB1FamilyTreeMemberId`, InRelationshipType: `EB1FamilyRelationshipType`	`FB1EntityId`	Returns Family Tree Member One.
`GetMemberData`	InMemberId: `FB1FamilyTreeMemberId`, InOutMember: `FB1FamilyTreeMemberData`	`boolean`	Returns Member Data.
`IsParentChild` (static)	InMemberParent: `FB1FamilyTreeMemberData`, InMemberChild: `FB1FamilyTreeMemberData`	`boolean`	Returns whether Parent Child.
`IsSpouseByMemberData` (static)	InMemberA: `FB1FamilyTreeMemberData`, InMemberB: `FB1FamilyTreeMemberData`	`boolean`	Returns whether Spouse By Member Data.
`IsSpouseByMemberId` (static)	InMemberIdA: `FB1FamilyTreeMemberId`, InMemberIdB: `FB1FamilyTreeMemberId`	`boolean`	Returns whether Spouse By Member Id.
`Reset`	`-`	`-`
`SameFamilyTree`	InMemberIdA: `FB1FamilyTreeMemberId`, InMemberIdB: `FB1FamilyTreeMemberId`, InQueryType: `EB1FamilyTreeQueryType`	`boolean`

Override points (10)

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

Function	Parameters	Returns	Description
`Override_AddMember`	InMemberId: `FB1FamilyTreeMemberId`	`boolean`	Adds Member.
`Override_CanMarry`	InMemberIdA: `FB1FamilyTreeMemberId`, InMemberIdB: `FB1FamilyTreeMemberId`	`boolean`	Returns whether it can Marry.
`Override_ConnectMemberParentChild`	InMemberIdParent: `FB1FamilyTreeMemberId`, InMemberIdChild: `FB1FamilyTreeMemberId`, bIsBiologicalParents: `boolean`	`boolean`
`Override_ConnectMemberSpouse`	InMemberIdA: `FB1FamilyTreeMemberId`, InMemberIdB: `FB1FamilyTreeMemberId`	`boolean`
`Override_ConnectRelation`	InMemberIdA: `FB1FamilyTreeMemberId`, InMemberIdB: `FB1FamilyTreeMemberId`, InRelationshipTypeAToB: `EB1FamilyRelationshipType`	`boolean`
`Override_DisconnectAllMember`	InMemberId: `FB1FamilyTreeMemberId`	`-`
`Override_DisconnectMemberSpouse`	InMemberIdA: `FB1FamilyTreeMemberId`, InMemberIdB: `FB1FamilyTreeMemberId`	`boolean`
`Override_FindSpouse`	InOwnerMemberId: `FB1FamilyTreeMemberId`	`FB1EntityId`	Finds and returns Spouse.
`Override_Reset`	`-`	`-`
`Override_SameFamilyTree`	InMemberIdA: `FB1FamilyTreeMemberId`, InMemberIdB: `FB1FamilyTreeMemberId`, InQueryType: `EB1FamilyTreeQueryType`	`boolean`