Editing Module:Test/doc

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

'''Even if it works at the moment it might break at any time.'''

'''Parser is done (needs a few more finishing touches) so any data that is missing can be easily added.'''

'''At the moment the dataset has ThingDefs, BiomeDefs and DamageDefs (filtered).'''

== Description ==

This module is used to query information from the parsed (and filtered) game's definition files.

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 "OmnivoreRoughAnimal" is not entirely helpful. (TODO: This could be automatically converted to something more recognizable.)

== Usage ==

A note on the order of parameters. All of the parameters that begin with <code>somelabel=...</code> are called named parameters and their order is not important (as is the general case with parameters for templates).

<hr/>
=== query ===

The work-horse. Output varies based on use. If simple values are queried it will return the string. If lists are queried it will return nothing but call <code><nowiki>{{#vardefine}}</nowiki></code> for 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>

<code><def ID></code>

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

: <code>defName=<defName></code>
:: <defName> ''(case sensitive)'' should be replaced with the actual defName of a Def.

: <code>label=<label></code>
:: <label> ''(case insensitive)'' should be replaced with the actual label of a Def.

<code>[...|...|...]</code> 
: 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>[tag]</code>
: The final parameter is just a normal numbered parameter but because it is the last one, it is mentioned here so it can be referred to.

<code>[sibling=<value>]</code>
: Allows querying for something if we know its sibling's value (works only for values at the moment). It does not have to be at the end because named arguments do not depend on the order.

<hr/>
=== count ===

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

Arguments are the same as for [[#query]]. It's basically a wrapped up query.

Because count (if not 0) means that a table was counted - it will also be displayed in the log.

<hr/>
=== getDefName ===

Used to retrieve a Def's defName if we know the label. Most of the wiki pages are labels of Defs so this can come in handy.

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

<code><label></code>
: Def's label (not case sensitive)

== How-to ==

=== Get defName if we know label ===

<code><nowiki>{{#invoke:Test|getDefName|feNNec fOx}}</nowiki></code>

<code>{{#invoke:Test|getDefName|feNNec fOx}}</code>

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