FB2StatComponent

Overview

Component that manages stats (needs/abilities).

Metadata

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

Properties (10)

Name	Type	Description
`CurrentProcessData`	`FB2StatProcessData`
`GrowthStep`	`EB1GrowthStep`
`ModifierComponent`	`FB2ModifierComponent`
`MotiveStatType`	`EB2StatPhaseType`
`MotiveStatTypeSet`	`table<string, boolean>`
`StatEventTrigger`	`string[]`
`StatReasons`	`table<string, FB1StatReasonSet>`
`Stats`	`table<string, number>`
`bPossessed`	`boolean`	Pre-cached/precomputed value to reduce function calls.
`bUpdateStat`	`boolean`

Functions (41)

Function	Parameters	Returns	Description
`AddStat`	StatId: `string`, Value: `number`, InReason: `EB1ScriptReason`, InStatReason: `EB1StatReason`	`-`	Adds Stat.
`AddStatEx`	StatId: `string`, Value: `number`, InReason: `EB1ScriptReason`	`-`	Adds Stat Ex.
`CalculateAutonomyStatTier`	StatId: `string`	`EB1StatServiceTier`
`CallScriptInternal`	ScriptId: `string`	`-`
`CheckMotiveStatUrgent`	`-`	`string`	Checks Motive Stat Urgent.
`ClearRoutineStat`	`-`	`-`	Clears Routine Stat.
`GetDefaultCityMoveDataPolicy`	`-`	`EB1CityMoveDataPolicy`	Returns Default City Move Data Policy.
`GetLowestMotiveStatValue`	`-`	`number`	Returns Lowest Motive Stat Value.
`GetNotEnoughStatCountForPlay`	`-`	`integer`	Returns Not Enough Stat Count For Play.
`GetPhaseType`	InStatId: `string`	`EB2StatPhaseType`	Returns Phase Type.
`GetStat`	StatId: `string`	`number`	Returns Stat.
`GetStatMap`	`-`	`table<string, number>`	Returns Stat Map.
`GetStoredEnoughStatsForPlayFlag`	`-`	`boolean`	Returns Stored Enough Stats For Play Flag.
`GetType`	`-`	`EB2ComponentType`	Returns Type.
`GhostRequestReArrangeStat`	`-`	`-`
`HasDangerousWatchStat`	`-`	`boolean`	Returns whether it has Dangerous Watch Stat.
`HasStat`	StatId: `string`	`boolean`	Returns whether it has Stat.
`HasTalkExcludeWatchStat`	`-`	`boolean`	Returns whether it has Talk Exclude Watch Stat.
`IsFreeTimeReady`	`-`	`boolean`	Returns whether Free Time Ready.
`IsFreezing`	`-`	`boolean`	Returns whether Freezing.
`IsPossessed`	`-`	`boolean`	Returns whether Possessed.
`IsStatUrgent`	InStatId: `string`	`boolean`	Returns whether Stat Urgent.
`IsUpdateStat`	`-`	`boolean`	Returns whether Update Stat.
`MakeConnectModifierCom`	`-`	`-`	Makes Connect Modifier Com.
`MakeStatDiffLog`	OutStr: `string`	`-`	Makes Stat Diff Log.
`OnChangeGrowthStep`	PrevGrowthStep: `EB1GrowthStep`, CurrGrowthStep: `EB1GrowthStep`	`-`	Callback invoked on Change Growth Step.
`OnDayChanged`	Before: `FDateTime`, After: `FDateTime`	`-`	Callback invoked on Day Changed.
`OnHourChanged`	Before: `FDateTime`, After: `FDateTime`	`-`	Callback invoked on Hour Changed.
`OnRestoreBuildMode`	`-`	`-`	Callback invoked on Restore Build Mode.
`OnUpdateDirtyData`	`-`	`-`	Function required for the direct-access pool.
`PickAutonomyStat`	FilterList: `string[]`	`string`
`RemoveStat`	StatId: `string`, InStatReason: `EB1StatReason`	`-`	Removes Stat.
`ResetUpdateStat`	`-`	`-`	Resets Update Stat.
`SendStopAllFxPacket`	`-`	`-`	Sends Stop All Fx Packet.
`SetPossessed`	Flag: `boolean`	`-`	Sets Possessed.
`SetStat`	StatId: `string`, Value: `number`, InReason: `EB1ScriptReason`	`-`	Sets Stat.
`SetStatEx`	StatId: `string`, Value: `number`, InReason: `EB1ScriptReason`	`-`	Optimization-related: separates the script-call part when a stat changes.
`ShouldUseScheduler`	`-`	`boolean`	Returns whether it should Use Scheduler.
`TryPickUrgentStat`	InCooldownStats: `string[]`, OutStatId: `string`	`boolean`
`TryPickUrgentStatFromCandidates`	InCandidateStats: `string[]`, InCooldownStats: `string[]`, OutStatId: `string`	`boolean`
`UpdateRoutineStat`	InTime: `FDateTime`	`-`	Updates Routine Stat.

Override points (14)

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

Function	Parameters	Returns	Description
`Override_AddStatEx`	StatId: `string`, Value: `number`, InReason: `EB1ScriptReason`	`-`	Adds Stat Ex.
`Override_CalculateAutonomyStatTier`	StatId: `string`	`EB1StatServiceTier`
`Override_CheckMotiveStatUrgent`	`-`	`string`	Checks Motive Stat Urgent.
`Override_GhostRequestReArrangeStat`	`-`	`-`
`Override_HasDangerousWatchStat`	`-`	`boolean`	Returns whether it has Dangerous Watch Stat.
`Override_HasStat`	StatId: `string`	`boolean`	Returns whether it has Stat.
`Override_HasTalkExcludeWatchStat`	`-`	`boolean`	Returns whether it has Talk Exclude Watch Stat.
`Override_MakeConnectModifierCom`	`-`	`-`	Makes Connect Modifier Com.
`Override_OnChangeGrowthStep`	PrevGrowthStep: `EB1GrowthStep`, CurrGrowthStep: `EB1GrowthStep`	`-`	Callback invoked on Change Growth Step.
`Override_OnDayChanged`	Before: `FDateTime`, After: `FDateTime`	`-`	Callback invoked on Day Changed.
`Override_OnRestoreBuildMode`	`-`	`-`	Callback invoked on Restore Build Mode.
`Override_OnUpdateDirtyData`	`-`	`-`	Function required for the direct-access pool.
`Override_RemoveStat`	StatId: `string`, InStatReason: `EB1StatReason`	`-`	Removes Stat.
`Override_SendStopAllFxPacket`	`-`	`-`	Sends Stop All Fx Packet.