Editing Module:Test/doc

__NOTOC__ __NOEDITSECTION__
'''This module is used for development.'''

== Purpose ==

This module is used to query information from the uploaded and parsed game files.

Its main purpose is to populate the infoboxes.

== 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 ===
<hr>

The work-horse. Output varies based on use:
: 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.

<pre><nowiki>{{#invoke:Test|query|<def ID>[|...|][|tag|][|sibling=...]}}</nowiki></pre>

'''Named parameters:'''

<code><def ID></code>

: This parameter identifies the Def so it is mandatory. It can take two forms:

: <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 ===
<hr>

<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>
{{#invoke:Test|query|label=desert}}
''(check the log)''

=== Retrieve a simple value ===

<code><nowiki>{{#invoke:Test|query|defName=Caribou|description}}</nowiki></code>

<code>{{#invoke:Test|query|defName=Caribou|description}}</code>

=== Dealing with lists ===

<code><nowiki>{{#invoke:Test|query|defName=Mech_Scyther|tools}}</nowiki></code>

<code>{{#invoke:Test|query|defName=Mech_Scyther|tools}}</code>

When a list is retrieved there will be no output but the log will contain a list of defined variables.

For convenience the list is reprinted here:

<pre>
tools_1_linkedBodyPartsGroup = LeftBlade
tools_1_cooldownTime = 2
tools_1_label = left blade
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>{{#var:tools_1_DPS}}</nowiki></code>

<code>{{#var:tools_1_DPS}}</code>

''DPS'' is not a normal member of this table but has been added with Lua. Let's call it a virtual field.

=== Retrieve something if a sibling is known ===

<code><nowiki>{{#invoke:Test|query|label=guinea pig|minAge|sibling=AnimalAdult}}</nowiki></code>

<code>{{#invoke:Test|query|label=guinea pig|minAge|sibling=AnimalAdult}}</code>