Item - Revision history

Siegelayer: changed "mmushrooms" to "mushrooms"

2013-11-03T06:33:27Z

changed "mmushrooms" to "mushrooms"

Sunjammer: Updating link

2012-02-23T13:10:57Z

Updating link

Proleric1: /* Variables */

2010-12-08T17:17:57Z

‎Variables

Proleric1: /* Variables */

2010-12-08T17:17:35Z

‎Variables

Proleric1: /* Variables */

2010-12-08T11:35:54Z

‎Variables

Proleric1: /* Variables */

2010-12-08T11:19:22Z

‎Variables

Proleric1: /* Properties */

2010-12-08T11:12:08Z

‎Properties

Proleric1: /* Properties */

2010-12-08T11:08:13Z

‎Properties

Mikemike37: inventory subgroup link added. speculated usage.

2010-05-07T21:20:19Z

inventory subgroup link added. speculated usage.

BillHoyt: /* Overview */

2010-04-02T19:00:27Z

‎Overview

@@ Line 6: / Line 6: @@
 |}
-An item is a game object that can be picked up or equipped by a creature. Armor, as well as mmushrooms.
+An item is a game object that can be picked up or equipped by a creature. Armor, as well as mushrooms.
 == Overview ==

@@ Line 127: / Line 127: @@
 {{variable table row|ITEM_CRUST | int |0| }}
 {{variable table row|ITEM_DO_ONCE_A and B | int |0| }}
-{{variable table row|ITEM_SEND_ACQUIRED_EVENT | int |0| When true, [[EVENT_TYPE_CAMPAIGN_ITEM_ACQUIRED]] is sent to the module's event script when the item is acquired. Unlike plot items, campaign items can be equipped. However, any special behaviour must be scripted. See [[Tutorial: Usable_campaign_items]].}}
+{{variable table row|ITEM_SEND_ACQUIRED_EVENT | int |0| When true, [[EVENT_TYPE_CAMPAIGN_ITEM_ACQUIRED]] is sent to the module's event script when the item is acquired. Unlike plot items, campaign items can be equipped. However, any special behaviour must be scripted. See the [[Usable campaign items tutorial]].}}
 {{variable table row|ITEM_SET | int |-1| Certain items will give a bonus when equipped with other members of the same set (as identified by this integer).}}
 {{variable table row|ITEM_SPECIALIZATION_FLAG| int|0|For items that unlock a class specialisation this must match an ID from Achievements.xls, ITEM_SEND_ACQUIRED_EVENT must also be set.}}

@@ Line 127: / Line 127: @@
 {{variable table row|ITEM_CRUST | int |0| }}
 {{variable table row|ITEM_DO_ONCE_A and B | int |0| }}
-{{variable table row|ITEM_SEND_ACQUIRED_EVENT | int |0| When true, [[EVENT_TYPE_CAMPAIGN_ITEM_ACQUIRED]] is sent to the module's event script when the item is acquired. Unlike plot items, campaign items can be equipped. However, any special behaviour must be scripted. See *[[Tutorial: Usable_campaign_items]].}}
+{{variable table row|ITEM_SEND_ACQUIRED_EVENT | int |0| When true, [[EVENT_TYPE_CAMPAIGN_ITEM_ACQUIRED]] is sent to the module's event script when the item is acquired. Unlike plot items, campaign items can be equipped. However, any special behaviour must be scripted. See [[Tutorial: Usable_campaign_items]].}}
 {{variable table row|ITEM_SET | int |-1| Certain items will give a bonus when equipped with other members of the same set (as identified by this integer).}}
 {{variable table row|ITEM_SPECIALIZATION_FLAG| int|0|For items that unlock a class specialisation this must match an ID from Achievements.xls, ITEM_SEND_ACQUIRED_EVENT must also be set.}}

@@ Line 127: / Line 127: @@
 {{variable table row|ITEM_CRUST | int |0| }}
 {{variable table row|ITEM_DO_ONCE_A and B | int |0| }}
-{{variable table row|ITEM_SEND_ACQUIRED_EVENT | int |0| When true, [[EVENT_TYPE_CAMPAIGN_ITEM_ACQUIRED]] is sent to the module's event script when the item is acquired. Unlike plot items, campaign items can be equipped. However, any special behaviour must be scripted. For example, using [[SetItemIndestructible]] to prevent destruction, or handling the scenario that the item is sold.}}
+{{variable table row|ITEM_SEND_ACQUIRED_EVENT | int |0| When true, [[EVENT_TYPE_CAMPAIGN_ITEM_ACQUIRED]] is sent to the module's event script when the item is acquired. Unlike plot items, campaign items can be equipped. However, any special behaviour must be scripted. See *[[Tutorial: Usable_campaign_items]].}}
 {{variable table row|ITEM_SET | int |-1| Certain items will give a bonus when equipped with other members of the same set (as identified by this integer).}}
 {{variable table row|ITEM_SPECIALIZATION_FLAG| int|0|For items that unlock a class specialisation this must match an ID from Achievements.xls, ITEM_SEND_ACQUIRED_EVENT must also be set.}}

@@ Line 127: / Line 127: @@
 {{variable table row|ITEM_CRUST | int |0| }}
 {{variable table row|ITEM_DO_ONCE_A and B | int |0| }}
-{{variable table row|ITEM_SEND_ACQUIRED_EVENT | int |0| When true, [[EVENT_TYPE_CAMPAIGN_ITEM_ACQUIRED]] is sent to the module's event script when the item is acquired. Unlike plot items, campaign items can be equipped. However, any special behaviour must be scripted. For example,  [[SetItemIndestructible]] or preventing it from being sold (no easy matter!).  }}
+{{variable table row|ITEM_SEND_ACQUIRED_EVENT | int |0| When true, [[EVENT_TYPE_CAMPAIGN_ITEM_ACQUIRED]] is sent to the module's event script when the item is acquired. Unlike plot items, campaign items can be equipped. However, any special behaviour must be scripted. For example, using [[SetItemIndestructible]] to prevent destruction, or handling the scenario that the item is sold.}}
 {{variable table row|ITEM_SET | int |-1| Certain items will give a bonus when equipped with other members of the same set (as identified by this integer).}}
 {{variable table row|ITEM_SPECIALIZATION_FLAG| int|0|For items that unlock a class specialisation this must match an ID from Achievements.xls, ITEM_SEND_ACQUIRED_EVENT must also be set.}}
-{{variable table row|ITEM_SEND_LOST_EVENT| int| 0 | When true, [[EVENT_TYPE_CAMPAIGN_ITEM_LOST]] is sent to the module's event script when the item is acquired.}}
+{{variable table row|ITEM_SEND_LOST_EVENT| int| 0 | When true, [[EVENT_TYPE_CAMPAIGN_ITEM_LOST]] is sent to the module's event script when the item is removed from the player's party (but not when a party member equips the item) }}
 {{variable table row|PROJECTILE_OVERRIDE|int|0|Used to change the default projectile for Mage Staves, values must match an ID from [[PRJ_base.xls|PRJ_base.xls]] (typically 125-129).}}
 {{variable table row|ITEM_RUNE_ENABLED|int|0|When true, items may have a number of rune slots, dependant on the relevant RuneCount values in [[BITM_base.xls#BITM_base_worksheet|BITM_base.xls]] and [[Materialtypes.xls#materialtypes|Materialtypes.xls]] }}

@@ Line 92: / Line 92: @@
 {{inspector row|OnHit Effect| {{undocumented}} }}
 {{inspector row|OnHit Power| {{undocumented}} }}
-{{inspector row|Plot Item| A plot item can not be destroyed or removed from inventory by the player once the player has acquired it. Plot items can only be removed via scripts written by the designer.}}
+{{inspector row|Plot Item| A plot item can not be destroyed, sold or removed from inventory by the player once the player has acquired it. Plot items can only be removed via scripts written by the designer. Plot items cannot be equipped.}}
 {{inspector row|Script| Event script assigned to the resource - see below}}
 {{inspector row|Unique| {{undocumented}} }}

@@ Line 88: / Line 88: @@
 {{inspector row|Body Tint Mask| Affects the appearance of item wearer. Typically used to customize the Dog's warpaint. }}
 {{inspector row|Cost| Base money value of the item in coppers - see below.}}
-{{inspector row|Damaged| {{undocumented}} }}
+{{inspector row|Damaged| A damaged item cannot be equipped or used (but strangely it can be sold at the normal price) }}
 {{inspector row|Item Properties| Allows selecting one or more item properties for the item. Item Properties are any special power, effects, or stat variations beyond the basic item attributes. Properties also includes restrictions by class, race, etc. See [[Item properties]] for more information. }}
 {{inspector row|OnHit Effect| {{undocumented}} }}

@@ Line 74: / Line 74: @@
 {{inspector row|Heraldry| Allows Heraldry when defined in [[BITM base.xls]] (Shields can). Variations as defined in "[[heraldry.xls]]" 2DA. }}
 {{inspector row|Icon| Icon for display in game. Only names beginning with ico_ to be used }}
-{{inspector row|Inventory Subgroup| {{undocumented}} }}
+{{inspector row|Inventory Subgroup| (speculation) sorts items within inventory. See [http://social.bioware.com/wiki/datoolset/index.php/Inventory#Inventory_Subgroup_Codes Inventory Page] for examples {{undocumented}} }}
 {{inspector row|Item Variation| An appearance variation based on the base item type. As defined in the appropriate Variations 2DA. See [[ItemVariations.xls]] }}
 {{inspector row|MaterialProgression| {{undocumented}} }}

@@ Line 10: / Line 10: @@
 == Overview ==
-Items for the Single player campaign are all stored in the Toolset's [[Resource palette]], under the Item Category. They are as such files describing what an Item is and what it looks like, but they do not tell who or where it is in the Game. It is sort of indepentant resource in that way. Any other Resource however can make use of it as they want.
+Items for the Single player campaign are all stored in the Toolset's [[Resource palette]], under the Item Category. They are as such files describing what an Item is and what it looks like, but they do not tell who or where it is in the game. It is sort of independent resource in that way. Any other Resource however can make use of it as they want.
 Items, as with any other Resource follow a [[Naming conventions#Resource Naming Convention|Naming convention]], to make it easier to navigate the [[Resource palette]].