Class: particle

Particle playback action.

Source

C++ class particle

Custom Constructor

particle

Remarks

Bone-attached particles require the controlled object visual to contain the requested bone. Position-only particles use world coordinates.

Extends

• EngineBinding

Constructors

Constructor

new particle(
   particle_to_run: string, 
   particle_params?: particle_params, 
   auto_remove?: boolean): particle;

Create a particle action.

Parameters

Parameter	Type	Description
particle_to_run	string	Particle effect name.
particle_params?	particle_params	Optional transform parameters.
auto_remove?	boolean	Whether the particle should be removed after playback.

Returns

particle

Overrides

EngineBinding.constructor

Constructor

new particle(
   particle_to_run: string, 
   bone_name: string, 
   particle_params: particle_params, 
   auto_remove: boolean): particle;

Create a particle action attached to a bone.

Parameters

Parameter	Type	Description
particle_to_run	string	Particle effect name.
bone_name	string	Bone name.
particle_params	particle_params	Transform parameters.
auto_remove	boolean	Whether the particle should be removed after playback.

Returns

particle

Overrides

EngineBinding.constructor

Methods

completed()

completed(): boolean;

Returns

boolean

Whether particle playback is complete.

---

set_angles()

set_angles(vector: vector): void;

Set particle angles.

Parameters

Parameter	Type	Description
vector	vector	Angles.

Returns

void

---

set_bone()

set_bone(bone_id: string): void;

Set attached bone.

Parameters

Parameter	Type	Description
bone_id	string	Bone name.

Returns

void

---

set_particle()

set_particle(value1: string, value2: boolean): void;

Set particle effect and auto-remove flag.

Parameters

Parameter	Type	Description
value1	string	Particle effect name.
value2	boolean	Whether the particle should be removed after playback.

Returns

void

---

set_position()

set_position(vector: vector): void;

Set particle position.

Parameters

Parameter	Type	Description
vector	vector	Position.

Returns

void

---

set_velocity()

set_velocity(vector: vector): void;

Set particle velocity.

Parameters

Parameter	Type	Description
vector	vector	Velocity.

Returns

void

Properties

__name

readonly __name: string;

LuaBind instance constructor name.

Inherited from

EngineBinding.__name

---

__name

readonly static __name: string;

LuaBind class constructor name.

Inherited from

EngineBinding.__name