Skip to main content

Introduction

Provides a Stat that can be modified, monitored, and consumed

Fields#

NameDescription
ExpressionsExpressions used to generate values for this stat
RegenerationSettings for regenerating the stat's value
IncrementationSettings for auto-incrementing the stat's value
Start MaxedStart with maximum value
On Modifier AddedEvent raise whenever a Stat Modifier is added
On Modifier RemovedEvent raise whenever a Stat Modifier is removed
OwnerStat Source this object belongs to
On Value ChangedEvent raised whenever the value changed

Properties#

NameDescription
activeModifiersReturn a list of Stat Modifiers active on this object
infoInformation about this object
initializedGets if object has been initialized
initializingGets if object is currently being initialized
instanceIdId of this object instance
maximumGet/Set the maximum value
minimumGet/Set the minimum value
regenerationDelayGet/Set the regeneration delay
regenerationRateGet/Set the regeneration rate
specialGet/Set the 'special' value
valueGet/Set the current value

Methods#

NameDescription
AddModifierAdd a Stat Modifier to this object
AddSubscriptionAdd a subscription to this stat
CloneCreate a clone of this object
GetValueGet the value of a formula
InitializeInitialize this object
IsConditionTrueCheck if a condition is true
MatchesCheck if this objects data matches that of another object
RemoveModifierRemove a Stat Modifier from this object
RemoveModifierFromSourceRemove all Stat Modifiers from a specific source
RemoveSubscriptionRemove a subscription
ShutdownShutdown this object