Packageorg.wak.inventory
Classpublic class InventoryItem
InheritanceInventoryItem Inheritance flash.display.Sprite
ImplementsIInteractable

This class represents an item in the Inventory.



Public Properties
 PropertyDefined by
  defaultAction : String
[read-only] The default action to apply on this Interactable
InventoryItem
  description : String
[read-only] The item description
InventoryItem
  guiItemDisplay : Sprite
[read-only] The DisplayObject which represents this item on the interface on SCI gui.
InventoryItem
  interactableId : String
[read-only] id of this interactable entity
InventoryItem
  interactionName : String
[read-only] A text with the name for gui purposes.
InventoryItem
  itemDisplay : Sprite
[read-only] The DisplayObject which represents this item on the interface.
InventoryItem
  itemIconDisplay : DisplayObject
[read-only] The DisplayObject icon which represents this item on the interface.
InventoryItem
  unitaryUse : Boolean
If the item is true for unitary use in the scumm style adventures, the action Use will be ready only when the player try Use with this interactable without wait a second parameter.
InventoryItem
Protected Properties
 PropertyDefined by
  mDescription : String = ""
InventoryItem
  mItemDisplay : Sprite = null
InventoryItem
  mItemId : String = ""
InventoryItem
  mItemMouseIcon : DisplayObject = null
InventoryItem
  mItemName : String = ""
InventoryItem
  mItemPanelIconCopy : Sprite = null
InventoryItem
  mResources : Class = null
InventoryItem
  mUnitaryUse : Boolean = false
InventoryItem
Public Methods
 MethodDefined by
  
Constructor
InventoryItem
Property detail
defaultActionproperty
defaultAction:String  [read-only]

The default action to apply on this Interactable

Implementation
    public function get defaultAction():String
descriptionproperty 
description:String  [read-only]

The item description

Implementation
    public function get description():String
guiItemDisplayproperty 
guiItemDisplay:Sprite  [read-only]

The DisplayObject which represents this item on the interface on SCI gui.

Implementation
    public function get guiItemDisplay():Sprite
interactableIdproperty 
interactableId:String  [read-only]

id of this interactable entity

Implementation
    public function get interactableId():String
interactionNameproperty 
interactionName:String  [read-only]

A text with the name for gui purposes.

Implementation
    public function get interactionName():String
itemDisplayproperty 
itemDisplay:Sprite  [read-only]

The DisplayObject which represents this item on the interface.

Implementation
    public function get itemDisplay():Sprite
itemIconDisplayproperty 
itemIconDisplay:DisplayObject  [read-only]

The DisplayObject icon which represents this item on the interface.

Implementation
    public function get itemIconDisplay():DisplayObject
mDescriptionproperty 
protected var mDescription:String = ""
mItemDisplayproperty 
protected var mItemDisplay:Sprite = null
mItemIdproperty 
protected var mItemId:String = ""
mItemMouseIconproperty 
protected var mItemMouseIcon:DisplayObject = null
mItemNameproperty 
protected var mItemName:String = ""
mItemPanelIconCopyproperty 
protected var mItemPanelIconCopy:Sprite = null
mResourcesproperty 
protected var mResources:Class = null
mUnitaryUseproperty 
protected var mUnitaryUse:Boolean = false
unitaryUseproperty 
unitaryUse:Boolean  [read-write]

If the item is true for unitary use in the scumm style adventures, the action Use will be ready only when the player try Use with this interactable without wait a second parameter.

Implementation
    public function get unitaryUse():Boolean
    public function set unitaryUse(value:Boolean):void
Constructor detail
InventoryItem()constructor
public function InventoryItem(pDef:IInventoryItemDefinition)

Constructor

Parameters
pDef:IInventoryItemDefinition — Definition of the inventory item