Files
patchnotes/shipdisplay.txt
2026-03-18 23:02:38 +01:00

165 lines
7.8 KiB
Plaintext

{{Doc}}
This template displays ships as cards, showing their attributes, skins, skin backgrounds, construction times, and other useful information.
== Usage ==
<syntaxhighlight lang="Wikitext">
{{ShipDisplay|<rarity>|<shipname>|<shiptype>|<skinCategory>|<skinName>|<description>|<limited>|<live2d>|<skinbg>|<small>}}
</syntaxhighlight>
=== Rarity ===
Use <code>&lt;rarity&gt;</code> to assign different background colors for the ship display cards.
{| class="wikitable"
! Rarity !! Values !! Result
|-
| None || Unreleased, 0<ref>Any numerical value besides 1, 2, 3, 4, 5, and 6 will also work.</ref> || <div style="width: 40px; height: 40px;"></div>
|-
| Common || Normal, N, 1, 2<ref>Any non-numerical value (or leaving it blank) will also work.</ref> || <div class="rarity-2" style="width: 40px; height: 40px; border-radius:8px;"></div>
|-
| Rare || Rare, R, 3 || <div class="rarity-3" style="width: 40px; height: 40px; border-radius:8px;"></div>
|-
| Elite || Elite, E, 4 || <div class="rarity-4" style="width: 40px; height: 40px; border-radius:8px;"></div>
|-
| Super Rare<br>(Priority) || Super Rare, Priority, SR, PR, 5 || <div class="rarity-5" style="width: 40px; height: 40px; border-radius: 8px;"></div>
|-
| Ultra Rare<br>(Decisive, Legendary) || Ultra Rare, Decisive, Legendary, UR, DR, L, 6 || <div class="rarity-6" style="width: 40px; height: 40px; border-radius: 8px;"></div>
|-
| colspan="3" | <references />
|}
=== Classification ===
Ships have different classifications in-game, which are based on their real-world naval classifications. Use <code>&lt;shiptype&gt;</code> to assign a classification label to a ship's display card.
{| class="wikitable"
! Classification !! Values !! Icon
|-
| Destroyer || DD, Destroyer || [[File:DD img0.png|x20px]]
|-
| Guided-Missile Destroyer || DDG, Guided-Missile Destroyer || [[File:DDGv img0.png|x20px]]
|-
| Light Cruiser || CL, Light Cruiser || [[File:CL img0.png|x20px]]
|-
| Heavy Cruiser || CA, Heavy Cruiser || [[File:CA img0.png|x20px]]
|-
| Large Cruiser || CB, Large Cruiser || [[File:CB img0.png|x20px]]
|-
| Battleship || BB, Battleship || [[File:BB img0.png|x20px]]
|-
| Battlecruiser || BC, Battlecruiser || [[File:BC img0.png|x20px]]
|-
| Monitor || BM, Monitor || [[File:BM img0.png|x20px]]
|-
| Aviation Battleship || BBV, Aviation Battleship || [[File:BBV img0.png|x20px]]
|-
| Aircraft Carrier || CV, Aircraft Carrier || [[File:CV img0.png|x20px]]
|-
| Light Aircraft Carrier || CVL, Light Aircraft Carrier || [[File:CVL img0.png|x20px]]
|-
| Submarine || SS, Submarine || [[File:SS img0.png|x20px]]
|-
| Submarine Carrier || SSV, Submarine Carrier || [[File:SSV img0.png|x20px]]
|-
| Repair Ship || AR, Repair Ship || [[File:AR img0.png|x20px]]
|-
| Munition Ship || AE, Munition Ship || [[File:AE img0.png|x20px]]
|-
| Sailing Frigate (Submarine) || IXs, Sailing Frigate (Submarine) || [[File:IXs img0.png|x20px]]
|-
| Sailing Frigate (Vanguard) || IXv, Sailing Frigate (Vanguard) || [[File:IXv img0.png|x20px]]
|-
| Sailing Frigate (Main) || IXm, Sailing Frigate (Main) || [[File:IXm img0.png|x20px]]
|}
== Examples ==
<syntaxhighlight lang="Wikitext">
{{ShipDisplay|Elite|Laffey|DD|RPG|Sleepageddon|Sleepy magic is dangerous|1||158}}
{{ShipDisplay|Elite|Javelin|DD|RPG|A Legend is Born?!|Food can be used as weapons, too|1||158}}
{{ShipDisplay|Elite|Z23|DD|RPG|Upgrade Failure?!|Nimi got scammed|1||158|y}}
{{ShipDisplay|Elite|Ayanami|DD|RPG|Dynamic Kick!|Most powerful fighter|1||158|y}}
{{ShipDisplay|Super Rare|Amagi|BB|Party|Red Kite Respite|Floof mom|1|L2D|146|y}}
{{ShipDisplay|Ultra Rare|Shinano|CV|RaceQueen|Moonlit Chrome|Floof queen|1|L2D|132}}
</syntaxhighlight>
{{ShipDisplay|Elite|Laffey|DD|RPG|Sleepageddon|Sleepy magic is dangerous|1||158}}
{{ShipDisplay|Elite|Javelin|DD|RPG|A Legend is Born?!|Food can be used as weapons, too|1||158}}
{{ShipDisplay|Elite|Z23|DD|RPG|Upgrade Failure?!|Nimi got scammed|1||158|y}}
{{ShipDisplay|Elite|Ayanami|DD|RPG|Dynamic Kick!|Most powerful fighter|1||158|y}}
{{ShipDisplay|Super Rare|Amagi|BB|Party|Red Kite Respite|Floof mom|1|L2D|146|y}}
{{ShipDisplay|Ultra Rare|Shinano|CV|RaceQueen|Moonlit Chrome|Floof queen|1|L2D|132}}
== TemplateData ==
<templatedata>
{
"description": "Makes a custom card display for ships that shows useful information.",
"format": "inline",
"params": {
"1": {
"label": "<rarity>",
"description": "Rarity type of the ship. See \"Rarity\" section for details.",
"type": "string",
"default": "Unknown",
"required": true
},
"2": {
"label": "<shipname>",
"description": "Name of the ship. MUST use the exact name so the ship's shipyard icon displays correctly on the card.",
"type": "string",
"required": true
},
"3": {
"label": "<shiptype>",
"description": "Clasification type of the ship. See \"Classification\" section for details.",
"type": "string",
"required": true
},
"4": {
"label": "<skinCategory>",
"description": "Ship's skin category. Will display the ship in her skin under the specified category.",
"type": "string",
"default": "Default",
"example": "Summer, Party, RaceQueen"
},
"5": {
"label": "<skinName>",
"description": "Name of the ship's skin that will be hyperlinked to its Gallery page if \"<skinCategory>\" is used. If \"<skinCategory>\" is left empty, this acts as description text.",
"type": "string",
"default": "Default"
},
"6": {
"label": "<description>",
"description": "Description text displayed beneath \"<skinName>\", or extra description text if \"<skinCategory>\" is left empty.",
"type": "string"
},
"7": {
"label": "<limited>",
"description": "Toggle for showing the limited availability of a skin.",
"type": "number",
"example": "Use \"1\" for Limited; \"2\" for Event; \"3\" for Unavailable."
},
"8": {
"label": "<live2d>",
"description": "Toggle for showing a skin as Live2D, Dynamic, or Dual-Form.",
"type": "string",
"example": "Use \"L2D\" for Live2D; \"DYN\" for Dynamic; \"DUAL\" for Dual-Form."
},
"9": {
"label": "<skinbg>",
"description": "Number ID for a skin's background image. See \"Category:Skin Backgrounds\" for all backgrounds and their IDs - the IDs are in their filenames.",
"type": "number"
},
"10": {
"label": "<small>",
"description": "Toggle for shrinking the pixel width of the ship display card. Default size is 148px width; when used, card is shrunk down to 128px width. Assign this parameter any value to activate.",
"type": "boolean"
}
}
}
</templatedata>
== Notes ==
* Shipyard icon files on the display cards will be recorded as page transclusions because [[Module:ShipCard]] uses the <code><nowiki>:getContent()</nowiki></code> [https://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Title_objects Title object method].
* The parameters defined in [[Module:ShipCard]] are [https://www.mediawiki.org/wiki/Help:Templates#Anonymous_parameters anonymous], so using a URL link with a [https://www.ibm.com/docs/en/cics-ts/6.1?topic=concepts-components-url <code>?--query-string</code>] containing <code>name=value</code> pairs will be treated as a [https://www.mediawiki.org/wiki/Help:Templates#Named_parameters named parameter]. This results in an expected link not showing up because the name-value pair in the query string is treated as an undefined parameter by the module.
== See also ==
* [[:Category:Skin Backgrounds]]
* [[Template:ShipIcon]]
* [[Template:EquipIcon]]