• Reference
  • LUA API
  • Classes
  • Beam

Beam

You can create beam between units or points.

Functions

create_unit_to_point

Create beam (from unit to point).

Parameters

VariableTypeDescription
res_idintegerType ID of the link effect.
unitunitUnit.
socket_namestringName of the linking point.
pointpointPoint.
end_heightnumberEndpoint height.
durationnumberDuration.
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

VariableTypeDescription
res_idintegerLink effect type ID.
unitunitUnit.
socket_namestringName of the hookup point.
target_unitunitTarget unit.
target_socket_namestringName of the target unit's mount point.
durationnumberDuration.
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

VariableTypeDescription
res_idintegerBeam type ID.
pointpointPoint.
start_heightnumberStarting height.
target_unitunitTarget unit.
target_socket_namestringName of the target unit mount point.
durationnumberDuration.
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

VariableTypeDescription
res_idintegerBeam type ID.
pointpointPoint.
start_heightnumberStarting height.
target_pointpointTarget point.
end_heightnumberEnd point height.
durationnumberDuration.
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

VariableTypeDescription
is_showbooleanWhether to show.
beam:display_or_hide(is_show)

set_link_sfx_point

Set to point.

Parameters

VariableTypeDescription
point_type_namestringStart or end point.
pointpointStarting point.
heightnumberHeight of the target point.
beam:set_to_point(point_type_name, point, height)

set_link_sfx_unit_socket

Set to unit hookup point.

Parameters

VariableTypeDescription
point_type_namestringStart or end point.
unitunitUnit.
socket_namestrName of the mount point.
beam:set_to_unit_socket(point_type_name, unit, socket_name)