Modify Item API: Item Info

Pilus edited this page Aug 11, 2015 · 1 revision

.DisplayItemTooltip

Syntax

obj.DisplayItemTooltip()

Returns

Tooltip
''Special''
Shows the item's Tooltip

.GetAuthorInfo

Syntax

obj.GetAuthorInfo()

Returns

authorID
''String''
A GUID unique to the creator of the item.

.GetCooldown

Syntax

obj.GetCooldown()

Returns

cooldown
''Number''
Returns the cooldown of the item in seconds.

.GetFlavorText

Syntax

obj.GetFlavorText()

Returns

white 1
''String''
White Text Line 1 of item.
white 2
''String''
White Text Line 2 of item.
comment
''String''
Yellow Text of item.
useText
''String''
Green On Use Text of item.
### Example > `local white1, white2, comment, use = obj.GetFlavorText()`

.GetGUID

Syntax

obj.GetGUID()

Returns

itemGuid
''String''
GUID of the current item.

.GetItemComplexity

Syntax

obj.GetItemComplexity()

Returns

complexity
''String''
Retruns "standard" or "advanced" depending on if it is a standard or advanced item.

.GetItemInfo

Syntax

obj.GetItemInfo()

Returns

name
''String''
The item's name.
icon
''String''
The item's icon path.
quality
''Number''
Number form 0 to 6 representing item quality. 0 being Grey, 6 being Heirloom.
stackSize
''Number''
The stack size of the item
itemType
''Number''
A number indicating if this is a custom item or an official GHI item from a special source. This return can usually be left out.
### Example > ` local name, icon, quality, stackSize, itemType = obj.GetItemInfo() >`

.GetLastCastTime

Syntax

obj.GetLastCastTime()

Returns

lastCast
''Number''
Numerical value of the time the item was used last.

.GetSimpleAction

Syntax

obj.GetSimpleAction(index)

Arguments

index
''Number''
The index in the list of actions you wish ti get.
### Returns
action
''Table''
Returns a table containing the details of the action.
### Example > ` local action = itemAPI.GetSimpleAction(1) for i,v in pairs(action) do print(i, v) end >`

.GetSimpleActionCount

Syntax

obj.GetSimpleActionCount()

Returns

actionCount
''Number''
The number of simple actions an item has.

.GetVersions

Syntax

obj.GetVersions()

Returns

versions
''Number''
This is the number of versions of the item save. The version increases for every edit.

.IsConsumed

Syntax

obj.IsConsumed()

Returns

consume
''Boolean''
Returns true if the item is set to consume on use.

.IsCopyable

Syntax

obj.IsCopyable()

Returns

copyable
''Boolean''
Returns true if the item is flagged so others can copy it.

.IsEditable

Syntax

obj.IsEditable()

Returns

editable
''Boolean''
Returns true if the item is flagged to be edited by others.

.IsOnCooldown

Syntax

obj.IsOnCooldown()

Returns

cooldown
''Boolean''
Returns true if the item is currently on cooldown.
Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.