Difference between revisions of "Template:Artifact/Documentation"

From GodWiki
Jump to navigation Jump to search
(Document |effect= field, add to example for activatable artifacts)
m (Add WardPhoenix's table of activation effect strings to parameter docs)
Line 16: Line 16:
 
:: ''('''Note''': Setting {{para|monster}} will categorize the article into the [[:Category:Monsters' Artifacts|Monsters' Artifacts]] category.)''
 
:: ''('''Note''': Setting {{para|monster}} will categorize the article into the [[:Category:Monsters' Artifacts|Monsters' Artifacts]] category.)''
  
===Activatable Artifact parameters===
+
===Activatable parameters===
 
For artifacts of {{para|type|activatable}}, the following additional parameters can be set:
 
For artifacts of {{para|type|activatable}}, the following additional parameters can be set:
 
;{{para|cost|<var>godpower</var>}}: ''Optional'' – Indicates the activation cost. Possible values are:
 
;{{para|cost|<var>godpower</var>}}: ''Optional'' – Indicates the activation cost. Possible values are:
Line 22: Line 22:
 
::{{para|cost|50}} – Requires 50% of godpower to activate (can also be: <code>50%</code>)
 
::{{para|cost|50}} – Requires 50% of godpower to activate (can also be: <code>50%</code>)
  
;{{para|effect|<var>Activation effect</var>}}: ''Optional'' – A brief description of the artifact's effect when activated. Free-form text field.
+
;{{para|effect|<var>Activation effect</var>}}: ''Optional'' – A brief description of the artifact's effect when activated. Free-form text field, preferably one of the entries on the following table.
 +
: {|class="wikitable"
 +
|-
 +
! Wikicode !! Formatted
 +
|-
 +
| <code><nowiki>Teleport to a random [[Town]]</nowiki></code>
 +
| Teleport to a random [[Town]]
 +
|-
 +
| <code><nowiki>Sends to the [[Arena]]</nowiki></code>
 +
| Sends to the [[Arena]]
 +
|-
 +
| <code><nowiki>Transform bold items into [[Golden bricks]]</nowiki></code>
 +
| Transform bold items into [[Golden bricks]]
 +
|-
 +
| <code><nowiki>Fuse 3000 coins into a [[Golden brick]] or kill a monster</nowiki></code>
 +
| Fuse 3000 coins into a [[Golden brick]] or kill a monster
 +
|-
 +
| <code><nowiki>Fully restore {{hero or heroine}}'s [[Health]]</nowiki></code>
 +
| Fully restore {{hero or heroine}}'s [[Health]]
 +
|-
 +
| <code><nowiki>Grants some [[Artifacts]]</nowiki></code>
 +
| Grants some [[Artifacts]]
 +
|-
 +
| <code><nowiki>Grants an [[Aura]]</nowiki></code>
 +
| Grants an [[Aura]]
 +
|-
 +
| <code><nowiki>Summons an aboveground [[Boss monster]]</nowiki></code>
 +
| Summons an aboveground [[Boss monster]]
 +
|-
 +
| <code><nowiki>Starts search for an underground [[Boss monster]]</nowiki></code>
 +
| Starts search for an underground [[Boss monster]]
 +
|-
 +
| <code><nowiki>Affect in a good or a bad way ([[Black boxes]])</nowiki></code>
 +
| Affect in a good or a bad way ([[Black boxes]])
 +
|-
 +
| <code><nowiki>Accentuate the {{hero or heroine}}'s [[personality]]</nowiki></code>
 +
| Accentuate the {{hero or heroine}}'s [[personality]]
 +
|-
 +
| <code><nowiki>Adds an [[Accumulator]] charge</nowiki></code>
 +
| Adds an [[Accumulator]] charge
 +
|}
  
 
===Template functionality===
 
===Template functionality===

Revision as of 18:40, 5 April 2019

As well as automatically categorizing an article into Category:Artifacts, this template supplies some standard information about the subject of the article.

Parameters

|image=filename
Optional but preferred — The full image file name.
If an image is not supplied, a placeholder will be used, and by default the template will place the {{picture}} hatnote before the infobox. Disable this if necessary with |ignore-no-image=yes (see below).
|caption=Image description
Optional — Use only if |image= is also set. Text of a descriptive caption to display beneath the image.
|type=Normal,Bold,Healing,Activatable
Required — The type of the item. (Default: Unknown)
(Note: Setting |type= to Bold, Healing, or Activatable will also categorize the article into the Bold Artifacts, Healing Artifacts, or Activatable Artifacts category, respectively.)
|description=
Required — A brief description of the item. (Default: Unknown)
|value=
Optional — The average amount in gold coins this item can be sold for.
|monster=Monster Name
Optional — Only include if the artifact actually has its own associated monster. Will automatically link to the Godwiki article for that monster.
(Note: Setting |monster= will categorize the article into the Monsters' Artifacts category.)

Activatable parameters

For artifacts of |type=activatable, the following additional parameters can be set:

|cost=godpower
Optional – Indicates the activation cost. Possible values are:
|cost=0 – Requires no godpower to activate (can also be: free,none,0%)
|cost=50 – Requires 50% of godpower to activate (can also be: 50%)
|effect=Activation effect
Optional – A brief description of the artifact's effect when activated. Free-form text field, preferably one of the entries on the following table.
Wikicode Formatted
Teleport to a random [[Town]] Teleport to a random Town
Sends to the [[Arena]] Sends to the Arena
Transform bold items into [[Golden bricks]] Transform bold items into Golden bricks
Fuse 3000 coins into a [[Golden brick]] or kill a monster Fuse 3000 coins into a Golden brick or kill a monster
Fully restore {{hero or heroine}}'s [[Health]] Fully restore hero's Health
Grants some [[Artifacts]] Grants some Artifacts
Grants an [[Aura]] Grants an Aura
Summons an aboveground [[Boss monster]] Summons an aboveground Boss monster
Starts search for an underground [[Boss monster]] Starts search for an underground Boss monster
Affect in a good or a bad way ([[Black boxes]]) Affect in a good or a bad way (Black boxes)
Accentuate the {{hero or heroine}}'s [[personality]] Accentuate the hero's personality
Adds an [[Accumulator]] charge Adds an Accumulator charge

Template functionality

|ignore-no-image=yes
Optional — Set to yes (or any similar positive-state value) to disable the automatic placement of {{Picture}} above the infobox.

Example of Use

Quick blank template:

{{artifact
| image = <!-- An image filename (e.g. Example_picture_name.jpg). If the filename doesn't exist, this gives you a link to upload it. -->
| type = <!-- Set to one of: Normal, Bold, Healing, or Activatable. Will show "Unknown" if not set -->
| description = 
| value = <!-- Average selling value -->
| monster = <!-- If this is only found on a specific monster, list it here -->
}}
Artifacts of Godville
Artifact/Documentation
Example.jpg
Type 🧷Normal
Value 55
Associated Monster Generic Enemy
Description A completely everyday and normal item.
{{artifact
| image = Example.jpg
| type = Normal
| description = A completely everyday and normal item.
| value = 55
| monster = Generic Enemy
}}
Artifacts of Godville
Artifact/Documentation
Example.jpg
Type ⚙️Activatable
Description Unknown
Activation
Cost 50% of godpower
Effect Something good or bad
{{Artifact
|image = Example.jpg
|caption=
|type = Activatable 
|cost = 50
|effect = Something good or bad
|description = 
}}