StatisticalScenarioWML - Revision history

Shiki: /* The [team] tag */ update syntax

2018-11-09T15:09:42Z

‎The [team] tag: update syntax

Esr: Highlight attributes

2008-02-15T22:51:06Z

Highlight attributes

Viliam: redesigned

2006-06-07T22:29:25Z

redesigned

Viliam: side menu

2006-03-20T12:38:43Z

side menu

Jorda at 11:27, 20 January 2006

2006-01-20T11:27:45Z

WikiSysop at 14:54, 9 July 2005

2005-07-09T14:54:39Z

New page

== the [scenario] tag for describing the results of a scenario ==

Each [scenario] in [statistics] describes the results of a scenario.
This information is used for the "Statistics" menu option.
When this option is accessed, then a menu is displayed, each option corresponding to a collection of unit types
described in [statistics].
Currently most of the keys/tags are not being used, but they are being recorded in case it is decided to use them.

the following key/tags are recognized:
* ''scenario'' the ID of the scenario whose results are being described
* '''[team]''' describes the statistics for 1 team.
[team] tags must be in index order.
Currently only the side 1 (index 0) statistics are used.
** ''damage_inflicted'' total damage inflicted by units on [team]
** ''damage_taken'' total damage inflicted on units on [team]
** ''recall_cost'' total cost of units that were recalled
** ''recruit_cost'' total cost of units on [team] that were recruited

Each of the following tags describe the unit types of a set of units
by describing the collection of their unit types.
The tags all use attributes of the form '''''unit-type//=//number''''',
meaning that ''number'' units of type ''unit-type'' are in the collection
** '''[recruits]''' displayed.
the set of units on [team] that were recruited in this scenario
** '''[recalls]''' displayed.
the set of units that were recalled in this scenario
** '''[advances]''' displayed as "advancements".
the set of units on [team] that advanced in this scenario
** '''[deaths]''' displayed as "losses".
the set of units on [team] that died in this scenario
** '''[killed]''' displayed as "kills".
the set of units that were killed by units on [team]
** '''[attacks]''' not displayed.
** '''[defends]''' not displayed.

== See Also ==
* [[SavefileWML]]
* [[ReferenceWML]]

@@ Line 88: / Line 88: @@
 * '''[defends]''': not displayed
-The subtags describe numbers per unit type.
+The subtags describe unit types per number.
-For example the following information means that in given scenario the given team has recruited 3 Elvish Archers and 2 Elvish Fighters.
+For example the following information means that in given scenario the given team has recruited 2 Elvish Fighters, 2 Elvish Shamans and 3 Elvish Archers.
   [recruits]
-    Elvish Archer="3"
+="Elvish Fighter,Elvish Shaman"
-    Elvish Fighter="2"
+="Elvish Archer"
   [/recruits]

@@ Line 18: / Line 18: @@
 Attribute:
-* ''mid_scenario'' -- whether the last scenario is currently being played
+* '''mid_scenario''': whether the last scenario is currently being played
 Subtag:
@@ Line 61: / Line 61: @@
 Attribute:
-* ''scenario'' -- the ID of the scenario whose results are recorded
+* '''scenario''': the ID of the scenario whose results are recorded
 Subtag:
-* ''[[#The_.5Bteam.5D_tag|[team]]]'' -- recorded information for one team
+* '''[[#The_.5Bteam.5D_tag|[team]]]''': recorded information for one team
 Teams must be in index order.
@@ Line 74: / Line 74: @@
 Attributes:
-* ''damage_inflicted'' -- total damage inflicted by units on team
+* '''damage_inflicted''': total damage inflicted by units on team
-* ''damage_taken'' -- total damage inflicted on units on team
+* '''damage_taken''':total damage inflicted on units on team
-* ''recall_cost'' -- total cost of units that were recalled
+* '''recall_cost''': total cost of units that were recalled
-* ''recruit_cost'' -- total cost of units on team that were recruited
+* '''recruit_cost''': total cost of units on team that were recruited
 Subtags:
-* ''[recruits]'' -- the set of units on [team] that were recruited in this scenario
+* '''[recruits]''': the set of units on [team] that were recruited in this scenario
-* ''[recalls]'' -- the set of units that were recalled in this scenario
+* '''[recalls]''': the set of units that were recalled in this scenario
-* ''[advances]'' -- "advancements"; the set of units on [team] that advanced in this scenario
+* '''[advances]''': "advancements"; the set of units on [team] that advanced in this scenario
-* ''[deaths]'' -- "losses"; the set of units on [team] that died in this scenario
+* '''[deaths]''': "losses"; the set of units on [team] that died in this scenario
-* ''[killed]'' -- "kills"; the set of units that were killed by units on [team]
+* '''[killed]''': "kills"; the set of units that were killed by units on [team]
-* ''[attacks]'' -- not displayed
+* '''[attacks]''': not displayed
-* ''[defends]'' -- not displayed
+* '''[defends]''': not displayed
 The subtags describe numbers per unit type.

← Older revision		Revision as of 12:38, 20 March 2006
Line 1:		Line 1:
		+	{{WML Tags}}
	== the [scenario] tag for describing the results of a scenario ==		== the [scenario] tag for describing the results of a scenario ==

← Older revision		Revision as of 11:27, 20 January 2006
Line 38:		Line 38:
	* [[ReferenceWML]]		* [[ReferenceWML]]

		+
		+	[[Category: WML Reference]]

@@ Line 1: / Line 1: @@
 {{WML Tags}}
-== the [scenario] tag for describing the results of a scenario ==
+The [[SavefileWML|save file]] contains statistical information about all previously played scenarios; each one inside a [[#The_.5Bscenario.5D_tag|[scenario]]] tag.
-Each [scenario] in [statistics] describes the results of a scenario.
+The statistics are recorded per scenario, per team, per unit type.
-This information is used for the "Statistics" menu option.
+Some of these statistics are available during game in "Statistics" menu option.
-When this option is accessed, then a menu is displayed, each option corresponding to a collection of unit types
+Others are collected, but not currently displayed; this may later change.
-the following key/tags are recognized:
+The recorded information includes:
-* ''scenario'' the ID of the scenario whose results are being described
+* number of units recruited
-* '''[team]''' describes the statistics for 1 team.
+* number of units recalled
-[team] tags must be in index order.
+* number of units advanced
-Currently only the side 1 (index 0) statistics are used.
+* number of units killed
-Each of the following tags describe the unit types of a set of units
+== The [statistics] tag ==
-by describing the collection of their unit types.
-The tags all use attributes of the form '''''unit-type//=//number''''',
+Top-level tag; appears directly in [[SavefileWML|save file]].
-meaning that ''number'' units of type ''unit-type'' are in the collection
-** '''[recruits]''' displayed.
+Attribute:
-the set of units on [team] that were recruited in this scenario
+* ''mid_scenario'' -- whether the last scenario is currently being played
-** '''[recalls]''' displayed.
-the set of units that were recalled in this scenario
+Subtag:
-** '''[advances]''' displayed as "advancements".
+* ''[[#The_.5Bscenario.5D_tag|[scenario]]]'' -- recorded information for one played scenario
 the set of units on [team] that advanced in this scenario
-** '''[deaths]''' displayed as "losses".
+The example statistics tag looks like this:
 the set of units on [team] that died in this scenario
-** '''[killed]''' displayed as "kills".
+ [statistics]
-the set of units that were killed by units on [team]
+   mid_scenario="false"
-** '''[attacks]''' not displayed.
+   [scenario]
-** '''[defends]''' not displayed.
+     scenario="My first scenario"
 == See Also ==
 * [[SavefileWML]]
 * [[ReferenceWML]]
 [[Category: WML Reference]]