Template:Item Attributes/doc - Revision history

Ividyon at 08:23, 12 February 2014

2014-02-12T08:23:41Z

Ividyon: /* List of attributes */

2014-02-12T08:13:30Z

‎List of attributes

Ividyon: /* List of attributes */ Added 4 new values

2014-02-12T08:12:44Z

‎List of attributes: Added 4 new values

Ividyon: /* Important notes */

2014-02-12T07:20:32Z

‎Important notes

Ividyon: /* Important notes */

2014-02-11T18:52:28Z

‎Important notes

Ividyon: /* Important info */

2014-02-11T18:44:20Z

‎Important info

Ividyon: /* Skeleton */

2014-02-11T18:43:14Z

‎Skeleton

Ividyon: /* List of attributes */ Cleaned up a bit.

2014-02-11T18:18:03Z

‎List of attributes: Cleaned up a bit.

Ividyon: /* Usage */

2014-02-11T12:16:02Z

‎Usage

Ividyon: /* Usage */

2014-02-11T12:10:28Z

‎Usage

@@ Line 75: / Line 75: @@
 :* Skippable. ''Boolean''; defaults to 'no'.
-;Passive Effect in Room
+;Has Passive Effect in Room
 : Does this item have a passive effect when placed in a room? Mainly for the '''Instruments''' category.
 :* Skippable. ''Boolean''; defaults to 'no'.

@@ Line 68: / Line 68: @@
 ;Enables Action
-: Does this item enable a new action, either by itself or when used with a character/equipment/room/item? Mainly for the '''Tools''' category.
+: Does this item enable a new action, either by itself or when used with a character/equipment/room/item? Mainly for the '''Tools''' category. <span style="color:red; font-weight: bold;">You don't need this for Consumables; "Is Consumable" is responsible for those.</span>
 :* Skippable. ''Boolean''; defaults to 'no'.

@@ Line 65: / Line 65: @@
 ;Is Artefact
 : Is this item an alien artifact from an [[Exploration|expedition]], marked by the according icon?
 :* Skippable. ''Boolean''; defaults to 'no'.

@@ Line 9: / Line 9: @@
 *Most fields marked '''Skippable''', and many have '''default values'''. If the item doesn't deviate from these defaults, or the field does not apply to it (such as ''Weapon Damage'' for a non-weapon), '''remove the field from the list completely!''' This is '''important!'''
 *If you're unsure about what to put in a field, but you know it should have ''some'' content, '''keep it in the list, but empty''' so that any following editors can easily fill it in.
 ===List of attributes===

@@ Line 4: / Line 4: @@
 <onlyinclude>
 ===Important notes===
-'''Tip''': These are '''''important'''''.
+{{Note|These are '''''important'''''.}}
 *'''Booleans''' are either '''yes''' or '''no'''; written in lowercase. No other values are accepted, they will break things.
-*Fields marked '''Skippable''' either have '''default values''' set or belong to certain item categories, meaning they don't apply to all items.
+*Most fields marked '''Skippable''', and many have '''default values'''. If the item doesn't deviate from these defaults, or the field does not apply to it (such as ''Weapon Damage'' for a non-weapon), '''remove the field from the list completely!''' This is '''important!'''
-*If a field does not apply to the item you're editing, '''remove the field from the list'''. This is important!
+*If you're unsure about what to put in a field, but you know it should have ''some'' content, '''keep it in the list, but empty''' so that any following editors can easily fill it in.
-*If you're hesitant about a field, perhaps because it may apply to the item, '''leave it in the list without any value'''. Leave it empty.
 ===List of attributes===

@@ Line 123: / Line 123: @@
 == Skeleton ==
-When creating a new page for an item, insert the following code at the top:
+{{Main|Help:Item_page_guidelines/Skeleton}}
-−
-<pre><onlyinclude>{{Item Attributes|<Name of the item goes here!>|
-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 =
-−
-| Origin 4 =
-−
-| Origin Amount 4 =
-−
-| Is Destroyed in Fire =
-−
-| Is Consumable =
-−
-| Consumable Effects =
-−
-| Can Perish =
-−
-| Is Heavy =
-−
-| Is Artefact =
-−
-| Has Module Access =
-−
-| Starts Broken =
-−
-| Max Charges =
-−
-| Starting 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 Component =
-−
-| Weapon Damage =
-−
-| Weapon Accuracy =
-−
-| Weapon Expedition Strength =
-−
-}}</onlyinclude></pre>
-−
-You can now begin filling in these fields using the information provided above.

@@ Line 22: / Line 22: @@
 ;In-game Effects
-: '''Skippable.''' The item's list of effects as seen in the game tooltip; not all items have this.
+: 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.
+: The text you receive in your room log when you '''Examine''' the item, without any repetitions of the flavor text and effects list.
 ;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}}''.
+: A source of the item. For instance, Origin 1 of {{Item|Thick Tube}} is ''Dismantling'' '''[[Shower]]''', Origin 2 is ''Dismantling'' {{Item|Lizaro Jungle}}.
 ;Origin Amount X
@@ Line 34: / Line 35: @@
 ;Is Destroyed in Fire
-: '''Skippable.''' Boolean; defaults to 'no'. Is this item fully consumed by fire? (Whether it breaks is handled in '''Repair Chance''').
+: Is this item fully consumed by fire? (Whether it breaks is handled by '''Repair Chance''').
 ;Is Consumable
-: '''Skippable.''' Boolean; defaults to 'no'. Is this item a [[Inventory#Consumables|Consumable]], enabling the '''Consume''' action and granting effects?
+: Is this item a [[Inventory#Consumables|Consumable]], enabling the '''Consume''' action and granting effects?
 ;Consumable Effects
-: '''Skippable.''' If consumable, list of effects goes here.
+: If consumable, list of effects goes here. Separate each effect with a <nowiki><br></nowiki>.
 ;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]]?
+: Only for [[Inventory#Consumables|Consumables]]. Can this item perish, giving a chance for diseases and being auto-destroyed by [[BIOS Terminal|NERON]]?
 ;Has Module Access
-: '''Skippable.''' Boolean; defaults to 'no'. Does this Item have '''module access''', opening a new window to do something in (such as {{Item|Block of Post-It Notes}})?
+: Does this Item have '''module access''', opening a new window to do something in (such as {{Item|Block of Post-It Notes}})?
 ;Starts Broken
-: '''Skippable.''' Boolean; defaults to 'no'. Whether this item starts off broken.
+: Whether this item starts off broken.
 ;Is Heavy
-: '''Skippable.''' Boolean; defaults to 'no'. Is this item Heavy, causing the {{Status|Burdened}} status?
+: 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?
+: 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.'''
+: At how many {{Charge}} does this item max out? '''Doubles as "Has Charges" statement.'''
 ;Starting Charges
-: '''Skippable.''' Only for items with charges. How many charges does the item start with?
+: How many charges does the item start with?
 ;Repair Chance
-: '''Skippable.''' Only for repairable items. What is the '''base repair chance''' (without tools) of this item? '''Doubles as "Can be Broken" statement.'''
+: What is the '''base repair chance''' (without tools) of this item? '''Doubles as "Can be Broken"/"Broken by Fires" 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.'''
+: 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''.
+: 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''.
+: 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 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 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?
+: 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}}.
+: Can this item only be seen and interacted with by you? Should be set to 'yes' for communications items like {{Item|iTrakie}}.
 ;Is Blueprint Component
-: '''Skippable.''' Defaults to 'no'. Only for items which are components for blueprint construction, like {{Item|Scrap Metal}}.
+: Is this item part of a {{Item|Blueprint}}? Examples of this are {{Item|Scrap Metal}} and {{Item|Soap}}.
 ;Weapon Damage
-: Only for [[Inventory#Weapons|weapons]]. The damage range this weapon can inflict. Example: ''2-5''
+: 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%''
+: The base chance of hitting with this weapon, without any modifiers. Example: ''60%''
 ;Weapon Expedition Strength
-: Only for [[Inventory#Weapons|weapons]]. The combat strength this weapon adds to an expedition. Example: ''1''</onlyinclude>
+: The combat strength this weapon adds to an expedition. Example: ''1''
 == Skeleton ==

@@ Line 3: / Line 3: @@
 == Usage ==
 <onlyinclude>
-'''Important info:'''
+===Important info===
 *'''Booleans''' are either '''yes''' or '''no'''; written in lowercase. No other values are accepted, they will break things.
@@ Line 10: / Line 10: @@
 *If you're hesitant about a field, perhaps because it may apply to the item, '''leave it in the list without any value'''. Leave it empty.
-'''List of attributes:'''
+===List of attributes===
-*Icon: The file name of the item's icon, i.e. ''Alien can opener.jpg''
+;Icon
-*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.
+: The file name of the item's icon, i.e. ''Alien can opener.jpg''
-*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.
+;Summary
-*In-game Examine Text: The text you receive in your room log when you '''Examine''' the item.
+: A summary of the item and its effects to be used on the [[Inventory]] page, where not all info can be seen at once.
-*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''.
+;In-game Flavor
-*Is Destroyed in Fire: '''Skippable.''' Boolean; defaults to 'no'. Is this item fully consumed by fire? (Whether it breaks is handled in '''Repair Chance''').
+: The item's lore flavor text as seen in the game tooltip.
-*Is Consumable: '''Skippable.''' Boolean; defaults to 'no'. Is this item a [[Inventory#Consumables|Consumable]], enabling the '''Consume''' action and granting effects?
-*Consumable Effects: '''Skippable.''' If consumable, list of effects goes here.
+;In-game 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]]?
+: '''Skippable.''' The item's list of effects as seen in the game tooltip; not all items have this.
-*Has Module Access: '''Skippable.''' Boolean; defaults to 'no'. Does this Item have '''module access''', opening a new window to do something in (such as {{Item|Block of Post-It Notes}})?
-*Starts Broken: '''Skippable.''' Boolean; defaults to 'no'. Whether this item starts off broken.
+;In-game Examine Text
-*Is Heavy: '''Skippable.''' Boolean; defaults to 'no'. Is this item Heavy, causing the {{Status|Burdened}} status?
+: The text you receive in your room log when you '''Examine''' the item.
-*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.'''
+;Origin X
-*Starting Charges: '''Skippable.''' Only for items with charges. How many charges does the item start with?
+: 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}}''.
-*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.'''
+;Origin Amount X
-*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''.
+: 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''.
-*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)?
+;Is Destroyed in Fire
-*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.
+: '''Skippable.''' Boolean; defaults to 'no'. Is this item fully consumed by fire? (Whether it breaks is handled in '''Repair Chance''').
-*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 Consumable
-*Is Blueprint Component: '''Skippable.''' Defaults to 'no'. Only for items which are components for blueprint construction, like {{Item|Scrap Metal}}.
+: '''Skippable.''' Boolean; defaults to 'no'. Is this item a [[Inventory#Consumables|Consumable]], enabling the '''Consume''' action and granting effects?
-*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%''
+;Consumable Effects
-*Weapon Expedition Strength: Only for [[Inventory#Weapons|weapons]]. The combat strength this weapon adds to an expedition. Example: ''1''</onlyinclude>
+: '''Skippable.''' If consumable, list of effects goes here.
 == Skeleton ==