NGUI: Next-Gen UI kit  3.7.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros
InvEquipment Class Reference

Inventory system – Equipment class works with InvAttachmentPoints and allows to visually equip and remove items. More...

Inheritance diagram for InvEquipment:

Public Member Functions

InvGameItem Replace (InvBaseItem.Slot slot, InvGameItem item)
 Equip the specified item automatically replacing an existing one. More...
 
InvGameItem Equip (InvGameItem item)
 Equip the specified item and return the item that was replaced. More...
 
InvGameItem Unequip (InvGameItem item)
 Unequip the specified item, returning it if the operation was successful. More...
 
InvGameItem Unequip (InvBaseItem.Slot slot)
 Unequip the item from the specified slot, returning the item that was unequipped. More...
 
bool HasEquipped (InvGameItem item)
 Whether the specified item is currently equipped. More...
 
bool HasEquipped (InvBaseItem.Slot slot)
 Whether the specified slot currently has an item equipped. More...
 
InvGameItem GetItem (InvBaseItem.Slot slot)
 Retrieves the item in the specified slot. More...
 

Properties

InvGameItem[] equippedItems [get]
 List of equipped items (with a finite number of equipment slots). More...
 

Detailed Description

Inventory system – Equipment class works with InvAttachmentPoints and allows to visually equip and remove items.

Member Function Documentation

InvGameItem InvEquipment.Equip ( InvGameItem  item)

Equip the specified item and return the item that was replaced.

InvGameItem InvEquipment.GetItem ( InvBaseItem.Slot  slot)

Retrieves the item in the specified slot.

bool InvEquipment.HasEquipped ( InvGameItem  item)

Whether the specified item is currently equipped.

bool InvEquipment.HasEquipped ( InvBaseItem.Slot  slot)

Whether the specified slot currently has an item equipped.

InvGameItem InvEquipment.Replace ( InvBaseItem.Slot  slot,
InvGameItem  item 
)

Equip the specified item automatically replacing an existing one.

InvGameItem InvEquipment.Unequip ( InvGameItem  item)

Unequip the specified item, returning it if the operation was successful.

InvGameItem InvEquipment.Unequip ( InvBaseItem.Slot  slot)

Unequip the item from the specified slot, returning the item that was unequipped.

Property Documentation

InvGameItem [] InvEquipment.equippedItems
get

List of equipped items (with a finite number of equipment slots).


The documentation for this class was generated from the following file: