Class Destructable<T>

Note

ASUNA!!!

Type Parameters

T extends DestructableEventMap = DestructableEventMap

Hierarchy

Widget<T>
- Destructable

Index

Constructors

constructor

new Destructable<T>(destructableHandle): Destructable<T>
Type Parameters
- T extends DestructableEventMap = DestructableEventMap
Parameters
- destructableHandle: HandleHolder<"item">
Returns Destructable<T>
Overrides Widget.constructor
- Defined in bootstrap.d.ts:984
new Destructable<T>(destructableHandle): Destructable<T>
Type Parameters
- T extends DestructableEventMap = DestructableEventMap
Parameters
- destructableHandle: Destructable<DestructableEventMap>
Returns Destructable<T>
Overrides Widget<T>.constructor
- Defined in bootstrap.d.ts:985
new Destructable<T>(destructableId, x, y, face, scale, variation): Destructable<T>
Type Parameters
- T extends DestructableEventMap = DestructableEventMap
Parameters
- destructableId: number
- x: number
- y: number
- face: number
- scale: number
- variation: number
Returns Destructable<T>
Overrides Widget<T>.constructor
- Defined in bootstrap.d.ts:986

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): Destructable<T>
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- listener: T[E]
Returns Destructable<T>
Inherited from Widget.addListener
- Defined in bootstrap.d.ts:23

animationOffsetPercent

animationOffsetPercent(): number
Class chain property alias for GetDestructableAnimationOffsetPercent and SetDestructableAnimationOffsetPercent

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

blighted

blighted(): boolean
Class chain property alias for IsDestructableBlighted and SetDestructableBlighted

Returns boolean
- Defined in bootstrap.d.ts:1033
blighted<T>(value): Destructable<T>
Type Parameters
- T = boolean
Parameters
- value: T | ((this, currentValue) => T)
Returns Destructable<T>
- Defined in bootstrap.d.ts:1034

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

getCurrentAnimationId

getCurrentAnimationId(): number
Class member alias for GetDestructableCurrentAnimationId

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

getCurrentAnimationName

getCurrentAnimationName(): string
Class member alias for GetDestructableCurrentAnimationName

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

getFacing

getFacing(): number
Class member alias for GetDestructableFacing

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

getMaxListeners

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

getModelObjectPositionLoc

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

getModelObjectX

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

getModelObjectY

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

getModelObjectZ

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

getName

getName(): string
Class member alias for GetDestructableName

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

getScreenX

getScreenX(): number
Class member alias for GetDestructableScreenX

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

getScreenY

getScreenY(): number
Class member alias for GetDestructableScreenY

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

getSprite

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

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

getTypeId

getTypeId(): number
Class member alias for GetDestructableTypeId

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

getVertexColour

getVertexColour(): number
Class member alias for GetDestructableVertexColour

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

invulnerable

invulnerable(): boolean
Class chain property alias for IsDestructableInvulnerable and SetDestructableInvulnerable

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

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

kill

kill(): void
Class member alias for KillDestructable

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

life

life(): number
Class chain property alias for GetDestructableLife and SetDestructableLife

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

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 GetDestructableMaxLife and SetDestructableMaxLife

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

model

model(): string
Class chain property alias for GetDestructableModel and SetDestructableModel

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

occluderHeight

occluderHeight(): number
Class chain property alias for GetDestructableOccluderHeight and SetDestructableOccluderHeight

Returns number
- Defined in bootstrap.d.ts:1021
occluderHeight<T>(value): Destructable<T>
Type Parameters
- T = number
Parameters
- value: T | ((this, currentValue) => T)
Returns Destructable<T>
- Defined in bootstrap.d.ts:1022

off

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

on

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

once

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

pitch

pitch(): number
Class chain property alias for GetDestructablePitch and SetDestructablePitch

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

positionLoc

positionLoc(): Location
Class chain property alias for GetDestructablePositionLoc and SetDestructablePositionLoc

Returns Location
Overrides Widget.positionLoc
- Defined in bootstrap.d.ts:1039
positionLoc<T>(value): Destructable<T>
Type Parameters
- T = Location
Parameters
- value: T | ((this, currentValue) => T)
Returns Destructable<T>
Overrides Widget.positionLoc
- Defined in bootstrap.d.ts:1040

prependListener

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

prependOnceListener

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

queueAnimation

queueAnimation(whichAnimation): void
Class member alias for QueueDestructableAnimation
Parameters
- whichAnimation: string
Returns void
Overrides Widget.queueAnimation
- Defined in bootstrap.d.ts:1107

queueAnimationByIndex

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

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

remove

remove(): void
Class member alias for RemoveDestructable

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

removeAllListeners

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

removeListener

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

resetMatrix

resetMatrix(): void
Class member alias for ResetDestructableMatrix

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

restoreLife

restoreLife(life, birth): void
Class member alias for DestructableRestoreLife
Parameters
- life: number
- birth: boolean
Returns void
- Defined in bootstrap.d.ts:1102

roll

roll(): number
Class chain property alias for GetDestructableRoll and SetDestructableRoll

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

scale

scale(): number
Class chain property alias for GetDestructableScale and SetDestructableTimeScale

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

setAnimationWithRarity

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

setAnimationWithRarityByIndex

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

setFacing

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

setMaterialTexture

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

setMatrixScale

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

setMaxListeners

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

setModelEx

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

setOrientation

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

setOrientationEx

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

setPosition

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

setPositionWithZ

setPositionWithZ(x, y, z): void
Class member alias for SetDestructablePositionWithZ
Parameters
- x: number
- y: number
- z: number
Returns void
- Defined in bootstrap.d.ts:1132

setReplaceableTexture

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

setTexture

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

setVariationEx

setVariationEx(variation, ignoreStateCheck): void
Class member alias for SetDestructableVariationEx
Parameters
- variation: number
- ignoreStateCheck: boolean
Returns void
- Defined in bootstrap.d.ts:1122

setVertexColour

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

show

show(flag): void
Class member alias for ShowDestructable
Parameters
- flag: boolean
Returns void
- Defined in bootstrap.d.ts:1112

timeScale

timeScale(): number
Class chain property alias for GetDestructableTimeScale and SetDestructableTimeScale

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

variation

variation(): number
Class chain property alias for GetDestructableVariation and SetDestructableVariation

Returns number
- Defined in bootstrap.d.ts:1027
variation<T>(value): Destructable<T>
Type Parameters
- T = number
Parameters
- value: T | ((this, currentValue) => T)
Returns Destructable<T>
- Defined in bootstrap.d.ts:1028

visible

visible(): boolean
Class chain property alias for IsWidgetVisible and SetWidgetVisible

Returns boolean
Inherited from Widget.visible
- Defined in bootstrap.d.ts:260
visible<T>(value): Destructable<T>
Type Parameters
- T = boolean
Parameters
- value: T | ((this, currentValue) => T)
Returns Destructable<T>
Inherited from Widget.visible
- Defined in bootstrap.d.ts:261

x

x(): number
Class chain property alias for GetDestructableX and SetDestructableX

Returns number
Overrides Widget.x
- Defined in bootstrap.d.ts:997
x<T>(value): Destructable<T>
Type Parameters
- T = number
Parameters
- value: T | ((this, currentValue) => T)
Returns Destructable<T>
Overrides Widget.x
- Defined in bootstrap.d.ts:998

y

y(): number
Class chain property alias for GetDestructableY and SetDestructableY

Returns number
Overrides Widget.y
- Defined in bootstrap.d.ts:1003
y<T>(value): Destructable<T>
Type Parameters
- T = number
Parameters
- value: T | ((this, currentValue) => T)
Returns Destructable<T>
Overrides Widget.y
- Defined in bootstrap.d.ts:1004

yaw

yaw(): number
Class chain property alias for GetDestructableYaw and SetDestructableYaw

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

`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 Destructable<T>

Note

Type Parameters

T extends DestructableEventMap = DestructableEventMap

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends DestructableEventMap = DestructableEventMap

Parameters

destructableHandle: HandleHolder<"item">

Returns Destructable<T>

Type Parameters

T extends DestructableEventMap = DestructableEventMap

Parameters

destructableHandle: Destructable<DestructableEventMap>

Returns Destructable<T>

Type Parameters

T extends DestructableEventMap = DestructableEventMap

Parameters

destructableId: number

x: number

y: number

face: number

scale: number

variation: number

Returns Destructable<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 Destructable<T>

animationOffsetPercent

Returns number

Type Parameters

T = number

Parameters

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

Returns Destructable<T>

blighted

Returns boolean

Type Parameters

T = boolean

Parameters

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

Returns Destructable<T>

emit

Type Parameters

E extends string | number | symbol

Parameters

event: E

Rest ...args: Parameters<(T & AnyEmmiter)[E]>

Returns boolean

equals

Parameters

anotherHandle: Handle<HandleEventMap>

Returns boolean

eventNames

Returns (string | symbol)[]

`Private` #private

`Static` defaultMaxListeners

`Rest` ...args: Parameters<(T & AnyEmmiter)[E]>