Template:Item Attributes/doc

From Mushpedia
Jump to: navigation, search

This is a template to store stats of 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

Important notes

Icon Note: These are important.

  • Booleans are either yes or no; written in lowercase. No other values are accepted, they will break things.
  • 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.
    • Exceptions are Repair Chance and Dismantle Chance; if you know these can be repaired/dismantled, but don't know the percentage, write down ??%. This will, at least, mark the item as breakable/dismantleable.

List of attributes

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
The item's list of effects as seen in the game tooltip; not all items have this.
  • Skippable. Only for items which do have an in-game list of effects.
In-game Examine Text
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 Icon Thick Tube is Dismantling Shower, Origin 2 is Dismantling Icon Lizaro Jungle.
Origin Amount X
The amount of the item received from the origin. For instance, Origin Amount 1 of Icon Thick Tube is 1, Origin Amount 2 is also 1.
Is Destroyed in Fire
Is this item fully consumed by fire? (Whether it breaks is handled by Repair Chance).
  • Skippable. Boolean; defaults to 'no'.
Is Consumable
Is this item a Consumable, enabling the Consume action and granting effects?
  • Skippable. Boolean; defaults to 'no'.
Consumable Effects
If consumable, list of effects goes here. Separate each effect with a <br>.
  • Skippable. Only for consumables.
Can Perish
Only for Consumables. Can this item perish, giving a chance for diseases and being auto-destroyed by NERON?
  • Skippable. Boolean; defaults to 'no'.
Has Module Access
Does this Item have module access, opening a new window to do something in (such as Icon Block of Post-it Notes)?
  • Skippable. Boolean; defaults to 'no'.
Starts Broken
Whether this item starts off broken.
  • Skippable. Boolean; defaults to 'no'.
Is Heavy
Is this item Heavy, causing the Icon Burdened status?
  • Skippable. Boolean; defaults to 'no'.
Is Artefact
Is this item an alien artifact from an expedition, marked by the according icon?
  • Skippable. Boolean; defaults to 'no'.
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. You don't need this for Consumables; "Is Consumable" is responsible for those.
  • Skippable. Boolean; defaults to 'no'.
Has Passive Effect
Does this item have a passive effect on its wielder? Mainly for the Gear category.
  • Skippable. Boolean; defaults to 'no'.
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'.
Has Exploration Effect
Does this item have a passive effect when taken along on an expedition? Mainly for the Exploration category.
  • Skippable. Boolean; defaults to 'no'.
Max Charges
At how many Charge does this item max out? Doubles as "Has Charges" statement.
  • Skippable. Only for items with Charge.
Starting Charges
How many charges does the item start with?
  • Skippable. Only for items with Charge.
Repair Chance
What is the base repair chance (without tools) of this item? Doubles as "Can be Broken"/"Broken by Fires" statement.
  • Skippable. Only for repairable items.
Dismantle Chance
What is the base dismantle chance (without tools) of this item? Doubles as "Can be Dismantled" statement.
  • Skippable. Only for items which can be dismantled.
Dismantle Result X
Item names (without template) of the items received from dismantling this item. For instance, Dismantle Result 1 of Icon Microwave is Scrap Metal.
  • Skippable. Only for items which can be dismantled.
Dismantle Result Amount X
The amount of the item received from the dismantling. For instance, Dismantle Result Amount 1 of Icon Microwave is 2.
  • Skippable. Only for items which can be dismantled.
Can be Stacked
Can this item be stacked with others of its type (like Icon Standard Ration can)?
  • Skippable. Boolean; defaults to 'no'.
Can be Dropped
Can this item be dropped? Should be set to 'no' for things like Icon Fuel Capsule, Icon Camera etc.
  • Skippable. Boolean; defaults to 'yes'.
Can be Hidden
Can this item be hidden?
  • Skippable. Boolean; defaults to 'yes'.
Is Personal
Can this item only be seen and interacted with by you? Should be set to 'yes' for communications items like Icon iTrakie.
  • Skippable. Boolean; defaults to 'no'.
Is Blueprint Component
Is this item part of a Icon Blueprint? Examples of this are Icon Scrap Metal and Icon Soap.
  • Skippable. Boolean; defaults to 'no'.
Weapon Damage
The damage range this weapon can inflict. Example: 2-5
Weapon Accuracy
The base chance of hitting with this weapon, without any modifiers. Example: 60%
Weapon Expedition Strength
The combat strength this weapon adds to an expedition. Example: 1

Skeleton

More info Main article: Help:Item_page_guidelines/Skeleton.