Editing Module:Test/doc

'''This module is used for development. Even if it works at the moment it might break at any time.'''

== Description ==

This module is used to get information about game objects.
Its main purpose is to populate the contents of infoboxes.

Values retrieved are those defined in the files so they may need to be processed to be user friendly. For example "foodType" that holds the value "OminvoreRoughAnimal" is not entirely helpful.

If the queried value is not a simple one (strings, numbers or booleans), for now, the default behaviour is to dump the contents of the thing to the log. The log can be accessed when previewing a page you're editing. A hint that this has happened (there is something in the log) may be that the modlue returned the string "table".

== Usage ==

=== query ===

<pre><nowiki>
{{#invoke:Test|query|<defName>|...|<tag>}}
</nowiki></pre>

; <defName>
: defName of the Def.

; ...
: Additional arguments are here to help uniquely identify the final argument <tag>. If the wanted tag is already unique within a Def tree, then additional parameters are not needed.

; <tag>
: This is the key to be retrieved. They are the same as those in the XML files (filtered, of course; not all of the data from the files is available).

=== getDefName ===

<pre><nowiki>
{{#invoke:Test|getDefName|<label>}}
</nowiki></pre>

; <label>
: get defName based on the label of a Def (not case sensitive)

== Examples ==
=== strings, numbers, booleans ===
;<code><nowiki>{{#invoke:Test|query|Fox_Fennec|description}}</nowiki></code>
:{{#invoke:Test|query|Fox_Fennec|description}}

;<code><nowiki>{{#invoke:Test|query|Fox_Fennec|MoveSpeed}}</nowiki></code>
:{{#invoke:Test|query|Fox_Fennec|MoveSpeed}}

;<code><nowiki>{{#invoke:Test|query|Caribou|herdAnimal}}</nowiki></code>
:{{#invoke:Test|query|Caribou|herdAnimal}}

"herdAnimal" is located in a branch of the main Def called "races" but because it appears nowhere else in the Def no additional parameters are needed to uniquely identify it.
The following query retrieves the same data (just as an example) but with the use of an additional argument.

;<code><nowiki>{{#invoke:Test|query|Caribou|race|herdAnimal}}</nowiki></code>
:{{#invoke:Test|query|Caribou|race|herdAnimal}}

=== numbered lists (tradeTags) ===
* TODO: define syntax to get list length

=== sibling queries (lifeStageAges or tools) ===
* TODO: define syntax

=== getDefName ===

;<code><nowiki>{{#invoke:Test|getDefName|fennec fox}}</nowiki></code>
:{{#invoke:Test|getDefName|feNNec fox}}
@@ Line 1: / Line 1: @@
-__NOEDITSECTION__
+'''This module is used for development. Even if it works at the moment it might break at any time.'''
-'''This module is used for development.'''
-== Purpose ==
+== Description ==
-This module is used to query information from the uploaded and parsed game files.
+This module is used to get information about game objects.
+Its main purpose is to populate the contents of infoboxes.
-Its main purpose is to populate the infoboxes.
+Values retrieved are those defined in the files so they may need to be processed to be user friendly. For example "foodType" that holds the value "OminvoreRoughAnimal" is not entirely helpful.
+If the queried value is not a simple one (strings, numbers or booleans), for now, the default behaviour is to dump the contents of the thing to the log. The log can be accessed when previewing a page you're editing. A hint that this has happened (there is something in the log) may be that the modlue returned the string "table".
 == Usage ==
-A note on the order of named parameters. All of the parameters that look like <code>...=...</code> are called named parameters and their order is not important (this is true for all templates).
 === query ===
-<pre><nowiki>{{#invoke:Test|query|<def ID>[|...|][|tag|][|sibling=...]}}</nowiki></pre>
-The work-horse. Output varies based on use:
-: If only the <code><def ID></code> parameter is set, it will show the whole Def in the log.
-: If simple values are queried it will return them.
-: If lists are queried it will return nothing but call <code><nowiki>{{#vardefine}}</nowiki></code> on all the simple values within it. What got defined can be seen in the page's log.
-Named parameters:
-: <code><def ID></code>
-:: This parameter identifies the Def so it is mandatory. It can take two forms, if both are defined then <code>defName</code> takes preference.
-::: <code>defName=<defName></code>
-:::: <code><defName></code> <small>''(case sensitive)''</small> should be replaced with the actual defName of a Def.
-::: <code>label=<label></code>
-:::: <code><label></code> <small>''(case insensitive)''</small> should be replaced with the actual label of a Def.
-: <code>[sibling=...]</code> <small>''(optional)''</small> <small>''(case sensitive)''</small>
-::: Allows querying for something if we know its sibling's value (works only for values at the moment).
-Anonymous parameters:
-: <code>[|...|]</code> <small>''(optional)''</small> <small>''(case sensitive)''</small>
-:: Anonymous paramaters before the last one (<code>[tag]</code>) are here to help uniquely identify it. If the <code>[tag]</code> is already unique within a Def tree, then these additional parameters are not needed.
-: <code>[|tag|]</code> <small>''(optional)''</small> <small>''(case sensitive)''</small>
-:: The final anonymous parameter defines what is to be queried.
-=== count ===
-<pre><nowiki>{{#invoke:Test|count|<def ID>[|...|][|tag|][|sibling=...]}}</nowiki></pre>
-Parameters are the same as for <code>query</code>. It's basically a wrapped up query that behaves a bit differently.
-The difference is in how it handles lists. If a list is queried, unlike <code>query</code>, it will return the length of the list.
-== How-to ==
-=== Take a look at a Def ===
-<code><nowiki>{{#invoke:Test|query|label=desert}}</nowiki></code>
-<code>{{#invoke:Test|query|label=desert}}</code>
-Data is in the log.
-=== Retrieve a simple value ===
-<code><nowiki>{{#invoke:Test|query|defName=Caribou|description}}</nowiki></code>
+<pre><nowiki>
+{{#invoke:Test|query|<defName>|...|<tag>}}
+</nowiki></pre>
-<code>{{#invoke:Test|query|defName=Caribou|description}}</code>
+; <defName>
+: defName of the Def.
-=== Dealing with lists ===
+; ...
+: Additional arguments are here to help uniquely identify the final argument <tag>. If the wanted tag is already unique within a Def tree, then additional parameters are not needed.
-<code><nowiki>{{#invoke:Test|query|defName=Mech_Scyther|tools}}</nowiki></code>
+; <tag>
+: This is the key to be retrieved. They are the same as those in the XML files (filtered, of course; not all of the data from the files is available).
-<code>{{#invoke:Test|query|defName=Mech_Scyther|tools}}</code>
+=== getDefName ===
-When a list is retrieved there will be no output but the log will contain a list of defined variables.
+<pre><nowiki>
+{{#invoke:Test|getDefName|<label>}}
+</nowiki></pre>
-For convenience the list is reprinted here:
+; <label>
+: get defName based on the label of a Def (not case sensitive)
-<pre>
+== Examples ==
-tools_1_linkedBodyPartsGroup = LeftBlade
+=== strings, numbers, booleans ===
-tools_1_cooldownTime = 2
+;<code><nowiki>{{#invoke:Test|query|Fox_Fennec|description}}</nowiki></code>
-tools_1_label = left blade
+:{{#invoke:Test|query|Fox_Fennec|description}}
-tools_1_DPS = 10
-tools_1_power = 20
-tools_1_capacities_1 = Cut
-tools_1_capacities_2 = Stab
-tools_2_linkedBodyPartsGroup = RightBlade
-tools_2_cooldownTime = 2
-tools_2_label = right blade
-tools_2_DPS = 10
-tools_2_power = 20
-tools_2_capacities_1 = Cut
-tools_2_capacities_2 = Stab
-tools_3_linkedBodyPartsGroup = HeadAttackTool
-tools_3_capacities_1 = Blunt
-tools_3_label = head
-tools_3_DPS = 4.5
-tools_3_chanceFactor = 0.2
-tools_3_power = 9
-tools_3_cooldownTime = 2
-</pre>
-All of the above can be accessed with the use of <code><nowiki>{{#var:...}}</nowiki></code>.
+;<code><nowiki>{{#invoke:Test|query|Fox_Fennec|MoveSpeed}}</nowiki></code>
+:{{#invoke:Test|query|Fox_Fennec|MoveSpeed}}
-<code><nowiki>{{#var:tools_1_DPS}}</nowiki></code>
+;<code><nowiki>{{#invoke:Test|query|Caribou|herdAnimal}}</nowiki></code>
+:{{#invoke:Test|query|Caribou|herdAnimal}}
-<code>{{#var:tools_1_DPS}}</code>
+"herdAnimal" is located in a branch of the main Def called "races" but because it appears nowhere else in the Def no additional parameters are needed to uniquely identify it.
+The following query retrieves the same data (just as an example) but with the use of an additional argument.
-''DPS'' is not a normal member of this table but has been added with Lua. Let's call it a virtual field.
+;<code><nowiki>{{#invoke:Test|query|Caribou|race|herdAnimal}}</nowiki></code>
+:{{#invoke:Test|query|Caribou|race|herdAnimal}}
-=== Retrieve something if a sibling is known ===
+=== numbered lists (tradeTags) ===
+* TODO: define syntax to get list length
-<code><nowiki>{{#invoke:Test|query|label=guinea pig|minAge|sibling=AnimalAdult}}</nowiki></code>
+=== sibling queries (lifeStageAges or tools) ===
+* TODO: define syntax
-<code>{{#invoke:Test|query|label=guinea pig|minAge|sibling=AnimalAdult}}</code>
+=== getDefName ===
-<includeonly>[[Category:Module]]</includeonly>
+;<code><nowiki>{{#invoke:Test|getDefName|fennec fox}}</nowiki></code>
-<noinclude>[[Category:Module documentation]]</noinclude>
+:{{#invoke:Test|getDefName|feNNec fox}}