Difference between revisions of "Template:Artifact/Documentation"
m (Update docs for possible |cost= values) |
(Document |effect= field, add to example for activatable artifacts) |
||
Line 13: | Line 13: | ||
;{{para|value}} : ''Optional'' — The average amount in gold coins this item can be sold for. | ;{{para|value}} : ''Optional'' — The average amount in gold coins this item can be sold for. | ||
− | ;{{para| | + | ; {{para|monster|<var>Monster Name</var>}} : ''Optional'' — Only include if the artifact actually has its own [[Monsters' Artifacts|associated monster]]. Will automatically link to the Godwiki article for that monster. |
+ | :: ''('''Note''': Setting {{para|monster}} will categorize the article into the [[:Category:Monsters' Artifacts|Monsters' Artifacts]] category.)'' | ||
+ | |||
+ | ===Activatable Artifact parameters=== | ||
+ | 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|0}} – Requires no godpower to activate (can also be: <code>free</code>,<code>none</code>,<code>0%</code>) | ::{{para|cost|0}} – Requires no godpower to activate (can also be: <code>free</code>,<code>none</code>,<code>0%</code>) | ||
::{{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| | + | ;{{para|effect|<var>Activation effect</var>}}: ''Optional'' – A brief description of the artifact's effect when activated. Free-form text field. |
− | |||
+ | ===Template functionality=== | ||
; {{para|ignore-no-image|<var>yes</var>}} : ''Optional'' — Set to <code>yes</code> (or any similar positive-state value) to disable the automatic placement of {{tlx|Picture}} above the infobox. | ; {{para|ignore-no-image|<var>yes</var>}} : ''Optional'' — Set to <code>yes</code> (or any similar positive-state value) to disable the automatic placement of {{tlx|Picture}} above the infobox. | ||
Line 52: | Line 57: | ||
|type = Activatable | |type = Activatable | ||
|cost = 50 | |cost = 50 | ||
+ | |effect = Something good or bad | ||
|description = | |description = | ||
}} | }} | ||
Line 59: | Line 65: | ||
|type = Activatable | |type = Activatable | ||
|cost = 50 | |cost = 50 | ||
+ | |effect = Something good or bad | ||
|description = | |description = | ||
}}</nowiki></pre> | }}</nowiki></pre> | ||
{{clear}}<noinclude>[[Category:Templates/Documents|{{PAGENAME}}]]</noinclude> | {{clear}}<noinclude>[[Category:Templates/Documents|{{PAGENAME}}]]</noinclude> |
Revision as of 15:39, 2 April 2019
As well as automatically categorizing an article into Category:Artifacts, this template supplies some standard information about the subject of the article.
Contents
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=
toBold
,Healing
, orActivatable
will also categorize the article into the Bold Artifacts, Healing Artifacts, or Activatable Artifacts category, respectively.)
- (Note: Setting
|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.)
- (Note: Setting
Activatable Artifact 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.
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 --> }}
Artifact/Documentation | |
---|---|
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 }}
Artifact/Documentation | |
---|---|
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 = }}