Module:Navboxes/doc: Difference between revisions

From Desynced Wiki
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 2: Line 2:


This module is about creating navboxes autopopulated with in game data, with game extra user customization on top of it.<br>
This module is about creating navboxes autopopulated with in game data, with game extra user customization on top of it.<br>
The generated table tries to mimic the game data & categories.<br>
For Buildings & Items: The generated table tries to mimic the game data & categories.<br>
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>
Extra "fake" categories or forced categorisation can be done by registering objects with the [[Template:NavCategory]] on the specific pages.<br>


Line 9: Line 13:
<code><nowiki>{{#invoke:Navboxes|create|title=<NavboxTitle>|type=<navBoxType>}}</nowiki></code>
<code><nowiki>{{#invoke:Navboxes|create|title=<NavboxTitle>|type=<navBoxType>}}</nowiki></code>
<br>
<br>
Where navBoxType is within <code>NavboxType</code> values, see LUA code. As of writing, valid values are: Unit, Building, Component, Item (Case insensitive)
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 ===


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


==== Item ====
==== Items ====
<code><nowiki>{{#invoke:Navboxes|create|title=Items|type=item}}</nowiki></code>
 
{{#invoke:Navboxes|create|title=Items|type=item}}
{{#invoke:Navboxes|create|title=Items|type=item}}


==== Unit ====
==== Bots ====
{{#invoke:Navboxes|create|title=Units|type=UNIT}}
<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>


==== Component ====
{{#invoke:Navboxes|create|title=Components|type=component}}
{{#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}}