• Reference
  • LUA API
  • Classes
  • Scene UI

Scene UI

The Scene UI is used in conjunction with the UI, which can be placed on a scene or unit pendant for display.

Functions

get_lua_scene_ui_from_py

Get the UI instance of the lua layer from the UI instance of the py layer.

Parameters

VariableTypeDescription
py_scene_uistring

Return

TypeDescription
tableReturn the lua layer skill instance after initialization in the lua layer.
scene_ui.get_lua_scene_ui_from_py(player, py_scene_ui)

create_scene_ui_at_player_unit_socket

Create a scene interface to a player unit mount point.

Parameters

VariableTypeDescription
scene_ui_typenumberScene UI type.
playerplayerPlayer.
unitunitUnit.
socket_namestringName of the hookup point.
distancenumberVisible distance.

Return

TypeDescription
scene_uiScene UI.
scene_ui.create_scene_ui_at_player_unit_socket(scene_ui_type, player, unit, socket_name, distance)

remove_scene_ui

Remove the scene interface.

scene_ui:remove_scene_ui()

get_widget_in_scene_ui

Get the controls in the scene UI

Return

TypeDescription
ui
scene_ui:get_widget_in_scene_ui(str)

set_scene_ui_visible_distance

Set the visible distance of the scene interface to the player.

Parameters

VariableTypeDescription
playerplayerPlayer.
disnumberVisible distance.
scene_ui:set_scene_ui_visible_distance(player, dis)