FB2BioComponent

Overview

Component that manages bio info (name/age/gender/growth).

Metadata

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

Properties (38)

Name	Type	Description
`AgeProgress`	`number`
`AgingPauseReasons`	`table<string, boolean>`
`BiologicalParentA`	`FB1EntityId`	EntityId of a biologically recognized parent whose genetic traits are inherited (e.g. pregnancy/birth, single-parent birth, science-assisted conception).
`BiologicalParentB`	`FB1EntityId`
`BornDay`	`integer`
`CachedBabySpawnData`	`FB1BabyCharacterSpawnData`
`CachedBellyGroupShapeValue`	`number`
`CachedParentGeneticOwner`	`FB1CharacterGeneticData`
`CachedParentGeneticPartner`	`FB1CharacterGeneticData`
`CalcedDeadAge`	`integer`	The actual value to use.
`CurrGrowthStep`	`EB1GrowthStep`
`CurrentPregnancyState`	`string`
`CurrentPregnancyTimeTaskId`	`FB1TimeTaskId`
`DayCalorieValue`	`integer`
`DayMuscleValue`	`integer`
`DeadAge`	`integer`
`DiversityInfo`	`FB1DiversityInfo`
`FirstNameData`	`FB1DisplayNameData`
`GenderDiversityInfo`	`FB1GenderDiversityInfo`
`GenderIdentitySetting`	`FB1GenderIdentitySetting`
`GenderType`	`EB1GenderType`
`HasGeneticAppearance`	`boolean`
`LastNameData`	`FB1DisplayNameData`
`LastUpdatedAge`	`integer`
`MaxPregnancyCount`	`integer`
`ParentCradleEntityId`	`FB1EntityId`
`PausedAge`	`integer`
`PendingNewbornBirthTick`	`integer`
`PendingNewbornCatchUpToTick`	`integer`
`PregnancyNextTriggerTicks`	`integer`
`PrevGrowthStep`	`EB1GrowthStep`
`TestVectors`	`FVector[]`
`Voice`	`FB1VoiceSettings`
`bAlreadySpawnedToddler`	`boolean`
`bBirthdayCandleBlown`	`boolean`
`bIsGivingBirth`	`boolean`
`bNeedsUpdateAging`	`boolean`
`bToddlerWalkUnlocked`	`boolean`

Functions (76)

Function	Parameters	Returns	Description
`ApplyMuscle`	`-`	`-`	Applies Muscle.
`ApplyObesity`	`-`	`-`	Applies Obesity.
`AttachToParentCradleObject`	`-`	`-`
`CanCoopBlowCandle`	`-`	`boolean`	Returns whether it can Coop Blow Candle.
`CanPregnancyCheckFamilyCount`	`-`	`boolean`	Returns whether it can Pregnancy Check Family Count.
`CancelPregnancy`	`-`	`-`
`CatchUpAging`	InFromTick: `integer`, InToTick: `integer`	`-`
`CatchUpPregnancy`	InFromTick: `integer`, InToTick: `integer`	`-`
`ChildBirth`	`-`	`-`
`GetAge`	`-`	`integer`	Returns Age.
`GetAgeProgress`	`-`	`number`	Returns Age Progress.
`GetAgingPausedReasons`	`-`	`table<string, boolean>`	Returns Aging Paused Reasons.
`GetBabySpawnDataGenderType`	`-`	`EB1GenderType`	Returns Baby Spawn Data Gender Type.
`GetBiologicalParents`	`-`	`table<FB1EntityId, boolean>`	Returns Biological Parents.
`GetBodyType`	`-`	`EB1BodyAgeType`	Returns Body Type.
`GetBornDay`	`-`	`integer`	Returns Born Day.
`GetCityMovePolicyMap`	InCityMoveDataPolicyType: `EB1CityMoveDataPolicyType`	`table<string, EB1CityMoveDataPolicy>`	Returns City Move Policy Map.
`GetCurrentPartnerGeneticEntityId`	`-`	`FB1EntityId`	pregnancy,birth
`GetCurrentPregnancyState`	`-`	`string`	Returns Current Pregnancy State.
`GetCurrentPregnancyStateInfo`	`-`	`FB1PregnancyStateInfo`	Returns Current Pregnancy State Info.
`GetCurrentPregnancyTimeTaskId`	`-`	`FB1TimeTaskId`	Returns Current Pregnancy Time Task Id.
`GetDeadAge`	`-`	`integer`	Returns Dead Age.
`GetDefaultCityMoveDataPolicy`	`-`	`EB1CityMoveDataPolicy`	Returns Default City Move Data Policy.
`GetDiversityInfo`	`-`	`FB1DiversityInfo`	Returns Diversity Info.
`GetFirstDisplayNameData`	`-`	`FB1DisplayNameData`	Returns First Display Name Data.
`GetFirstName`	`-`	`string`	Returns First Name.
`GetFirstNameTextId`	`-`	`string`	Returns First Name Text Id.
`GetGenderDiversityInfo`	`-`	`FB1GenderDiversityInfo`	Returns Gender Diversity Info.
`GetGenderIdentitySetting`	`-`	`FB1GenderIdentitySetting`	Returns Gender Identity Setting.
`GetGenderType`	`-`	`EB1GenderType`	Returns Gender Type.
`GetGrowthStep`	`-`	`EB1GrowthStep`	Returns Growth Step.
`GetHasGeneticAppearance`	`-`	`boolean`	Returns Has Genetic Appearance.
`GetLastDisplayNameData`	`-`	`FB1DisplayNameData`	Returns Last Display Name Data.
`GetLastName`	`-`	`string`	Returns Last Name.
`GetLastNameTextId`	`-`	`string`	Returns Last Name Text Id.
`GetMaxPregnancyCount`	`-`	`integer`	Returns Max Pregnancy Count.
`GetParentCradleEntityId`	`-`	`FB1EntityId`	Returns Parent Cradle Entity Id.
`GetSpouseCharacter`	`-`	`FB2Character`	Returns Spouse Character.
`GetUniqueName`	`-`	`string`	Returns Unique Name.
`GetVoice`	`-`	`FB1VoiceSettings`	Returns Voice.
`HandleCustomPolicyCityMoveData`	InCityMovedData: `nil`, InCityMoveDataPolicyType: `EB1CityMoveDataPolicyType`	`-`
`HandlePreSnapshot`	`-`	`-`
`HasBirthdayCandleBlown`	`-`	`boolean`	Returns whether it has Birthday Candle Blown.
`HasBirthdayPassed`	`-`	`boolean`	Returns whether it has Birthday Passed.
`IsAgingPaused`	`-`	`boolean`	Returns whether Aging Paused.
`IsAgingPausedByReason`	InReason: `string`	`boolean`	Returns whether Aging Paused By Reason.
`IsBirthdayToday`	`-`	`boolean`	Returns whether Birthday Today.
`IsGrowthStep`	InRhs: `EB1GrowthStep`	`boolean`	Returns whether Growth Step.
`IsPregnant`	ConsiderHideInUI: `boolean`	`boolean`	Returns whether Pregnant.
`IsToddlerWalkUnlocked`	`-`	`boolean`	Returns whether Toddler Walk Unlocked.
`NeedsUpdateAging`	`-`	`boolean`
`OnChangeGrowthStep`	PrevGrowthStep: `EB1GrowthStep`, CurrGrowthStep: `EB1GrowthStep`	`-`	Callback invoked on Change Growth Step.
`OnDayChanged`	Before: `FDateTime`, After: `FDateTime`	`-`	Callback invoked on Day Changed.
`OnUpdateAgingByAction`	`-`	`-`	Callback invoked on Update Aging By Action.
`PostChildBirth`	InFirstName: `string`, InLastName: `string`	`-`
`PostSpawnBaby`	InBaby: `FB2Character`	`-`
`Pregnancy`	FatherEntityId: `FB1EntityId`	`-`
`ProceedToNextPregnancyState`	`-`	`-`
`SetAge`	InAge: `integer`	`-`	Sets Age.
`SetAgeByCheat`	InAge: `integer`	`-`	Sets Age By Cheat.
`SetAgeWithDeadAge`	InAge: `integer`, InDeadAge: `integer`	`-`	Sets Age With Dead Age.
`SetAgingPaused`	bInSetPaused: `boolean`, InReason: `string`	`-`	Sets Aging Paused.
`SetBiologicalParentA`	InParent: `FB1EntityId`	`-`	Sets Biological Parent A.
`SetBiologicalParentB`	InParent: `FB1EntityId`	`-`	Sets Biological Parent B.
`SetCurrentPregnancyState`	InPregnancyState: `string`, InCustomDuration: `integer`	`-`	Sets Current Pregnancy State.
`SetDisplayNameData`	InFirstNameData: `FB1DisplayNameData`, InLastNameData: `FB1DisplayNameData`	`-`	Sets Display Name Data.
`SetDiverSityInfo`	InDiversityInfo: `FB1DiversityInfo`	`-`	Sets Diver Sity Info.
`SetGenderIdentitySetting`	InGenderIdentitySetting: `FB1GenderIdentitySetting`, bFromUserInput: `boolean`	`-`	Sets Gender Identity Setting.
`SetGenderType`	InGenderType: `EB1GenderType`	`-`	Sets Gender Type.
`SetHasGeneticAppearance`	InHasGeneticAppearance: `boolean`	`-`	Sets Has Genetic Appearance.
`SetParentCradleEntityId`	InEntityId: `FB1EntityId`	`-`	Sets Parent Cradle Entity Id.
`SetVoice`	InVoice: `FB1VoiceSettings`, bSendPacket: `boolean`	`-`	Sets Voice.
`TeleportToToddlerSpawnTransform`	`-`	`-`
`ToggleCradleObject`	bSpawn: `boolean`	`-`	Toggles Cradle Object.
`TriggerBirthdayGrowth`	InBlowType: `EB1BirthdayBlowType`	`-`	Birthday growth system
`TryHandleBabyGrowthStep`	`-`	`-`

Override points (24)

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

Function	Parameters	Returns	Description
`Override_ApplyMuscle`	`-`	`-`	Applies Muscle.
`Override_ApplyObesity`	`-`	`-`	Applies Obesity.
`Override_AttachToParentCradleObject`	`-`	`-`
`Override_CanPregnancyCheckFamilyCount`	`-`	`boolean`	Returns whether it can Pregnancy Check Family Count.
`Override_CancelPregnancy`	`-`	`-`
`Override_CatchUpAging`	InFromTick: `integer`, InToTick: `integer`	`-`
`Override_CatchUpPregnancy`	InFromTick: `integer`, InToTick: `integer`	`-`
`Override_ChildBirth`	`-`	`-`
`Override_HandleCustomPolicyCityMoveData`	InCityMovedData: `nil`, InCityMoveDataPolicyType: `EB1CityMoveDataPolicyType`	`-`
`Override_HandlePreSnapshot`	`-`	`-`
`Override_HasBirthdayPassed`	`-`	`boolean`	Returns whether it has Birthday Passed.
`Override_NeedsUpdateAging`	`-`	`boolean`
`Override_OnChangeGrowthStep`	InPrevGrowthStep: `EB1GrowthStep`, InCurrGrowthStep: `EB1GrowthStep`	`-`	Callback invoked on Change Growth Step.
`Override_OnDayChanged`	Before: `FDateTime`, After: `FDateTime`	`-`	Callback invoked on Day Changed.
`Override_OnUpdateAgingByAction`	`-`	`-`	Callback invoked on Update Aging By Action.
`Override_PostChildBirth`	InFirstName: `string`, InLastName: `string`	`-`
`Override_PostSpawnBaby`	InBaby: `FB2Character`	`-`
`Override_Pregnancy`	FatherEntityId: `FB1EntityId`	`-`
`Override_ProceedToNextPregnancyState`	`-`	`-`
`Override_TeleportToToddlerSpawnTransform`	`-`	`-`
`Override_ToggleCradleObject`	bSpawn: `boolean`	`-`	Toggles Cradle Object.
`Override_TriggerBirthdayGrowth`	InBlowType: `EB1BirthdayBlowType`	`-`	Birthday growth system
`Override_TryHandleBabyGrowthStep`	`-`	`-`
`Override_UpdateAgeInfo`	`-`	`-`	Updates Age Info.