FANDOM


Ship Form Data Format

"Refer to" are meant to refer to API and client code, see for example [1][2].

The table for each form should contain a number of key value pairs that describe the ship.

_name

String. The name of the ship.

If unknown, omit or set to nil.

_nick

String. The nickname of the ship.

If specified, _japanese_nick should also be specified.

Omit or set to nil if none.

_suffix

String. The suffix of the ship, e.g. Kai, Kai Ni.

If unknown, omit or set to nil.

_module_name

String. The name of the data module the ship resides in.

Defaults to _name. Omit or set to nil if not different from _name.

_api_id

Integer. The API id of the ship. Refer to api_id.

Note that for player ships _api_id = api_id, while for enemy ships _api_id = api_id - 1000.

If unknown, omit or set to nil.

_id

Integer. The id of the ship as shown in the Ship Library. Refer to api_sortno.

However, if this ship shares a slot in the ship list with another ship, api_sortno may not match the id it is listed under in the Ship Library. In this case use the Ship Library id.

If unknown, omit or set to nil.

_true_id

Integer. The true id of the ship.

If the Ship Library id does not match the api_sortno, the api_sortno should be recorded as the _true_id.

If the Ship Library id does match the api_sortno, set this to false.

If unknown, omit or set to nil.

_rarity

Integer. A number from 1-8 indicating the rarity of the ship. Refer to api_backs.

If unknown, omit or set to nil.

_back

Integer. A number from 1-8 indicating the background of the card of the ship. Defaults to _rarity.

_overlay

String. An overlay from Module:Effects for when _rarity is 8. This is used to simulate the "sakura" or "stars" effect in Module:ShipInfoKai.

Defaults to "bloom". The only other overlay available currently is "stars".

_class

String. The class of the ship.

Module:_class will be loaded to provide data on the ship class.

The ship class should be named according to the class shown in the in-game Album.

If unknown, omit or set to nil.

_class_number

String. The number specifying that the ship is the _th ship in its class. Use the number in the in-game Album. If the ship is generic and doesn't have a class number, use false.

If unknown, set to nil.

_type

Integer. The type of the ship. Refer to api_stype.

If unknown, omit or set to nil.

_pillbox

Boolean. Whether or not this ship is a pillbox. Defaults to false.

Only used to distinguish installations and pillboxes, both of which have 0 _speed.

_card

String. An override for the name of the card image on Kancolle Wiki. Omit "File:" from the image.

If the fields _api_id, _type, _name, _suffix are available, then the system should be able to derive the filename if it matches the naming convention. For circumstances where the above fields are unavailable, use this field to explicitly specify the filename.

If unknown, omit or set to nil.

_card_reference

String. Optional. A reference to a ship that should be used to obtain the card for this ship in "name/suffix" form.

The name portion of the reference can be omitted if it refers to the same data module.

_battle_card

String. An override for the name of the battle card image on Kancolle Wiki. Omit "File:" from the image.

See #card.

If unknown, omit or set to nil.

_battle_card_layers

Table. A list of strings specifying layers to overlay on top of the battle card. See Module:ShipBattleCardKai's _battle_card_layers for available layers.

This is not inherited through _battle_card_reference.

_battle_card_reference

String. Optional. A reference to a ship that should be used to obtain the battle card for this ship in "name/suffix" form.

See #card_reference.

_cg

String. An override for the name of the CG image on Kancolle Wiki. Omit "File:" from the image.

See #card.

If unknown, omit or set to nil.

_cg_reference

String. Optional. A reference to a ship that should be used to obtain the CG for this ship in "name/suffix" form.

See #card_reference.

_japanese_name

String. The japanese name of the ship. Refer to api_name.

If unknown, omit or set to nil.

_japanese_nick

String. The japanese nickname of the ship.

If specified, _nick should also be specified.

Omit or set to nil if none.

_reading

String. The furigana for the _japanese_name of the ship. api_yomi may provide a base for this value.

For ships that have multiple names, api_yomi may contain the readings for all of the names.

If unknown, omit or set to nil.

_reading_nick

String. The furigana for the _japanese_nick of the ship.

Only valid when _japanese_nick is set.

_hp

Integer. The base hp of the ship. Refer to api_taik[0].

If unknown, omit or set to nil.

_hp_max

Integer. The max hp of the ship. Refer to api_taik[1].

If equal to the base stat, set to false.

If unknown, omit or set to nil.

_firepower

Integer. The base firepower of the ship. Refer to api_houg[0].

If unknown, omit or set to nil.

_firepower_max

Integer. The max firepower of the ship. Refer to api_houg[1].

If equal to the base stat, set to false.

If unknown, omit or set to nil.

_firepower_mod

Integer. The amount of firepower the ship grants through Modernization. Refer to api_powup[0].

If none is granted, set to false.

If unknown, omit or set to nil.

_armor

Integer. The base armor of the ship. Refer to api_souk[0].

If unknown, omit or set to nil.

_armor_max

Integer. The max armor of the ship. Refer to api_souk[1].

If equal to the base stat, set to false.

If unknown, omit or set to nil.

_armor_mod

Integer. The amount of armor the ship grants through Modernization. Refer to api_powup[3].

If none is granted, set to false.

If unknown, omit or set to nil.

_torpedo

Integer. The base torpedo of the ship. Refer to api_raig[0].

If unknown, omit or set to nil.

_torpedo_max

Integer. The max torpedo of the ship. Refer to api_raig[1].

If equal to the base stat, set to false.

If unknown, omit or set to nil.

_torpedo_mod

Integer. The amount of torpedo the ship grants through Modernization. Refer to api_powup[1].

If none is granted, set to false.

If unknown, omit or set to nil.

_evasion

Integer. The base (f(1)) evasion of the ship. Refer to:

  • Displayed value for level 1 ships without equipment (api_kaihi[0] in api_port/port).
  • Displayed base evasion in kandex (api_kaih in api_get_member/picture_book).
  • Or use the formula method.

If unknown, omit or set to nil.

_evasion_max

Integer. The max (f(99)) evasion of the ship. Refer to:

  • Displayed value for level 99 ships without equipment (api_kaihi[0] in api_port/port).
  • api_kaihi[1] in api_port/port or api_get_member/ship3 at any level.
  • Or use the formula method.

If equal to the base stat, set to false.

If unknown, omit or set to nil.

_aa

Integer. The base AA of the ship. Refer to api_tyku[0].

If unknown, omit or set to nil.

_aa_max

Integer. The max AA of the ship. Refer to api_tyku[1].

If equal to the base stat, set to false.

If unknown, omit or set to nil.

_aa_mod

Integer. The amount of AA the ship grants through Modernization. Refer to api_powup[2].

If none is granted, set to false.

If unknown, omit or set to nil.

_asw

Integer. The base (f(1)) ASW of the ship. Refer to:

  • Displayed value for level 1 ships without equipment (api_taisen[0] in api_port/port).
  • Base ASW in kandex (not displayed, api_tais in api_get_member/picture_book).
  • Or use the formula method.

If unknown, omit or set to nil.

_asw_max

Integer. The max (f(99)) ASW of the ship. Refer to:

  • Displayed value for level 99 ships without equipment (api_taisen[0] in api_port/port).
  • api_taisen[1] in api_port/port or api_get_member/ship3 at any level.
  • Or use the formula method.

If equal to the base stat, set to false.

If unknown, omit or set to nil.

_speed

Integer. The speed of the ship. Refer to api_soku.

If unknown, omit or set to nil.

_los

Integer. The base (f(1)) LOS of the ship. Refer to:

  • Displayed value for level 1 ships without equipment (api_sakuteki[0] in api_port/port).
  • Or use the formula method.

If unknown, omit or set to nil.

_los_max

Integer. The max (f(99)) LOS of the ship. Refer to:

  • Displayed value for level 99 ships without equipment (api_sakuteki[0] in api_port/port).
  • api_sakuteki[1] in api_port/port or api_get_member/ship3 at any level.
  • Or use the formula method.

If equal to the base stat, set to false.

If unknown, omit or set to nil.

_range

Integer. The range of the ship. Refer to api_leng.

If unknown, omit or set to nil.

_luck

Integer. The base luck of the ship. Refer to api_luck[0].

If unknown, omit or set to nil.

_luck_max

Integer. The max luck of the ship. Refer to api_luck[1].

If equal to the base stat, set to false.

If unknown, omit or set to nil.

_luck_mod

Integer. The amount of luck the ship grants through Modernization.

If none is granted, set to false.

If unknown, omit or set to nil.

_buildable

Boolean. Whether or not this ship is buildable in normal Construction.

If unknown, omit or set to nil.

_buildable_lsc

Boolean. Whether or not this ship is buildable in Large Ship Construction.

If unknown, omit or set to nil.

_build_time

Integer. The amount of minutes it takes to build the ship. Refer to api_buildtime.

If unknown, omit or set to nil.

_remodel_level

Integer. The level at which a ship can remodel into this form. Refer to api_afterlv of the previous form.

If this ship is not a remodel, set to false.

If unknown, omit or set to nil.

_remodel_ammo

Integer. The amount of ammo required to remodel into this form. Refer to api_afterbull of the previous form.

Only used when _remodel_level is true.

If unknown, omit or set to nil.

_remodel_steel

Integer. The amount of ammo required to remodel into this form. Refer to api_afterfuel of the previous form.

Only used when _remodel_level is true.

If unknown, omit or set to nil.

_remodel_development_material

Integer. The amount of development materials required to remodel into this form. Refer to vo.MasterShipUpgradeData.

Only used when _remodel_level is true.

If unknown, omit or set to nil.

_remodel_construction_material

Integer. The amount of construction materials required to remodel into this form. Refer to vo.MasterShipUpgradeData.

Only used when _remodel_level is true.

Optional.

_remodel_blueprint

Boolean. Whether a blueprint is needed to remodel into this form. Refer to api_drawing_count.

Only used when _remodel_level is true.

If unknown, omit or set to nil.

_remodel_catapult

Boolean. Whether a prototype deck catapult is needed to remodel into this form. Refer to api_catapult_count.

Only used when _remodel_level is true.

If unknown, omit or set to nil.

_remodel_from

String. A reference to the ship form that this ship remodels from in "name/suffix" form.

Set to false if this ship is not a remodel.

_remodel_to

String. A reference to the ship form that this ship remodels to in "name/suffix" form.

Set to false if this ship does not remodel.

_remodel_to_level

Integer. The level at which a ship can remodel into the _remodel_to form. Refer to api_afterlv. Use this only when _remodel_from is the same as _remodel_to (ie. a reversible remodel).

If unknown, omit or set to nil.

_remodel_to_ammo

Integer. The amount of ammo required to remodel into the _remodel_to form. Refer to api_afterbull. Use this only when _remodel_from is the same as _remodel_to (ie. a reversible remodel).

If unknown, omit or set to nil.

_remodel_to_steel

Integer. The amount of ammo required to remodel into the _remodel_to form. Refer to api_afterfuel. Use this only when _remodel_from is the same as _remodel_to (ie. a reversible remodel).

If unknown, omit or set to nil.

_remodel_to_development_material

Integer. The amount of development materials required to remodel into the _remodel_to form. Refer to vo.MasterShipUpgradeData. Use this only when _remodel_from is the same as _remodel_to (ie. a reversible remodel).

If unknown, omit or set to nil.

_remodel_to_construction_material

Integer. The amount of construction materials required to remodel into the _remodel_to form. Refer to vo.MasterShipUpgradeData. Use this only when _remodel_from is the same as _remodel_to (ie. a reversible remodel).

Optional.

_remodel_to_blueprint

Boolean. Whether a blueprint is needed to remodel into the _remodel_to form. Refer to api_drawing_count. Use this only when _remodel_from is the same as _remodel_to (ie. a reversible remodel).

If unknown, omit or set to nil.

_remodel_to_catapult

Boolean. Whether a prototype deck catapult is needed to remodel into the _remodel_to form. Refer to api_catapult_count. Use this only when _remodel_from is the same as _remodel_to (ie. a reversible remodel).

If unknown, omit or set to nil.

_fuel

Integer. The max amount of fuel consumed. Refer to api_fuel_max.

If unknown, omit or set to nil.

_ammo

Integer. The max amount of ammo consumed. Refer to api_bull_max.

If unknown, omit or set to nil.

_scrap_fuel

Integer. The amount of fuel returned when the ship is scrapped. Refer to api_broken[0].

If none is returned, set to false.

If unknown, omit or set to nil.

_scrap_ammo

Integer. The amount of ammo returned when the ship is scrapped. Refer to api_broken[1].

If none is returned, set to false.

If unknown, omit or set to nil.

_scrap_steel

Integer. The amount of steel returned when the ship is scrapped. Refer to api_broken[2].

If none is returned, set to false.

If unknown, omit or set to nil.

_scrap_baux

Integer. The amount of bauxite returned when the ship is scrapped. Refer to api_broken[3].

If none is returned, set to false.

If unknown, omit or set to nil.

_wikipedia

String. Wikipedia page for the ship. For example, Japanese submarine I-401.

If unknown, omit or set to nil.

_voice_actor

String. Name of the seiyuu data module for ship's seiyuu. Use existing modules as a template for new seiyuu data modules.

If unknown, omit or set to nil.

_artist

String. Name of the artist data module for ship's artist. Use existing modules as a template for new artist data modules.

If unknown, omit or set to nil.

_implementation_date

Table: { <year>, <month>, <day> } (JST). Ship's implementation date.

If unknown, omit or set to nil.

_availability

Todo
That is kinda hard to use and update?

Table. Ship's current availability.

Example usage:

{ "drop", "event_reward", "event_drop",
  drop = {
    {
      1, -- world
      4, -- map
      "B", -- node, can be a list of nodes or true for all nodes
      -- optional formation, can be a table from nodes
    },
    -- ...
  },
  event_reward = {
    {
      2016, -- year
      4, -- quarter, 1 = winter, 4 = spring, 7 = summer, 10 = fall
      5, -- map
      -- optional difficulty, 0 = All, 1 = Easy, 2 = Medium, 3 = Hard
    }
  },
  event_drop = {
    {
      2016, -- year
      4, -- quarter, see "event_reward"
      7, -- map
      "N", -- node, see "drop"
      -- optional formation, see "drop"
    },
    -- ...
  }
}

If not available yet, set to false.

If unknown, omit or set to nil.

_equipment

Table. A table containing other tables that represent equipment slots.

The table should contain the same number of tables as slots the ship has. Refer to api_slot_num.

If unknown, omit or set to nil.

Equipment Slot

Table. A table representing an equipment slot.

equipment

String. The name of the equipment in the slot.

If no equipment is equipped, set to false.

If unknown, omit or set to nil.

size

String. The size of the slot. Refer to api_maxeq[slot number].

If unknown, omit or set to nil.

Community content is available under CC-BY-SA unless otherwise noted.