• Welcome to the Kancolle Wiki!
  • If you have any questions regarding site content, account registration, etc., please visit the KanColle Wiki Discord

Difference between revisions of "Template:ShipDataDocumentation"

From Kancolle Wiki
Jump to navigation Jump to search
>Ckwng
(Documentation for ShipData data modules. WIP.)
 
>Ckwng
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
This is a module containing the data for {{{$1}}}.
+
This page is a [[w:c:c:Help:Lua|Lua]] ''data module'' for {{#ifeq:{{{ship|false}}}|true|the ship [[{{BASEPAGENAME}}]]{{#ifeq:{{{class|false}}}|true|, <nowiki></nowiki>|<nowiki></nowiki> and <nowiki></nowiki>}}it's forms}}{{#ifeq:{{{class|false}}}|true|{{#ifeq:{{{ship|false}}}|true|, and the ship class of the same name|the ship class [[{{BASEPAGENAME}}]]}} }}.{{#ifeq:{{{ship|false}}}|true|<nowiki></nowiki>
  
==Ship Data Format==
+
The name, stats, equipment, and other data for the ship [[{{BASEPAGENAME}}]] are recorded here.}}{{#ifeq:{{{class|false}}}|true|<nowiki></nowiki>
  
This module should return a table, which contains other tables for each form of the ship. The table for the basic form should be under the key "", or the empty string. Remodels should be under the suffix of that remodel, like "Kai" or "Kai Ni".
+
The name, base ship type, and other data for the ship class [[{{BASEPAGENAME}}]] are {{#ifeq:{{{ship|false}}}|true|also <nowiki></nowiki>}}recorded here.}}
  
For example,
+
{{ShipDataDocumentation/ShipData}}
  
local Ooyodo = {
+
{{#ifeq:{{{ship|false}}}|true|{{ShipDataDocumentation/ShipForm}} }}
    [""] = {
 
        ...
 
    },
 
    ["Kai"] = {
 
        ...
 
    },
 
}
 
 
return Ooyodo
 
  
==Ship Form Data Format==
+
{{#ifeq:{{{class|false}}}|true|{{ShipDataDocumentation/ShipClass}} }}<noinclude>
  
The table for each form should contain a number of key value pairs that describe the ship.
+
{{documentation}}</noinclude>
 
 
===_name===
 
String. The name of the ship.
 
 
 
===_rarity===
 
Integer. A number from 1-8 indicating the rarity of the ship.
 

Latest revision as of 23:06, 4 March 2015

This page is a Lua data module for .

Ship Data Format

This module should return a table.

If the module contains ship forms, the returned table should contain other tables for each form of the ship. The table for the basic form should be under the key "", or the empty string. Remodels should be under the suffix of that remodel, like "Kai" or "Kai Ni".

For example,
local Ooyodo = {
    [""] = {
        ...
    },
    ["Kai"] = {
        ...
    },
}

return Ooyodo

If the module contains a ship class, the returned table should contain contain a table under the key class.

local Ooyodo = {
    class = {
        ...
    },
}

return Ooyodo



Template-info.png Template documentation [view] [edit] [history] [purge]