มอดูล:KanmusuModule/doc

This module page contains multiple functions that is used by several templates which will be listed below.

List of functions

shipmodule.KanmusuInfo(frame)

This function is used to build a Kanmusu info table on Kanmusu's respective page. This function will utilize Module:ShipDatabase which contains the main data of respective Kanmusu. It should be used with {{KanmusuInfo}} which will utilize this function instead of directly invoking this function.

Usage

Simply invoke the function with the code below:

{{#invoke:KanmusuModule|KanmusuInfo|<ID> or <Name>}}

Highly preferable to use Kanmusu Sort ID instead of Kanmusu name

Kanmusu Sort ID will always have 3 digits, means that leading zero must be included into the ID if the Sort ID doesn't have 3 digits, for example 001 and 045. The only exception is Mist1 to Mist3.

shipmodule.RemodelBlueprintChk(blueprint)

This function is used as a sub-function to shipmodule.KanmusuInfo(frame). It will read the integer value and return whether the Kanmusu's remodel needs blueprint or not in string form.

Usage

Simply invoke the function with the code below:

{{#invoke:KanmusuModule|RemodelBlueprintChk|<integer value>}}

This function is not intended to work independently and should be used by shipmodule.KanmusuInfo(frame).

shipmodule.KanmusuList(frame)

This function is used to list out all Kanmusu data in table format. This function will be planned to use with certain keywords in order to change how the list would be built. This function will also utilize Module:ShipDatabase just like shipmodule.KanmusuInfo(frame). It should be used with {{KanmusuList}} which will utilize this function instead of directly invoking this function.

Usage

Simply invoke the function with the code below:

{{#invoke:KanmusuModule|KanmusuList|<string, optional>|<max, optional>}}

This function will display the full list if no string was entered. String will be used to determine what type of class the list will be displayed (in progress). If max is entered, max values of stats will be displayed, otherwise the base values will be printed.

shipmodule.KanmusuListEntry(id, printMax)

This function is used to list the data of the specific Kanmusu ID. It is intended to be used with shipmodule.KanmusuList(frame) as this function is to be looped with the table-creating function which is within the shipmodule.KanmusuList(frame).

Usage

Simply invoke the function with the code below:

{{#invoke:KanmusuModule|KanmusuListEntry|<kanmusu sort id>|<true or false>}}

This function will built with only <tr> and <td> tags and it is not recommended to be used independently.