Class StatDefinition

Namespace

SurvivorsMaker.Core

Assembly

SurvivorsMaker.Core.dll

One stat a game defines: its id, starting value and optional limits.

public sealed class StatDefinition

Inheritance

object

StatDefinition

Inherited Members

object.GetType()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

StatDefinition()

public StatDefinition()

StatDefinition(string, int, string)

public StatDefinition(string id, int baseValue = 0, string displayName = null)

Parameters

id string

baseValue int

displayName string

Fields

BaseValue

Value before any effect is applied.

public int BaseValue

Field Value

int

Description

public string Description

Field Value

string

DisplayName

public string DisplayName

Field Value

string

HasMax

public bool HasMax

Field Value

bool

HasMin

public bool HasMin

Field Value

bool

Id

Key used by effects and code, e.g. "max_health". Must be unique within a catalog.

public string Id

Field Value

string

IsPercent

Hint for UI: show the value with a % sign.

public bool IsPercent

Field Value

bool

Max

public int Max

Field Value

int

Min

public int Min

Field Value

int

Methods

AsPercent()

Marks values as percentage points for authoring/display and returns this definition.

public StatDefinition AsPercent()

Returns

StatDefinition

Clamp(int)

Applies Min/Max to a final value.

public int Clamp(int value)

Parameters

value int

Returns

int

ToString()

public override string ToString()

Returns

string

WithMax(int)

Enables and assigns the upper integer bound, then returns this definition.

public StatDefinition WithMax(int max)

Parameters

max int

Returns

StatDefinition

WithMin(int)

Enables and assigns the lower integer bound, then returns this definition.

public StatDefinition WithMin(int min)

Parameters

min int

Returns

StatDefinition