Difference between revisions of "Items"
m (Redirected page to Items/Inventory) |
(Split the tutorial in another article, this is now generally about items, link to the tutorial is provided) |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {{TutorialsBox | |
| + | |contents = [[Creating a weapon item]] | ||
| + | }} | ||
| + | '''Items''' are [[catalog]] objects that can be equipped by units when paired with an [[Inventory]]. They can have very basic effects like adding armor to a unit, equipping a weapon to a unit, or even have more complex "on-use" effects that deal damage to a target or heal the unit. | ||
| + | |||
| + | Item itself just links several other objects together. An item consist of: | ||
| + | *[[Buttons|Button]] - contains the item's icon and description | ||
| + | *[[Behaviors|Behavior]] - (optional) provides passive bonuses for item's bearer (the behavior is applied as usually, beware of stacking limits) | ||
| + | *[[Effects|Effect]] or [[Ability]] - (optional) used for items with active effects | ||
| + | *[[Weapons|Weapon]] - (optional) used for items that give a [[Weapons|weapon]] to the bearer | ||
| + | *[[Units|Unit]] - represents the unit when ''outside'' of inventory (the link goes the other way here, the ''unit'' has a field called ''item'', which links them together) | ||
| + | **[[Actors|Actor]] - obviously the item's unit needs it's own actor | ||
| + | |||
| + | Additionally, item has an [[Item classes|item class]], which is used by [[Item containers|item containers]] to determine, which items can be placed in which slots. | ||
| + | ==Types== | ||
| + | ===Generic=== | ||
| + | Generic items are passive, they can only give the unit [[Behaviors|behavior]] or [[Weapons|weapon]]. | ||
| + | ===Effect - Instant=== | ||
| + | These items have, as the name suggests, an instant effect. It is possible to specify cost for use (commonly used for items with limited charges). | ||
| + | ===Effect - Target=== | ||
| + | Same as above, except uses targeted effect. | ||
| + | ===Ability=== | ||
| + | ??? Can be safely used with Effec - Instant and Effect - Target abilities | ||
| + | ==Fields== | ||
| + | Each item has several basic fields: | ||
| + | *'''Face''' - [[Buttons|Button]] used for this item | ||
| + | *'''Carry Behaviors/Weapons''' - Behaviors/Weapons added to unit when ''carrying'' the item | ||
| + | *'''Equip Behaviors/Weapons''' - Behaviors/Weapons added to unit when the item is ''equipped'' | ||
| + | ''(Some slot in inventory can be marked to not equip the item (storage slots), items in this slots will provide only carry bonuses.) For more info, see [[Item containers]].'' | ||
| + | *'''Container''' - items can be used as further item containers, containing other items. See [[Item containers]] | ||
| + | |||
| + | [[Category:StarCraft II]] | ||
| + | [[Category:Data Editor]] | ||
| + | [[Category:Reference]] | ||
| + | [[Category:Catalogs]] | ||
Latest revision as of 13:15, 9 May 2011
| Related Tutorials | |
|---|---|
|
Items are catalog objects that can be equipped by units when paired with an Inventory. They can have very basic effects like adding armor to a unit, equipping a weapon to a unit, or even have more complex "on-use" effects that deal damage to a target or heal the unit.
Item itself just links several other objects together. An item consist of:
- Button - contains the item's icon and description
- Behavior - (optional) provides passive bonuses for item's bearer (the behavior is applied as usually, beware of stacking limits)
- Effect or Ability - (optional) used for items with active effects
- Weapon - (optional) used for items that give a weapon to the bearer
- Unit - represents the unit when outside of inventory (the link goes the other way here, the unit has a field called item, which links them together)
- Actor - obviously the item's unit needs it's own actor
Additionally, item has an item class, which is used by item containers to determine, which items can be placed in which slots.
Types
Generic
Generic items are passive, they can only give the unit behavior or weapon.
Effect - Instant
These items have, as the name suggests, an instant effect. It is possible to specify cost for use (commonly used for items with limited charges).
Effect - Target
Same as above, except uses targeted effect.
Ability
??? Can be safely used with Effec - Instant and Effect - Target abilities
Fields
Each item has several basic fields:
- Face - Button used for this item
- Carry Behaviors/Weapons - Behaviors/Weapons added to unit when carrying the item
- Equip Behaviors/Weapons - Behaviors/Weapons added to unit when the item is equipped
(Some slot in inventory can be marked to not equip the item (storage slots), items in this slots will provide only carry bonuses.) For more info, see Item containers.
- Container - items can be used as further item containers, containing other items. See Item containers