Difference between revisions of "Template:Status effect/doc"

From Wildermyth Wiki
m (Remove spurious ))
(Add technical details)
 
Line 1: Line 1:
<includeonly>: ''This documentation is transcluded from [[Template:Status effect/doc]]''</includeonly><!--
<includeonly>: ''This documentation is transcluded from [[Template:Status effect/doc]]''</includeonly><!--
--><noinclude><div class="messagebox" style="padding-left:1ex;">'''This is a documentation subpage for [[Template:Status effect]].'''</div></noinclude><!--
--><noinclude><div class="messagebox" style="padding-left:1ex;">'''This is a documentation subpage for [[Template:Status effect]].'''</div></noinclude>
-->
This template is used by the game data process to help keep pages up-to-date. It should not need to be called manually.
 
== Usage ==
== Usage ==


This template displays a stylized reference to a status effect. (Hero) status effects are also categorized, although monster status effects aren't.
This template displays a stylized reference to a status effect. Hero status effects are also auto-categorized, although monster status effects aren't.


The Infobox uses the following parameters:
The template uses the following parameters:


; ''1'' : a word associated with a status effect
; ''word'' : a word (e.g., hobble, hobbles, hobbled, hobbling) associated with a status effect. The word can be capitalized.
 
; ''pagename'' : The (sub)pagename (e.g., Bear Hug) of the ability that applies the status effect. The status effect will only be categorized on that (sub)page.


== Example ==
== Example ==


<pre><nowiki>Hero grabs an enemy, dealing damage and {{Status effect|stunning}} them.</nowiki></pre>
<pre><nowiki>Hero grabs an enemy, dealing damage and {{Status effect|word=stunning|pagename=Bear Hug}} them.</nowiki></pre>
 
Hero grabs an enemy, dealing damage and {{Status effect|word=stunning|pagename=Bear Hug}} them.
 
== Technical details ==
 
{{See also|Template:Data description}}
 
Description (.blurb) data comes from Wildermyth's<code>.properties</code> files. For example, <code>assets/text/effects/bear/bearHug.properties</code> includes the following lines:
.blurb=<self> grabs an enemy, dealing damage and [:statusEffect.senseless]stunning[] them.
.name=Bear Hug
 
The <code>[:statusEffect.senseless]stunning[]</code> markup stylizes the word '''stunning''' for the UI's action tooltips, and character sheet. On the wiki, the stylized text is also linked (to the appropriate status effect page), and possibly categorized (only if the text appears on the [[Beartouched/Bear Hug|Bear Hug]] page).
 
=== Unrecognized words ===
 
If the developers add a new status effect to the game (or a new associated word for an existing status effect), the associated word(s) (and any new status effect category) would need to be added to this template.
 
<pre><nowiki>Victor {{Status effect|word=hides|pagename=Hidden}}</nowiki> from the monster.</pre>
 
Victor {{Status effect|word=hides|pagename=Hidden}} from the monster.
 
<pre><nowiki>Cipolla {{Status effect|word=hypnotizes|pagename=Hypnotized}} the waiter.</nowiki></pre>


Hero grabs an enemy, dealing damage and {{Status effect|stunning}} them.
Cipolla {{Status effect|word=hypnotizes|pagename=Hypnotized}} the waiter.


__NOTOC__
<includeonly>[[Category:Template]]</includeonly>
<includeonly>[[Category:Template]]</includeonly>

Latest revision as of 12:56, 21 January 2022

This is a documentation subpage for Template:Status effect.

This template is used by the game data process to help keep pages up-to-date. It should not need to be called manually.

Usage

This template displays a stylized reference to a status effect. Hero status effects are also auto-categorized, although monster status effects aren't.

The template uses the following parameters:

word
a word (e.g., hobble, hobbles, hobbled, hobbling) associated with a status effect. The word can be capitalized.
pagename
The (sub)pagename (e.g., Bear Hug) of the ability that applies the status effect. The status effect will only be categorized on that (sub)page.

Example

Hero grabs an enemy, dealing damage and {{Status effect|word=stunning|pagename=Bear Hug}} them.

Hero grabs an enemy, dealing damage and stunning them.

Technical details

Description (.blurb) data comes from Wildermyth's.properties files. For example, assets/text/effects/bear/bearHug.properties includes the following lines:

.blurb=<self> grabs an enemy, dealing damage and [:statusEffect.senseless]stunning[] them.
.name=Bear Hug

The [:statusEffect.senseless]stunning[] markup stylizes the word stunning for the UI's action tooltips, and character sheet. On the wiki, the stylized text is also linked (to the appropriate status effect page), and possibly categorized (only if the text appears on the Bear Hug page).

Unrecognized words

If the developers add a new status effect to the game (or a new associated word for an existing status effect), the associated word(s) (and any new status effect category) would need to be added to this template.

Victor {{Status effect|word=hides|pagename=Hidden}} from the monster.

Victor (unrecognized word “hides” for Template:Status effect) from the monster.

Cipolla {{Status effect|word=hypnotizes|pagename=Hypnotized}} the waiter.

Cipolla (unrecognized word “hypnotizes” for Template:Status effect) the waiter.