Difference between revisions of "Template:Skill extended infobox/doc"

← Older edit

Template:Skill extended infobox/doc (view source)

Revision as of 16:27, 28 November 2020

397 bytes added , 16:27, 28 November 2020

no edit summary

SurtrFan8511

trusted

5,894

edits

@@ Line 1: / Line 1: @@
 == Description ==
-This templates creates a formatted string using the skill information as well as a skill subobject using the following properties:
+This templates creates a formatted infobox using the skill information as well as a skill subobject.
-* Has game context
+==Usage==
-* Has Japanese name
-* Has English name
-* Has Japanese-English name
-* Has lowercase English name
-* Has Japanese description
-* Has English description
-* Has skill trigger timing
-* Has skill proc chance
-* Has preformatted English description
-* Has raw English description
-* Has evolved skill
-* Has precursor skill
-* Has additional skills
-== Usage ==
+Just like many other major templates, this one uses the masterdata extension. To invoke the template, simply write <pre>{{#masterdata:Skill|<id>|format=<format>}}</pre>
-<pre>{{Skill infobox
-| jp name =
-| en name =
-| jp-en name =
-| jp trigger timing =
-| jp description =
-| en description =
-| proc chance =
-}}</pre>
-=== Parameters ===
+Where <id> is ID of the skill, <format> is infobox format. These include:
+* '''wiki''' - the default one. Translates skill descriptions, lists transients that use the skill and adds a guide template at the bottom.
-; jp name : Japanese name.
+* others - ???
-; en name : English name.
-; jp-en name: Translated English name.
-; jp trigger timing : Activation method in Japanese without parentheses.
-; jp description : Skill description in Japanese.
-; en description : Translated English skill description.
-; proc chance : The skill's chance to activate at skill level 1 in percent.
-; evolution : The skill's evolution
-; precursor : The skill's pre-evolution (base)
-== Examples ==
+To see preparsed version of the template, go to <code>https://api.housamo.xyz/housamo/api/parse/skill/?skill_id=<id></code>, where <id> is ID of the skill.
-<!--
+The template can be interacted with using variables.
-<pre>{{Skill infobox
-| jp name = 獣の末裔
+===Variables===
-| en name = Beast Descendant
-| jp trigger timing = 移動後
+All of the variables below apply to the wiki format. Their effect on other formats is unknown.
-| jp description = 自身に頑強付与
-| en description = Apply {{Status effect|頑強}} to Self
+Variables that can be commonly encountered on skill pages:
-| proc chance = 50
-}}
+* '''skill en name''' - English translation of the skill name. English names get automatically updated to official ones if translations are found in the game files.
-</pre>
+* '''skill evolution''' - ID of an evolved version of the skill. Multiple IDs should be separated with a semicolon.
-{{Skill infobox
+* '''hide guide''' - set to ''true'' to hide the [[Template:Guide|guide]] from appearing. This is useful when invoking multiple skill infoboxes on one page.
-| jp name = 獣の末裔
-| en name = Beast Descendant
+Variables used by other templates:
-| jp trigger timing = 移動後
-| jp description = 自身に頑強付与
+* '''hide transient skill list''' - set to ''true'' to hide the [[Template:Transient list|transient list]] from appearing.
-| en description = Apply {{Status effect|頑強}} to Self
+* '''ar skill page'''/'''charge skill page''' - set these variables to anything to indicate the type of a skill. This is useful for queries and stuff.
-| proc chance = 50
-}}
+==Examples==
--->
+<pre>{{#vardefine:skill en name|Example translation}}
+{{#vardefine:hide guide|true}}
+{{#vardefine:skill evolution|2020}}
+{{#masterdata:Skill|1000|format=wiki}}</pre>
+{{#vardefine:skill en name|Example translation}}
+{{#vardefine:hide guide|true}}
+{{#vardefine:skill evolution|2020}}
+{{#masterdata:Skill|1000|format=wiki}}
 [[Category:Infobox templates]] [[Category:Subobject templates]]