Statistic Management (stat_set.nvgt)

Classes

Adds a stat to the set.

stat@ stat_set::add(const string&in name, var@ value, const string&in text = "", stat_callback@ callback = null, dictionary@ user = null);

const string&in name: the name of the stat to add.
var@ value: the starting value for this stat.
const string&in text = "": an optional text template to be used when getting the value of this stat. In this template, use %0 anywhere you want to output the raw value of the stat itself.
stat_callback@ callback = null: an optional callback to call every time the value of this stat is requested. One of text or callback has to be provided in order for a stat to work correctly.
dictionary@ user = null: Not touched by the stat_set itself, allows the linkage of any user values to a stat to help with display.

stat@: a handle to the newly added stat object.

Deletes a stat from the set.

bool stat_set::delete(const string&in name);

bool: true if the stat was successfully located and deleted, false otherwise.

Determine if a stat with the given name exists in the set.

bool stat_set::exists(const string&in stat_name) const;

bool: true if a stat with the specified name exists in the stat_set, false otherwise.

Clears all stats from the set.

void stat_set::reset();

Updates a particular stat with a new value.

void stat_set::update(const string&in name, var@ value);

Allows for the easy access of stats with [...] syntax.

stat@ stat_set::opIndex(const string&in stat_name) const;

stat@: a handle to a stat with the given name, or null if no stat could be found.

Returns the number of stats in the set.

int stat_set::size;