Difference between revisions of "Template:Item Attributes"

From Mushpedia
Jump to: navigation, search
m
(I think I fixed origin 5?)
 
(45 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<onlyinclude><includeonly>{{#vardefine:
+
<includeonly><onlyinclude>{{#vardefine:
{{{1}}} Name | Unknown Item
+
{{{1}}} Name |
{{{1}}}
+
{{{Name|{{{1|Unknown Item}}}}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
{{{1}}} Icon | Postit.jpg
+
{{{1}}} Icon |
{{{Icon}}}
+
{{{Icon|Postit.jpg}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
{{{1}}} Summary |
+
{{{1}}} In-game Flavor |
{{{Summary}}} | {{Todo|Missing a short summary to be displayed on the Inventory page. Please append it.}}
+
{{{In-game Flavor|}}}
}}{{#vardefine:
+
{{{1}}} In-game Flavor
+
{{{In-game Flavor}}}  | {{Todo|Missing "flavor text" from the in-game item description.}}
+
 
}}{{#vardefine:
 
}}{{#vardefine:
 
{{{1}}} In-game Effects |  
 
{{{1}}} In-game Effects |  
{{{In-game Effects}}} | N/A
+
{{{In-game Effects|}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
 
{{{1}}} In-game Examine Text |
 
{{{1}}} In-game Examine Text |
{{{In-game Examine Text}}} | {{Todo|Missing text seen when examining the item in the game.}}
+
{{{In-game Examine Text|}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
 
{{{1}}} Origin 1 |
 
{{{1}}} Origin 1 |
{{{Origin 1}}}
+
{{{Origin 1|}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
 
{{{1}}} Origin Amount 1 |
 
{{{1}}} Origin Amount 1 |
{{{Origin Amount 1}}}
+
{{{Origin Amount 1|}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
 
{{{1}}} Origin 2 |
 
{{{1}}} Origin 2 |
{{{Origin 2}}}
+
{{{Origin 2|}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
 
{{{1}}} Origin Amount 2 |
 
{{{1}}} Origin Amount 2 |
{{{Origin Amount 2}}}
+
{{{Origin Amount 2|}}}
 +
}}{{#vardefine:
 +
{{{1}}} Origin 3 |
 +
{{{Origin 3|}}}
 +
}}{{#vardefine:
 +
{{{1}}} Origin Amount 3 |
 +
{{{Origin Amount 3|}}}
 +
}}{{#vardefine:
 +
{{{1}}} Origin 4 |
 +
{{{Origin 4|}}}
 +
}}{{#vardefine:
 +
{{{1}}} Origin Amount 4 |
 +
{{{Origin Amount 4|}}}
 +
}}{{#vardefine:
 +
{{{1}}} Origin 5 |
 +
{{{Origin 5|}}}
 +
}}{{#vardefine:
 +
{{{1}}} Origin Amount 5 |
 +
{{{Origin Amount 5|}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
 
{{{1}}} Is Destroyed in Fire |
 
{{{1}}} Is Destroyed in Fire |
{{{Is Destroyed in Fire}}} | no
+
{{{Is Destroyed in Fire|no}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
 
{{{1}}} Is Consumable |
 
{{{1}}} Is Consumable |
{{{Is Consumable}}} | no
+
{{{Is Consumable|no}}}  
 +
}}{{#vardefine:
 +
{{{1}}} Consumable Effects |  
 +
{{{Consumable Effects|}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
 
{{{1}}} Can Perish |
 
{{{1}}} Can Perish |
{{{Can Perish}}} | no
+
{{{Can Perish|no}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
 
{{{1}}} Is Heavy |
 
{{{1}}} Is Heavy |
{{{Is Heavy}}} | no
+
{{{Is Heavy|no}}}
 +
}}{{#vardefine:
 +
{{{1}}} Has Module Access |
 +
{{{Has Module Access|no}}}
 +
}}{{#vardefine:
 +
{{{1}}} Starts Broken |
 +
{{{Starts Broken|no}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
 
{{{1}}} Is Artefact |
 
{{{1}}} Is Artefact |
{{{Is Artefact}}} | no
+
{{{Is Artefact|no}}}
 +
}}{{#vardefine:
 +
{{{1}}} Enables Action |
 +
{{{Enables Action|no}}}
 +
}}{{#vardefine:
 +
{{{1}}} Has Passive Effect |
 +
{{{Has Passive Effect|no}}}
 +
}}{{#vardefine:
 +
{{{1}}} Has Passive Effect in Room |
 +
{{{Has Passive Effect in Room|no}}}
 +
}}{{#vardefine:
 +
{{{1}}} Has Exploration Effect |
 +
{{{Has Exploration Effect|no}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
 
{{{1}}} Max Charges |
 
{{{1}}} Max Charges |
{{{Max Charges}}} | N/A
+
{{{Max Charges|}}}
 +
}}{{#vardefine:
 +
{{{1}}} Starting Charges |
 +
{{{Starting Charges|}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
 
{{{1}}} Repair Chance |
 
{{{1}}} Repair Chance |
{{{Repair Chance}}} | N/A
+
{{{Repair Chance|}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
 
{{{1}}} Dismantle Chance |
 
{{{1}}} Dismantle Chance |
{{{Dismantle Chance}}} | N/A
+
{{{Dismantle Chance|}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
{{{1}}} Dismantle Results |
+
{{{1}}} Dismantle Result 1 |
{{{Dismantle Results}}} | {{Todo|Missing items that result from of dismantling this.}}
+
{{{Dismantle Result 1|}}}
 +
}}{{#vardefine:
 +
{{{1}}} Dismantle Result Amount 1 |
 +
{{{Dismantle Result Amount 1|}}}
 +
}}{{#vardefine:
 +
{{{1}}} Dismantle Result 2 |
 +
{{{Dismantle Result 2|}}}
 +
}}{{#vardefine:
 +
{{{1}}} Dismantle Result Amount 2 |
 +
{{{Dismantle Result Amount 2|}}}
 +
}}{{#vardefine:
 +
{{{1}}} Construction Material 1 |
 +
{{{Construction Material 1|}}}
 +
}}{{#vardefine:
 +
{{{1}}} Construction Material Amount 1 |
 +
{{{Construction Material Amount 1|}}}
 +
}}{{#vardefine:
 +
{{{1}}} Construction Material 2 |
 +
{{{Construction Material 2|}}}
 +
}}{{#vardefine:
 +
{{{1}}} Construction Material Amount 2 |
 +
{{{Construction Material Amount 2|}}}
 +
}}{{#vardefine:
 +
{{{1}}} Construction Material 3 |
 +
{{{Construction Material 3|}}}
 +
}}{{#vardefine:
 +
{{{1}}} Construction Material Amount 3 |
 +
{{{Construction Material Amount 3|}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
 
{{{1}}} Can be Stacked |
 
{{{1}}} Can be Stacked |
{{{Can be Stacked}}} | no
+
{{{Can be Stacked|no}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
 
{{{1}}} Can be Dropped |
 
{{{1}}} Can be Dropped |
{{{Can be Dropped}}} | yes
+
{{{Can be Dropped|yes}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
 
{{{1}}} Can be Hidden |
 
{{{1}}} Can be Hidden |
{{{Can be Hidden}}} | yes
+
{{{Can be Hidden|yes}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
 
{{{1}}} Is Personal |
 
{{{1}}} Is Personal |
{{{Is Personal}}} | no
+
{{{Is Personal|no}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
{{{1}}} Is Blueprint Material |
+
{{{1}}} Can be Moved |
{{{Is Blueprint Material}}} | no
+
{{{Can be Moved|yes}}}
 +
}}{{#vardefine:
 +
{{{1}}} Can be Read |
 +
{{{Can be Read|no}}}
 +
}}{{#vardefine:
 +
{{{1}}} Reading Text |
 +
{{{Reading Text|}}}
 +
}}{{#vardefine:
 +
{{{1}}} Is Blueprint Component |
 +
{{{Is Blueprint Component|no}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
 
{{{1}}} Weapon Damage |
 
{{{1}}} Weapon Damage |
{{{Weapon Damage}}} | N/A
+
{{{Weapon Damage|}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
 
{{{1}}} Weapon Accuracy |
 
{{{1}}} Weapon Accuracy |
{{{Weapon Accuracy}}} | N/A
+
{{{Weapon Accuracy|}}}
 +
}}{{#vardefine:
 +
{{{1}}} Weapon Expedition Strength |
 +
{{{Weapon Expedition Strength|}}}
 
}}{{#vardefine:
 
}}{{#vardefine:
{{{1}}} Weapon Expedition Strength | N/A
+
{{{1}}} Summary |
{{{Weapon Expedition Strength}}}
+
{{#ifeq: {{#var: {{{1}}} Starts Broken}}|yes|Starts '''broken'''.&nbsp;|}}{{#ifeq: {{#var: {{{1}}} Can be Moved}}|no|'''Cannot be moved.'''&nbsp;|}}{{#ifeq: {{#var: {{{1}}} Can Perish}}|yes|'''Perishable'''.&nbsp;|}}{{#if: {{#var: {{{1}}} Starting Charges}}|Starts with {{Charge}}x'''{{#var: {{{1}}} Starting Charges}}'''.&nbsp;|}}{{#ifeq: {{#var: {{{1}}} Is Personal}}|yes|'''Personal''' item; only visible to the owner.&nbsp;|}}{{#ifeq: {{#var: {{{1}}} Can be Stacked}}|yes|'''Stackable'''.&nbsp;|}}{{#ifeq: {{#var: {{{1}}} Can be Dropped}}|no|'''Cannot be dropped'''.&nbsp;|}}{{#ifeq: {{#var: {{{1}}} Can be Hidden}}|no|'''Cannot be hidden'''.&nbsp;|}}{{{Summary|{{Todo|Missing a short summary to be displayed on the Inventory page. Please append it.}}}}}
}}</includeonly></onlyinclude>
+
}}</onlyinclude></includeonly>As a temporary solution while I'm getting the inclusion to work, check '''[[:Template:Item Attributes/doc|this page]]''' for instructions on how to use this.
This is a template to ''store'' '''stats of [[Inventory|pick-up items]]''' in their respective articles. It is, thus, strictly a '''development template''' and should not be used in any articles that aren't '''item articles''', and other than in the precise way described below.
+
 
+
'''Usage''':
+
 
+
When creating a new page for an item, insert the following code at the top:
+
<pre><nowiki><onlyinclude>{{Item Stats|{{PAGENAME}}|
+
Icon =
+
 
+
| Summary =
+
 
+
| In-game Flavor =
+
 
+
| In-game Effects =
+
 
+
| In-game Examine Text =
+
 
+
| Origin 1 =
+
 
+
| Origin Amount 1 =
+
 
+
| Origin 2 =
+
 
+
| Origin Amount 2 =
+
 
+
| Origin 3 =
+
 
+
| Origin Amount 3 =
+
 
+
| Is Destroyed in Fire =
+
 
+
| Is Consumable =
+
 
+
| Can Perish =
+
 
+
| Is Heavy =
+
 
+
| Is Artefact =
+
 
+
| Max Charges =
+
 
+
| Repair Chance =
+
 
+
| Dismantle Chance =
+
 
+
| Dismantle Result 1 =
+
 
+
| Dismantle Result Amount 1 =
+
 
+
| Dismantle Result 2 =
+
 
+
| Dismantle Result Amount 2 =
+
 
+
| Can be Stacked =
+
 
+
| Can be Dropped =
+
 
+
| Can be Hidden =
+
 
+
| Is Personal =
+
 
+
| Is Blueprint Material =
+
 
+
| Weapon Damage =
+
 
+
| Weapon Accuracy =
+
 
+
| Weapon Expedition Strength =
+
 
+
}}</onlyinclude></nowiki>
+
</pre>
+
You can now begin filling in these fields. The following is an explanation of all of them.
+
 
+
{{Note|Booleans are either '''yes''' or '''no'''.}}
+
 
+
{{Note|Fields marked '''Skippable''' either have default values set or belong to certain item categories, so they can be omitted from the list.}}
+
 
+
{{Note|Make sure '''no empty fields''' are left when you're done; if something is its default value or doesn't belong into the item, please completely remove the field from the list.}}
+
 
+
*Icon: The file name of the item's icon, i.e. ''Alien can opener.jpg''
+
*Summary: A summary of the item and its effects to be used on the [[Inventory]] page, where not all info can be seen at once.
+
*In-game Flavor: The item's lore flavor text as seen in the game tooltip.
+
*In-game Effects: '''Skippable.''' The item's list of effects as seen in the game tooltip; not all items have this.
+
*In-game Examine Text: The text you receive in your room log when you '''Examine''' the item.
+
*Origin X: A source of the item. For instance, Origin 1 of {{Item|Thick Tube}} is ''Dismantling the Shower'', Origin 2 is ''Dismantling the {{Item|Lizaro Jungle}}''.
+
*Origin Amount X: The amount of the item received from the origin. For instance, Origin Amount 1 of {{Item|Thick Tube}} is ''1'', Origin Amount 2 is also ''1''.
+
*Is Destroyed in Fire: Boolean. Is this item fully consumed by fire? (Whether it breaks is handled in '''Repair Chance''').
+
*Is Consumable: '''Skippable.''' Boolean; defaults to 'no'. Is this item a [[Inventory#Consumables|Consumable]], enabling the '''Consume''' action and granting effects?
+
*Can Perish: '''Skippable.''' Boolean; defaults to 'no'. Only for [[Inventory#Consumables|Consumables]]. Can this item perish, giving a chance for diseases and being auto-destroyed by [[BIOS Terminal|NERON]]?
+
*Is Heavy: '''Skippable.''' Boolean; defaults to 'no'. Is this item Heavy, causing the {{Status|Burdened}} status?
+
*Is Artefact: '''Skippable.''' Boolean; defaults to 'no'. Is this item an alien artifact from an [[Exploration|expedition]], marked by the according icon?
+
*Max Charges: '''Skippable.''' Only for items with charges. At how many charges does this item max out? '''Doubles as "Has Charges" statement.'''
+
*Repair Chance: '''Skippable.''' Only for repairable items. What is the '''base repair chance''' (without tools) of this item? '''Doubles as "Can be Broken" statement.'''
+
*Dismantle Chance: '''Skippable.''' Only for items which can be dismantled. What is the '''base dismantle chance''' (without tools) of this item? '''Doubles as "Can be Dismantled" statement.'''
+
*Dismantle Result X: '''Skippable.''' Only for items which can be dismantled. Item names (without template) of the items received from dismantling this item. For instance, Dismantle Result 1 of {{Item|Microwave}} is ''Scrap Metal''.
+
*Dismantle Result Amount X: '''Skippable.''' Only for items which can be dismantled. The amount of the item received from the dismantling. For instance, Dismantle Result Amount 1 of {{Item|Microwave}} is ''2''.
+
*Can be Stacked: '''Skippable.''' Defaults to 'no'. Can this item be stacked with others of its type (like {{Item|Standard Ration}} can)?
+
*Can be Dropped: '''Skippable.''' Defaults to 'yes'. Can this item be dropped? Should be set to 'no' for things like {{Item|Fuel Capsule}}, {{Item|Camera}} etc.
+
*Can be Hidden: '''Skippable.''' Defaults to 'yes'. Can this item be hidden?
+
*Is Personal: '''Skippable.''' Defaults to 'no'. Can this item only be seen and interacted with by you? Should be set to 'yes' for communications items like {{Item|iTrakie}}.
+
*Is Blueprint Material: '''Skippable.''' Defaults to 'no'. Only for items which are material in blueprint construction, like {{Item|Scrap Metal}}.
+
*Weapon Damage: Only for [[Inventory#Weapons|weapons]]. The damage range this weapon can inflict. Example: ''2-5''
+
*Weapon Accuracy: Only for [[Inventory#Weapons|weapons]]. The base chance of hitting with this weapon. Example: ''60%''
+
*Weapon Expedition Strength: Only for [[Inventory#Weapons|weapons]]. The combat strength this weapon adds to an expedition. Example: ''1''
+
 
+
[[Category: Incomplete]]
+

Latest revision as of 16:47, 15 April 2015

As a temporary solution while I'm getting the inclusion to work, check this page for instructions on how to use this.