Module:Navboxes/doc: Difference between revisions

From Desynced Wiki
No edit summary
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Description ==
== Description ==


This module is about creating navboxes autopopulated with in game data, with game extra user customization on top of it.
This module is about creating navboxes autopopulated with in game data, with game extra user customization on top of it.<br>
Table generated try to mimic the game data & categories.
For Buildings & Items: The generated table tries to mimic the game data & categories.<br>
Extra "fake" categories or forced categorisation can be done by registering objects with the [[Template:NavCategory]] on the specific pages
For Bots: Using custom sorting defined in this script.<br>
For Components: ?<br>
Tech is not covered by this module.<br>
 
Extra "fake" categories or forced categorisation can be done by registering objects with the [[Template:NavCategory]] on the specific pages.<br>


== Usage ==
== Usage ==
Usage:
Usage:
<code><nowiki>{{#invoke:Navboxes|create|title=<NavboxTitle>|type=<navBoxType>}}</nowiki></code>
<code><nowiki>{{#invoke:Navboxes|create|title=<NavboxTitle>|type=<navBoxType>}}</nowiki></code>
Where navBoxType is within NavboxType values below.
<br>
Where navBoxType is within <code>NavboxType</code> values, see LUA source in this page. As of writing, valid values are: Unit, Building, Component, Item (Case insensitive)
 
=== Example ===


Example:
==== Buildings ====


<code><nowiki>{{#invoke:Navboxes|create|title=Buildings|type=building}}</nowiki></code> results in:
<code><nowiki>{{#invoke:Navboxes|create|title=Buildings|type=building}}</nowiki></code>  


{{#invoke:Navboxes|create|title=Buildings|type=building}}
{{#invoke:Navboxes|create|title=Buildings|type=building}}
==== Items ====
<code><nowiki>{{#invoke:Navboxes|create|title=Items|type=item}}</nowiki></code>
{{#invoke:Navboxes|create|title=Items|type=item}}
==== Bots ====
<code><nowiki>{{#invoke:Navboxes|create|title=Bots|type=bot}}</nowiki></code>
{{#invoke:Navboxes|create|title=Bots|type=bot}}
==== Components ====
<code><nowiki>{{#invoke:Navboxes|create|title=Components|type=component}}</nowiki></code>
{{#invoke:Navboxes|create|title=Components|type=component}}

Latest revision as of 06:21, 13 August 2025

Description[edit source]

This module is about creating navboxes autopopulated with in game data, with game extra user customization on top of it.
For Buildings & Items: The generated table tries to mimic the game data & categories.
For Bots: Using custom sorting defined in this script.
For Components: ?
Tech is not covered by this module.

Extra "fake" categories or forced categorisation can be done by registering objects with the Template:NavCategory on the specific pages.

Usage[edit source]

Usage: {{#invoke:Navboxes|create|title=<NavboxTitle>|type=<navBoxType>}}
Where navBoxType is within NavboxType values, see LUA source in this page. As of writing, valid values are: Unit, Building, Component, Item (Case insensitive)

Example[edit source]

Buildings[edit source]

{{#invoke:Navboxes|create|title=Buildings|type=building}}

Items[edit source]

{{#invoke:Navboxes|create|title=Items|type=item}}

Bots[edit source]

{{#invoke:Navboxes|create|title=Bots|type=bot}}

Components[edit source]

{{#invoke:Navboxes|create|title=Components|type=component}}