FeralKitty: Created page with ": ''This documentation is transcluded from Template:Data description/doc''
'..."

2022-01-21T20:31:12Z

Created page with "<includeonly>: ''This documentation is transcluded from Template:Data description/doc''</includeonly><noinclude><div class="messagebox" style="padding-left:1ex;">'..."

New page

<includeonly>: ''This documentation is transcluded from [[Template:Data description/doc]]''</includeonly><noinclude><div class="messagebox" style="padding-left:1ex;">'''This is a documentation subpage for [[Template:Data description]].'''</div></noinclude>
{{See also|Template:Tooltip ability}}

This template is used by the game data process to help automatically keep pages up-to-date.

'''Warning: Manually editing this template data may cause your changes to be overwritten or lost if the template is automatically updated.''' If specific game data is missing from this template, please ask about it on the Discord #wiki channel (to arrange for its data to automatically be added to these templates).

== Usage ==

This template returns a description for a specific [[Status Effect|status effect]], [[theme]], theme piece, theme upgrade, or theme ability. A future update will add hero abilities.

The template uses the following parameter:

; ''1'' : The name associated with the specific description.

== Examples ==
{{See also|Template:Quote}}

=== Theme descriptions ===

<pre><nowiki>{{Quote|{{Data description|Drauven Wings (theme)}}}}</nowiki></pre>

{{Quote|{{Data description|Drauven Wings (theme)}}}}

''Theme names are followed by (theme), to unambiguously distinguish them from any identically named theme pieces. E.g., in the game, "Drauven Wings" is both a theme, and a theme piece.''

=== Theme piece descriptions ===

<pre><nowiki>{{Quote|{{Data description|Fire Chicken (theme piece)}}}}</nowiki></pre>

{{Quote|{{Data description|Fire Chicken (theme piece)}}}}

''Theme piece names are followed by (theme piece), to unambiguously distinguish them from any identically named theme abilities. E.g., in the game, "Fire Chicken" is both a theme piece, and a theme ability.''

=== Theme upgrade descriptions ===

<pre><nowiki>{{Quote|{{Data description|Crow Scratch+ (theme upgrade)}}}}</nowiki></pre>

{{Quote|{{Data description|Crow Scratch+ (theme upgrade)}}}}

''Theme upgrade names are followed by (theme upgrade), to unambiguously distinguish them from any identically named theme abilities. E.g., in the game, "Crow Scratch+" is both a theme upgrade, and a theme ability.''

=== Theme ability descriptions ===

<pre><nowiki>{{Quote|{{Data description|Bear Hug}}}}</nowiki></pre>

{{Quote|{{Data description|Bear Hug}}}}

''Theme ability names are not followed by any disambiguation.''

=== Hero ability descriptions (to be added) ===

<pre><nowiki>{{Quote|{{Data description|Flashcone}}}}</nowiki></pre>

{{Quote|{{Data description|Flashcone}}}} (No description is returned, as this hero ability data has not been added yet to the template.)

''Hero ability names are (also) not followed by any disambiguation.''

== 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

=== Name conflicts ===

Internally, the game uses aspects (e.g., theme_drauvenWings, themePiece_petFireChicken_fireChicken, theme_crow_upgrade) to uniquely distinguish between identically named descriptions.

To avoid how tedious it would be to lookup these aspects to retrieve a particular description, the more familiar name is used.

{| class="wikitable"
! Name !! Description
|-
| {{Data description|Drauven Wings (theme)}} || {{Data description|Drauven Wings (theme)}}
|-
| {{Data description|Drauven Wings (theme piece)}} || {{Data description|Drauven Wings (theme piece)}}
|-
| {{Data description|Fire Chicken (theme piece)}} || {{Data description|Fire Chicken (theme piece)}}
|-
| {{Data description|Fire Chicken}} || {{Data description|Fire Chicken}}
|-
| {{Data description|Crow Scratch+ (theme upgrade)}} || {{Data description|Crow Scratch+ (theme upgrade)}}
|-
| {{Data description|Crow Scratch+}} || {{Data description|Crow Scratch+}}
|}

Theme-related descriptions were the only present name conflict.

If monster abilities are added to the game data templates, a (monster ability) suffix would be needed to avoid some monster ability conflicts (e.g., Guardian) with the identically named hero ability.

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

Template:Data description/doc - Revision history

FeralKitty: Created page with ": ''This documentation is transcluded from Template:Data description/doc'''..."

FeralKitty: Created page with ": ''This documentation is transcluded from Template:Data description/doc''
'..."