Item

Handle Wrappers View source
Item

Updates the item’s name, tooltip, extendedtooltip, description or icon for the specific player. If p == null, the item is updated for all players Returns false if no player is given.

Source on GitHub

Re-exports: Vectors

Functions

createItem

public function createItem(int itemId, vec2 pos) returns item

createItem

public function createItem(int itemId, vec3 pos) returns item

Extension Functions

item.remove

public function item.remove()

item.getTypeId

public function item.getTypeId() returns int

item.getItemtype

public function item.getItemtype() returns itemtype

Returns “itemtype” of this item. Do not confuse it with itemTypeId.

item.getLevel

public function item.getLevel() returns int

item.getX

public function item.getX() returns real

item.getY

public function item.getY() returns real

item.getPos

public function item.getPos() returns vec2

item.setPos

public function item.setPos(vec2 pos)

item.setDropOnDeath

public function item.setDropOnDeath(boolean flag)

item.setDroppable

public function item.setDroppable(boolean flag)

item.setPawnable

public function item.setPawnable(boolean flag)

item.setInvulnerable

public function item.setInvulnerable(boolean flag)

item.setVisible

public function item.setVisible(boolean flag)

item.isInvulnerable

public function item.isInvulnerable() returns boolean

item.isVisible

public function item.isVisible() returns boolean

item.isOwned

public function item.isOwned() returns boolean

item.isPowerup

public function item.isPowerup() returns boolean

item.isSellable

public function item.isSellable() returns boolean

item.isPawnable

public function item.isPawnable() returns boolean

item.isAlive

public function item.isAlive() returns boolean

Returns true if item is not destroyed and has a valid type id.

item.isPickupable

public function item.isPickupable() returns boolean

Returns true if item can be picked up by a unit.

item.getPlayer

public function item.getPlayer() returns player

item.setPlayer

public function item.setPlayer(player whichPlayer, boolean changeColor)

item.getCharges

public function item.getCharges() returns int

item.setCharges

public function item.setCharges(int charges)

item.getUserData

public function item.getUserData() returns int

item.setUserData

public function item.setUserData(int data)

item.getName

public function item.getName() returns string

item.setName

public function item.setName(string name)

item.getDescription

public function item.getDescription() returns string

item.setDescription

public function item.setDescription(string description)

item.getTooltip

public function item.getTooltip() returns string

item.setTooltip

public function item.setTooltip(string tooltip)

item.getExtendedTooltip

public function item.getExtendedTooltip() returns string

item.setExtendedTooltip

public function item.setExtendedTooltip(string tooltip)

item.getIconPath

public function item.getIconPath() returns string

item.setIconPath

public function item.setIconPath(string path)

item.getSkin

public function item.getSkin() returns int

item.setSkin

public function item.setSkin(int skinId)

item.getAbilityByIndex

public function item.getAbilityByIndex(int index) returns ability

item.getAbility

public function item.getAbility(int abiId) returns ability

item.addAbility

public function item.addAbility(int abiId) returns bool

item.removeAbility

public function item.removeAbility(int abiId) returns bool

item.getField

public function item.getField(itembooleanfield field) returns bool

item.getField

public function item.getField(itemintegerfield field) returns int

item.getField

public function item.getField(itemrealfield field) returns real

item.getField

public function item.getField(itemstringfield field) returns string

item.setField

public function item.setField(itembooleanfield field, bool value) returns bool

item.setField

public function item.setField(itemintegerfield field, int value) returns bool

item.setField

public function item.setField(itemrealfield field, real value) returns bool

item.setField

public function item.setField(itemstringfield field, string value) returns bool

item.updateDetailsForPlayer

public function item.updateDetailsForPlayer(player p, string itemName, string itemTooltip, string itemExtendedTooltip, string itemDesc, string itemIcon) returns bool

item.updateDetailsForAll

public function item.updateDetailsForAll(string itemName, string itemTooltip, string itemExtendedTooltip, string itemDesc, string itemIcon) returns bool

Updates the item’s name, tooltip, extendedtooltip, description or icon for the specific player. If p == null, the item is updated for all players Returns false if no player is given.

item.setItemDropID

public function item.setItemDropID(integer unitId)

item.blzSetItemSkin

public function item.blzSetItemSkin(integer skinId)