Overview

Ability

Ability is one of the basic elements within the project and needs to be hooked up to a unit and released by the unit to produce a subsequent effect.

Functions

Show table

Function	Description
enable	Enable abilitys.
disable	Disable the ability.
restart_cd	Enter cooldown.
remove	Finish cooling.
complete_cd	Complete cooling.
set_level	Set ability level.
increase_cd	Increase cooldown.
set_stack_count	Set the number of energized layers.
set_float_attr	Set the real number attribute.
set_int_attr	Set the integer attribute.
set_remaining_cd	Set the remaining cooldown time.
add_level	Add an ability level.
add_stack_count	Add a ability charge level.
add_remaining_cd	Add the remaining cooldown of the ability.
add_float_attr	Add a real number attribute
add_int_attr	Add an integer attribute
set_name	Set the ability name.
set_description	Set the ability description
learn_ability	Learn abilitys.
set_remaining_charge_time	Set the remaining charge time of the ability.
set_cast_range	Set the casting range of the ability.
set_player_attr_cost	Set ability player attribute cost.
add_player_attr_cost	Increase ability player attribute cost.
set_is_impacted_by_cd_reduce	Set whether the ability is affected by the cooldown reduction.
set_is_cost_hp_can_die	Set whether consuming life will kill.
set_can_cast_when_hp_insufficient	Set whether the ability can be released when life is low.
set_sector_indicator_radius	Set the sector indicator radius.
set_sector_indicator_angle	Set the sector indicator angle.
set_arrow_or_multistage_indicator_length	Set the length of the arrow/multistage indicator.
set_arrow_or_multistage_indicator_width	Set arrow/multistage indicator width.
set_circle_indicator_radius	Set the radius of the arrow circle indicator.
set_indicator_type	Set the ability indicator type.
set_normal_attack_preview_state	Set the player's attack preview state.
set_smart_cast_with_indicator	Set whether the player's indicator is displayed when smart casting.
show_ability_indicator	Show the ability indicator.
hide_ability_indicator	Disable the ability indicator.
is_influenced_by_cd_reduce	Whether it is influenced by cooldown reduction or not.
is_cost_hp_can_die	Whether costing life will kill or not.
is_can_cast_when_hp_insufficient	Whether insufficient life can be released or not.
has_tag	Whether it has a tag or not.
api_get_stack_cd_left_time	Get the current remaining charge time of the ability.
get_type	Gets the ability classification.
get_ability_type_id	Get the ability type ID (object code ID).
get_ability_index	Get the ability bit where the ability is located.
get_player_attr_cost	Get the value of the player attribute consumed by the ability.
get_cast_type	Get the ability release type.
check_ability_key_precondition	Check ability type precondition.
is_ability_type_influenced_by_cd_reduce	Whether the ability type is influenced by cooldown reduction.
get_icon_id_by_ability_type	Get the image ID of the icon for the ability type.
get_related_ability	Get related abilitys.
get_formula_kv	Get the KV of the ability formula type.
get_float_attr	Get the real number attribute.
get_string_attr	Get a string attribute.
get_ability_owner	Get the owner of the ability.
get_cd_left_time	Get the current cooldown time.
is_exist	Get whether the ability exists or not.
ability_selected_target_item	The target item selected by the ability.
ability_selected_target_unit	The target unit selected by the ability.
ability_selected_destructible	Ability selected target destructible.
selected_location_by_ability	Ability selected points.
get_ability_cast_direction	Get the direction of the ability release -- waiting for data to be processed.
get_ability_by_unit_and_seq	Get the ability in the event.

Ability triggers need to be included in a group to use group variables.

Events

Show table

Event	Description
Ability gained	Get ability event.
Ability lost	Loss of ability event.
Learn ability (ability point consumed)	Upgrade ability event
About to castability	Upcoming spell event.
Ability anticipation starts	Cast start event.
Ability anticipation ends	Spellcasting event.
Ability continuous casting ends	Spell completion event.
Ability continuous casting starts	Spellcasting event.
Ability CD ends	Ability Cooldown Completion Event.
Casting stops	Cast stop event.
Ability continuous casting starting interrupted	Spellcasting shot was interrupted event.
Ability anticipation starting interrupted	Casting start is interrupted event.
Ability anticipation ending interrupted	Casting channel is interrupted event.
Ability level changed (including being changed by triggers)	Ability level change event.

Area

The Area is one of the base elements within the project that can be controlled against a fixed region, triggering the unit to enter and leave the region event.

Functions

Show table

Function	Description
get_circle_area_by_scene_id	Get the circle area by scene ID.
get_rectangle_area_by_scene_id	Get the rectangle area by scene ID.
get_polygon_area_by_scene_id	Get polygon area by scene ID.
get_lua_area_from_py	Create area from py object.
add_trigger	Add a trigger to the area.
remove_area	Remove an area.
set_collision	Set area collision.
add_tag	Add a tag to the area.
remove_area_tag	Remove a tag from an area.
has_tag	Whether the area has a tag or not.
set_area_visibility	Set the visibility of the polygon area to the player.
set_circle_area_radius	Set the radius of the circle area.
set_rectangle_area_size	Set the radius of the rectangle area.
get_circle_area_radius	Get the radius of the circle area.
get_circle_area_min_x	Get the minimum X coordinate in the circle area.
get_circle_area_min_y	Get the minimum Y coordinate in the circle area.
get_circle_area_max_x	Get the maximum X coordinate in the circle area.
get_circle_area_max_y	Get the maximum Y coordinate in the circle area.
get_rectangle_area_min_x	Get the minimum X coordinate in the rectangle area.
get_rectangle_area_min_y	Get the minimum Y coordinate in the rectangle area.
get_rectangle_area_max_x	Get the maximum X coordinate in the rectangle area.
get_rectangle_area_max_y	Get the maximum Y coordinate in the rectangle area.
get_circle_area_center_point	Get the center point of the circle area.
get_random_point_in_circle_area	Get random points in a circle area.
get_rectangle_area_center_point	Get the rectangle area center point.
get_random_point_in_rectangle_area	Get random points in rectangle area.
get_weather	Get the weather of the area.
get_all_unit_in_area	All units (groups of units) in the area.
get_unit_group_in_area	Player units in area (unit group).
get_unit_num_in_area	The number of units in the area.
get_usable_map_range	Get the full map area.
get_rectangle_area_last_created	Get the last created rectangle area.
create_circle_area	Create a circular area.
create_rectangle_area	Creates a rectangle area.
create_rectangle_area_from_two_points	Creates a rectangle area from two points.
get_circle_areas_by_tag	Circle area -- iterate through the tags to do the action.

Beam

You can create beam between units or points.

Functions

Function	Description
create_unit_to_point	Create beam (from unit to point).
create_unit_to_unit	Create a beam (from unit to unit).
create_point_to_unit	Create a beam (from point to unit).
create_point_to_point	Create a beam (from point to point).
remove_link_sfx	Destroy a beam.
enable_link_sfx_show	Show/hide a beam.
set_link_sfx_point	Set to point.
set_link_sfx_unit_socket	Set to unit hookup point.

Camera

The camera is one of the basic elements within the project. The game camera is the tool that controls the player's point of view.

Functions

Show table

Function	Description
get_camera_by_scene_id	Get the camera by scene ID.
get_camera_by_scene_id	Whether the player camera is playing an animation or not.
create_camera	Create a camera.
apply_camera	Apply the camera.
enable_camera_move	Allow the player camera to move.
disable_camera_move	Disable player camera movement.
play_camera_timeline	Play the camera animation.
stop_camera_timeline	Stop the camera animation.
camera_shake_with_decay	Camera shake with decay.
camera_shake	Camera shake camera.
linear_move_by_time	Linear move (time).
set_camera_follow_unit	Set the camera follow unit.
cancel_camera_follow_unit	Set the camera to cancel following.
set_tps_follow_unit	Set the camera's third-person follow unit.
cancel_tps_follow_unit	Cancel the third-person follow unit of the camera.
look_at_point	Set the camera to face the point.
set_max_distance	Set the maximum height of the camera.
set_rotate	Set the camera angle.
set_distance	Set the focus distance.
set_focus_height	Set the focus height of the camera.
limit_in_rectangle_area	Limit the camera movement area.
cancel_area_limit	Turn off camera limit movement.
set_moving_with_mouse	Set whether the camera can be moved with the mouse.
set_mouse_move_camera_speed	Set the camera moving speed (mouse).
set_keyboard_move_camera_speed	Set the camera move speed (keyboard).
get_player_camera_direction	Get the player camera direction.
get_camera_center_raycast	Get the collision point of the player's camera center ray.

Destructible

Destructible is one of the basic elements in the project, which can be directly created on the map, generally immovable, and can interact with skills.

Functions

Show table

Function	Description
create_destructible	Create destructible.
destroy	Kill destructible.
delete	Delete destructible.
resurrect	Revive destructible.
move_to_point	Move to target point.
set_hp	Set health.
add_hp	Increase current health.
set_max_hp	Set max health.
add_max_hp	Increase max health.
set_current_resource_number	Set the current number of resources.
add_current_resource_number	Increase the current resource count.
set_max_resource_number	Set the maximum number of resources.
add_max_resource_number	Increase the maximum number of resources.
set_name	Set the name of the destructible.
set_description	Set the description of the destructible.
set_scale	Set the scale of the destructible.
set_rotation	Set the destructible to face.
set_height	Set the height of the destructible.
add_height	Increased height of destructibles.
set_lockable_by_ability	Whether the setting can be locked by the skill indicator.
set_attackable	Whether the setting can be attacked or not.
set_selectable	Whether the setting can be selected or not.
set_gatherable	Whether the setting can be collected or not.
add_tag	Add label.
remove_tag	Remove label.
play_animation.	Play animation.
stop_animation	Stop animation.
replace_model	Replace model.
cancel_replace_model	Cancel replace model.
set_visible	Show/hide destructibles.
is_lockable_by_ability	Whether the destructible object can be selected by skill indicators or not.
is_attackable	Whether the destructible object can be attacked.
is_selectable	Whether the destructible object can be selected.
is_collectable	Whether the destructible object can be harvested.
is_visible	Whether the destructible is visible or not.
is_alive	Whether the destructible is alive or not.
has_tag	Whether the destructible has a tag or not.
get_destructible_type	Get the destructible type.
get_destructible_name	Get the name of the destructible.
get_destructible_description	Get destructible description.
get_destructible_current_hp	Get the health of a destructible.
get_destructible_source_name	Get the resource name of the destructible.
get_destructible_max_hp	Get the maximum health of a destructible.
get_current_source_number	Get the current resource count of the destructible.
get_max_source_number	Get the maximum number of resources for destructibles.
get_resource_type	Get the player property of the destructible.
get_item_type	Get the item type of the destructible.
get_model	Get the model of the destructible.
get_height	Get the height of the destructible.
get_rotation	Get the facing angle of the destructible.
get_position	Get the position of the destructible object.
get_name_by_type	Get the name of the destructible type.
get_description_by_type	Get the description of the destructible type.
get_model_by_type	Get the model of the destructible type.
destructible_in_event	Destructibles in events.

Destroyable triggers need to be contained in a group to use group variables.

Item

Item is one of the basic elements in a project, which can be placed on the map or held by units.

Functions

Show table

Function	Description
remove	Delete item.
drop_to_point	Drop item to point.
transfer_to_point	Move item to point.
set_name	Set the name of the item.
set_description	Set item description.
set_icon	Set the item's icon.
set_creator	Set owning player.
set_level	Set level.
set_charges	Set the number of charges.
add_charges	Increase the number of charges.
set_max_charges	Set the maximum number of charges.
set_stacks	Set the number of stacks.
add_stacks	Increase the number of stacks.
set_basic_attributes	Set basic properties.
add_basic_attributes	Increase basic attributes.
set_hp	Set health.
add_passive_ability	Add passive skills to items.
set_droppable	Set discard status.
add_tag	Add tag.
remove_tag	Delete label.
set_sale_state	Set whether the item can be sold.
set_scale	Set item scaling.
set_direction	Set item orientation.
create_item_at_point	Create items to point.
add_item_to_unit	Unit add items.
remove_item_from_unit	Unit removes items.
transfer_item_to_unit	Transfer item type1 item column type2 backpack column.
check_item_key_precondition	Check item type preconditions.
has_tag	Presence tag.
is_in_scene	Whether it is in the scene.
is_in_bar	Whether the item is in inventory.
is_in_bag	Whether the item is in inventory.
get_last_created_item	Recently created items
get_item_buy_price	Get item purchase price.
get_item_sell_price	Get the sale price of the item.
get_item_group_in_area	Get all items in the area.
get_item_type_name	Get item type name.
get_icon_id_by_item_type	Get the image ID of the icon of the item type.
get_item_description_by_type	Get the description of the item type.
get_type	Get item type.
get_owner	Get item owner.
get_position	Get item location.
get_stacks	Get item stack count.
get_charges	Get item charges.
get_max_charge	Get the maximum charge.
get_level	Get item level.
get_hp	Get the health of an item.
get_basic_attributes	Get the basic properties of the item.
get_name	Get item name.
get_description	Get item description.
get_scale	Get item scale.
get_direction	Get the orientation of the item.
get_positive_ability	Active skills for acquiring items.
get_passive_ability	Passive ability to acquire items.
get_item_slot_index	Get the grid position of the item on the unit.
get_creator	The owning player who gets the item.
get_item_slot_type	Get the inventory slot type of the item on the unit.
item_that_triggered_current_event	The item that triggered the current event.
unit_gains_item	Items obtained by the unit.
unit_loses_item	Unit lost item.
unit_uses_item	Items used by the unit.
item_whose_stack_changed	Items with varying stacks.
item_whose_charge_changed	Items that change charge.
item_purchased	Buy items.
item_sold	Sale items.

Item triggers need to be contained in a group to use group variables.

Events

Event	Description
Item created	Item creation event.
Item created as collection	Items are collected and created.
Item pick up	Item acquisition event.
Item lose	Item lost event.
Item used	Item use event.
Item in bag	Item enters backpack event.
Item remove bag	Item leaving inventory slot event.
Item in item bar	Item enters inventory event.
Item remove item bar	Item leaves inventory event.
Item stack changed	Item change layer event.
Item charge changed	Item change charge event.
Item destroy	Item destruction event.

Item group

The item group can perform traversal operations on multiple items in the area.

Functions

Function	Description
get_all_items_in_shapes	Filter all items in the range.

Light

Light Play Light is a tool that simulates real-world optical properties and can add realism and beauty to a game scene.

Functions

Function	Description
get_light_by_scene_id	Get the Light according to the scene ID.
get_light_attribute	Get the light attribute.
get_light_cast_shadow_state	Get whether the light casts a shadow.
create_point_light_at_point	Create a point light to a point.
create_point_light_at_unit_socket	Create a point light to a unit socket.
create_directional_light_at_point	Create directional light to point.
create_directional_light_at_unit_socket	Create a directional Light to a unit mount point.
remove_light	Remove light.
set_shadow_casting_status	Set whether the light casts shadows.
set_point_light_attribute	Set the point light attribute.
set_directional_light_attribute	Set the directional light attribute.

Modifier

Modifier is one of the basic elements in the project, which needs to be placed on the unit to produce the corresponding effect.

Functions

Show table

Function	Description
remove	Remove a modifier.
set_name	Set the name of the modifier.
set_description	Set the description of the modifier object.
set_remaining_time	Set remaining duration.
add_remaining_time	Increase remaining duration.
set_stacks	Set the number of stacked layers.
add_stacks	Increase the number of stacked layers.
set_shield_value	set shield value
add_shield_value	Increase shield value.
has_tag	Whether the modifier has a label or not.
icon_is_visible	Whether the icon of the modifier is visible or not.
get_stacks	Get the stacked number of modifiers.
get_remaining_duration	Get the remaining duration of the modifier.
get_modifier_type	Get the modifier type.
get_modifier_effect_type	Get the modifier effect type.
get_max_stacks	Get the maximum number of stacks for modifiers.
get_modifier_shield	Get a shield with magical effects.
get_affiliated_aura	Get the halo.
get_cycle_time	Get modifier cycle.
get_expended_modifier_duration	The duration of the modifier
get_modifier_aura_effect_type	Get the aura effect type for the modifier.
get_modifier_aura_range	Get the aura range of the modifier.
get_provider	Get the caster of the modifier.
get_receiver	Get the bearer of the modifier.
get_name	Get the name of the modifier object.
get_description	Get the description of the modifier object.
get_level	Get grade.
modifier_type_icon_is_visible	Whether the icon of the modifier type is visible or not.
get_type_of_modifier_entity	The category that gets the modifier.
get_modifier_type_description	Get the description of the modifier type.
get_image_of_modifier_type_icon	Get the picture of the icon of the modifier type.

Magic effect triggers need to be contained in a group to use group variables.

Events

Event	Description
Gain modifier	Get magic effect.
Lose modifier	Lost magic effect.
Period ends	Cycle expires.
Modifier stacks change	Magic effect layer change event.
About to gain modifier	The magic effect is about to be obtained.
Modifier overwritten	Magic effect override.

Particle

Particle implements various effects effects in the game, which can be created to be displayed on points, or units hanging on points.

Functions

Function	Description
create_at_point	Create at point.
remove	Remove.
create_at_unit	Create to unit.
set_rotational_angle	Set the rotation angle.
set_orientation	Set the orientation.
set_scale	Set the scaling.
set_height	Set the height.
set_coordinate	Set the coordinates.
set_animation_speed	Set the animation speed.
set_duration	Set the duration.

Path

Path is one of the basic elements in a project, consisting of multiple point links that can be used as unit movement routes.

Functions

Function	Description
get_path_by_scene_id	Get path by scene ID.
get_lua_path_from_py	Create paths from py objects.
has_tag	Whether the path has a tag or not.
remove_path	Remove path.
add_point	Add a point to a path.
remove_point	Remove a point from a path.
add_tag	Adds a tag to a path.
remove_tag	Remove a tag from a path.
get_point_count	Get the number of points in the path.
create_path	Create a path starting with a point.

Players

The player is the main object within the project and can be played by either the user or the ai.

Functions

Show table

Function	Description
get_save_data_bool_value	Get player archive data.
is_joins_in_the_middle_of_round	Whether the player joins in the middle of the round or not.
players_is_enemy	Whether the players are enemies or not.
is_hotkey_of_basic_operation_is_occupied	Whether the player's basic operation shortcut key is occupied or not.
set_role_name	Set the name.
set_faction_id	Set the team ID.
set_player_attribute	Set the value of the attribute.
add_player_attribute	Add an attribute value.
set_rate_of_gaining_exp	Set the rate of experience gained.
set_hostile_relationship	Set hostile relationship.
set_strict_group_navigation	Set group pathfinding strict mode.
select_unit	Select units/unit groups.
set_follow_distance	Set the following distance.
set_player_mouse_click_selection	Turn on/off mouse click selection for the player.
set_player_mouse_drag_selection	Enable/disable mouse frame selection for the player.
set_player_mouse_wheel	Turn on/turn off the mouse wheel for the player.
set_role_editable_game_func	Set the player's basic action shortcuts (filter out the ones that are disabled).
set_role_all_game_func_enable	Set the player's basic operation switch (contains all basic operations).
set_tech_level	Set tech level.
add_tech_level	Add a tech level.
share_view_with_player	Open view with player.
close_view_with_player	View is closed with player.
share_view_with_unit	Unit is open to player view.
close_view_with_unit	Unit closes the view with respect to the player.
upload_save_data	Upload the archive.
add_global_archive	Add a global archive.
save_data	Set the player archive.
use_purchasable_item	Consume player platform props.
point_is_visible_to_player	Point is visible to the player.
point_is_in_fog_to_player	Point is in the fog.
point_is_in_shadow_to_player	Point is in black shadow.
get_key_related_to_basic_operation	Get the player's basic operation in response to keyboard keystrokes (filter out prohibited settings).
get_player_attribute	Get player attributes.
get_player_id	Get the player ID.
get_game_state	Get the player's game state.
get_control_type	Get the player controller type.
get_name	Get the player name.
get_save_data_table_value	Tabular player archive data.
get_exp_multiplier	Get the experience gain rate.
get_faction_id	Get the team ID.
get_string_player_archive_data	String type player archive data.
get_float_player_archive_data	Real type archive data.
get_tech_level	Gets the tech level.
get_platform_icon	Get the player's platform avatar.
get_player_purchasable_number	Number of player platform props.
get_int_player_archive_data	Get integer type archive data.
get_player_archive_rank_num	Get integer archive player rank.
get_player_platform_level	Get player platform rank.
is_player_in_group	The player is in the player group.
all_units_belonging_to_specified_player	All units belonging to a player.
remove_player	Force kick out.
set_currency_icon	Set the player property icon.
get_player_platform_model	Get the player platform appearance model.
get_mouse_world_coordinates_of_player	Get the mouse's in-game coordinates.
get_proportion_of_player_mouse_screen_coordinate_x	Get the proportion of the player's mouse screen coordinate x.
get_proportion_of_player_mouse_screen_coordinate_y	Get the proportion of the player's mouse screen coordinate Y.
get_player_ui_pos_x	Get the X coordinate of the mouse on the screen.
get_player_ui_pos_y	Get the Y coordinate of the mouse on the screen.
set_currency_icon_for_player_attribute	Get the currency icon for the player attribute.
convert_player_id_to_player	Convert player ID to player.
get_player_attribute_name	Get the name of the player attribute.

Player Group

Player Group can be filtered to store multiple players, and traverse the player group to perform uniform actions on the players in the player group.

Functions

Function	Description
add_player	Add a player.
remove_player	Remove a player.
clear_group	Clear the group.
get_player_num	Get the number of players in a player group.
get_all_players	Get all players.
get_player_group_by_camp	All players in the camp.
get_enemy_player_group_by_player	All hostile players of the player.
get_ally_player_group_by_player	All allied players of the player.
get_victorious_player_group	Get all the victorious players.
get_defeated_player_group	Get all defeated players.
get_neutral_player_group	All non-neutral players.

Point

The point is one of the base elements within the project, and can be used as a prefabricated position, or a coordinate record.

Functions

Function	Description
get_point_by_scene_id	Get area by scene ID.
get_lua_point_from_py	Create points from py objects.
set_collision	Set the collision.
get_ground_collision	Get the collision type of the map at this point.
get_view_block_type	Gets the view type of the map at the point's location.
get_point_x	The X coordinate of the point.
get_point_y	The Y coordinate of the point.
get_point_z	The Z coordinate of the point.
get_point_by_xy	Convert coordinates to points.
get_point_offset_vector	Point offset in the direction.
get_point_in_path	The point in the path.

Projectile

Projectile is one of the basic elements in the project, which can be placed on the scene.

Functions

Show table

Function	Description
add_tag	Add a tag to a projectile.
remove_tag	Remove tag from a projectile.
create_projectile_at_unit_socket	A projectile will be created at the unit mount point.
set_affiliated_unit	Set up the unit.
set_affiliated_ability	Set associated skills.
destroy	Destroy the projectile.
set_height	Set height.
set_coordinate	Set coordinates.
set_orientation	Set orientation.
set_rotation	Set rotation.
set_scale	Set zoom.
set_animation_speed	Set animation speed.
set_duration	Set duration.
increase_duration	Increase duration.
get_type	Type of projectile.
get_projectile_height	Get the height of the projectile.
get_remaining_projectile_duration	Get the remaining duration of the projectile.
affiliated_unit	Get the owner of the projectile.
get_projectile_orientation	Get projectile orientation.
projectile_location_point	Get the point where the projectile is located.
has_tag	Whether the projectile own the tag or not.
all_projectiles_in_filter_range	Filters all projectiles in range.
get_mover_bound_projectiles	Get kinematically bound projectiles.

Projectile triggers need to be contained in a group to use group variables.

Events

Event	Description
Destructible created	Destructible creation.
Destructible revived	Destroyable resurrection.
Destructible died	Destructible death event.
Destructible collected	Destructibles are harvested.
Destructible resource change	Changes in the amount of destructible resources.
Destructible hunted	Destructibles take damage.

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

Function	Description
get_lua_scene_ui_from_py	Get the UI instance of the lua layer from the UI instance of the py layer.
create_scene_ui_at_player_unit_socket	Create a scene interface to a player unit mount point.
remove_scene_ui	Remove the scene interface.
get_widget_in_scene_ui	Get the controls in the scene UI
set_scene_ui_visible_distance	Set the visible distance of the scene interface to the player.

Selector

The selector selector can select multiple units in a certain area by specifying the shape and the corresponding selection rule.

Functions

Function	Description
get_units_in_circular_area
get_projectiles_in_circular_area

Timer

The timer is accurate to milliseconds. A callback function will be executed every time the timer expires.

Functions

Function	Description
get_elapsed_time	Get the elapsed time of the timer.
get_init_count	Get the initial count of the timer.
get_remaining_time	Get the remaining time of the timer.
get_remaining_count	Get the remaining count of the timer.
get_time_out_time	Get the time the timer was set for.

UI

UI is one of the basic elements in the project and one of the important ways for players to interact with the game.

Functions

Show table

Function	Description
get_lua_ui_from_py	Obtain the interface instance of the lua layer through the interface instance of the py layer.
create_ui_widget	Create interface controls.
set_visible	Set the UI control to be visible or hidden.
set_image	Set picture.
set_text	Set text.
set_alpha	Set the transparency of the control.
set_is_draggable	Set whether the control can be dragged.
set_intercepts_operations	Set whether the control intercepts the operation.
set_z_order	Set control depth.
set_max_progress_bar_value	Set the maximum value of the progress bar.
set_current_progress_bar_value	Set the current value of the progress bar.
set_button_enable	Enable/disable button.
set_ui_size	Set control size.
set_font_size	Set text font size.
set_input_field_focus	Let the input box get the focus.
set_skill_on_ui_comp	Bind the skill object to the control.
set_buff_on_ui	Bind the unit to the magic effect display bar component.
set_item_on_ui	Bind the item object to the item component.
set_prefab_ui_visible	Set the switch of the default game interface.
set_ui_model_id	Set the model of the model control.
change_mini_map_img	Change minimap image.
set_ui_unit_slot	Set the item component binding unit.
set_button_shortcut	Set button shortcuts.
set_btn_meta_key	Set button combination shortcut key.
set_skill_btn_smart_cast_key	Set smart casting shortcuts.
set_skill_btn_func_meta_key	Set shortcut keys for smart casting combinations.
set_skill_btn_action_effect	Play/stop skill button activates animation.
set_text_color	Set text color.
change_showroom_fov	Set the camera field of view of the model control.
change_showroom_cposition	Set the camera coordinates of the model control.
change_showroom_crotation	Set the camera rotation of the model control.
create_ui_event	Create interface events.
display_system_information_message	System message prompt.
set_widget_relative_rotation	Set the relative rotation of the control.
set_widget_absolute_coordinates	Set the absolute coordinates of the control.
set_widget_absolute_rotation	Set absolute rotation of the control.
set_widget_absolute_scale	Set the absolute scaling of the control.
set_widget_relative_scale	Set the relative zoom of the control.
change_minimap_display_mode	Set the minimap display mode.
set_slider_value	Set the progress of the slider.
unbind_widget	Unbind controls.
get_ui_comp_children	Traverse the child nodes of an interface control.
play_timeline_animation	Play timeline animation.
set_ui_model_focus_pos	Set model control watchpoint.
bind_unit_attribute_to_player_ui_widget_attribute	Binding unit properties to properties of player interface controls.
bind_global_variable_to_player_ui_widget_attribute	Binding global variables to properties of player interface controls.
unbind_ui_widget_attribute	Unbind interface control property binding.
ui_widget_attribute_bound_to_specified_unit	Interface control property binding specified unit.
set_disable_image_type	Set disabled pictures (picture type).
set_hover_image_type	Set floating picture (picture type).
set_press_image_type	Set the pressed picture (picture type).
bind_player_attribute_to_ui_widget_attribute	Bind player properties to properties of player interface controls.
set_alignment_type_for_ui_widget	Set the alignment of interface components.
enable_drawing_unit_path	Turn on drawing unit path lines.
disable_drawing_unit_path	Turn off drawing unit path lines.
remove_ui_comp	Delete interface controls.
set_ui_comp_bind_ability_cd	Binding skill cooldown time to the property of the player interface control.
set_ui_comp_bind_modifier_cd	A property that binds the magic effect's remaining time to the player interface control.
set_chat_send_enabled	Enable/disable send chat feature.
set_player_chat_show	Show/hide chat box.
clear_player_chat_panel	Clear chat.
send_chat_to_role	Send private message.
create_floating_text	Create floating text.
set_window_mode	Set window.
set_graphics_quality	Set quality.
set_screen_resolution	Screen Resolution.
get_widget_relative_x_coordinate	Get the X of the relative coordinates of the local control.
get_widget_relative_y_coordinate	Get the Y of the relative coordinates of the local control.
get_widget_absolute_x_coordinate	Get the X of the absolute coordinates of the local control.
get_widget_absolute_y_coordinate	Get the Y of the absolute coordinates of the local control.
get_widget_relative_rotation	Get the relative rotation of the local control.
get_widget_absolute_rotation	Get the absolute rotation of the local control.
get_widget_relative_scale_x_coordinate	Get the X of the relative zoom of the local control.
get_widget_relative_scale_y_coordinate	Get the relative scaled Y of the native control.
get_widget_absolute_scale_x_coordinate	Get the X of the absolute scaling of the native control.
get_widget_absolute_scale_y_coordinate	Get the Y of the local control's absolute scaling.
convert_ui_widget_to_string	Interface controls are converted to strings.
get_slider_current_value	Get the current value of the slider.
get_ui_widget_name	Get interface control name.
get_child_widget_of_specified_name	Get the child control with the specified name.
get_widget_width	Get the width of the control.
get_widget_height	Get control height.
get_screen_horizontal_resolution	Get the horizontal resolution of the screen.
get_screen_vertical_resolution	Get the vertical resolution of the screen.
get_parent_widget_of_ui_widget	Get the parent control of the interface control.
get_input_field_content	Get the text content of the player input box.
get_ui_comp_visible	Get control visibility.

UI Prefab

UI Prefab can be used in conjunction with UI, and multiple UI modules can be used.

Functions

Function	Description
get_lua_ui_prefab_from_py	Get the interface instance of lua layer from the interface instance of py layer.
create_ui_prefab_instance	Create an interface module instance.
set_show_room_background_color	Set the background color of the interface model control.
remove_ui_prefab	Example of removing an interface module.
get_ui_prefab_child_by_path	Get the controls under the interface module instance by the interface module path.

Unit

Unit is one of the basic elements in the project, skill and magic effect need to be attached to the unit to produce subsequent effects.

Functions

Function	Description
create_unit	Create unit.
remove_unit	Delete unit.Deleting a unit will trigger a Unit Destroyed Event.
Teleport_to_Point	Move unit to point instant. Units may get stuck in weird positions if the target point is not reachable.
set_unit_to_point	Force move unit to point. After smooth movement is checked, the unit will translate to the target point, forcing the movement to ignore restrictions such as collisions.
resurrect_unit	Resurrection unit to target point. Only units that have not been destroyed can be revived.
heals	Heal the unit.
add_tag	Label an organization.
remove_tag	Remove an organization's label.
add_state	Add status to unit. The unit's status exists counted, that is, after being added twice, it needs to be removed twice before it can actually be removed.
remove_state	Remove the status of the unit. The unit's status exists counted, that is, after being added twice, it needs to be removed twice before it can actually be removed.
learns_ability	Let units learn skills. Learning requires skill points.
release_command	Issue orders to units.
set_orientation	Set the orientation of the unit. The unit will slowly turn its face towards it during the turn time.
set_name	Set the name of the unit.
set_description	Set the description of the unit.
set_attributes	Set the properties of the unit
increase_attributes	Add unit properties. Negative values decrease.
set_level	Set the level of the unit. Downgrading does not reclaim skill points.
increase_level	Increase the level of the unit. Downgrading does not reclaim skill points.
set_exp	Set the unit's current experience.
increase_exp	Add experience to units.
set_current_hp	Set the unit's current health.
increase_current_hp	Increase the unit's current health.
set_current_mp	Set the unit's current mana.
increase_current_mp	Increase the unit's current mana.
set_hero_ability_point	Set the number of skill points for a unit.
increase_hero_ability_point	Add skill points to units.
set_unit_height	Set the flying height of the unit. After changing the altitude, the unit will slowly move past within the changing time.
set_life_cycle	Set the lifecycle of the unit. After the life cycle runs out, the unit will die naturally.
set_pause_state_of_life_cycle	Set a unit's lifecycle paused state.
set_alert_range	Set the alert range of the unit.
set_cancel_alert_range	Set the unit's disarm range.
set_unit_pkg_cnt	Set the number of slots in the unit's inventory slot.
set_unit_bar_cnt	Set the number of slots in the unit's inventory.
set_default_switch_behavior	Set the default behavior of units.
set_attr_growth	Set the property growth of the unit.
set_unit_reward_exp	Set the experience value reward for the unit being killed.
set_unit_reward_res	Set the attribute reward of the killed player.
set_attack_type	Set the unit's attack type.
set_armor_type	Set the armor type of the unit.
enable_afterimage	Turn on afterimages of units.
disable_afterimage	Turn off the afterimage of the unit.
set_afterimage_color	Set the afterimage color for units.
set_afterimage_time	Set the afterimage time for the unit.
set_unit_avatar	Set unit avatar.
set_blood_bar_type	Set the unit's health bar style.
set_health_bar_display	Set the health bar display mode of the unit.
set_minimap_avatar_for_unit	Set the unit minimap avatar.
set_minimap_avatar_for_enemy_unit	Set the minimap portrait of the enemy unit.
set_model_scale	Set model scaling in units.
set_turning_speed	Set the unit's turn speed.
replace_model	Replace model.
cancel_replace_model	Cancel model replacement. Restore the unit's model to how it was originally.
set_semitransparency_when_hidden_unit_is_visible	Set whether to be translucent or not when invisible.
set_corpse_recyclable_status_after_fading	Set whether to recycle or not after the corpse disappears.
set_Xray_is_open	Set perspective state.
add_tech_to_unit	Units add technology.
remove_tech_from_unit	Unit delete technology.
research_tech	Research technology.
play_animation	play animation.
stop_animation	Stop animation.
change_animation	Replace animation.
cancel_change_animation	Cancel animation replacement.
clear_change_animation	reset animation replacement
stop_cur_animation	Stop the currently playing animation.
set_animation_speed	Set the animation playback rate.
add_item	Add items to the store.
remove_item	Remove item from store.
set_item_stock	Set the inventory of items in the store.
sell_item_to_shop	Sell items to shop.
purchase_item_from_shop	Purchase items from the store.
remove_item_from_unit	Unit removes items.
transfer_item_to_unit	Transfer items.
add_item_to_unit	Unit add items.
add_modifier	Add magic effects to units.
remove_modifier_type	Unit removal magic effect type.
delete_all_modifiers_by_effect_type	Remove magic effects that affect the type.
get_specified_modifier_type	Get the magic effect of the specified type for the unit.
get_recovery_interval_of_shop_goods	Get the stock interval of store items.
get_remaining_recovery_time_of_shop_goods	Get the remaining recovery time of a store item.
remove_abilities_in_type	Remove skills (specific types).
get_abilities_by_type	Get a specific type of skill.
add_ability	Add skills.
remove_ability	Remove skill.
get_ability_by_type	Find skills by skill name.
get_ability_by_slot	Acquiring the skill of a certain skill position.
get_item_by_slot	Get the item in the unit's backpack slot.
get_all_items	All items in the unit.
kill_unit	Kill unit.
create_illusion	Create illusion.
unit_gains_tech	Units gain technology.
change_unit_role	Set owning player.
get_tech_list	Traversing research and development technology to do actions.
get_affect_techs	Traversing applied technology doing actions.
get_shop_item_list	Iterate through the items in the store to perform actions.
get_current_unit_hp	Get the current health value.
get_current_unit_mp	Get the current mana.
get_attr_other	Get the property of the unit's extra property type.
get_attr_base	Get the property of the unit's base property type.
get_attr_base_ratio	Get the attribute of the unit's basic attribute bonus type.
get_attr_bonus	Get properties of unity gain property type.
get_attr_all_ratio	Get the attribute of the unit's total attribute bonus type.
get_attr_bonus_ratio	Get the attribute of the unit gain attribute bonus type.
get_unit_attribute_growth	Get unit attribute growth.
get_life_cycle_of_unit	Get unit lifecycle.
get_height	Get unit flight altitude.
get_unit_turning_speed	Get unit turn speed.
get_unit_alert_range	Get unit alert range.
get_unit_cancel_alert_range	Get unit cancel alert range.
get_unit_collision_radius	Get the unit collision radius.
get_unit_resource_cost	Get unit construction resource consumption property.
get_player_attribute_gained_from_killing_unit	Get the attribute of the player who was killed by the unit.
get_scale	Get the unit scale.
get_unit_selection_range_scale	Get unit selection circle zoom.
get_unit_xaxis_scale	Get the X-axis scaling of the unit.
get_unit_zaxis_scale	Get the Z-axis scaling of the unit.
get_unit_yaxis_scale	Get the Y-axis scaling of the unit.
get_shop_purchase_range	Get the purchase scope of the store.
get_unit_level	Get unit level.
get_key	Get the unit type ID of the unit.
get_current_exp_of_unit	Get the current experience value of the unit.
get_exp_required_for_current_upgrade	Gain the experience needed for the unit's current upgrade.
get_hero_ability_point_number	Get the hero's skill points.
get_unit_bag_slot_number	Get the number of slots in the unit's inventory.
get_unit_inventory_slot_number	Get the number of slots in the unit's inventory.
get_item_type_number_of_unit	Get the number of item types owned by the unit.
get_exp_gained_from_killing_unit	Get unit kill experience.
get_shield_value_of_specified_type_for_unit	Get the shield value of the specified shield type for the unit.
get_shop_tab_number	Get the number of store tabs.
get_shop_item_stock	Get the store's item inventory.
get_unit_name	Get unit name.
get_unit_description	Get the description of the unit.
get_unit_type_name	Get unit type name.
get_unit_type_description	Get the description of the unit type.
get_shop_tab_name	Get the store's page signature.
get_unit_subtype	Get unit classification.
get_image_of_unit_type_icon	Get the avatar of the unit type.
get_unit_type	Get unit type.
last_unit_created	Last created unit.
get_unit_owner	Get the owner of the unit unit.
get_illusion_summoner	Get the summoner of visions.
get_unit_orientation	Get the orientation of the unit.
get_armor_type	Get armor type.
get_attack_type	Get attack type.
get_shop_goods	Get items from the store.
get_current_unit_model	Get the current model of the unit.
get_original_unit_model	Get the original model of the unit.
get_unit_location_point	Get the location of the unit.
get_nearest_reachable_point_to_unit	Get the nearest passable point of the unit.
get_camp	Get unit's team.
has_tag	Whether to have a label or not.
is_unit_alive	Whether to survive or not.
visibility_of_unit	Whether it is visible or not.
is_unit_moving	Whether the unit is moving or not.
is_in_radius	Whether it is near the unit or not.
unit_is_shop	Whether the unit is a store or not.
is_unit_illusion	Whether the unit is an illusion or not.
unit_in_group	Whether the unit is in the unit group or not.
is_in_battle	Whether the unit is in combat or not.
has_buff_status	Whether the unit has a designated status or not.
check_has_ability_type	Whether the unit has a specific type of skill or not.
unit_has_item	Whether there are items or not.
unit_has_item_name	Whether there are items of the specified type or not.
unit_has_modifier	Whether the unit has magic effect or not.
unit_has_modifier_style	Whether the unit has magic effects of the specified affect type or not.
unit_has_modifier_tag	Whether the unit has the magic effects with specified tags or not.
check_unit_key_precondition	Whether the unit type precondition is passed or not.
is_enemy_relation	Whether the unit is a hostile relationship or not.
can_teleport_to	Whether the unit can be sent to the point or not.
unit_can_collide_with_point	Whether to collide with the point or not.
unit_can_from_point_to_point	Whether pathfinding is reachable or not.
get_unit_move_collision	Whether to have the specified collision type or not.
get_unit_player	Get the player the unit belongs to.

Unit triggers need to be included in a group to use group variables.

Events

Show table

Event	Description
Before unit die	Dying.
Unit Die	Die.
Kill unit	Kill event.
Unit born	Create.
Revive unit	Rebirth.
Upgrade unit	Upgrade.
Unit pre add exp	About to gain experience.
Unit on add exp	Get experience.
Unit be hurt	Hurt.
Unit hurt other	Cause some damages.
Unit hurt other finish	After inflicting damage.
Unit be hurt complete	After being hurt.
Unit get cure	Be treated.
Unit releaseability	Cast skills.
Unit start move	Start moving.
Unit enter battle	Enter combat state.
Unit exit battle	Out of combat.
Unit enter grass	Into the grass.
Unit leave grass	Leave the grass.
Unit on command	Request order.
Ability plus point	Learning skills.
Unit remove	Delete.

Unit group

Unit Group allows you to put multiple units in a group for uniform processing.

Functions

Show table

Function	Description
pick_unit_in_unit_group_to_perform_action	Iterate through the units in a unit group to perform an action.
select_unit_by_unit_group	Select units by unit group.
add_unit	Add a unit.
remove_unit	Remove a unit.
remove_unit_type	Remove unit type.
integer_random_units_from_unit_group	Random integer units from a unit group
number_of_units_in_unit_group	Get the number of units in a unit group.
get_number_of_units_of_specified_type_in_unit_group	Number of unit types in a unit group.
get_the_first_unit_in_a_unit_group	Get the first unit in a unit group.
get_random_unit_from_unit_group	Get a random unit from a unit group.
get_last_unit_in_unit_group	Get the last unit in a unit group.
get_number_of_units_in_specified_state_in_unit_group	The number of units in a state in a unit group.
filter_unit_in_area	Filter all units in the range.
unit_of_a_specified_unit_type	Unit of a specified unit type.

Overview Ability