• Reference
  • LUA API
  • Classes
  • Particle

Particle

Particle implements various effects effects in the game, which can be created to be displayed on points, or units hanging on points.

Functions

create_at_point

Create at point.

Parameters

VariableTypeDescription
sfx_idintegerSpecial effect type ID.
pointpointPoint.
directionnumberDirection.
scalenumberScale.
heightnumberHeight.
durationnumberDuration.

Return

TypeDescription
particleSpecial effects.
particle.create_at_point(sfx_id, point, direction, scale, height, duration)

remove

Remove.

particle:remove()

create_at_unit

Create to unit.

Parameters

VariableTypeDescription
sfx_idintegerSpecial effect type ID.
unitunitUnit.
socketstringDirection.
scalenumberScale.
heightnumberHeight.
durationnumberDuration.

Return

TypeDescription
particleSpecial effects.
particle.create_at_unit(sfx_id, unit, socket, rotate_type, is_scale, scale, height, duration)

set_rotational_angle

Set the rotation angle.

Parameters

VariableTypeDescription
xnumberX-axis angle.
ynumberY-axis angle.
znumberZ-axis angle.
particle:set_rotational_angle(x, y, z)

set_orientation

Set the orientation.

Parameter

VariableTypeDescription
directionnumberDirection.
particle:set_orientation(direction)

set_scale

Set the scaling.

Parameters

VariableTypeDescription
xnumberX-axis scaling.
ynumberY-axis scaling.
znumberZ-axis scaling.
particle:set_scale(x, y, z)

set_height

Set the height.

Parameter

VariableTypeDescription
heightnumberHeight.
particle:set_height(height)

set_coordinate

Set the coordinates.

Parameter

VariableTypeDescription
pointpointPoint.
particle:set_coordinate(point)

set_animation_speed

Set the animation speed.

Parameter

VariableTypeDescription
speednumberSpeed.
particle:set_animation_speed(speed)

set_duration

Set the duration.

Parameter

VariableTypeDescription
durationnumberDuration.
particle:set_duration(duration)