Modding:Statistics - Revision history

Game Hunter: added real_time_ms, drltable edits

2012-03-24T22:12:39Z

added real_time_ms, drltable edits

Game Hunter: a few more entries

2012-01-15T21:03:43Z

a few more entries

Game Hunter: statistic API

2012-01-15T20:45:58Z

statistic API

New page

Statistics are not game objects but, rather, a table of values that are accrued throughout the game. Often they are referenced for the purpose of granting [[Modding:Medal|medals]] and [[Modding:Badge|badges]], although they can be accessed at any time.

== Properties ==
Statistics properties can be called using the syntax "''statistics.stat_name''", where stat_name refers to the property names as explained here. ''(Specific to 0.9.9.6: All statistics from the core game can be updated simply by calling them, but they are also updated by default: default updates are mentioned in the statistic's description.)''

In addition, you can create new statistics using the same syntax and assign them values (e.g., "''statictics.stat_name = 0''"). Values assigned to a statistic must always be an integer.

{|class="wikitable" style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
! colspan="2" style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Statistics Properties'''
{{Table2Col
|es=background: #333;
|c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
|c2=padding:0px 2px;
|damage_on_level|The total amount of damage the player has taken on the current level. It is updated whenever the player takes damage, and resets whenever the player exits a level.
|damage_taken|The total amount of damage that the player has taken over the course of a game. It is updated whenever the player takes damage.
|game_time|The amount of game time (that is, measured by in-game turns) that has passed since the game started. It is updated whenever a game ends.
|kills|The number of enemies that have been killed since the game started. It is updated whenever the player exits a level.
|kills_non_damage|The number of enemies that have died while the player has not taken damage. It is tracked (but not necessarily updated) each time an enemy dies.
|levers_pulled|The number of [[lever|levers]] pulled over the course of a game. It is updated whenever a lever is pulled.
|max_kills|The total number of enemies that have appeared since the game started. It is updated upon entering a new level.
|real_time|The amount of real time (that is, measured by a clock) that has passed since the game started. It is updated whenever a game ends.
|uniques_found|The total number of [[Specials|uniques]] found over the course of a game. It is updated whenever the player picks up a unique item.
|}}
|}

== API ==
{|class="wikitable" style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
! colspan="2" style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Statistics Interface'''
{{Table2Col
|es=background: #333;
|c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
|c2=padding:0px 2px;
|'''void'''|statistics.[[#statistics_inc|inc]]('''string''' name, '''integer''' value)
|}}
|}

{{Anchor|statistics_inc}}
;statistics.inc('''string''' name, '''integer''' value)
:This increments the statistic ''name'' by ''value''. ''value'' can be positive (increasing the statistic) or negative (decreasing the statistic).

@@ Line 2: / Line 2: @@
 == Properties ==
-Statistics properties can be called using the syntax "''statistics.stat_name''", where stat_name refers to the property names as explained here. ''(Specific to 0.9.9.6: All statistics from the core game can be updated simply by calling them, but they are also updated by default: default updates are mentioned in the statistic's description.)''
+Statistics properties can be called using the syntax "''statistics.stat_name''", where stat_name refers to the property names as explained here. All statistics from the core game can be updated simply by calling them, but they are also updated by default: default updates are mentioned in the statistic's description.
 In addition, you can create new statistics using the same syntax and assign them values (e.g., "''statictics.stat_name = 0''"). Values assigned to a statistic must always be an integer.
-{|class="wikitable" style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
+{{drltable|Statistics|2|{{Table2Col
- ! colspan="2" style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Statistics Properties'''
- {{Table2Col
    |es=background: #333;
    |c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
@@ Line 25: / Line 23: @@
    |max_kills|The total number of enemies that have appeared since the game started. It is updated upon entering a new level.
    |real_time|The amount of real time (that is, measured by a clock) that has passed since the game started. It is updated whenever a game ends.
    |uniques_found|The total number of [[Specials|uniques]] found over the course of a game. It is updated whenever the player picks up a unique item.
    |}}
-|}
+}}
 == API ==
-{|class="wikitable" style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
+{{drltable|Statistics Interface|2|{{Table2Col
- ! colspan="2" style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Statistics Interface'''
- {{Table2Col
    |es=background: #333;
    |c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
@@ Line 38: / Line 35: @@
    |'''void'''|statistics.[[#statistics_inc|inc]]('''string''' name, '''integer''' value)
    |}}
-|}
+}}
 {{Anchor|statistics_inc}}
 ;statistics.inc('''string''' name, '''integer''' value)
 :This increments the statistic ''name'' by ''value''. ''value'' can be positive (increasing the statistic) or negative (decreasing the statistic).

@@ Line 12: / Line 12: @@
    |c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
    |c2=padding:0px 2px;
    |damage_on_level|The total amount of damage the player has taken on the current level. It is updated whenever the player takes damage, and resets whenever the player exits a level.
    |damage_taken|The total amount of damage that the player has taken over the course of a game. It is updated whenever the player takes damage.
-   |game_time|The amount of game time (that is, measured by in-game turns) that has passed since the game started. It is updated whenever a game ends.
+   |entry_time|The amount of game time (that is, measured by in-game turns) that has passed  since the game started. It is updated whenever the player enters a level.
    |kills|The number of enemies that have been killed since the game started. It is updated whenever the player exits a level.
    |kills_non_damage|The number of enemies that have died while the player has not taken damage. It is tracked (but not necessarily updated) each time an enemy dies.
    |levers_pulled|The number of [[lever|levers]] pulled over the course of a game. It is updated whenever a lever is pulled.
    |max_kills|The total number of enemies that have appeared since the game started. It is updated upon entering a new level.