Difference between revisions of "Template:Artifact/Documentation"

From GodWiki
Jump to navigation Jump to search
m (Add WardPhoenix's table of activation effect strings to parameter docs)
(updated - sentences may needs spell checks, see more on the template talk page.)
Line 27: Line 27:
 
! Wikicode !! Formatted
 
! Wikicode !! Formatted
 
|-
 
|-
| <code><nowiki>Teleport to a random [[Town]]</nowiki></code>
+
| Aboveground boss
 +
| Summons an [[Boss-monsters#Aboveground_Boss-Monsters|aboveground Boss monster]]
 +
|-
 +
| Underground boss
 +
| Starts 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]]
 
|-
 
|-
| <code><nowiki>Sends to the [[Arena]]</nowiki></code>
+
| Teleport to the Arena
 
| Sends to the [[Arena]]
 
| Sends to the [[Arena]]
 
|-
 
|-
| <code><nowiki>Transform bold items into [[Golden bricks]]</nowiki></code>
+
| Mini-quest
 +
| Sends on a [[Mini-quest]]
 +
|-
 +
| Bold items into Golden bricks
 
| Transform bold items into [[Golden bricks]]
 
| Transform bold items into [[Golden bricks]]
 
|-
 
|-
| <code><nowiki>Fuse 3000 coins into a [[Golden brick]] or kill a monster</nowiki></code>
+
| 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
 
|-
 
|-
| <code><nowiki>Fully restore {{hero or heroine}}'s [[Health]]</nowiki></code>
+
| Artifacts gift
| Fully restore {{hero or heroine}}'s [[Health]]
+
| Grants some [[Artifacts]]
 +
|-
 +
| Black Boxes
 +
| Affect in a good or a bad way ([[Black boxes]])
 
|-
 
|-
| <code><nowiki>Grants some [[Artifacts]]</nowiki></code>
+
| Heal
| Grants some [[Artifacts]]
+
| Fully restores {{hero or heroine}}'s [[Health]]
 
|-
 
|-
| <code><nowiki>Grants an [[Aura]]</nowiki></code>
+
| Aura
 
| Grants an [[Aura]]
 
| Grants an [[Aura]]
 
|-
 
|-
| <code><nowiki>Summons an aboveground [[Boss monster]]</nowiki></code>
+
| [[Hammer of realignment]] (Unique so far)
| Summons an aboveground [[Boss monster]]
+
| Accentuate the {{hero or heroine}}'s [[personality]]
 
|-
 
|-
| <code><nowiki>Starts search for an underground [[Boss monster]]</nowiki></code>
+
| Restore GP
| Starts search for an underground [[Boss monster]]
+
| Restores 50% of [[Godpower]]
 
|-
 
|-
| <code><nowiki>Affect in a good or a bad way ([[Black boxes]])</nowiki></code>
+
| Add accumulator charge
| Affect in a good or a bad way ([[Black boxes]])
+
| Adds an [[Accumulator]] charge
 
|-
 
|-
| <code><nowiki>Accentuate the {{hero or heroine}}'s [[personality]]</nowiki></code>
+
| Random friends
| Accentuate the {{hero or heroine}}'s [[personality]]
+
| Adds a random God to your [[Friends]] List
 
|-
 
|-
| <code><nowiki>Adds an [[Accumulator]] charge</nowiki></code>
+
| [[Invite to Godville]] (Unique so far)
| Adds an [[Accumulator]] charge
+
| Adds an Invite to your [[Friends]] List
 
|}
 
|}
  

Revision as of 21:12, 7 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
Aboveground boss Summons an aboveground Boss monster
Underground boss Starts search for an underground Boss monster
Teleport to random town Teleport to a random Town
Teleport to the Arena Sends to the Arena
Mini-quest Sends on a Mini-quest
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
Artifacts gift Grants some Artifacts
Black Boxes Affect in a good or a bad way (Black boxes)
Heal Fully restores heroine's Health
Aura Grants an Aura
Hammer of realignment (Unique so far) Accentuate the heroine's personality
Restore GP Restores 50% of Godpower
Add accumulator charge Adds an Accumulator charge
Random friends Adds a random God to your Friends List
Invite to Godville (Unique so far) Adds 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.

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