Class: Destructable

Hierarchy

• Widget

  ↳ Destructable

Constructors

constructor

new Destructable(objectId: number, x: number, y: number, z: number, face: number, scale: number, varation: number): Destructable

Creates a destructable at the specified coordinates.

Parameters:

Name	Type	Description
objectId	number	The rawcode of the destructable to be created.
x	number	The x-coordinate of the Destructable.
y	number	The y-coordinate of the Destructable.
z	number	The z-coordinate of the Destructable.
face	number	The facing of the Destructable.
scale	number	The X-Y-Z scaling value of the Destructable.
varation	number	The integer representing the variation of the Destructable to be created.

Returns: Destructable

Defined in: handles/destructable.ts:7

Properties

handle

• Readonly handle: destructable

Overrides: Widget.handle

Defined in: handles/destructable.ts:7

Accessors

id

id(): number

Get the unique ID of the handle. The ID is recycled once you destroy the object.

Returns: number

The unique ID of a handle object.

Defined in: handles/handle.ts:18

---

invulnerable

invulnerable(): boolean

Returns: boolean

Defined in: handles/destructable.ts:31

invulnerable(flag: boolean): void

Parameters:

Name	Type
flag	boolean

Returns: void

Defined in: handles/destructable.ts:27

---

life

life(): number

Returns: number

Defined in: handles/destructable.ts:35

life(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Defined in: handles/destructable.ts:39

---

maxLife

maxLife(): number

Returns: number

Defined in: handles/destructable.ts:43

maxLife(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Defined in: handles/destructable.ts:47

---

name

name(): string

This will return different values depending on the locale.

Returns: string

Defined in: handles/destructable.ts:54

---

occluderHeight

occluderHeight(): number

Returns: number

Defined in: handles/destructable.ts:58

occluderHeight(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Defined in: handles/destructable.ts:62

---

typeId

typeId(): number

Returns: number

Defined in: handles/destructable.ts:66

---

x

x(): number

Returns: number

Defined in: handles/destructable.ts:70

---

y

y(): number

Returns: number

Defined in: handles/destructable.ts:74

Methods

destroy

destroy(): void

Returns: void

Defined in: handles/destructable.ts:78

---

heal

heal(life: number, birth: boolean): void

Resurrects a Destructable with the specified hit points.

Parameters:

Name	Type	Description
life	number	The amount of hit points the Destructable will have when it is resurrected. A value of 0, or any value above the Destructable's maximum HP, will give the Destructable its maximum HP (as defined in the object editor). Any value below 0.5 will give the Destructable 0.5 hit points.
birth	boolean	If true, the Destructable will play its birth animation upon resurrection.

Returns: void

Defined in: handles/destructable.ts:90

---

kill

kill(): void

Returns: void

Defined in: handles/destructable.ts:94

---

queueAnim

queueAnim(whichAnimation: string): void

Parameters:

Name	Type
whichAnimation	string

Returns: void

Defined in: handles/destructable.ts:98

---

setAnim

setAnim(whichAnimation: string): void

Parameters:

Name	Type
whichAnimation	string

Returns: void

Defined in: handles/destructable.ts:102

---

setAnimSpeed

setAnimSpeed(speedFactor: number): void

Parameters:

Name	Type
speedFactor	number

Returns: void

Defined in: handles/destructable.ts:106

---

show

show(flag: boolean): void

Parameters:

Name	Type
flag	boolean

Returns: void

Defined in: handles/destructable.ts:110

---

fromEvent

static fromEvent(): Destructable

Returns: Destructable

Overrides: Widget

Defined in: handles/destructable.ts:114

---

fromHandle

static fromHandle(handle: destructable): Destructable

Parameters:

Name	Type
handle	destructable

Returns: Destructable

Overrides: Widget

Defined in: handles/destructable.ts:118