Difference between revisions of "Template:Infobox item/doc"

From Underrail Wiki
Jump to navigation Jump to search
m (added itemquality parameter)
(updated documentation)
Line 1: Line 1:
−
==Description==
+
== Description ==
−
This is the generic item infobox template. It can be used for all items, but some item types also have their own infoboxes.
+
This is the infobox template for all items.
  
−
'''NOTE''': [[Template:Infobox item|generic items]], [[Template:Infobox armor|armor]], [[Template:Infobox blueprint|blueprints]], [[Template:Infobox component|components]] and [[Template:Infobox weapon|weapons]] all have their own infobox templates!
+
; Aliases
 +
* [[Template:Infobox ammo]]
 +
* [[Template:Infobox armor]]
 +
* [[Template:Infobox blueprint]]
 +
* [[Template:Infobox component]]
 +
* [[Template:Infobox weapon]]
  
−
==Syntax==
+
== Syntax ==
−
To use this template, copy the following code, fill in the appropriate fields and remove the rest.
+
To use this template, copy the following code, fill in the appropriate fields and remove all the rest.
−
<pre>
+
<pre class="mw-collapsible">
−
{{infobox item
+
{{item infobox
 
| example      = [marks the infobox as example. remove this line if stats are exact]
 
| example      = [marks the infobox as example. remove this line if stats are exact]
 
| image        = [leave this field empty if there's no image yet]
 
| image        = [leave this field empty if there's no image yet]
−
| itemquality  = [accepted values: low, normal, high, rarity, artifact. defaults to normal if omitted]
+
| itemquality  = [accepted values: low, normal, high, rarity, artifact.]
−
| name          =
+
| name          =  
−
| type          =  
+
| type          = [item type (special exception on bullets)]
 
| description  =  
 
| description  =  
−
| whitestats    = [optional, energy capacity and other stats written in white]
+
| whitestats    = [any stats written in white that the infobox doesn't cover]
−
| greenstats    = [optional, uses and other stats written in green]
+
| greenstats    = [uses, equip effects and other stats written in green]
−
| whitestats2  = [optional, any stats written in white, below the green section]
+
| energy        =
−
| value        =  
+
| whitestats2  = [any stats written in white, below the green section]
 +
| value        = [base trading value, NOT value affected by trading multiplier]
 +
|
 +
|ammo attributes:
 +
| caliber      = eg. "7.62mm"
 +
| type          = Standard, JHP or W2C
 +
|
 +
|armor attributes:
 +
| resistances  = [multiple lines, each intended with ":"]
 +
| encumbrance  =
 +
| minstr        =
 +
|
 +
|blueprint attributes:
 +
| description2  = [description on the crafting recipe]
 +
| component1    = [mandatory first component]
 +
| component2    =
 +
| component3    =
 +
| component4    =
 +
| optional1    =
 +
| diffmod1      =
 +
| optional2    =
 +
| diffmod2      =
 +
| optional3    =
 +
| diffmod3      =
 +
|
 +
|component attributes:
 +
| quality      =
 +
| skillsreq    = [multiple lines, intended with ":"]
 +
|
 +
|weapon attributes:
 +
| damage        =
 +
| impactspeed  = [accepted values: Very Low, Low, Medium, High, Very High]
 +
| ap            =
 +
| range        =
 +
| precision    =
 +
| burstprec.    =
 +
| cqprec.      =
 +
| moveprec.    =
 +
| critchance    =
 +
| minstr        =
 +
| minskill      =
 +
| ammotype      =
 +
| magcap        =
 +
| energy/shot  =
 +
| energy        =  
 
}}
 
}}
 
</pre>
 
</pre>
  
−
==Samples==
+
== Samples ==
−
<pre>
+
Please see the source code.
 +
{{infobox blueprint
 +
| itemquality  = high
 +
| name          = Blueprint: Sniper Rifle
 +
| description  = Contain instructions on how to create a sniper rifle.
 +
| value        = 2000
 +
| description2  = Sniper rifles can be created from frame, barrel and scope parts. The type and quality of the frame will determine the rifle's overall damage potential, while the barrel will dictate the payload. Scope will influence the rifle's precision, critical hit chance and other qualities.
 +
 
 +
 
 +
A number of optional components can also be added to further enhance the weapon.
 +
| component1    = Frame
 +
| component2    = Barrel
 +
| component3    = Scope
 +
| optional1    = Sniper Rifle Enhancement
 +
| diffmod1      = 15%
 +
| optional2    = Sniper Rifle Enhancement
 +
| diffmod2      = 15%
 +
}}
 +
 
 +
{{clear}}
 +
 
 +
{{infobox blueprint
 +
| itemquality  = high
 +
| name          = Blueprint: Health Hypo
 +
| description  = Contains instructions on how to create a health hypo.
 +
| value        = 800
 +
| description2  = Health Hypo can be created by mixing healthy animal blood with insectoid saliva and preserving the mixture with anticoagulant.
 +
| component1    = Blood (x3)
 +
| component2    = Insectoid Saliva
 +
| component3    = Anticoagulant
 +
| component4    = Syringe (x2)
 +
}}
 +
 
 +
{{clear}}
 +
 
 
{{infobox item
 
{{infobox item
 
| image        = items_medicine_health_hypo.png
 
| image        = items_medicine_health_hypo.png
Line 29: Line 112:
 
| type          = Medicine
 
| type          = Medicine
 
| description  = A hypo filled with blood and enzymes that catalyze rapid regenerative process. Double check your blood type before use.
 
| description  = A hypo filled with blood and enzymes that catalyze rapid regenerative process. Double check your blood type before use.
−
| greenstats    = Use: Instantly restores 80 health points.
+
| greenstats    = Use: Instantly restores 80 health points.<br>(AP: 10, Cooldown: 6 turns)
−
(AP: 10, Cooldown: 6 turns)
 
 
| value        = 120
 
| value        = 120
 
}}
 
}}
−
</pre>
 
  
−
Results in...
+
{{clear}}
 +
 
 +
{{infobox weapon
 +
| image        = Crowbar icon.png
 +
| itemquality  = normal
 +
| name          = Steel Crowbar
 +
| type          = Melee Weapon
 +
| description  = This handy tool can also be used as a weapon in a pinch.
 +
| damage        = 5-13 (Mechanical)
 +
| impactspeed  = Very Low
 +
| ap            = 18 AP
 +
| range        = Melee
 +
| critchance    = 10%
 +
| greenstats    = Damage increased by 3% for every point in strength above 6.
 +
 
 +
Use: Forces open a ventilation shaft. It won't be able to close afterwards.<br>(AP: 15)
 +
| value        = 50
 +
}}
 +
 
 +
{{clear}}
 +
 
 +
{{Infobox ammo
 +
| caliber = 9mm
 +
| type    = JHP
 +
| value  = 18
 +
}}
 +
 
 +
{{clear}}
 +
 
 +
{{infobox armor
 +
| example      = yes
 +
| image        = steel armor.png
 +
| itemquality  = normal
 +
| name          = Galvanic Steel Armor
 +
| type          = Armor Suit
 +
| description  = This is a suit of steel armor. Below the protective plates is a vest that provides moderate protection against electrical attacks.
 +
| resistances  =
 +
:Mechanical: 51% / 15
 +
:{{color|orangered|Heat: 5}}
 +
:{{color|yellow|Electricity: 16% / 3}}
 +
:{{color|green|Acid: 5}}
 +
:{{color|aqua|Energy: 38% / 10}}
 +
| encumbrance  = 70%
 +
| minstr        = 8
 +
| durability    = 505 / 505 (mechanical)
 +
| value        = 10758
 +
}}
 +
 
 +
{{clear}}
 +
 
 +
{{infobox component
 +
| example      = [marks the infobox as example. remove this line if stats are exact]
 +
| image        = items_components_leather3.png
 +
| itemquality  = high
 +
| name          = Mutated Dog Leather
 +
| description  = This skin can be turned into an acid resistant leather armor.
 +
| quality      = 62
 +
| skillsreq    =
 +
:Tailoring 62
 +
:Chemistry 18
 +
| value        = 1500
 +
}}
 +
 
 +
{{clear}}
  
 
{{infobox item
 
{{infobox item
−
| image        = items_medicine_health_hypo.png
+
| image        = keycard_blue.png
 
| itemquality  = normal
 
| itemquality  = normal
−
| name          = Health Hypo
+
| name          = Private Quarters Key Card
−
| type          = Medicine
+
| type          = Key
−
| description  = A hypo filled with blood and enzymes that catalyze rapid regenerative process. Double check your blood type before use.
+
| description  = Unlocks your private quarters.
−
| greenstats    = Use: Instantly restores 80 health points.
 
−
(AP: 10, Cooldown: 6 turns)
 
−
| value        = 120
 
 
}}
 
}}
 
<includeonly>[[Category:Infobox templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
 
<includeonly>[[Category:Infobox templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Revision as of 17:05, 15 August 2013

Description

This is the infobox template for all items.

Aliases

Syntax

To use this template, copy the following code, fill in the appropriate fields and remove all the rest. 

{{item infobox
| example       = [marks the infobox as example. remove this line if stats are exact]
| image         = [leave this field empty if there's no image yet]
| itemquality   = [accepted values: low, normal, high, rarity, artifact.]
| name          = 
| type          = [item type (special exception on bullets)]
| description   = 
| whitestats    = [any stats written in white that the infobox doesn't cover]
| greenstats    = [uses, equip effects and other stats written in green]
| energy        = 
| whitestats2   = [any stats written in white, below the green section]
| value         = [base trading value, NOT value affected by trading multiplier]
|
|ammo attributes:
| caliber       = eg. "7.62mm"
| type          = Standard, JHP or W2C
|
|armor attributes:
| resistances   = [multiple lines, each intended with ":"]
| encumbrance   = 
| minstr        =
|
|blueprint attributes:
| description2  = [description on the crafting recipe]
| component1    = [mandatory first component]
| component2    = 
| component3    = 
| component4    = 
| optional1     = 
| diffmod1      = 
| optional2     = 
| diffmod2      = 
| optional3     = 
| diffmod3      = 
|
|component attributes:
| quality       = 
| skillsreq     = [multiple lines, intended with ":"]
|
|weapon attributes:
| damage        = 
| impactspeed   = [accepted values: Very Low, Low, Medium, High, Very High]
| ap            = 
| range         = 
| precision     = 
| burstprec.    = 
| cqprec.       = 
| moveprec.     = 
| critchance    = 
| minstr        = 
| minskill      = 
| ammotype      = 
| magcap        = 
| energy/shot   = 
| energy        = 
}}

Samples

Please see the source code.

Misc icon.png
Blueprint: Sniper Rifle
{{{type}}}
Contain instructions on how to create a sniper rifle.
Value: 2000
Sniper rifles can be created from frame, barrel and scope parts. The type and quality of the frame will determine the rifle's overall damage potential, while the barrel will dictate the payload. Scope will influence the rifle's precision, critical hit chance and other qualities.


A number of optional components can also be added to further enhance the weapon.

Frame Barrel Scope
Sniper Rifle Enhancement
Optional.
Using this slot will increase the total skill requirements by 15% of the occupying item's requirements.
 Sniper Rifle Enhancement
Optional.
Using this slot will increase the total skill requirements by 15% of the occupying item's requirements.
Misc icon.png
Blueprint: Health Hypo
{{{type}}}
Contains instructions on how to create a health hypo.
Value: 800
Health Hypo can be created by mixing healthy animal blood with insectoid saliva and preserving the mixture with anticoagulant.
Blood (x3) Insectoid Saliva
Anticoagulant Syringe (x2)
Health Hypo.png
Health Hypo
Medicine
A hypo filled with blood and enzymes that catalyze rapid regenerative process. Double check your blood type before use.
Value: 120
Steel Crowbar.png
Steel Crowbar
Melee Weapon
This handy tool can also be used as a weapon in a pinch.
Damage: 5-13 (Mechanical)
Impact speed: Very Low
Base action points: 18 AP
Range: Melee
Critical chance: 10%
Value: 50
Misc icon.png
{{{name}}}
JHP
{{{description}}}
Value: 18
Steel Armor.png
Galvanic Steel Armor
Armor Suit
This is a suit of steel armor. Below the protective plates is a vest that provides moderate protection against electrical attacks.
Resistances:
Minimal strength: 8
Armor penalty: 70%
Durability: 505 / 505 (mechanical)
Value: 10758
Mutated Dog Leather.png
Mutated Dog Leather
{{{type}}}
This skin can be turned into an acid resistant leather armor.
Quality: 62 ?
Required crafting skills:
Tailoring 62
Chemistry 18
Value: 1500
Keycard blue.png
Private Quarters Key Card
Key
Unlocks your private quarters.
Cannot be sold.
Retrieved from "https://www.stygiansoftware.com/wiki/index.php?title=Template:Infobox_item/doc&oldid=3948"