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

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

<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).

{{#invoke:Test|getDefName|<label>}}

<label>

get defName based on the label of a Def

Examples

strings, numbers, booleans

{{#invoke:Test|query|Fox_Fennec|description}}

{{#invoke:Test|query|fennec fox|description}}

{{#invoke:Test|query|Fox_Fennec|MoveSpeed}}

{{#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 would retrieve the same data (just as an example) but with the use of an additional argument.

{{#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

{{#invoke:Test|getDefName|fennec fox}}