EntityStatistic

Represents some quantifiable metric about an entity that can be changed.

Properties

string StatisticName

• Read-Only

• Returns the database-selected statistic name.

float MaxValue

• Gets or sets the maximum value to clamp this statistic value to.

• Setting will fire the statistic max changed event.

float Value

• Gets or sets the current value of this statistic.

• Will be clamped to the max value.

• Setting will fire the statistic changed event.

int StatisticID

• Read-Only

• Hashes the statistic name to produce an ID.

Events

Action<float, float> StatisticChanged

• Called when the statistic's value is changed. 

• Arguments are the old and the new value respectively.

Action<float, float> StatisticMaxChanged

• Called when the statistic's max value is changed. 

• Arguments are the old and the new value respectively.

Methods

void Decrease(float amount)

• Decreases the statistic's current value by the given amount.

• amount The amount to decrease.

void Increase(float amount)

• Increases the statistic's current value by the given amount.

• Will be clamped to the max value.

• amount The amount to increase.