Skip to main content

FB2GameObjectStatComponent

Overview

  • Component that manages game-object stats.

Metadata

FieldValue
Kindcomponent
EnvironmentB2 - Simulation
Categorycomponents
ExtendsFB2StatComponent
Requirerequire('Components.B2GameObjectStatComponent')

Properties (1)

NameTypeDescription
Debug_RefreshStatMaptable<string, number>

Functions (6)

FunctionParametersReturnsDescription
AddStatStatId: string, Value: number, InReason: EB1ScriptReason, InStatReason: EB1StatReason-Adds Stat.
GetEstimatedRemainStatValueInElapsedTicks: integer, InCurrentTicks: integer, InStatId: stringnumberReturns Estimated Remain Stat Value.
GetNextDecayCompletionTime-numberReturns Next Decay Completion Time.
GetStatDecayCompletionTimeInStatSystem: FB2StatSystem, InStatId: string, InStatValue: numbernumberReturns Stat Decay Completion Time.
HasDecayStat-booleanReturns whether it has Decay Stat.
RefreshFromInventoryInElapsedTicks: integer, InCurrentTicks: integer-

Override points (1)

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

FunctionParametersReturnsDescription
Override_AddStatStatId: string, Value: number, InReason: EB1ScriptReason, InStatReason: EB1StatReason-Adds Stat.