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
Variable | Type | Description |
---|---|---|
sfx_id | integer | Special effect type ID. |
point | point | Point. |
direction | number | Direction. |
scale | number | Scale. |
height | number | Height. |
duration | number | Duration. |
Return
Type | Description |
---|---|
particle | Special effects. |
particle.create_at_point(sfx_id, point, direction, scale, height, duration)
remove
Remove.
particle:remove()
create_at_unit
Create to unit.
Parameters
Variable | Type | Description |
---|---|---|
sfx_id | integer | Special effect type ID. |
unit | unit | Unit. |
socket | string | Direction. |
scale | number | Scale. |
height | number | Height. |
duration | number | Duration. |
Return
Type | Description |
---|---|
particle | Special effects. |
particle.create_at_unit(sfx_id, unit, socket, rotate_type, is_scale, scale, height, duration)
set_rotational_angle
Set the rotation angle.
Parameters
Variable | Type | Description |
---|---|---|
x | number | X-axis angle. |
y | number | Y-axis angle. |
z | number | Z-axis angle. |
particle:set_rotational_angle(x, y, z)
set_orientation
Set the orientation.
Parameter
Variable | Type | Description |
---|---|---|
direction | number | Direction. |
particle:set_orientation(direction)
set_scale
Set the scaling.
Parameters
Variable | Type | Description |
---|---|---|
x | number | X-axis scaling. |
y | number | Y-axis scaling. |
z | number | Z-axis scaling. |
particle:set_scale(x, y, z)
set_height
Set the height.
Parameter
Variable | Type | Description |
---|---|---|
height | number | Height. |
particle:set_height(height)
set_coordinate
Set the coordinates.
Parameter
Variable | Type | Description |
---|---|---|
point | point | Point. |
particle:set_coordinate(point)
set_animation_speed
Set the animation speed.
Parameter
Variable | Type | Description |
---|---|---|
speed | number | Speed. |
particle:set_animation_speed(speed)
set_duration
Set the duration.
Parameter
Variable | Type | Description |
---|---|---|
duration | number | Duration. |
particle:set_duration(duration)