Difference between revisions of "Module:Test/doc"

Revision as of 13:09, 18 May 2021

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 ...=... are called named parameters and their order is not important (this is true for all templates).

query

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

The work-horse. Output varies based on use:

If only the <def ID> 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 {{#vardefine}} on all the simple values within it. What got defined can be seen in the page's log.

Named parameters:

<def ID>

This parameter identifies the Def so it is mandatory. It can take two forms, if both are defined then defName takes preference.

defName=<defName>

<defName> (case sensitive) should be replaced with the actual defName of a Def.

label=<label>

<label> (case insensitive) should be replaced with the actual label of a Def.

[sibling=...] (optional) (case sensitive)

Allows querying for something if we know its sibling's value (works only for values at the moment).

Anonymous parameters:

[|...|] (optional) (case sensitive)

Anonymous paramaters before the last one ([tag]) are here to help uniquely identify it. If the [tag] is already unique within a Def tree, then these additional parameters are not needed.

[|tag|] (optional) (case sensitive)

The final anonymous parameter defines what is to be queried.

count

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

Parameters are the same as for query. 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 query, it will return the length of the list.

How-to

Take a look at a Def

{{#invoke:Test|query|label=desert}}

Data is in the log.

Retrieve a simple value

{{#invoke:Test|query|defName=Caribou|description}}

A large member of the deer family, well-adapted to life in cold climates. Caribou can be milked, but refuse to carry packs.

Dealing with lists

{{#invoke:Test|query|defName=Mech_Scyther|tools}}

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:

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

All of the above can be accessed with the use of {{#var:...}}.

{{#var:tools_1_DPS}}

10

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

{{#invoke:Test|query|label=guinea pig|minAge|sibling=AnimalAdult}}

0.3

Module documentation

@@ Line 1: / Line 1: @@
-'''This is a work in progress. It's still quite useless at the moment.'''
+__NOEDITSECTION__
+'''This module is used for development.'''
-== Description ==
+== Purpose ==
-This module is used to obtain information about certain game objects.
-It uses data stored in the subpages of the module.
+This module is used to query information from the uploaded and parsed game files.
-The data that is in those subpages is gathered from Defs in the game's XML files.
+Its main purpose is to populate the infoboxes.
 == Usage ==
-<code><nowiki>
-{{#invoke:DefInfo|query|type|object|property}}
-</nowiki></code>
-; type
+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).
-: For now, the only type that is available is: Races. More will be added.
+=== 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>
+<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>.
-; object
+<code><nowiki>{{#var:tools_1_DPS}}</nowiki></code>
-: If we're querying Races, then, an object is for example: Hare, Lynx, Lancer, LabradorRetriever, ... (defNames are used).
-; property
+<code>{{#var:tools_1_DPS}}</code>
-: MoveSpeed, description, baseBodySize, ...
-NOTE: What you can use in <code>object</code> and <code>property</code> parameters is not strictly defined and some properties can't be dependably obtained (tags that appear multiple times such as those in sublists - work in progress).
+''DPS'' is not a normal member of this table but has been added with Lua. Let's call it a virtual field.
-== Examples ==
+=== Retrieve something if a sibling is known ===
-<code><nowiki>{{#invoke:DefInfo|query|Races|Hare|description}}</nowiki></code>
-will return:
+<code><nowiki>{{#invoke:Test|query|label=guinea pig|minAge|sibling=AnimalAdult}}</nowiki></code>
-{{#invoke:DefInfo|query|Races|Hare|description}}
+<code>{{#invoke:Test|query|label=guinea pig|minAge|sibling=AnimalAdult}}</code>
-<noinclude>[[Category:Module documentation]]</noinclude>
+<noinclude>{{documentation}}</noinclude>