Overview

Common

Functions

Show table

Function	Description
remove_kv	Clear the key value of the instance.
remove_unit_kv	Clear unit type key.
remove_item_kv	Clear item type key.
remove_ability_kv	Clear skill type key.
remove_prefab_kv	Clear Destroyables/Technology/Projectiles/Magic Effects/Type Keys.
cleartag	Clear label.
create_random_pool	Create a random pool.
set_weight_of_specified_number	Set random pool to specify integer weight.
remove_specified_number	The random pool removes the specified integer.
pick_random_pool	Traverse the random pool.
display_info_to_player	Tip the player.
increase_weight_of_specified_number	The random pool increases the specified integer weight.
separate_string	Split string array.
get_camp_by_camp_id	Get camp.
stringtobool	String type to bool.
set_cascaded_shadow_distance	Set shadow distance.
remove_timer	Delete timer.
pause_timer	Pause timer.
resume_timer	Resume timer.
set_terrain_texture_at_a_specified_point	Set the terrain texture for a point.
replace_specified_terrain_texture_in_region	Replace the specified terrain texture within the area.
set_region_weather	Set regional weather.
set_global_weather	Set global weather.
set_player_filter_effect	Set player's filter effect.
display_player_terrain_texture	Show/Hide Player Surface Textures.
enable_vignetting	Set dark corner switch.
set_vignetting_size	Set vignette size.
set_vignetting_breathing_period	Set vignette breathing cycle.
set_vignetting_changing_amplitude	Set the variation range of vignetting.
set_vignetting_color	Set vignette color.
set_fog_attribute	Set fog properties.
set_cascaded_shadow_enable	Switch Cascaded Shadows
set_post_effect	Switch style for player
insert_table_value	Insert values into the table.
remove_nth_table_value	Delete the N-th value of a one-dimensional table.
pick_table	Traverse the table.
pick_table_ordered	Traversing the table (preserving order).
dump_table	Print sheet.
new_empty_table	Create empty table.
copy_table	Copy table.
pause_game	Pause game.
start_new_round_of_game	Start a new game.
enable_soft_pause	Enable soft pause.
resume_soft_pause	Resume soft pause.
set_damage_factor	Set damage factor.
set_compound_attributes	Set composite properties.
set_game_time_elapsing_rate	Set how fast game time passes.
set_game_time	Set game time.
create_artificial_time	Create artificial time.
set_random_seed	Set random number seed.
toggle_time_elapsing_is_on	Switching time lapse.
toggle_target_point_grassland_is_on	Grass at switch target point.
clear	Empty.
play_screen_particle_for_a_set_duration	Create screen effects.
set_variable	Set variable.
play_sound_for_player	Play sound.
stop_sound_for_player	Stop playing sound.
play_3d_sound_for_player	Play 3D sound.
follow_object_play_3d_sound_for_player	Play sound with unit.
set_sound_volume	Set sound volume.
print_to_dialog	Print log.
test_show_message_tip	Display interface test information.
test_log_message	Record API test log (optional display).
get_icon_id	Get the picture of the icon icon of the skill/buff/item/unit.
get_obj_from_data	Get the contents of the data table.
all_conditions_succeed	All conditions are met.
any_conditions_succeed	Either condition holds.
all_conditions_failed	None of the conditions is met.
get_str_length	Get string length.
pos_in_str	Index of the target character in the string.
get_tech_max_level	Get the maximum level of technology.
get_player_ui_pos_x	Get the player's mouse screen coordinate X.
get_player_ui_pos_y	Get the player's mouse screen coordinate X.
get_player_pointing_pos	Get the player's mouse coordinates.
get_instance_location_point	Get the location of the projectile/item/unit/destructible object.
get_team	Get the team of the player/unit.
str_to_unit_command_type	String to unit command type.
str_to_point	String to point.
str_to_ability_cast_type	String transfer skill release type.
str_to_link_sfx_key	String to link effect.
str_to_role_relation	String to Player Relationship.
str_to_unit_type	String to unit classification.
str_to_unit_key	String to unit type.
str_to_unit_name	String to unit property.
str_to_item_key	String to item type.
str_to_role_res	String to player attribute.
str_to_role_status	String to player state.
str_to_role_type	String to player control state.
str_to_ability_key	String to skill type.
str_to_ability_type	String to skill slot type.
str_to_dest_key	String to destructible type.
str_to_project_key	String to projectile type.
str_to_particle_sfx_key	String to special effect.
str_to_tech_key	String to technology type.
str_to_model_key	String to model type.
str_to_modifier_key	String to magic effect type.
str_to_modifier_effect_type	String to magic effect effect type.
str_to_modifier_type	String to magic effect category.
str_to_camp	String to alignment.
str_to_keyboard_key	String to keyboard key.
str_to_mouse_key	String to mouse button.
str_to_mouse_wheel	String to mouse wheel.
str_to_store_key	String to platform prop type.
str_to_damage_type	String to damage type.
str_to_unit_attr_type	String to unit attribute type.
str_to_audio_key	String to sound type.
get_icon_id	Get pictures according to the picture ID.
move_to_pos	Move.
stop	Stop.
garrison	Stationed.
attack_move	Attack move.
attack_target	Target.
move_along_path	Move along the path.
cast_ability	Release skills.
pick_up_item	Pick up items.
discard_item	Discarded items.
give_item	Give items.
use_item	Items used.
follow	Follow.
empty	Empty command.
table_length	Table length.
get_max_tech_level	Get the maximum level of technology.
get_tech_icon	Get tech icons.
get_tech_type_from_event	Get the technology type in the event.
get_tech_type_description	Get the description of the technology type.
get_tech_type_name	Get the name of the technology type.
get_current_game_mode	Get the current game mode.
get_local_language_environment	Get locale.
current_game_run_time	The time the game has been running.
get_current_game_time	Get the current time of the game.
get_damage_factor	Get damage factor.
get_coefficient	Get the slave coefficient of the 3D attribute.
get_game_environment_of_current_round	Get the game environment of this game.
get_global_archive	Get global archive.
get_archive_rank_player_archive_value	Get integer save leaderboard player save value.
if_pri_attr_state_open	Whether to enable 3D attributes or not.
get_mover_bound_projectiles	Get kinematically bound projectiles.
get_tech_changed_level	Get the level of technology change.
trigger_modifier	Trigger magic effect.
tech_researched	Researched technology.
get_unit_in_event	Get the units in the event.
modifier_receiver	Magic effect carrier.
get_ability_owner	Get the owner of the skill.
modifier_provider	Magic effect caster.
ability_selected_target_item	The target item selected by the skill.
picked_modifier	The magic effect traversed.
player_that_triggered_current_event	The player who triggered the current event.
projectile_that_triggered_current_event	The projectile that triggered the current event.
ability_selected_target_unit	Get the unit selected by the skill.
get_modifier_stack_changed_value	Get the change value of the magic effect layer.
tech_upgraded_or_downgraded	Level-up technology.
item_selected_in_picking_item_group	The selected item when traversing the item group.
level_changed_tech	Level-changing technology.
get_damage_or_healing_target_unit	Get the unit taking damage (healing).
picked_unit_in_unit_group	Get the units traversed in the unit group.
get_killer_unit	Get killer unit.
get_picked_projectile	Get the projectiles traversed.
get_dead_unit	Get dead unit.
Get_Damage_or_Healing_Source_Unit	Get the unit dealing damage (healing).
unit_to_gain_item	Get item unit.
unit_to_lose_item	Lost item unit.
unit_to_use_item	Use item units.
unit_to_change_stacks	Holder of items with varying stacks.
get_unit_about_to_gain_modifier	Get units about to get magic effects.
last_unit_to_make_purchase	The unit that made the last purchase.
last_unit_to_make_sale	The unit that was last sold.
get_current_array_index	Get the current array index.
ability_that_triggered_current_event	Ability that triggers the current event.
ability_selected_destructible	The target destructible object selected by the skill.
destructible_in_event	Destructibles in events.
damage_value_that_triggered_current_event	The amount of damage that triggers the current event.
item_that_triggered_current_event	The item that triggered the current event.
unit_gains_item	Unit gets items.
unit_loses_item	Unit lost item.
unit_uses_item	Items used by the unit.
item_whose_stack_changed	Items with stacked layer changes.
item_whose_charge_changed	Charged Change Items.
item_purchased	Buy items.
item_sold	Sale items.
selected_location_by_ability	The point selected by the skill.
string_in_event	String in event.
mover_collision_unit	Kinematic collision unit.
get_unit_in_destructible_event	Get unit in destructible event.
get_current_damage_type	Get the current damage type.
player_resource_type_involved_in_the_event	Player resource type in event.
unit_group_involved_in_the_event	Unit group in event.
current_purchasable	Current platform props.
convert_float_to_angle	Real rotation angle.
convert_angle_to_float	Angle to real number.
get_ability_cast_direction	Get the skill release direction.
unit_in_destroy_destructible_event	Units in destructible death events.
unit_in_destructible_is_damaged_event	Units in destructible damage events.
unit_in_destructible_is_gathered_event	The unit in the event that the destructible is harvested.
resource_change_value_in_destructible_event	Resource change value in destructible event.
ability_in_destructible_event	Ability Objects in destructible events.
number_of_player_attributes_gathered_in_destructible_event	The number of collected player attributes in destructible object events.
damage_value_in_destructible_event	Damage value in destructible event.
get_ability_by_unit_and_seq	Get skills from events.
get_build_unit	Get the construction unit in the event.
get_healing_value_before_settlement	Get the value of this treatment (before settlement).
get_mover_bound_units	Get the kinematics binding unit.
all_units_belonging_to_specified_player	All units belonging to a player.
unit_of_a_specified_unit_type	Units of the specified unit type.
number_random_units_from_unit_group	Random integer number of units in the 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	The number of unit types in the unit group.
get_the_first_unit_in_a_unit_group	Get the first unit in the unit group.
get_random_unit_from_unit_group	Gets a random unit in the unit group.
get_last_unit_in_unit_group	Get the last unit in the unit group.
get_object_from_data	Get object from data.
is_point_in_area	Whether the point is within the region or not.
string_to_bool	String to boolean.
get_global_weather	Get global weather.
player_keyboard_key_is_pressed	Whether the player keyboard key is pressed.
player_mouse_key_is_pressed	Whether the player mouse is pressed.
check_tech_key_precondition	Check technology type preconditions.
joint_string	String concatenation.
extract_string	Intercept string.
delete_sub_string	Remove substring.
get_text_config	Get multilingual content.
get_random_pool_probability	Get the weight probability of the specified integer in the random pool.
get_int_value_from_random_pool	Get a random integer from the random pool.
get_random_pool_all_weight	Get the total weight of the random pool.
get_random_pool_size	Get the number of integers in the random pool.
get_random_pool_pointed_weight	Get the weight of the specified integer in the random pool.
get_point_ground_height	Get the level of the map at this point.
get_random_seed	Get random seed.
get_game_init_time_stamp	Get the game start timestamp.
get_game_x_resolution	Get the initial horizontal resolution.
get_game_y_resolution	Get the initial vertical resolution.
get_graphics_quality	Get the initial game quality.
get_window_mode	Get the initialized window class.

Math

Functions

Show table

Function	Description
get_random_angle	Get a random angle.
get_points_angle	Get the angle between vector (O, `point_1`) and vector (O, `point_2`).
create_annular_shape	Annular area.
create_circular_shape	Circular region.
create_rectangle_shape	Rectangle region.
create_sector_shape	Sector.
int_to_float	Convert an integer to a real number.
string_to_float	Convert a string to a real number.
random_float_with_min_and_max	Random real number in range.
get_two_points_distance	Compute the distance between two points.
float_plus_one	Real number plus 1.
sin	Sine.
cos	Cosine.
tan	Tangent.
asin	Arcsine.
acos	Arccosine.
atan	Arctangent.
sqrt	Square root.
pow	Find the power.
abs	Find the absolute value.
log10	Logarithm based on 10.
log	Value is based on the logarithm of base.
round_dec	Result after keeping X decimal places.
get_minor_between_two_float	Get the smaller value between a real number and another real number.
get_bigger_between_two_float	Get the larger value between a real number and another real number.
float_to_int	Convert a float to an integer.
string_to_int	String to integer.
get_random_int	Random integer in range.
get_minor_between_two_int	Get the smaller value between two integers.
get_bigger_between_two_int	Get the larger value between two integers.
int_plus_one	Integer plus 1.

Util

Functions

Show table

Function	Description
remove_kv	Clear the key value of the instance.
remove_unit_kv	Clear unit type key value.
remove_item_kv	Clear item type key value.
remove_ability_kv	Clear skill type key.
remove_prefab_kv	Clear destructible objects/technology/projections/magic effects/type key.
cleartag	Clear tags.
create_random_pool	Create random pools.
set_weight_of_specified_number	Set random pool to specify integer weights.
remove_specified_number	Random pool to remove specified integers.
pick_random_pool	Iterating over a random pool.
display_info_to_player	Tips to players.
increase_weight_of_specified_number	Add specified integer weights to the random pool.
separate_string	Splitting an array of strings.
get_camp_by_camp_id	Get a camp.
stringtobool	Convert string type to bool.
set_cascaded_shadow_distance	Set shadow distance.
remove_timer	Delete timer.
pause_timer	Pause timer.
resume_timer	Resume timer.
set_terrain_texture_at_a_specified_point	Set the terrain texture of a point.
replace_specified_terrain_texture_in_region	Replace the specified terrain texture in the area.
set_region_weather	Set regional weather.
set_global_weather	Set global weather.
set_player_filter_effect	Set the player's filter effect.
display_player_terrain_texture	Show/hide player ground textures.
enable_vignetting	Set dark corner switch.
set_vignetting_size	Set dark corner size.
set_vignetting_breathing_period	Set dark corner breathing cycle.
set_vignetting_changing_amplitude	Set the dark angle change range.
set_vignetting_color	Set dark corner color.
set_fog_attribute	Set the fog effect properties.
set_cascaded_shadow_enable	Switch cascade shading.
set_post_effect	Switching the painting style for players.
set_table_value	Set the value of a one-dimensional table.
set_table_value_multi	Set the value of a multi-dimensional table.
insert_table_value	Insert values into a table.
remove_nth_table_value	Delete the N-th value of a one-dimensional table
pick_table
Traverse the table.
pick_table_ordered	Traverse the table (order preserving).
dump_table	Print the form.
new_empty_table	Create an empty table.
copy_table	Copy the table.
enable_soft_pause	Turn on soft pause.
resume_soft_pause	Resume soft pause.
set_damage_factor	Set damage factor.
set_compound_attributes	Set composite properties.
set_game_time_elapsing_rate	Set the speed of the game time passing.
set_game_time	Set game time.
create_artificial_time	Create artificial time.
set_random_seed	Set random number seed.
toggle_time_elapsing_is_on	Switch time passing.
toggle_target_point_grassland_is_on	Switch target point of grass.
clear	Empty.
play_screen_particle_for_a_set_duration	Create screen effects.
set_variable	Set variables.
play_sound_for_player	Playback sound.
stop_sound_for_player	Stop playing sound.
play_3d_sound_for_player	Play 3D sound.
follow_object_play_3d_sound_for_player	Follow the unit to play the sound.
set_sound_volume	Setting the sound volume.
print_to_dialog	Print log.
test_show_message_tip	Display interface test information.
test_log_message	Record API test logs (optional display).
get_icon_id	Get an image of the icon of the skill/buff/item/unit.
get_obj_from_data	Get the contents of a data table.
all_conditions_succeed	All conditions are valid.
any_conditions_succeed	Either condition holds.
all_conditions_failed	All conditions are not valid.
get_str_length	Get the length of the string.
pos_in_str	Index of the target character in the string.
get_tech_max_level	Get the maximum level of technology.
get_player_ui_pos_x	Get the player's mouse screen coordinates X.
get_player_ui_pos_y	Get the player's mouse screen coordinates Y.
get_player_pointing_pos	Get the player's mouse coordinates.
get_instance_location_point.	Get the point where the projectile/item/unit/damageable object is located.
get_team	Get the team the player/unit is in.
str_to_unit_command_type	String to unit command type.
str_to_point	String to dot.
str_to_ability_cast_type	String to skill release type.
str_to_link_sfx_key	String to link effects.
str_to_role_relation	String-to-player relationships.
str_to_unit_type	String to unit classification.
str_to_unit_key	String to unit type.
str_to_unit_name	String to unit property.
str_to_item_key	String to item type.
str_to_role_res	String to player attributes.
str_to_role_status	String to player status.
str_to_role_type	String to player control status.
str_to_ability_key	String to skill type.
str_to_ability_type	String to skill slot type.
str_to_dest_key	String to destructible type.
str_to_project_key	String to projector type.
str_to_particle_sfx_key	String to effects.
str_to_tech_key	String to technology type.
str_to_model_key	String to model type.
str_to_modifier_key	String to magic effect type.
str_to_modifier_effect_type	String to magic effect effect type.
str_to_modifier_type	String to magic effect category.
str_to_camp	String to camp.
str_to_keyboard_key	String to keyboard keys.
str_to_mouse_key	String to mouse button conversion.
str_to_mouse_wheel	String to mouse wheel.
str_to_store_key	String to platform prop type.
str_to_damage_type	String to harm type.
str_to_unit_attr_type	String to unit attribute type.
str_to_audio_key	String to sound type.
get_icon_id	Get an image based on its ID.
move_to_pos	Move to a position.
stop	Stop.
garrison	Stationed at a target point.
attack_move	Attack movement.
attack_target	Target of attack.
move_along_path	Move along the path.
cast_ability	Release skills.
pick_up_item	Pick up items.
discard_item	Discarded items.
give_item	Give items.
use_item	Use of items
follow	Follow a unit.
empty	Empty command.
table_length	Length of table.
get_max_tech_level	Get the maximum level of technology.
get_tech_icon	Get the icon of the technology.
get_tech_type_from_event	Get the type of technology in the event.
get_tech_type_description	Get the description of the type of technology.
get_tech_type_name	Get the name of the technology type.
get_current_game_mode	Get the current game mode.
get_local_language_environment	Get local language environment.
current_game_run_time	Time the game has been running.
get_current_game_time	Get the current time of the game.
get_damage_factor	Get damage factor.
get_coefficient	Get the slave coefficients of the 3D attributes.
get_game_environment_of_current_round	Acquire the game environment of the council.
get_global_archive	Get global archive.
get_archive_rank_player_archive_value	Get integer archive leaderboard player archive values.
if_pri_attr_state_open	Whether to open the three-dimensional properties or not.
get_mover_bound_projectiles.	Obtain the motile binding projection.
get_tech_changed_level	Get the level of technological change.
trigger_modifier	Trigger magic effect.
tech_researched	Technology being studied.
get_unit_in_event	Get the units in the event.
modifier_receiver	Magic effect carriers.
get_ability_owner	Acquisition of skill owners.
modifier_provider	Magic effect applicator.
ability_selected_target_item	Target item selected by the skill.
picked_modifier	Traversing to the magic effect.
player_that_triggered_current_event	The player who triggered the current event.
projectile_that_triggered_current_event	The projection that triggered the current event.
ability_selected_target_unit	Get the unit selected by the skill.
get_modifier_stack_changed_value	Get the value of the change in the number of layers of magic effects.
tech_upgraded_or_downgraded	Technology for level up and down.
item_selected_in_picking_item_group	Selected items when traversing the item group.
level_changed_tech	Grade change technology.
get_damage_or_healing_target_unit	Get units that take damage (healing).
picked_unit_in_unit_group	Get the units traversed in the unit group.
get_killer_unit	Get the killer unit.
get_picked_projectile	Get the traversed projection.
get_dead_unit	Obtain death units.
Get_Damage_or_Healing_Source_Unit	Get units that apply damage (healing).
unit_to_gain_item	Obtain item units.
unit_to_lose_item	Loss of item unit.
unit_to_use_item	Use of item units.
unit_to_change_stacks	Holders of stacked layer change items.
get_unit_about_to_gain_modifier	Obtain a unit that is about to acquire a magic effect.
last_unit_to_make_purchase	The last unit to perform the purchase operation.
last_unit_to_make_sale	The last unit to be sold.
get_current_array_index	Get the current array index.
ability_that_triggered_current_event	Skills that trigger the current event.
ability_selected_destructible	The target selected by the skill can destroy the object.
destructible_in_event	Destructible objects in the event.
damage_value_that_triggered_current_event	The value of the damage that triggered the current event.
item_that_triggered_current_event	The item that triggered the current event.
unit_gains_item	Unit that acquires items.
unit_loses_item	Unit that loses items.
unit_uses_item	Unit that uses items.
item_whose_stack_changed	Stacking layer change items.
item_whose_charge_changed	Charge change items.
item_purchased	Purchased items.
item_sold	Items for sale.
string_in_event	Strings in events.
mover_collision_unit	Exerciser collision unit.
get_current_damage_type	Get the current damage type.
player_resource_type_involved_in_the_event	Types of player resources in the event.
unit_group_involved_in_the_event	Unit groups in events.
current_purchasable	Current platform props.
convert_float_to_angle	Real number to angle.
convert_angle_to_float	Angle to real number.
get_ability_cast_direction	Get skill release directions.
unit_in_destroy_destructible_event	Units in destructible mortality events.
unit_in_destructible_is_damaged_event	Units in vandalizable injury incidents.
unit_in_destructible_is_gathered_event	Destructible objects are collected in the event of the unit.
resource_change_value_in_destructible_event	Value of resource change in destructible events.
ability_in_destructible_event	Skill objects in destructible events.
number_of_player_attributes_gathered_in_destructible_event	Number of player attributes collected in a destructible event.
damage_value_in_destructible_event	Damage value in destructible events.
get_ability_by_unit_and_seq	Get skills in events.
get_build_unit	Get the build unit in the event.
get_healing_value_before_settlement	Get the value of this treatment (before settlement).
get_mover_bound_units	Get the kinematic binding unit.
all_units_belonging_to_specified_player	All units belonging to a player.
unit_of_a_specified_unit_type	Specify the unit type of the unit.
number_random_units_from_unit_group	Random integer number of units in the unit group.
number_of_units_in_unit_group	Get the number of units in the unit group.
get_number_of_units_of_specified_type_in_unit_group	Number of unit types in the unit group.
get_the_first_unit_in_a_unit_group	Get the first unit in the unit group.
get_random_unit_from_unit_group	Get a random unit in the unit group.
get_last_unit_in_unit_group	Get the last unit in the unit group.
get_object_from_data	Obtaining objects from data.
is_point_in_area	Is the point in the area.
string_to_bool	String to boolean.
get_global_weather	Get global weather.
player_keyboard_key_is_pressed	Whether the player keyboard keys are pressed.
player_mouse_key_is_pressed	Whether the player mouse is pressed.
check_tech_key_precondition	Check the technology type pre-requisites.
joint_string.	String splicing.
extract_string	Intercept string.
delete_sub_string	Delete substring.
get_text_config	Get multilingual content.
get_random_pool_probability	Get the weight probability of the specified integer in the random pool.
get_int_value_from_random_pool	Get a random integer from a random pool.
get_random_pool_all_weight	Get the total weight of the random pool.
get_random_pool_size	Get the number of integers in the random pool.
get_random_pool_pointed_weight	Get the weight of the specified integer in the random pool.
get_point_ground_height	Get the layer of the map at the point location.
get_random_seed	Get random seeds.
get_game_init_time_stamp	Get the game start time stamp.
get_game_x_resolution	Get initialized horizontal resolution.
get_game_y_resolution	Get initialized vertical resolution.
get_graphics_quality	Get initialized game picture quality.
get_window_mode	Get the initialization window category.

Enum Lua Globals