FB2LifeComponent

Overview

Component that manages life (life stages, death, etc.).

Metadata

Field	Value
Kind	`component`
Environment	B2 - Simulation
Category	`components`
Extends	`FB2Component`
Require	`require('Components.B2LifeComponent')`

Properties (19)

Name	Type	Description
`AccumulatedTick`	`number`
`AscendingTicks`	`integer`	Ghost ascension management.
`BoundSiteType`	`EB1SiteType`	The type of the ghost's HomeSite before death.
`CachedMarriageInteractionBag`	`string`
`CachedSocialEventSettingParam`	`FB1SiteEventSettingParam`
`ConfirmedDeathTriggerId`	`string`
`IsTriggered`	`boolean`
`LastTriggerId`	`string`
`LifeTriggerMap`	`table<string, FB1LifeTriggerDetailData>`
`PendingRagdollDeathLifeTriggerId`	`string`
`bAttendedOwnFuneral`	`boolean`
`bCanGhost`	`boolean`
`bDeathStartedWithPossessedCharacter`	`boolean`
`bForceCanMarry`	`boolean`
`bHasDeathStartedWithPossessedCharacter`	`boolean`
`bInvincible`	`boolean`
`bPendingTeleportToHomeAfterInteraction`	`boolean`
`bPendingTravelDeath`	`boolean`
`bShouldCheckAscension`	`boolean`

Functions (34)

Function	Parameters	Returns	Description
`AddLifeTrigger`	InLifeTriggerId: `string`	`-`	Adds Life Trigger.
`AddLifeTriggerImmediate`	InLifeTriggerId: `string`	`-`	Adds Life Trigger Immediate.
`CanMarry`	InTargetEntityId: `FB1EntityId`, InCheckByAutonomy: `boolean`	`boolean`	marriage
`CheckLifeTrigger`	`-`	`-`	Checks Life Trigger.
`ClearAscendingInfo`	`-`	`-`	Clears Ascending Info.
`ClearLifeTriggerInteractionData`	`-`	`-`	Clears Life Trigger Interaction Data.
`FinishDivorce`	InTargetEntityId: `FB1EntityId`	`-`
`FinishMarriage`	InTargetEntityId: `FB1EntityId`, bIsAutonomy: `boolean`	`-`
`FinishMarriageFamilyMove`	InTargetEntityId: `FB1EntityId`, InIsSuccess: `boolean`	`-`
`GetAscendingTicks`	`-`	`integer`	Returns Ascending Ticks.
`GetBoundSiteType`	`-`	`EB1SiteType`	Returns Bound Site Type.
`GetDefaultCityMoveDataPolicy`	`-`	`EB1CityMoveDataPolicy`	Returns Default City Move Data Policy.
`GetLastTriggerId`	`-`	`string`	Returns Last Trigger Id.
`GetLifeTriggerMap`	`-`	`table<string, FB1LifeTriggerDetailData>`	Returns Life Trigger Map.
`HasAttendedOwnFuneral`	`-`	`boolean`	Returns whether it has Attended Own Funeral.
`InitializeAscendingInfo`	`-`	`-`	Initializes Ascending Info.
`IsPendingTeleportToHome`	`-`	`boolean`	Returns whether Pending Teleport To Home.
`IsTriggeredLifeTrigger`	`-`	`boolean`	Returns whether Triggered Life Trigger.
`OnCancelLifeTriggerInteraction`	`-`	`-`	Callback invoked on Cancel Life Trigger Interaction.
`OnDeath`	`-`	`-`	Callback invoked on Death.
`OnFinishLifeTriggerInteraction`	`-`	`-`	Callback invoked on Finish Life Trigger Interaction.
`PostprocessMarriage`	`-`	`-`
`RemoveLifeTrigger`	InLifeTriggerId: `string`	`-`	Removes Life Trigger.
`ReplaceContentData`	InPrevGrowthStep: `EB1GrowthStep`, InCurrGrowthStep: `EB1GrowthStep`	`-`	GrowthChangeInterface Begin
`SendLifePopupPacket`	bInBecameGhost: `boolean`	`boolean`	Sends Life Popup Packet.
`SetAscendingTicks`	InTicks: `integer`	`-`	Sets Ascending Ticks.
`SetAttendedOwnFuneral`	bInValue: `boolean`	`-`	Sets Attended Own Funeral.
`SetForceCanMarry`	InForce: `boolean`	`-`	Sets Force Can Marry.
`SetInvincible`	bInInvincible: `boolean`	`-`	Sets Invincible.
`SetPendingTeleportToHome`	bInPending: `boolean`	`-`	Sets Pending Teleport To Home.
`ShouldCheckAscension`	`-`	`boolean`	Returns whether it should Check Ascension.
`ShouldUseScheduler`	`-`	`boolean`	Returns whether it should Use Scheduler.
`StartDivorce`	InTargetEntityId: `FB1EntityId`, bIsAutonomy: `boolean`	`-`	Starts Divorce.
`TryStartMarriage`	InTargetEntityId: `FB1EntityId`, InInteractionBag: `string`, InSocialEventSettingParam: `FB1SiteEventSettingParam`	`boolean`

Override points (19)

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

Function	Parameters	Returns	Description
`Override_AddLifeTrigger`	InLifeTriggerId: `string`	`-`	Adds Life Trigger.
`Override_AddLifeTriggerImmediate`	InLifeTriggerId: `string`	`-`	Adds Life Trigger Immediate.
`Override_CanMarry`	InTargetEntityId: `FB1EntityId`, InCheckByAutonomy: `boolean`	`boolean`	marriage
`Override_CheckLifeTrigger`	`-`	`-`	Checks Life Trigger.
`Override_ClearAscendingInfo`	`-`	`-`	Clears Ascending Info.
`Override_ClearLifeTriggerInteractionData`	`-`	`-`	Clears Life Trigger Interaction Data.
`Override_FinishDivorce`	InTargetEntityId: `FB1EntityId`	`-`
`Override_FinishMarriage`	InTargetEntityId: `FB1EntityId`, bIsAutonomy: `boolean`	`-`
`Override_FinishMarriageFamilyMove`	InTargetEntityId: `FB1EntityId`, InIsSuccess: `boolean`	`-`
`Override_InitializeAscendingInfo`	`-`	`-`	Initializes Ascending Info.
`Override_OnCancelLifeTriggerInteraction`	`-`	`-`	Callback invoked on Cancel Life Trigger Interaction.
`Override_OnDeath`	`-`	`-`	Callback invoked on Death.
`Override_OnFinishLifeTriggerInteraction`	`-`	`-`	Callback invoked on Finish Life Trigger Interaction.
`Override_PostprocessMarriage`	`-`	`-`
`Override_RemoveLifeTrigger`	InInLifeTriggerId: `string`	`-`	Removes Life Trigger.
`Override_ReplaceContentData`	InPrevGrowthStep: `EB1GrowthStep`, InCurrGrowthStep: `EB1GrowthStep`	`-`	GrowthChangeInterface Begin
`Override_SendLifePopupPacket`	bInBecameGhost: `boolean`	`boolean`	Sends Life Popup Packet.
`Override_StartDivorce`	InTargetEntityId: `FB1EntityId`, bIsAutonomy: `boolean`	`-`	Starts Divorce.
`Override_TryStartMarriage`	InTargetEntityId: `FB1EntityId`, InInteractionBag: `string`, InSocialEventSettingParam: `FB1SiteEventSettingParam`	`boolean`