Template:Data description

From Wildermyth Wiki
Jump to navigation Jump to search
This documentation is transcluded from Template:Data description/doc

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

Theme descriptions

{{Quote|{{Data description|Drauven Wings (theme)}}}}
Looted off a dead Drauven and repurposed.

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

{{Quote|{{Data description|Fire Chicken (theme piece)}}}}
Useful for starting fires?

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

{{Quote|{{Data description|Crow Scratch+ (theme upgrade)}}}}
+1 base damage, scales twice as much with Bonus Damage and Potency. (Current damage increased by x)

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

{{Quote|{{Data description|Bear Hug}}}}
<self> grabs an enemy, dealing damage and stunning them.

Theme ability names are not followed by any disambiguation.

Hero ability descriptions (to be added)

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

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

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.

Name Description
{{Data description|Drauven Wings (theme)}} Looted off a dead Drauven and repurposed.
{{Data description|Drauven Wings (theme piece)}} Fashioned from hide and light wood, with a healthy infusion of magic.
{{Data description|Fire Chicken (theme piece)}} Useful for starting fires?
{{Data description|Fire Chicken}} <name>'s Pet can light a fire on an adjacent tile, once every three turns.
{{Data description|Crow Scratch+ (theme upgrade)}} +1 base damage, scales twice as much with Bonus Damage and Potency. (Current damage increased by x)
{{Data description|Crow Scratch+}} <self> scratches a nearby foe with their monstrous talons, blinding it on stunt.

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.