Class: MockSound

Mock of the X-Ray engine sound action enumeration.

Implements

• sound

Constructors

Constructor

new MockSound(...args: unknown[]): MockSound;

Parameters

Parameter	Type
...args	unknown[]

Returns

MockSound

Methods

completed()

completed(): boolean;

Returns

boolean

Whether sound playback is complete.

Implementation of

sound.completed

---

set_angles()

set_angles(vector: vector): void;

Set sound angles.

Parameters

Parameter	Type	Description
vector	vector	Angles.

Returns

void

Implementation of

sound.set_angles

---

set_bone()

set_bone(value: string): void;

Set sound bone.

Parameters

Parameter	Type	Description
value	string	Bone name.

Returns

void

Implementation of

sound.set_bone

---

set_position()

set_position(vector: vector): void;

Set sound position.

Parameters

Parameter	Type	Description
vector	vector	Position.

Returns

void

Implementation of

sound.set_position

---

set_sound()

set_sound(value: string | sound_object): void;

Set sound by name.

Parameters

Parameter	Type	Description
value	string | sound_object	Sound name.

Returns

void

Implementation of

sound.set_sound

---

set_sound_type()

set_sound_type(type: TXR_snd_type): void;

Set sound type.

Parameters

Parameter	Type	Description
type	TXR_snd_type	Sound type id.

Returns

void

Implementation of

sound.set_sound_type

---

create()

static create(...args: unknown[]): MockSound;

Parameters

Parameter	Type
...args	unknown[]

Returns

MockSound

---

mock()

static mock(...args: unknown[]): sound;

Parameters

Parameter	Type
...args	unknown[]

Returns

sound

Properties

__name

__name: string = "sound";

LuaBind instance constructor name.

Implementation of

sound.__name

---

angles

angles: vector | null = null;

---

args

args: unknown[];

---

bone

bone: string | null = null;

---

isCompleted

isCompleted: boolean = false;

---

position

position: vector | null = null;

---

sound

sound: string | sound_object | null = null;

---

soundType

soundType: TXR_snd_type | null = null;

---

attack

readonly static attack: 3;

Engine enum value for sound.attack.

---

attack_hit

readonly static attack_hit: 4;

Engine enum value for sound.attack_hit.

---

die

readonly static die: 7;

Engine enum value for sound.die.

---

eat

readonly static eat: 2;

Engine enum value for sound.eat.

---

idle

readonly static idle: 1;

Engine enum value for sound.idle.

---

panic

readonly static panic: 11;

Engine enum value for sound.panic.

---

steal

readonly static steal: 10;

Engine enum value for sound.steal.

---

take_damage

readonly static take_damage: 5;

Engine enum value for sound.take_damage.

---

threaten

readonly static threaten: 9;

Engine enum value for sound.threaten.