Difference between revisions of "Template:Artifact/Documentation"
WardPhoenix (talk | contribs) (documenting top parameter) |
WardPhoenix (talk | contribs) m |
||
Line 15: | Line 15: | ||
; {{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. | ; {{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.)'' | :: ''('''Note''': Setting {{para|monster}} will categorize the article into the [[:Category:Monsters' Artifacts|Monsters' Artifacts]] category.)'' | ||
− | |||
− | |||
===Activatable parameters=== | ===Activatable parameters=== | ||
Line 96: | Line 94: | ||
===Template functionality=== | ===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. | ||
+ | |||
+ | ; {{para|top|<var>no</var>}} : ''Optional'' — Set to <code>no</code> to disable the automatic placement of the {{tlx|Top}} template on the article. | ||
==Example of Use== | ==Example of Use== |
Revision as of 14:45, 5 December 2019
As well as automatically categorizing an article into Category:Artifacts, this template supplies some standard information about the subject of the article. For details on how to create an artifact article, refers to the Creators Manual and the Guideline: Artifact Articles.
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 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.
Type Formatted Wikicode Aboveground boss Summon an aboveground Boss monster Summon an [[Boss-monsters#Aboveground_Boss-Monsters|aboveground Boss monster]]
Underground boss Start search for an underground Boss monster Start search for an [[Boss-monsters#Underground_Boss-Monsters|underground Boss monster]]
Teleport to random town Teleport to a random Town Teleport to a random [[Town]]
Teleport to the Arena Send to the Arena Send to the [[Arena]]
Mini-quest Send on a Mini-quest Send on a [[Mini-quest]]
Bold items into Golden bricks Transform bold items into Golden bricks Transform bold items into [[Golden bricks]]
Fuse 3000 gold or kill monster Fuse 3000 coins into a Golden brick or kill a monster Fuse 3000 coins into a [[Golden brick]] or kill a monster
Artifacts gift Grant some Artifacts Grant some [[Artifacts]]
Black Boxes Affect in a good or a bad way (Black boxes) Affect in a good or a bad way ([[Black boxes]])
Heal Fully restore heroine's Health Fully restore {{hero or heroine}}'s [[Health]]
Aura Grant an Aura Grant an [[Aura]]
Hammer of realignment (Unique so far) Accentuate the heroine's personality Accentuate the {{hero or heroine}}'s [[personality]]
Restore GP Restore 50% of Godpower Restore 50% of [[Godpower]]
Add accumulator charge Add an Accumulator charge Add an [[Accumulator]] charge
Random friends Add a random God to your Friends List Add a random God to your [[Friends]] List
Invite to Godville (Unique so far) Add an Invite to your Friends List Add an Invite to your [[Friends]] List
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.
|top=no
- Optional — Set to
no
to disable the automatic placement of the{{Top}}
template on the article.
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. --> | caption = <!-- A caption to display below the image. --> | type = <!-- Set to one of: Normal, Bold, Healing, or Activatable. Will show "Unknown" if not set --> | description = <!-- A short description of the artifact. --> | 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 | caption = Example | type = Normal | description = A completely everyday and normal item. | value = 55 | monster = Generic Enemy }}
Artifact/Documentation | |
---|---|
| |
Type | ⚙️Activatable |
Description | Can be activated |
Activation | |
Cost | 50% of godpower |
Effect | Something good or bad |
{{artifact | image = Example.jpg | caption = Example | type = Activatable | description = Can be activated | cost = 50 | effect = Something good or bad }}