Beam
You can create beam between units or points.
Functions
create_unit_to_point
Create beam (from unit to point).
Parameters
Variable | Type | Description |
---|---|---|
res_id | integer | Type ID of the link effect. |
unit | unit | Unit. |
socket_name | string | Name of the linking point. |
point | point | Point. |
end_height | number | Endpoint height. |
duration | number | Duration. |
beam.create_unit_to_point(res_id, unit, socket_name, point, end_height, duration)
create_unit_to_unit
Create a beam (from unit to unit).
Parameters
Variable | Type | Description |
---|---|---|
res_id | integer | Link effect type ID. |
unit | unit | Unit. |
socket_name | string | Name of the hookup point. |
target_unit | unit | Target unit. |
target_socket_name | string | Name of the target unit's mount point. |
duration | number | Duration. |
beam.create_unit_to_unit(res_id, unit, socket_name, target_unit, target_socket_name, duration)
create_point_to_unit
Create a beam (from point to unit).
Parameters
Variable | Type | Description |
---|---|---|
res_id | integer | Beam type ID. |
point | point | Point. |
start_height | number | Starting height. |
target_unit | unit | Target unit. |
target_socket_name | string | Name of the target unit mount point. |
duration | number | Duration. |
beam.create_point_to_unit(res_id, point, start_height, target_unit, target_socket_name, duration)
create_point_to_point
Create a beam (from point to point).
Parameters
Variable | Type | Description |
---|---|---|
res_id | integer | Beam type ID. |
point | point | Point. |
start_height | number | Starting height. |
target_point | point | Target point. |
end_height | number | End point height. |
duration | number | Duration. |
beam.create_point_to_point(res_id, point, start_height, target_point, end_height, duration)
remove_link_sfx
Destroy a beam.
beam:destroy()
enable_link_sfx_show
Show/hide a beam.
Parameter
Variable | Type | Description |
---|---|---|
is_show | boolean | Whether to show. |
beam:display_or_hide(is_show)
set_link_sfx_point
Set to point.
Parameters
Variable | Type | Description |
---|---|---|
point_type_name | string | Start or end point. |
point | point | Starting point. |
height | number | Height of the target point. |
beam:set_to_point(point_type_name, point, height)
set_link_sfx_unit_socket
Set to unit hookup point.
Parameters
Variable | Type | Description |
---|---|---|
point_type_name | string | Start or end point. |
unit | unit | Unit. |
socket_name | str | Name of the mount point. |
beam:set_to_unit_socket(point_type_name, unit, socket_name)