Introduction
Provides a Stat that can be modified, monitored, and consumed
Fields#
| Name | Description |
|---|---|
| Expressions | Expressions used to generate values for this stat |
| Regeneration | Settings for regenerating the stat's value |
| Incrementation | Settings for auto-incrementing the stat's value |
| Start Maxed | Start with maximum value |
| On Modifier Added | Event raise whenever a Stat Modifier is added |
| On Modifier Removed | Event raise whenever a Stat Modifier is removed |
| Owner | Stat Source this object belongs to |
| On Value Changed | Event raised whenever the value changed |
Properties#
| Name | Description |
|---|---|
| activeModifiers | Return a list of Stat Modifiers active on this object |
| info | Information about this object |
| initialized | Gets if object has been initialized |
| initializing | Gets if object is currently being initialized |
| instanceId | Id of this object instance |
| maximum | Get/Set the maximum value |
| minimum | Get/Set the minimum value |
| regenerationDelay | Get/Set the regeneration delay |
| regenerationRate | Get/Set the regeneration rate |
| special | Get/Set the 'special' value |
| value | Get/Set the current value |
Methods#
| Name | Description |
|---|---|
| AddModifier | Add a Stat Modifier to this object |
| AddSubscription | Add a subscription to this stat |
| Clone | Create a clone of this object |
| GetValue | Get the value of a formula |
| Initialize | Initialize this object |
| IsConditionTrue | Check if a condition is true |
| Matches | Check if this objects data matches that of another object |
| RemoveModifier | Remove a Stat Modifier from this object |
| RemoveModifierFromSource | Remove all Stat Modifiers from a specific source |
| RemoveSubscription | Remove a subscription |
| Shutdown | Shutdown this object |