Difference between revisions of "Module:DefInfo/doc"
Jump to navigation
Jump to search
m (→Usage) |
m (→Usage) |
||
| Line 20: | Line 20: | ||
: MoveSpeed, description, baseBodySize, ... | : 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 (work in progress). | + | 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). |
== Examples == | == Examples == | ||
Revision as of 19:07, 14 March 2021
This is a work in progress.
Description
This module is used to obtain information about certain game objects. It uses data stored in the subpages of the module. The data that is in those subpages is gathered from Defs in the game's XML files.
Usage
{{#invoke:DefInfo|query|type|object|property}}
- type
- For now, the only type that is available is: Races. More will be added.
- object
- If we're querying Races, then, an object is for example: Hare, Lynx, Lancer, ... (defNames are used).
- property
- MoveSpeed, description, baseBodySize, ...
NOTE: What you can use in object and property 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).
Examples
{{#invoke:DefInfo|query|Races|Hare|description}}
will return:
Script error: The module returned a nil value. It is supposed to return an export table.