Class Item<T>

Note

ASUNA!!!

Type Parameters

T extends ItemEventMap = ItemEventMap

Hierarchy

Widget<T>
- Item

Index

Constructors

constructor

new Item<T>(itemHandle): Item<T>
Type Parameters
- T extends ItemEventMap = ItemEventMap
Parameters
- itemHandle: HandleHolder<"item">
Returns Item<T>
Overrides Widget.constructor
- Defined in bootstrap.d.ts:1259
new Item<T>(itemHandle): Item<T>
Type Parameters
- T extends ItemEventMap = ItemEventMap
Parameters
- itemHandle: Item<ItemEventMap>
Returns Item<T>
Overrides Widget<T>.constructor
- Defined in bootstrap.d.ts:1260
new Item<T>(itemId, x, y): Item<T>
Type Parameters
- T extends ItemEventMap = ItemEventMap
Parameters
- itemId: number
- x: number
- y: number
Returns Item<T>
Overrides Widget<T>.constructor
- Defined in bootstrap.d.ts:1261

Properties

`Private` #private

#private: any

`Static` defaultMaxListeners

defaultMaxListeners: number

Accessors

handle

get handle(): HandleHolder<string>
Returns HandleHolder<string>
Inherited from Widget.handle
- Defined in bootstrap.d.ts:226

Methods

addIndicator

addIndicator(red, green, blue, alpha): void
Class member alias for AddIndicator
Parameters
- red: number
- green: number
- blue: number
- alpha: number
Returns void
Inherited from Widget.addIndicator
- Defined in bootstrap.d.ts:320

addListener

addListener<E>(event, listener): Item<T>
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- listener: T[E]
Returns Item<T>
Inherited from Widget.addListener
- Defined in bootstrap.d.ts:23

animationOffsetPercent

animationOffsetPercent(): number
Class chain property alias for GetItemAnimationOffsetPercent and SetItemAnimationOffsetPercent

Returns number
Overrides Widget.animationOffsetPercent
- Defined in bootstrap.d.ts:1356
animationOffsetPercent<T>(value): Item<T>
Type Parameters
- T = number
Parameters
- value: T | ((this, currentValue) => T)
Returns Item<T>
Overrides Widget.animationOffsetPercent
- Defined in bootstrap.d.ts:1357

blzAddAbility

blzAddAbility(abilCode): boolean
Class member alias for BlzItemAddAbility
Parameters
- abilCode: number
Returns boolean
- Defined in bootstrap.d.ts:1657

blzGetAbility

blzGetAbility(abilCode): HandleHolder<"ability">
Class member alias for BlzGetItemAbility
Parameters
- abilCode: number
Returns HandleHolder<"ability">
- Defined in bootstrap.d.ts:1652

blzGetAbilityByIndex

blzGetAbilityByIndex(index): HandleHolder<"ability">
Class member alias for BlzGetItemAbilityByIndex
Parameters
- index: number
Returns HandleHolder<"ability">
- Defined in bootstrap.d.ts:1647

blzGetBooleanField

blzGetBooleanField(whichField): boolean
Class member alias for BlzGetItemBooleanField
Parameters
- whichField: HandleHolder<"itembooleanfield">
Returns boolean
- Defined in bootstrap.d.ts:1662

blzGetDescription

blzGetDescription(): string
Class member alias for BlzGetItemDescription

Returns string
- Defined in bootstrap.d.ts:1612

blzGetExtendedTooltip

blzGetExtendedTooltip(): string
Class member alias for BlzGetItemExtendedTooltip

Returns string
- Defined in bootstrap.d.ts:1632

blzGetIconPath

blzGetIconPath(): string
Class member alias for BlzGetItemIconPath

Returns string
- Defined in bootstrap.d.ts:1642

blzGetIntegerField

blzGetIntegerField(whichField): number
Class member alias for BlzGetItemIntegerField
Parameters
- whichField: HandleHolder<"itemintegerfield">
Returns number
- Defined in bootstrap.d.ts:1667

blzGetRealField

blzGetRealField(whichField): number
Class member alias for BlzGetItemRealField
Parameters
- whichField: HandleHolder<"itemrealfield">
Returns number
- Defined in bootstrap.d.ts:1672

blzGetSkin

blzGetSkin(): number
Class member alias for BlzGetItemSkin

Returns number
- Defined in bootstrap.d.ts:1707

blzGetStringField

blzGetStringField(whichField): string
Class member alias for BlzGetItemStringField
Parameters
- whichField: HandleHolder<"itemstringfield">
Returns string
- Defined in bootstrap.d.ts:1677

blzGetTooltip

blzGetTooltip(): string
Class member alias for BlzGetItemTooltip

Returns string
- Defined in bootstrap.d.ts:1622

blzRemoveAbility

blzRemoveAbility(abilCode): boolean
Class member alias for BlzItemRemoveAbility
Parameters
- abilCode: number
Returns boolean
- Defined in bootstrap.d.ts:1702

blzSetBooleanField

blzSetBooleanField(whichField, value): boolean
Class member alias for BlzSetItemBooleanField
Parameters
- whichField: HandleHolder<"itembooleanfield">
- value: boolean
Returns boolean
- Defined in bootstrap.d.ts:1682

blzSetDescription

blzSetDescription(description): void
Class member alias for BlzSetItemDescription
Parameters
- description: string
Returns void
- Defined in bootstrap.d.ts:1607

blzSetExtendedTooltip

blzSetExtendedTooltip(extendedTooltip): void
Class member alias for BlzSetItemExtendedTooltip
Parameters
- extendedTooltip: string
Returns void
- Defined in bootstrap.d.ts:1627

blzSetIconPath

blzSetIconPath(iconPath): void
Class member alias for BlzSetItemIconPath
Parameters
- iconPath: string
Returns void
- Defined in bootstrap.d.ts:1637

blzSetIntegerField

blzSetIntegerField(whichField, value): boolean
Class member alias for BlzSetItemIntegerField
Parameters
- whichField: HandleHolder<"itemintegerfield">
- value: number
Returns boolean
- Defined in bootstrap.d.ts:1687

blzSetName

blzSetName(name): void
Class member alias for BlzSetItemName
Parameters
- name: string
Returns void
- Defined in bootstrap.d.ts:1602

blzSetRealField

blzSetRealField(whichField, value): boolean
Class member alias for BlzSetItemRealField
Parameters
- whichField: HandleHolder<"itemrealfield">
- value: number
Returns boolean
- Defined in bootstrap.d.ts:1692

blzSetSkin

blzSetSkin(skinId): void
Class member alias for BlzSetItemSkin
Parameters
- skinId: number
Returns void
- Defined in bootstrap.d.ts:1712

blzSetStringField

blzSetStringField(whichField, value): boolean
Class member alias for BlzSetItemStringField
Parameters
- whichField: HandleHolder<"itemstringfield">
- value: string
Returns boolean
- Defined in bootstrap.d.ts:1697

blzSetTooltip

blzSetTooltip(tooltip): void
Class member alias for BlzSetItemTooltip
Parameters
- tooltip: string
Returns void
- Defined in bootstrap.d.ts:1617

charges

charges(): number
Class chain property alias for GetItemCharges and SetItemCharges

Returns number
- Defined in bootstrap.d.ts:1284
charges<T>(value): Item<T>
Type Parameters
- T = number
Parameters
- value: T | ((this, currentValue) => T)
Returns Item<T>
- Defined in bootstrap.d.ts:1285

cooldown

cooldown(): number
Class chain property alias for GetItemCooldown and SetItemCooldown

Returns number
- Defined in bootstrap.d.ts:1308
cooldown<T>(value): Item<T>
Type Parameters
- T = number
Parameters
- value: T | ((this, currentValue) => T)
Returns Item<T>
- Defined in bootstrap.d.ts:1309

emit

emit<E>(event, ...args): boolean
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- Rest ...args: Parameters<(T & AnyEmmiter)[E]>
Returns boolean
Inherited from Widget.emit
- Defined in bootstrap.d.ts:31

equals

equals(anotherHandle): boolean
Parameters
- anotherHandle: Handle<HandleEventMap>
Returns boolean
Inherited from Widget.equals
- Defined in bootstrap.d.ts:227

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Inherited from Widget.eventNames
- Defined in bootstrap.d.ts:33

getAbility

getAbility(abilityId): HandleHolder<"ability">
Class member alias for GetItemAbility
Parameters
- abilityId: number
Returns HandleHolder<"ability">
- Defined in bootstrap.d.ts:1482

getAbilityByIndex

getAbilityByIndex(abilityIndex): HandleHolder<"ability">
Class member alias for GetItemAbilityByIndex
Parameters
- abilityIndex: number
Returns HandleHolder<"ability">
- Defined in bootstrap.d.ts:1487

getBooleanField

getBooleanField(whichField): boolean
Class member alias for GetItemBooleanField
Parameters
- whichField: HandleHolder<"itembooleanfield">
Returns boolean
- Defined in bootstrap.d.ts:1437

getCurrentAnimationId

getCurrentAnimationId(): number
Class member alias for GetItemCurrentAnimationId

Returns number
Overrides Widget.getCurrentAnimationId
- Defined in bootstrap.d.ts:1572

getCurrentAnimationName

getCurrentAnimationName(): string
Class member alias for GetItemCurrentAnimationName

Returns string
Overrides Widget.getCurrentAnimationName
- Defined in bootstrap.d.ts:1577

getFacing

getFacing(): number
Class member alias for GetItemFacing

Returns number
Overrides Widget.getFacing
- Defined in bootstrap.d.ts:1502

getIntegerField

getIntegerField(whichField): number
Class member alias for GetItemIntegerField
Parameters
- whichField: HandleHolder<"itemintegerfield">
Returns number
- Defined in bootstrap.d.ts:1427

getLevel

getLevel(): number
Class member alias for GetItemLevel

Returns number
- Defined in bootstrap.d.ts:1412

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from Widget.getMaxListeners
- Defined in bootstrap.d.ts:37

getModelObjectPositionLoc

getModelObjectPositionLoc(whichObject): Location
Class member alias for GetItemModelObjectPositionLoc
Parameters
- whichObject: string
Returns Location
Overrides Widget.getModelObjectPositionLoc
- Defined in bootstrap.d.ts:1567

getModelObjectX

getModelObjectX(whichObject): number
Class member alias for GetItemModelObjectX
Parameters
- whichObject: string
Returns number
Overrides Widget.getModelObjectX
- Defined in bootstrap.d.ts:1552

getModelObjectY

getModelObjectY(whichObject): number
Class member alias for GetItemModelObjectY
Parameters
- whichObject: string
Returns number
Overrides Widget.getModelObjectY
- Defined in bootstrap.d.ts:1557

getModelObjectZ

getModelObjectZ(whichObject): number
Class member alias for GetItemModelObjectZ
Parameters
- whichObject: string
Returns number
Overrides Widget.getModelObjectZ
- Defined in bootstrap.d.ts:1562

getName

getName(): string
Class member alias for GetItemName

Returns string
- Defined in bootstrap.d.ts:1422

getPlayer

getPlayer(): Player<PlayerEventMap>
Class member alias for GetItemPlayer

Returns Player<PlayerEventMap>
- Defined in bootstrap.d.ts:1367

getRealField

getRealField(whichField): number
Class member alias for GetItemRealField
Parameters
- whichField: HandleHolder<"itemrealfield">
Returns number
- Defined in bootstrap.d.ts:1447

getScreenX

getScreenX(): number
Class member alias for GetItemScreenX

Returns number
Overrides Widget.getScreenX
- Defined in bootstrap.d.ts:1472

getScreenY

getScreenY(): number
Class member alias for GetItemScreenY

Returns number
Overrides Widget.getScreenY
- Defined in bootstrap.d.ts:1477

getSprite

getSprite(): HandleHolder<"sprite">
Class member alias for GetItemSprite

Returns HandleHolder<"sprite">
Overrides Widget.getSprite
- Defined in bootstrap.d.ts:1467

getStringField

getStringField(whichField): string
Class member alias for GetItemStringField
Parameters
- whichField: HandleHolder<"itemstringfield">
Returns string
- Defined in bootstrap.d.ts:1457

getType

getType(): HandleHolder<"itemtype">
Class member alias for GetItemType

Returns HandleHolder<"itemtype">
- Defined in bootstrap.d.ts:1417

getTypeId

getTypeId(): number
Class member alias for GetItemTypeId

Returns number
Overrides Widget.getTypeId
- Defined in bootstrap.d.ts:1372

getVertexColour

getVertexColour(): number
Class member alias for GetItemVertexColour

Returns number
Overrides Widget.getVertexColour
- Defined in bootstrap.d.ts:1492

getX

getX(): number
Class member alias for GetItemX

Returns number
- Defined in bootstrap.d.ts:1377

getY

getY(): number
Class member alias for GetItemY

Returns number
- Defined in bootstrap.d.ts:1382

invulnerable

invulnerable(): boolean
Class chain property alias for IsItemInvulnerable and SetItemInvulnerable

Returns boolean
Overrides Widget.invulnerable
- Defined in bootstrap.d.ts:1266
invulnerable<T>(value): Item<T>
Type Parameters
- T = boolean
Parameters
- value: T | ((this, currentValue) => T)
Returns Item<T>
Overrides Widget.invulnerable
- Defined in bootstrap.d.ts:1267

isOwned

isOwned(): boolean
Class member alias for IsItemOwned

Returns boolean
- Defined in bootstrap.d.ts:1397

isPowerup

isPowerup(): boolean
Class member alias for IsItemPowerup

Returns boolean
- Defined in bootstrap.d.ts:1402

isSellable

isSellable(): boolean
Class member alias for IsItemSellable

Returns boolean
- Defined in bootstrap.d.ts:1407

isTargetAllowed

isTargetAllowed(target, whichFlags): boolean
Class member alias for IsWidgetTargetAllowed
Parameters
- target: Widget<WidgetEventMap>
- whichFlags: HandleHolder<"targetflag">
Returns boolean
Inherited from Widget.isTargetAllowed
- Defined in bootstrap.d.ts:335

life

life(): number
Class chain property alias for GetItemLife and SetItemLife

Returns number
Overrides Widget.life
- Defined in bootstrap.d.ts:1296
life<T>(value): Item<T>
Type Parameters
- T = number
Parameters
- value: T | ((this, currentValue) => T)
Returns Item<T>
Overrides Widget.life
- Defined in bootstrap.d.ts:1297

listenerCount

listenerCount<E>(event): number
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
Returns number
Inherited from Widget.listenerCount
- Defined in bootstrap.d.ts:36

listeners

listeners<E>(event): T[E][]
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
Returns T[E][]
Inherited from Widget.listeners
- Defined in bootstrap.d.ts:35

maxLife

maxLife(): number
Class chain property alias for GetItemMaxLife and SetItemMaxLife

Returns number
- Defined in bootstrap.d.ts:1302
maxLife<T>(value): Item<T>
Type Parameters
- T = number
Parameters
- value: T | ((this, currentValue) => T)
Returns Item<T>
- Defined in bootstrap.d.ts:1303

model

model(): string
Class chain property alias for GetItemModel and SetItemModel

Returns string
Overrides Widget.model
- Defined in bootstrap.d.ts:1350
model<T>(value): Item<T>
Type Parameters
- T = string
Parameters
- value: T | ((this, currentValue) => T)
Returns Item<T>
Overrides Widget.model
- Defined in bootstrap.d.ts:1351

off

off<E>(event, listener): Item<T>
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- listener: T[E]
Returns Item<T>
Inherited from Widget.off
- Defined in bootstrap.d.ts:28

on

on<E>(event, listener): Item<T>
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- listener: T[E]
Returns Item<T>
Inherited from Widget.on
- Defined in bootstrap.d.ts:24

once

once<E>(event, listener): Item<T>
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- listener: T[E]
Returns Item<T>
Inherited from Widget.once
- Defined in bootstrap.d.ts:25

pawnable

pawnable(): boolean
Class chain property alias for IsItemPawnable and SetItemPawnable

Returns boolean
- Defined in bootstrap.d.ts:1278
pawnable<T>(value): Item<T>
Type Parameters
- T = boolean
Parameters
- value: T | ((this, currentValue) => T)
Returns Item<T>
- Defined in bootstrap.d.ts:1279

pitch

pitch(): number
Class chain property alias for GetItemPitch and SetItemPitch

Returns number
Overrides Widget.pitch
- Defined in bootstrap.d.ts:1338
pitch<T>(value): Item<T>
Type Parameters
- T = number
Parameters
- value: T | ((this, currentValue) => T)
Returns Item<T>
Overrides Widget.pitch
- Defined in bootstrap.d.ts:1339

positionLoc

positionLoc(): Location
Class chain property alias for GetWidgetPositionLoc and SetWidgetPositionLoc

Returns Location
Inherited from Widget.positionLoc
- Defined in bootstrap.d.ts:272
positionLoc<T>(value): Item<T>
Type Parameters
- T = Location
Parameters
- value: T | ((this, currentValue) => T)
Returns Item<T>
Inherited from Widget.positionLoc
- Defined in bootstrap.d.ts:273

prependListener

prependListener<E>(event, listener): Item<T>
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- listener: T[E]
Returns Item<T>
Inherited from Widget.prependListener
- Defined in bootstrap.d.ts:26

prependOnceListener

prependOnceListener<E>(event, listener): Item<T>
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- listener: T[E]
Returns Item<T>
Inherited from Widget.prependOnceListener
- Defined in bootstrap.d.ts:27

queueAnimation

queueAnimation(animationName): void
Class member alias for QueueItemAnimation
Parameters
- animationName: string
Returns void
Overrides Widget.queueAnimation
- Defined in bootstrap.d.ts:1597

queueAnimationByIndex

queueAnimationByIndex(animIndex): void
Class member alias for QueueItemAnimationByIndex
Parameters
- animIndex: number
Returns void
Overrides Widget.queueAnimationByIndex
- Defined in bootstrap.d.ts:1592

rawListeners

rawListeners<E>(event): T[E][]
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
Returns T[E][]
Inherited from Widget.rawListeners
- Defined in bootstrap.d.ts:34

remainingCooldown

remainingCooldown(): number
Class chain property alias for GetItemRemainingCooldown and SetItemRemainingCooldown

Returns number
- Defined in bootstrap.d.ts:1314
remainingCooldown<T>(value): Item<T>
Type Parameters
- T = number
Parameters
- value: T | ((this, currentValue) => T)
Returns Item<T>
- Defined in bootstrap.d.ts:1315

remove

remove(): void
Class member alias for RemoveItem

Returns void
- Defined in bootstrap.d.ts:1362

removeAllListeners

removeAllListeners<E>(event?): Item<T>
Type Parameters
- E extends string | number | symbol
Parameters
- Optional event: E
Returns Item<T>
Inherited from Widget.removeAllListeners
- Defined in bootstrap.d.ts:29

removeListener

removeListener<E>(event, listener): Item<T>
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- listener: T[E]
Returns Item<T>
Inherited from Widget.removeListener
- Defined in bootstrap.d.ts:30

resetMatrix

resetMatrix(): void
Class member alias for ResetItemMatrix

Returns void
Overrides Widget.resetMatrix
- Defined in bootstrap.d.ts:1517

roll

roll(): number
Class chain property alias for GetItemRoll and SetItemRoll

Returns number
Overrides Widget.roll
- Defined in bootstrap.d.ts:1344
roll<T>(value): Item<T>
Type Parameters
- T = number
Parameters
- value: T | ((this, currentValue) => T)
Returns Item<T>
Overrides Widget.roll
- Defined in bootstrap.d.ts:1345

scale

scale(): number
Class chain property alias for GetItemScale and SetItemTimeScale

Returns number
Overrides Widget.scale
- Defined in bootstrap.d.ts:1326
scale<T>(value): Item<T>
Type Parameters
- T = number
Parameters
- value: T | ((this, currentValue) => T)
Returns Item<T>
Overrides Widget.scale
- Defined in bootstrap.d.ts:1327

setAnimationWithRarity

setAnimationWithRarity(animationName, rarity): void
Class member alias for SetItemAnimationWithRarity
Parameters
- animationName: string
- rarity: HandleHolder<"raritycontrol">
Returns void
Overrides Widget.setAnimationWithRarity
- Defined in bootstrap.d.ts:1587

setAnimationWithRarityByIndex

setAnimationWithRarityByIndex(animIndex, rarity): void
Class member alias for SetItemAnimationWithRarityByIndex
Parameters
- animIndex: number
- rarity: HandleHolder<"raritycontrol">
Returns void
Overrides Widget.setAnimationWithRarityByIndex
- Defined in bootstrap.d.ts:1582

setBooleanField

setBooleanField(whichField, value): boolean
Class member alias for SetItemBooleanField
Parameters
- whichField: HandleHolder<"itembooleanfield">
- value: boolean
Returns boolean
- Defined in bootstrap.d.ts:1442

setFacing

setFacing(facing, isInstant): void
Class member alias for SetItemFacing
Parameters
- facing: number
- isInstant: boolean
Returns void
Overrides Widget.setFacing
- Defined in bootstrap.d.ts:1507

setIntegerField

setIntegerField(whichField, value): boolean
Class member alias for SetItemIntegerField
Parameters
- whichField: HandleHolder<"itemintegerfield">
- value: number
Returns boolean
- Defined in bootstrap.d.ts:1432

setMaterialTexture

setMaterialTexture(textureName, materialId, textureIndex): void
Class member alias for SetItemMaterialTexture
Parameters
- textureName: string
- materialId: number
- textureIndex: number
Returns void
Overrides Widget.setMaterialTexture
- Defined in bootstrap.d.ts:1537

setMatrixScale

setMatrixScale(x, y, z): void
Class member alias for SetItemMatrixScale
Parameters
- x: number
- y: number
- z: number
Returns void
Overrides Widget.setMatrixScale
- Defined in bootstrap.d.ts:1512

setMaxListeners

setMaxListeners(maxListeners): Item<T>
Parameters
- maxListeners: number
Returns Item<T>
Inherited from Widget.setMaxListeners
- Defined in bootstrap.d.ts:38

setModelEx

setModelEx(modelFile, playerColourId): void
Class member alias for SetItemModelEx
Parameters
- modelFile: string
- playerColourId: number
Returns void
Overrides Widget.setModelEx
- Defined in bootstrap.d.ts:1532

setOrientation

setOrientation(yaw, pitch, roll): void
Class member alias for SetItemOrientation
Parameters
- yaw: number
- pitch: number
- roll: number
Returns void
Overrides Widget.setOrientation
- Defined in bootstrap.d.ts:1527

setOrientationEx

setOrientationEx(yaw, pitch, roll, eulerOrder): void
Class member alias for SetItemOrientationEx
Parameters
- yaw: number
- pitch: number
- roll: number
- eulerOrder: number
Returns void
Overrides Widget.setOrientationEx
- Defined in bootstrap.d.ts:1522

setPlayer

setPlayer(whichPlayer, changeColor): void
Class member alias for SetItemPlayer
Parameters
- whichPlayer: Player<PlayerEventMap>
- changeColor: boolean
Returns void
- Defined in bootstrap.d.ts:1392

setPosition

setPosition(x, y): void
Class member alias for SetItemPosition
Parameters
- x: number
- y: number
Returns void
Overrides Widget.setPosition
- Defined in bootstrap.d.ts:1387

setRealField

setRealField(whichField, value): boolean
Class member alias for SetItemRealField
Parameters
- whichField: HandleHolder<"itemrealfield">
- value: number
Returns boolean
- Defined in bootstrap.d.ts:1452

setReplaceableTexture

setReplaceableTexture(textureName, textureIndex): void
Class member alias for SetItemReplaceableTexture
Parameters
- textureName: string
- textureIndex: number
Returns void
Overrides Widget.setReplaceableTexture
- Defined in bootstrap.d.ts:1547

setStringField

setStringField(whichField, value): boolean
Class member alias for SetItemStringField
Parameters
- whichField: HandleHolder<"itemstringfield">
- value: string
Returns boolean
- Defined in bootstrap.d.ts:1462

setTexture

setTexture(textureName, textureIndex): void
Class member alias for SetItemTexture
Parameters
- textureName: string
- textureIndex: number
Returns void
Overrides Widget.setTexture
- Defined in bootstrap.d.ts:1542

setVertexColour

setVertexColour(red, green, blue, alpha): void
Class member alias for SetItemVertexColour
Parameters
- red: number
- green: number
- blue: number
- alpha: number
Returns void
Overrides Widget.setVertexColour
- Defined in bootstrap.d.ts:1497

timeScale

timeScale(): number
Class chain property alias for GetItemTimeScale and SetItemTimeScale

Returns number
Overrides Widget.timeScale
- Defined in bootstrap.d.ts:1320
timeScale<T>(value): Item<T>
Type Parameters
- T = number
Parameters
- value: T | ((this, currentValue) => T)
Returns Item<T>
Overrides Widget.timeScale
- Defined in bootstrap.d.ts:1321

userData

userData(): number
Class chain property alias for GetItemUserData and SetItemUserData

Returns number
- Defined in bootstrap.d.ts:1290
userData<T>(value): Item<T>
Type Parameters
- T = number
Parameters
- value: T | ((this, currentValue) => T)
Returns Item<T>
- Defined in bootstrap.d.ts:1291

visible

visible(): boolean
Class chain property alias for IsItemVisible and SetItemVisible

Returns boolean
Overrides Widget.visible
- Defined in bootstrap.d.ts:1272
visible<T>(value): Item<T>
Type Parameters
- T = boolean
Parameters
- value: T | ((this, currentValue) => T)
Returns Item<T>
Overrides Widget.visible
- Defined in bootstrap.d.ts:1273

x

x(): number
Class chain property alias for GetWidgetX and SetWidgetX

Returns number
Inherited from Widget.x
- Defined in bootstrap.d.ts:248
x<T>(value): Item<T>
Type Parameters
- T = number
Parameters
- value: T | ((this, currentValue) => T)
Returns Item<T>
Inherited from Widget.x
- Defined in bootstrap.d.ts:249

y

y(): number
Class chain property alias for GetWidgetY and SetWidgetY

Returns number
Inherited from Widget.y
- Defined in bootstrap.d.ts:254
y<T>(value): Item<T>
Type Parameters
- T = number
Parameters
- value: T | ((this, currentValue) => T)
Returns Item<T>
Inherited from Widget.y
- Defined in bootstrap.d.ts:255

yaw

yaw(): number
Class chain property alias for GetItemYaw and SetItemYaw

Returns number
Overrides Widget.yaw
- Defined in bootstrap.d.ts:1332
yaw<T>(value): Item<T>
Type Parameters
- T = number
Parameters
- value: T | ((this, currentValue) => T)
Returns Item<T>
Overrides Widget.yaw
- Defined in bootstrap.d.ts:1333

`Static` listenerCount

listenerCount(emitter, type): number
Parameters
- emitter: EventEmitter<AnyEmmiter>
- type: string | number
Returns number
Inherited from Widget.listenerCount
- Defined in bootstrap.d.ts:21

Class Item<T>

Note

Type Parameters

T extends ItemEventMap = ItemEventMap

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends ItemEventMap = ItemEventMap

Parameters

itemHandle: HandleHolder<"item">

Returns Item<T>

Type Parameters

T extends ItemEventMap = ItemEventMap

Parameters

itemHandle: Item<ItemEventMap>

Returns Item<T>

Type Parameters

T extends ItemEventMap = ItemEventMap

Parameters

itemId: number

x: number

y: number

Returns Item<T>

Properties

Private #private

Static defaultMaxListeners

Accessors

handle

Returns HandleHolder<string>

Methods

addIndicator

Parameters

red: number

green: number

blue: number

alpha: number

Returns void

addListener

Type Parameters

E extends string | number | symbol

Parameters

event: E

listener: T[E]

Returns Item<T>

animationOffsetPercent

Returns number

Type Parameters

T = number

Parameters

value: T | ((this, currentValue) => T)

Returns Item<T>

blzAddAbility

Parameters

abilCode: number

Returns boolean

blzGetAbility

Parameters

abilCode: number

Returns HandleHolder<"ability">

blzGetAbilityByIndex

Parameters

index: number

Returns HandleHolder<"ability">

blzGetBooleanField

Parameters

whichField: HandleHolder<"itembooleanfield">

Returns boolean

blzGetDescription

Returns string

blzGetExtendedTooltip

Returns string

blzGetIconPath

Returns string

blzGetIntegerField

`Private` #private

`Static` defaultMaxListeners