Light
Light Play Light is a tool that simulates real-world optical properties and can add realism and beauty to a game scene.
Functions
get_light_by_scene_id
Get the Light according to the scene ID.
Parameter
Return
cli.get_light_by_scene_id(scene_id)
get_light_attribute
Get the light attribute.
Parameter
Return
light:get_light_attribute(key)
get_light_cast_shadow_state
Get whether the light casts a shadow.
Return
light:get_light_cast_shadow_state()
create_point_light_at_point
Create a point light to a point.
Parameters
Return
light.create_point_light_at_point(point, deviation_height)
create_point_light_at_unit_socket
Create a point light to a unit socket.
Parameters
light.create_point_light_at_unit_socket(unit, socket_name, deviation_height)
create_directional_light_at_point
Create directional light to point.
Parameters
light.create_directional_light_at_point(point, deviation_height, unit_point_projectile, target_deviation_height)
create_directional_light_at_unit_socket
Create a directional Light to a unit mount point.
Parameters
light.create_directional_light_at_unit_socket(unit, socket_name, deviation_height, target_unit, target_deviation_height)
remove_light
Remove light.
set_shadow_casting_status
Set whether the light casts shadows.
Parameter
light:set_shadow_casting_status(is_cast_shadow)
set_point_light_attribute
Set the point light attribute.
Parameters
light:set_point_light_attribute(light_attr_type_name, value)
set_directional_light_attribute
Set the directional light attribute.
Parameters
light:set_directional_light_attribute(light_attr_type_name, value)