Stat
Last updated
Last updated
A single stat.
| Name | Description | Type |
|---|---|---|
Overridable
Return Type: Stat
Creates an returns a copy of this stat.
Overridable
Recalculates the max value.
Overridable
Resets all values.
Overridable
Resets the current value.
Overridable
Return Type: float
Increases the current value by an amount. Returns the excess amount.
Parameters
Overridable
Return Type: float
Decreases the current value by an amount. Returns the excess amount.
Parameters
Overridable
Return Type: float
Sets the current value.
Parameters
Overridable
Combines this stat with others.
Parameters
Supported stat combine types.
Supported stat combine operators.
| Name | Description | Type |
|---|---|---|
| Name | Description | Type |
|---|---|---|
| Name | Description | Type |
|---|---|---|
| Name | Description | Type |
|---|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
identity
The identity of this stat.
StatIdentity
baseValue
The stat value without any alterations.
float
currentMaxValue
The stat's current max value (the value with all other stats combined).
float
currentValue
The stat value with alterations.
float
combineType
The method to use when combined with other stats.
CombineType
combineOperator
The operator to use when combined with another stat.
CombineOperator
combinedStats
A list of stats combined with this stat.
List<Stat>
amount
The amount to increase by.
float
amount
The amount to decrease by.
float
newValue
The value to set to.
float
stats
A list of stats to combine with.
params Stat[]
Value
Combine the stat with another by it's exact value.
PercentMax
Combine the stat with another by it's max value as a percentage.
PercentCurrent
Combine the stat with another by it's current value as a percentage.
Add
Add the value.
Subtract
Subtract the value.