Class Widget<T>

Note

ASUNA!!!

Type Parameters

T extends WidgetEventMap = WidgetEventMap

Hierarchy

Handle<T>
- Widget

Index

Constructors

Properties

#private defaultMaxListeners

Accessors

Constructors

constructor

new Widget<T>(handleHolder): Widget<T>
Type Parameters
- T extends WidgetEventMap = WidgetEventMap
Parameters
- handleHolder: Widget<WidgetEventMap> | HandleHolder<"widget" | "unit" | "item" | "destructable">
Returns Widget<T>
Overrides Handle.constructor
- Defined in bootstrap.d.ts:237

Properties

`Private` #private

#private: any

`Static` defaultMaxListeners

defaultMaxListeners: number

Accessors

handle

get handle(): HandleHolder<string>
Returns HandleHolder<string>
Inherited from Handle.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
- Defined in bootstrap.d.ts:320

addListener

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

animationOffsetPercent

animationOffsetPercent(): number
Class chain property alias for GetWidgetAnimationOffsetPercent and SetWidgetAnimationOffsetPercent

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

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 Handle.emit
- Defined in bootstrap.d.ts:31

equals

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

eventNames

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

getCurrentAnimationId

getCurrentAnimationId(): number
Class member alias for GetWidgetCurrentAnimationId

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

getCurrentAnimationName

getCurrentAnimationName(): string
Class member alias for GetWidgetCurrentAnimationName

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

getFacing

getFacing(): number
Class member alias for GetWidgetFacing

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

getMaxListeners

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

getModelObjectPositionLoc

getModelObjectPositionLoc(whichObject): Location
Class member alias for GetWidgetModelObjectPositionLoc
Parameters
- whichObject: string
Returns Location
- Defined in bootstrap.d.ts:430

getModelObjectX

getModelObjectX(whichObject): number
Class member alias for GetWidgetModelObjectX
Parameters
- whichObject: string
Returns number
- Defined in bootstrap.d.ts:415

getModelObjectY

getModelObjectY(whichObject): number
Class member alias for GetWidgetModelObjectY
Parameters
- whichObject: string
Returns number
- Defined in bootstrap.d.ts:420

getModelObjectZ

getModelObjectZ(whichObject): number
Class member alias for GetWidgetModelObjectZ
Parameters
- whichObject: string
Returns number
- Defined in bootstrap.d.ts:425

getScreenX

getScreenX(): number
Class member alias for GetWidgetScreenX

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

getScreenY

getScreenY(): number
Class member alias for GetWidgetScreenY

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

getSprite

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

Returns HandleHolder<"sprite">
- Defined in bootstrap.d.ts:325

getTypeId

getTypeId(): number
Class member alias for GetWidgetTypeId

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

getVertexColour

getVertexColour(): number
Class member alias for GetWidgetVertexColour

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

invulnerable

invulnerable(): boolean
Class chain property alias for IsWidgetInvulnerable and SetWidgetInvulnerable

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

isTargetAllowed

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

life

life(): number
Class chain property alias for GetWidgetLife and SetWidgetLife

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

listenerCount

listenerCount<E>(event): number
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
Returns number
Inherited from Handle.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 Handle.listeners
- Defined in bootstrap.d.ts:35

model

model(): string
Class chain property alias for GetWidgetModel and SetWidgetModel

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

off

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

on

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

once

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

pitch

pitch(): number
Class chain property alias for GetWidgetPitch and SetWidgetPitch

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

positionLoc

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

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

prependListener

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

prependOnceListener

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

queueAnimation

queueAnimation(animationName): void
Class member alias for QueueWidgetAnimation
Parameters
- animationName: string
Returns void
- Defined in bootstrap.d.ts:460

queueAnimationByIndex

queueAnimationByIndex(animIndex): void
Class member alias for QueueWidgetAnimationByIndex
Parameters
- animIndex: number
Returns void
- Defined in bootstrap.d.ts:455

rawListeners

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

removeAllListeners

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

removeListener

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

resetMatrix

resetMatrix(): void
Class member alias for ResetWidgetMatrix

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

roll

roll(): number
Class chain property alias for GetWidgetRoll and SetWidgetRoll

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

scale

scale(): number
Class chain property alias for GetWidgetScale and SetWidgetTimeScale

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

setAnimationWithRarity

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

setAnimationWithRarityByIndex

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

setFacing

setFacing(facing, isInstant): void
Class member alias for SetWidgetFacing
Parameters
- facing: number
- isInstant: boolean
Returns void
- Defined in bootstrap.d.ts:370

setMaterialTexture

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

setMatrixScale

setMatrixScale(x, y, z): void
Class member alias for SetWidgetMatrixScale
Parameters
- x: number
- y: number
- z: number
Returns void
- Defined in bootstrap.d.ts:375

setMaxListeners

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

setModelEx

setModelEx(modelFile, playerId): void
Class member alias for SetWidgetModelEx
Parameters
- modelFile: string
- playerId: number
Returns void
- Defined in bootstrap.d.ts:395

setOrientation

setOrientation(yaw, pitch, roll): void
Class member alias for SetWidgetOrientation
Parameters
- yaw: number
- pitch: number
- roll: number
Returns void
- Defined in bootstrap.d.ts:390

setOrientationEx

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

setPosition

setPosition(x, y): void
Class member alias for SetWidgetPosition
Parameters
- x: number
- y: number
Returns void
- Defined in bootstrap.d.ts:340

setReplaceableTexture

setReplaceableTexture(textureName, textureIndex): void
Class member alias for SetWidgetReplaceableTexture
Parameters
- textureName: string
- textureIndex: number
Returns void
- Defined in bootstrap.d.ts:410

setTexture

setTexture(textureName, textureIndex): void
Class member alias for SetWidgetTexture
Parameters
- textureName: string
- textureIndex: number
Returns void
- Defined in bootstrap.d.ts:405

setVertexColour

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

timeScale

timeScale(): number
Class chain property alias for GetWidgetTimeScale and SetWidgetTimeScale

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

visible

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

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

x

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

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

y

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

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

yaw

yaw(): number
Class chain property alias for GetWidgetYaw and SetWidgetYaw

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

`Static` listenerCount

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

Generated using TypeDoc