On This Page

  • Reference
  • LUA API
  • Global
  • Common

Common

Functions

remove_kv

Clear the key value of the instance.

Parameters

VariableTypeDescription
_instableInstance.
_valuestrKey value name.
cli.remove_kv (_ins, _value)

remove_unit_kv

Clear unit type key.

Parameters

VariableTypeDescription
_idnumberUnit type ID.
_valuestrKey value name.
cli.remove_unit_kv (_id, _value)

remove_item_kv

Clear item type key.

Parameters

VariableTypeDescription
_idnumberItem type ID.
_valuestrKey value name.
cli.remove_item_kv (_id, _value)

remove_ability_kv

Clear skill type key.

Parameters

VariableTypeDescription
_idnumberSkill type ID.
_valuestrKey value name.
cli.remove_ability_kv (_id, _value)

remove_prefab_kv

Clear Destroyables/Technology/Projectiles/Magic Effects/Type Keys.

Parameters

VariableTypeDescription
_idnumberSkill type ID.
_valuestrKey value name.
cli.remove_prefab_kv (_id, _value)

cleartag

Clear label.

Parameter

VariableTypeDescription
_objtableObject.
cli.cleartag (_obj)

create_random_pool

Create a random pool.

cli.create_random_pool ()

set_weight_of_specified_number

Set random pool to specify integer weight.

Parameters

VariableTypeDescription
pooltableRandom pool.
numbernumberSpecifies an integer.
weightnumberWeight.
cli.set_weight_of_specified_number (pool, number, weight)

remove_specified_number

The random pool removes the specified integer.

Parameters

VariableTypeDescription
pooltableRandom pool.
numbernumberSpecifies an integer.
cli.remove_specified_number (pool, number)

pick_random_pool

Traverse the random pool.

cli.pick_random_pool ()

display_info_to_player

Tip the player.

Parameters

VariableTypeDescription
playerplayerTarget player.
msgstrContent.
is_languageboolWhether multilingual is required.
cli.display_info_to_player (player, msg, is_language)

increase_weight_of_specified_number

The random pool increases the specified integer weight.

Parameters

VariableTypeDescription
pooltableRandom pool.
numbernumberSpecifies an integer.
weightnumberWeight.
cli.increase_weight_of_specified_number (pool, number, weight)

separate_string

Split string array.

Parameters

VariableTypeDescription
str_listarrayString array.
str1strOriginal string.
str2strDelimiter.
cli.separate_string (str_list, str1, str2)

get_camp_by_camp_id

Get camp.

Parameter

VariableTypeDescription
idnumberCamp ID.
cli.get_camp_by_camp_id (id)

stringtobool

String type to bool.

Parameter

VariableTypeDescription
_strstrString.
cli.stringtobool (_str)

set_cascaded_shadow_distance

Set shadow distance.

Parameter

VariableTypeDescription
_disnumberShadow distance.
cli.set_cascaded_shadow_distance (_dis)

remove_timer

Delete timer.

Parameter

VariableTypeDescription
timertimerTimer.
cli.remove_timer (timer)

pause_timer

Pause timer.

Parameter

VariableTypeDescription
timertimerTimer.
cli.pause_timer (timer)

resume_timer

Resume timer.

Parameter

VariableTypeDescription
timertimerTimer.
cli.resume_timer (timer)

set_terrain_texture_at_a_specified_point

Set the terrain texture for a point.

Parameters

VariableTypeDescription
pointpointTarget point.
terrain_type_namestrTexture.
rangenumberRange.
area_type_namestrShape.
cli.set_terrain_texture_at_a_specified_point (point, terrain_type_name, range, area_type_name)

replace_specified_terrain_texture_in_region

Replace the specified terrain texture within the area.

Parameters

VariableTypeDescription
areaareaTarget area.
terrain_type_namestrInitial texture.
target_terrain_type_namestrReplacement texture.
cli.replace_specified_terrain_texture_in_region (area, terrain_type_name, target_terrain_type_name)

set_region_weather

Set regional weather.

Parameters

VariableTypeDescription
areaareaArea.
weather_namestrWeather.
cli.set_region_weather (area, weather_name)

set_global_weather

Set global weather.

Parameter

VariableTypeDescription
weather_namestrWeather.
cli.set_global_weather (weather_name)

set_player_filter_effect

Set player's filter effect.

Parameters

VariableTypeDescription
playerplayerPlayer.
filter_namestrFilter.
cli.set_player_filter_effect (player, filter_name)

display_player_terrain_texture

Show/Hide Player Surface Textures.

Parameters

VariableTypeDescription
playerplayerPlayer.
is_visibleboolShow/hide.
cli.display_player_terrain_texture (player, is_visible)

enable_vignetting

Set dark corner switch.

Parameters

VariableTypeDescription
playerplayerPlayer.
is_enableboolSwitch.
cli.enable_vignetting (player, is_enable)

set_vignetting_size

Set vignette size.

Parameters

VariableTypeDescription
playerplayerPlayer.
sizenumberVignetting size.
cli.set_vignetting_size (player, size)

set_vignetting_breathing_period

Set vignette breathing cycle.

Parameters

VariableTypeDescription
playerplayerPlayer.
circle_timenumberCycle period.
cli.set_vignetting_breathing_period (player, circle_time)

set_vignetting_changing_amplitude

Set the variation range of vignetting.

Parameters

VariableTypeDescription
playerplayerPlayer.
rangenumberRange of change.
cli.set_vignetting_changing_amplitude (player, range)

set_vignetting_color

Set vignette color.

Parameters

VariableTypeDescription
playerplayerPlayer.
rednumberRed.
greennumberGreen.
bluenumberBlue.
alphanumberOpacity.
cli.set_vignetting_color (player, red, green, blue, alpha)

set_fog_attribute

Set fog properties.

Parameters

cli.set_fog_attribute (fog, direction, pos_x, pos_y, pos_z, scale_x, scale_y, scale_z, red, green, blue, concentration, speed)

set_cascaded_shadow_distanc

Set shadow distance.

Parameter

VariableTypeDescription
distancenumberShadow distance.
cli.set_cascaded_shadow_distance (distance)

set_cascaded_shadow_enable

Switch Cascaded Shadows

Parameter

VariableTypeDescription
is_enableboolSwitch.
cli.set_cascaded_shadow_enable (is_enable)

set_post_effect

Switch style for player

Parameters

VariableTypeDescription
playerplayerPlayer.
processing_namestrStyle of painting.
cli.set_post_effect (player, processing_name)

set_table_value

Set the value of a one-dimensional table

Parameters

VariableTypeDescription
tabletableTable.
valuestrValue.
keystrPrimary key.
cli.set_table_value (table, value, key)

set_table_value_multi

Set the value of multidimensional table

Parameters

VariableTypeDescription
tabletableTable.
valuestrValue.
keystrPrimary key.
fieldstrKey value.
cli.set_table_value_multi (table, value, key, field)

insert_table_value

Insert values into the table.

Parameters

VariableTypeDescription
tabletableTable.
valuestrValue.
indexnumberInsertion position.
cli.insert_table_value (table, value, index)

remove_nth_table_value

Delete the N-th value of a one-dimensional table.

Parameters

VariableTypeDescription
tabletableTable.
indexnumberPosition.
cli.remove_nth_table_value (table, index)

pick_table

Traverse the table.

Parameter

VariableTypeDescription
tabletableTable.
cli.pick_table (table)

pick_table_ordered

Traversing the table (preserving order).

Parameter

VariableTypeDescription
tabletableTable.
cli.pick_table_ordered (table)

dump_table

Print sheet.

Parameter

VariableTypeDescription
tabletableTable.
cli.dump_table (table)

new_empty_table

Create empty table.

Parameter

VariableTypeDescription
tabletableTable.

Return

TypeDescription
tableTable.
cli.new_empty_table ()

copy_table

Copy table.

Parameter

VariableTypeDescription
tabletableTable.

Return

TypeDescription
tableTable.
cli.copy_table (table)

pause_game

Pause game.

cli.pause_game ()

start_new_round_of_game

Start a new game.

Parameter

VariableTypeDescription
is_quick_resetboolQuick reset.
cli.start_new_round_of_game (is_quick_reset)

enable_soft_pause

Enable soft pause.

cli.enable_soft_pause ()

resume_soft_pause

Resume soft pause.

cli.resume_soft_pause ()

set_damage_factor

Set damage factor.

Parameters

VariableTypeDescription
attack_type_namestrAttack type.
armor_type_namestrArmor type.
rationumberCoefficient.
cli.set_damage_factor (attack_type_name, armor_type_name, ratio)

set_compound_attributes

Set composite properties.

Parameters

VariableTypeDescription
primary_attribute_namestrPrimary attribute.
secondary_attr_namestrSecondary attribute.
valuenumberCoefficient.
cli.set_compound_attributes (primary_attribute_name, secondary_attr_name, value)

set_game_time_elapsing_rate

Set how fast game time passes.

Parameter

VariableTypeDescription
speednumberSpeed at which game time passes.
cli.set_game_time_elapsing_rate (speed)

set_game_time

Set game time.

Parameter

VariableTypeDescription
timenumberGame time.
cli.set_game_time (time)

create_artificial_time

Create artificial time.

Parameters

VariableTypeDescription
timenumberTime.
durnumberDuration.
cli.create_artificial_time (time, dur)

set_random_seed

Set random number seed.

Parameter

VariableTypeDescription
seednumberSeed.
cli.set_random_seed (seed)

toggle_time_elapsing_is_on

Switching time lapse.

Parameter

VariableTypeDescription
is_onboolSwitch.
cli.toggle_time_elapsing_is_on (is_on)

toggle_target_point_grassland_is_on

Grass at switch target point.

Parameters

VariableTypeDescription
is_onboolSwitch.
pointpointTarget point.
cli.toggle_target_point_grassland_is_on (is_on, point)

clear

Empty.

Parameter

VariableTypeDescription
player_or_unit_groupunit_group/player_groupUnit group or player group.
cli.clear (player_or_unit_group)

play_screen_particle_for_a_set_duration

Create screen effects.

Parameters

VariableTypeDescription
sfx_idnumberSpecial effect type ID.
durationnumberDuration.
playerplayerVisible player.
is_on_fogboolWhether to be affected by shadow of war.
cli.play_screen_particle_for_a_set_duration (sfx_id, duration, player, is_on_fog)

set_variable

Set variable.

Parameters

VariableTypeDescription
keystrVariable name.
valuestrVariable value.
typestrVariable type.
cli.set_variable (key, value, type)

play_sound_for_player

Play sound.

Parameters

VariableTypeDescription
playerplayerPlayer.
soundsoundSound.
is_loopboolWhether to play in a loop.
fade_in_timenumberFade in time.
fade_out_timenumberFade out time.
cli.play_sound_for_player (player, sound, is_loop, fade_in_time, fade_out_time)

stop_sound_for_player

Stop playing sound.

Parameters

VariableTypeDescription
playerplayerPlayer.
soundsoundSound.
is_immediatelyboolStop immediately.
cli.stop_sound_for_player (player, sound, is_immediately)

play_3d_sound_for_player

Play 3D sound.

Parameters

VariableTypeDescription
playerplayerPlayer.
soundsoundSound.
pointpointPlayback position.
heightnumberHeight.
fade_in_timenumberFade in time.
fade_out_timenumberFade out time.
is_make_sure_playboolSure play.
is_loopboolWhether to play in a loop.
cli.play_3d_sound_for_player (player, sound, point, height, fade_in_time, fade_out_time, is_make_sure_play, is_loop)

follow_object_play_3d_sound_for_player

Play sound with unit.

Parameters

VariableTypeDescription
playerplayerPlayer.
soundsoundSound.
unitunitFollow unit.
fade_in_timenumberFade in time.
fade_out_timenumberFade out time.
is_make_sure_playboolSure play.
is_loopboolWhether to play in a loop.
cli.follow_object_play_3d_sound_for_player (player, sound, unit, fade_in_time, fade_out_time, is_make_sure_play, is_loop)

set_sound_volume

Set sound volume.

Parameters

VariableTypeDescription
playerplayerPlayer.
soundsoundSound.
valuenumberVolume.
cli.set_sound_volume (player, sound, value)

print_to_dialog

Print log.

Parameters

VariableTypeDescription
typenumberMessage type.
informationstrLog content.
cli.print_to_dialog (type, information)

test_show_message_tip

Display interface test information.

Parameters

VariableTypeDescription
informationstrLog content.
timenumberDuration.
cli.test_show_message_tip (information, time)

test_log_message

Record API test log (optional display).

Parameters

VariableTypeDescription
informationstrLog content.
timenumberDuration.
is_centerboolWhether to center the display.
cli.test_log_message (information, time, is_center)

get_icon_id

Get the picture of the icon icon of the skill/buff/item/unit.

Parameter

VariableTypeDescription
objobjectObject.
cli.get_icon_id (obj)

get_obj_from_data

Get the contents of the data table.

Parameters

VariableTypeDescription
datatableData table.
stringstrContent name.

Return

TypeDescription
tableContents of the table.
cli.get_obj_from_data (data, string)

all_conditions_succeed

All conditions are met.

Parameter

VariableTypeDescription
conditionstableList of conditions.

Return

TypeDescription
boolFinal result.
cli.all_conditions_succeed (conditions)

any_conditions_succeed

Either condition holds.

Parameter

VariableTypeDescription
conditionstableList of conditions.

Return

TypeDescription
boolFinal result.
cli.any_conditions_succeed (conditions)

all_conditions_failed

None of the conditions is met.

Parameter

VariableTypeDescription
conditionstableList of conditions.

Return

TypeDescription
boolFinal result.
cli.all_conditions_failed (conditions)
 

get_str_length

Get string length.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberString length.
cli.get_str_length (_str)

pos_in_str

Index of the target character in the string.

Parameters

VariableTypeDescription
_str1strSearch string.
_str2strTarget string.

Return

TypeDescription
number
cli.pos_in_str (_str1, _str2)

get_tech_max_level

Get the maximum level of technology.

Parameter

VariableTypeDescription
_techidnumberTechnology ID.

Return

TypeDescription
numberMaximum level.
cli.get_tech_max_level (_techid)

get_player_ui_pos_x

Get the player's mouse screen coordinate X.

Parameter

VariableTypeDescription
_playerplayerPlayer.

Return

TypeDescription
numberX-coordinate.
cli.get_player_ui_pos_x (_player)

get_player_ui_pos_y

Get the player's mouse screen coordinate X.

Parameter

VariableTypeDescription
_playerplayerPlayer.

Return

TypeDescription
numberX-coordinate.
cli.get_player_ui_pos_y (_player)

get_player_pointing_pos

Get the player's mouse coordinates.

Parameter

VariableTypeDescription
_playerplayerPlayer.

Return

TypeDescription
pointPoint.
cli.get_player_pointing_pos (_player)

get_instance_location_point

Get the location of the projectile/item/unit/destructible object.

Parameter

VariableTypeDescription
_instableInstance.

Return

TypeDescription
pointPoint.
cli.get_instance_location_point (_ins)

get_team

Get the team of the player/unit.

Parameter

VariableTypeDescription
_argtablePlayer/unit.

Return

TypeDescription
numberTeam ID.
cli.get_team (_arg)

str_to_unit_command_type

String to unit command type.

Parameter

VariableTypeDescription
_strstrPlayer/unit.

Return

TypeDescription
numberCommand type.
cli.str_to_unit_command_type (_str)

str_to_point

String to point.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
point
cli.str_to_point (_str)

str_to_ability_cast_type

String transfer skill release type.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberSkill release type.
cli.str_to_ability_cast_type (_str)

str_to_link_sfx_key

String to link effect.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberLink effect ID.
cli.str_to_link_sfx_key (_str)

str_to_role_relation

String to Player Relationship.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberPlayer relation.
cli.str_to_role_relation (_str)

str_to_unit_type

String to unit classification.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberUnit classification.
cli.str_to_unit_type (_str)

str_to_unit_key

String to unit type.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberUnit type.
cli.str_to_unit_key (_str)

str_to_unit_name

String to unit property.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberUnit attribute.
cli.str_to_unit_name (_str)

str_to_item_key

String to item type.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberItem type ID.
cli.str_to_item_key (_str)

str_to_role_res

String to player attribute.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberPlayer attribute.
cli.str_to_role_res (_str)

str_to_role_status

String to player state.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberPlayer state.
cli.str_to_role_status (_str)

str_to_role_type

String to player control state.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberPlayer control state.
cli.str_to_role_type (_str)

str_to_ability_key

String to skill type.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberSkill type ID.
cli.str_to_ability_key (_str)
 

str_to_ability_type

String to skill slot type.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberSkill slot type.
cli.str_to_ability_type (_str)

str_to_dest_key

String to destructible type.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberDestructible object type ID.
cli.str_to_dest_key (_str)

str_to_project_key

String to projectile type.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberProjectile type ID.
cli.str_to_project_key (_str)

str_to_particle_sfx_key

String to special effect.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberSpecial effect type ID.
cli.str_to_particle_sfx_key (_str)

str_to_tech_key

String to technology type.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberTechnology type ID.
cli.str_to_tech_key (_str)

str_to_model_key

String to model type.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberModel type ID.
cli.str_to_model_key (_str)

str_to_modifier_key

String to magic effect type.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberMagic effect type ID.
cli.str_to_modifier_key (_str)

str_to_modifier_effect_type

String to magic effect effect type.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberMagic effect effect type.
cli.str_to_modifier_effect_type (_str)

str_to_modifier_type

String to magic effect category.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberMagic effect category.
cli.str_to_modifier_type (_str)

str_to_camp

String to alignment.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberFaction ID.
cli.str_to_camp (_str)

str_to_keyboard_key

String to keyboard key.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberKeyboard key.
cli.str_to_keyboard_key (_str)

str_to_mouse_key

String to mouse button.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberMouse button.
cli.str_to_mouse_key (_str)

str_to_mouse_wheel

String to mouse wheel.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberMouse wheel.
cli.str_to_mouse_wheel (_str)

str_to_store_key

String to platform prop type.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberPlatform prop type ID.
cli.str_to_store_key (_str)

str_to_damage_type

String to damage type.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberDamage type.
cli.str_to_damage_type (_str)

str_to_unit_attr_type

String to unit attribute type.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberUnit attribute type.
cli.str_to_unit_attr_type (_str)

str_to_audio_key

String to sound type.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberSound type ID.
cli.str_to_audio_key (_str)

get_icon_id

Get pictures according to the picture ID.

Parameter

VariableTypeDescription
_strstrString.

Return

TypeDescription
numberPicture ID.
cli.get_icon_id (id)

move_to_pos

Move.

Parameters

VariableTypeDescription
pointpointTarget point.
rangenumberPathfinding range.

Return

TypeDescription
unit_commandCommand.
cli.move_to_pos (point, range)

stop

Stop.

Return

TypeDescription
unit_commandCommand.
cli.stop ()

garrison

Stationed.

Parameter

VariableTypeDescription
pointpointTarget point.

Return

TypeDescription
unit_commandCommand.
cli.garrison (point)

attack_move

Attack move.

Parameters

VariableTypeDescription
pointpointTarget point.
rangenumberPathfinding range.

Return

TypeDescription
unit_commandCommand.
cli.attack_move (point, range)

attack_target

Target.

Parameters

VariableTypeDescription
unitunitTarget unit.
rangenumberPathfinding range.

Return

TypeDescription
unit_commandCommand.
cli.attack_target (unit, range)

move_along_path

Move along the path.

Parameters

VariableTypeDescription
pathpathPath.
patrol_mode_namestrMovement mode.
is_attackboolWhether to automatically attack.
nearby_start_pointboolSelect the starting point nearby.
is_deviate_returnboolNearest return path.

Return

TypeDescription
unit_commandCommand.
cli.move_along_path (path, patrol_mode_name, is_attack, nearby_start_point, is_deviate_return)

cast_ability

Release skills.

Parameters

VariableTypeDescription
abilityabilitySkill.
point1pointTarget point.
point2pointTarget point 2.
point3pointTarget point 3.
unitunitTarget unit.
itemitemTarget item.
destdestructibleTarget destructible.

Return

TypeDescription
unit_commandCommand.
cli.cast_ability (ability, point1, point2, point3, unit, item, dest)

pick_up_item

Pick up items.

Parameter

VariableTypeDescription
itemitemItem.

Return

TypeDescription
unit_commandCommand.
cli.pick_up_item (item)

discard_item

Discarded items.

Parameters

VariableTypeDescription
itemitemItem.
pointpointTarget point.

Return

TypeDescription
unit_commandCommand.
cli.discard_item (item, point)

give_item

Give items.

Parameters

VariableTypeDescription
itemitemItem.
unitunitUnit.

Return

TypeDescription
unit_commandCommand.
cli.give_item (item, unit)

use_item

Items used.

Parameters

VariableTypeDescription
itemitemItem.
point1pointTarget point.
point2pointTarget point 2.
point3pointTarget point 3.
unitunitTarget unit.
itemitemTarget item.
destdestructibleTarget destructible.

Return

TypeDescription
unit_commandCommand.
cli.use_item (item, point1, point2, point3, unit, target_item, dest)

follow

Follow.

Parameter

VariableTypeDescription
unitunitTarget unit.

Return

TypeDescription
unit_commandCommand.
cli.follow (unit)

empty

Empty command.

Return

TypeDescription
unit_commandCommand.
cli.empty ()

table_length

Table length.

Parameter

VariableTypeDescription
tabletableTable.

Return

TypeDescription
numberLength of the table.
cli.table_length (table)

get_max_tech_level

Get the maximum level of technology.

Parameter

VariableTypeDescription
tech_idnumberTechnology type ID.

Return

TypeDescription
numberTechnology type ID.
cli.get_max_tech_level (tech_id)

get_tech_icon

Get tech icons.

Parameters

VariableTypeDescription
tech_idnumberTechnology type ID.
indexnumberGrade.

Return

TypeDescription
numberTech icon.
cli.get_tech_icon (tech_id, index)

get_tech_type_from_event

Get the technology type in the event.

Return

TypeDescription
numberTechnology type ID.
cli.get_tech_type_from_event ()

get_tech_type_description

Get the description of the technology type.

Parameter

VariableTypeDescription
tech_idnumberTechnology type ID.

Return

TypeDescription
stringDescription of technology type.
cli.get_tech_type_description (tech_id)

get_tech_type_name

Get the name of the technology type.

Parameter

VariableTypeDescription
tech_idnumberTechnology type ID.

Return

TypeDescription
stringName of the technology type.
cli.get_tech_type_name (tech_id)

get_current_game_mode

Get the current game mode.

Return

TypeDescription
numberGame mode.
cli.get_current_game_mode ()

get_local_language_environment

Get locale.

Return

TypeDescription
numberLocale.
cli.get_local_language_environment ()

current_game_run_time

The time the game has been running.

Return

TypeDescription
numberElapsed time.
cli.current_game_run_time ()

get_current_game_time

Get the current time of the game.

Return

TypeDescription
numberCurrent time.
cli.get_current_game_time ()

get_damage_factor

Get damage factor.

Parameters

VariableTypeDescription
attack_type_namestrAttack type.
area_type_namestrArmor type.

Return

TypeDescription
numberCoefficient.
cli.get_damage_factor (attack_type_name, area_type_name)

get_coefficient

Get the slave coefficient of the 3D attribute.

Parameters

VariableTypeDescription
primary_attribute_namestrPrimary attribute.
secondary_attr_namestrSecondary attribute.

Return

TypeDescription
numberCoefficient.
cli.get_coefficient (primary_attribute_name, secondary_attr_name)

get_game_environment_of_current_round

Get the game environment of this game.

Return

TypeDescription
numberGame environment.
cli.get_game_environment_of_current_round ()

get_global_archive

Get global archive.

Parameter

VariableTypeDescription
namestrArchive name.

Return

TypeDescription
stringArchive.
cli.get_global_archive (name)

get_archive_rank_player_archive_value

Get integer save leaderboard player save value.

Parameters

VariableTypeDescription
filestrArchive.
indexnumberSerial number.

Return

TypeDescription
strArchive value.
cli.get_archive_rank_player_archive_value (file, index)

if_pri_attr_state_open

Whether to enable 3D attributes or not.

Return

TypeDescription
booleanWhether to enable.
cli.if_pri_attr_state_open ()

get_mover_bound_projectiles

Get kinematically bound projectiles.

Return

TypeDescription
projectileProjectile.
cli.get_mover_bound_projectiles ()

get_tech_changed_level

Get the level of technology change.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
numberTechnology level.
cli.get_tech_changed_level (data)

trigger_modifier

Trigger magic effect.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
modifierMagic effect.
cli.trigger_modifier (data)

tech_researched

Researched technology.

Return

TypeDescription
numberTechnology.
cli.tech_researched ()

get_unit_in_event

Get the units in the event.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
unitUnit.
cli.get_unit_in_event (data)

modifier_receiver

Magic effect carrier.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
unitUnit.
cli.modifier_receiver (data)

get_ability_owner

Get the owner of the skill.

Parameter

VariableTypeDescription
abilityabilitySkill.

Return

TypeDescription
unitUnit.
cli.get_ability_owner (ability)

modifier_provider

Magic effect caster.

Parameter

VariableTypeDescription
modifiermodifierMagic effect.

Return

TypeDescription
unitUnit.
cli.modifier_provider (modifier)

ability_selected_target_item

The target item selected by the skill.

Parameters

VariableTypeDescription
abilityabilitySkill.
datatableEvent data.

Return

TypeDescription
itemItem.
cli.ability_selected_target_item (ability, data)

picked_modifier

The magic effect traversed.

Return

TypeDescription
modifierMagic effect.
cli.picked_modifier ()

player_that_triggered_current_event

The player who triggered the current event.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
playerPlayer.
cli.player_that_triggered_current_event (data)

projectile_that_triggered_current_event

The projectile that triggered the current event.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
projectileProjectile.
cli.projectile_that_triggered_current_event (data)

ability_selected_target_unit

Get the unit selected by the skill.

Parameters

VariableTypeDescription
abilityabilitySkill.
datatableEvent data.

Return

TypeDescription
unitUnit.
cli.ability_selected_target_unit (ability, data)

get_modifier_stack_changed_value

Get the change value of the magic effect layer.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
numberLayer change value.
cli.get_modifier_stack_changed_value (data)

tech_upgraded_or_downgraded

Level-up technology.

Return

TypeDescription
numberTechnology.
cli.tech_upgraded_or_downgraded ()

item_selected_in_picking_item_group

The selected item when traversing the item group.

Return

TypeDescription
itemItem.
cli.item_selected_in_picking_item_group ()

level_changed_tech

Level-changing technology.

Return

TypeDescription
numberTechnology that changes the level.
cli.level_changed_tech ()

get_damage_or_healing_target_unit

Get the unit taking damage (healing).

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
unitUnit.
cli.get_damage_or_healing_target_unit (data)

picked_unit_in_unit_group

Get the units traversed in the unit group.

Return

TypeDescription
unitUnit.
cli.picked_unit_in_unit_group ()

get_killer_unit

Get killer unit.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
unitUnit.
cli.get_killer_unit (data)

get_picked_projectile

Get the projectiles traversed.

Return

TypeDescription
projectileProjectile.
cli.get_picked_projectile ()

get_dead_unit

Get dead unit.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
unitUnit.
cli.get_dead_unit (data)

Get_Damage_or_Healing_Source_Unit

Get the unit dealing damage (healing).

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
unitUnit.
cli.Get_Damage_or_Healing_Source_Unit (data)

unit_to_gain_item

Get item unit.

Return

TypeDescription
unitUnit.
cli.unit_to_gain_item ()

unit_to_lose_item

Lost item unit.

Return

TypeDescription
unitUnit.
cli.unit_to_lose_item ()

unit_to_use_item

Use item units.

Return

TypeDescription
unitUnit.
cli.unit_to_use_item ()

unit_to_change_stacks

Holder of items with varying stacks.

Return

TypeDescription
unitUnit.
cli.unit_to_change_stacks ()

get_unit_about_to_gain_modifier

Get units about to get magic effects.

Parameter

VariableTypeDescription
modifiermodifierMagic effect.

Return

TypeDescription
unitUnit.
cli.get_unit_about_to_gain_modifier (modifier)

last_unit_to_make_purchase

The unit that made the last purchase.

Return

TypeDescription
unitUnit.
cli.last_unit_to_make_purchase ()

last_unit_to_make_sale

The unit that was last sold.

Return

TypeDescription
unitUnit.
cli.last_unit_to_make_sale ()

get_current_array_index

Get the current array index.

Parameter

VariableTypeDescription
datatableData in the trigger callback function.

Return

TypeDescription
numberIndex value.
cli.get_current_array_index (data)

ability_that_triggered_current_event

Ability that triggers the current event.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
abilitySkill.
cli.ability_that_triggered_current_event (data)

ability_selected_destructible

The target destructible object selected by the skill.

Parameters

VariableTypeDescription
abilityabilitySkill.
datatableEvent data.

Return

TypeDescription
destructibleDestructible.
cli.ability_selected_destructible (ability, data)

destructible_in_event

Destructibles in events.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
destructibleDestructible.
cli.destructible_in_event (data)

damage_value_that_triggered_current_event

The amount of damage that triggers the current event.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
numberValue of the damage.
cli.damage_value_that_triggered_current_event (data)

item_that_triggered_current_event

The item that triggered the current event.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
itemItem.
cli.item_that_triggered_current_event (data)

unit_gains_item

Unit gets items.

Return

TypeDescription
itemItem.
cli.unit_gains_item ()

unit_loses_item

Unit lost item.

Return

TypeDescription
itemItem.
cli.unit_loses_item ()

unit_uses_item

Items used by the unit.

Return

TypeDescription
itemItem.
cli.unit_uses_item ()

item_whose_stack_changed

Items with stacked layer changes.

Return

TypeDescription
itemItem.
cli.item_whose_stack_changed ()

item_whose_charge_changed

Charged Change Items.

Return

TypeDescription
itemItem.
cli.item_whose_charge_changed ()

item_purchased

Buy items.

Return

TypeDescription
itemItem.
cli.item_purchased ()

item_sold

Sale items.

Return

TypeDescription
itemItem.
cli.item_sold ()

selected_location_by_ability

The point selected by the skill.

Return

TypeDescription
pointPoint.
cli.selected_location_by_ability (ability, data)

string_in_event

String in event.

Return

TypeDescription
strString.
cli.string_in_event (data)

mover_collision_unit

Kinematic collision unit.

Return

TypeDescription
unitUnit.
cli.mover_collision_unit ()

get_unit_in_destructible_event

Get unit in destructible event.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
unitUnit.
cli.get_unit_in_destructible_event (data)

get_current_damage_type

Get the current damage type.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
numberDamage type.
cli.get_current_damage_type (data)

player_resource_type_involved_in_the_event

Player resource type in event.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
numberPlayer resource type.
cli.player_resource_type_involved_in_the_event (data)

unit_group_involved_in_the_event

Unit group in event.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
unit_groupUnit group.
cli.unit_group_involved_in_the_event (data)

current_purchasable

Current platform props.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
numberPlatform prop ID.
cli.current_purchasable (data)

convert_float_to_angle

Real rotation angle.

Parameter

VariableTypeDescription
valuenumberReal number.

Return

TypeDescription
angleAngle.
cli.convert_float_to_angle (value)

convert_angle_to_float

Angle to real number.

Parameter

VariableTypeDescription
valueangleReal number.

Return

TypeDescription
numberAngle.
cli.convert_angle_to_float (value)

get_ability_cast_direction

Get the skill release direction.

Parameters

VariableTypeDescription
abilityabilityskill
datatableEvent data.

Return

TypeDescription
angleRelease direction.
cli.get_ability_cast_direction (ability, data)

unit_in_destroy_destructible_event

Units in destructible death events.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
unitKiller unit.
cli.unit_in_destroy_destructible_event (data)

unit_in_destructible_is_damaged_event

Units in destructible damage events.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
unitDamage source unit.
cli.unit_in_destructible_is_damaged_event (data)

unit_in_destructible_is_gathered_event

The unit in the event that the destructible is harvested.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
unitCollection unit.
cli.unit_in_destructible_is_gathered_event (data)

resource_change_value_in_destructible_event

Resource change value in destructible event.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
numberResource change value.
cli.resource_change_value_in_destructible_event (data)

ability_in_destructible_event

Ability Objects in destructible events.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
abilityCollection skill.
cli.ability_in_destructible_event (data)

number_of_player_attributes_gathered_in_destructible_event

The number of collected player attributes in destructible object events.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
numberNumber of player attributes.
cli.number_of_player_attributes_gathered_in_destructible_event (data)

damage_value_in_destructible_event

Damage value in destructible event.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
numberDamage value.
cli.damage_value_in_destructible_event (data)

get_ability_by_unit_and_seq

Get skills from events.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
abilitySkill.
cli.get_ability_by_unit_and_seq (data)

get_build_unit

Get the construction unit in the event.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
unitUnit to be built.
cli.get_build_unit (data)

get_healing_value_before_settlement

Get the value of this treatment (before settlement).

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
numberHealing value.
cli.get_healing_value_before_settlement (data)

get_mover_bound_units

Get the kinematics binding unit.

Parameter

VariableTypeDescription
datatableEvent data.

Return

TypeDescription
unitUnit.
cli.get_mover_bound_units (data)

all_units_belonging_to_specified_player

All units belonging to a player.

Parameter

VariableTypeDescription
playerplayerPlayer.

Return

TypeDescription
unit_groupUnit group.
cli.all_units_belonging_to_specified_player (player)

unit_of_a_specified_unit_type

Units of the specified unit type.

Parameter

VariableTypeDescription
unit_idnumberUnit type ID.

Return

TypeDescription
unit_groupUnit group.
cli.unit_of_a_specified_unit_type (unit_id)

number_random_units_from_unit_group

Random integer number of units in the unit group.

Parameters

VariableTypeDescription
unit_groupunit_groupUnit group.
indexnumberQuantity.

Return

TypeDescription
unit_groupUnit group.
cli.number_random_units_from_unit_group (unit_group, index)

number_of_units_in_unit_group

Get the number of units in a unit group.

Parameter

VariableTypeDescription
unit_groupunit_groupUnit group.

Return

TypeDescription
numberNumber of units.
cli.number_of_units_in_unit_group (unit_group)

get_number_of_units_of_specified_type_in_unit_group

The number of unit types in the unit group.

Parameters

VariableTypeDescription
unit_groupunit_groupUnit group.
unit_idnumberUnit type ID.

Return

TypeDescription
numberNumber.
cli.get_number_of_units_of_specified_type_in_unit_group (unit_group, unit_id)

get_the_first_unit_in_a_unit_group

Get the first unit in the unit group.

Parameter

VariableTypeDescription
unit_groupunit_groupUnit group.

Return

TypeDescription
unitUnit.
cli.get_the_first_unit_in_a_unit_group (unit_group)

get_random_unit_from_unit_group

Gets a random unit in the unit group.

Parameter

VariableTypeDescription
unit_groupunit_groupUnit group.

Return

TypeDescription
unitUnit.
cli.get_random_unit_from_unit_group (unit_group)

get_last_unit_in_unit_group

Get the last unit in the unit group.

Parameter

VariableTypeDescription
unit_groupunit_groupUnit group.

Return

TypeDescription
unitUnit.
cli.get_last_unit_in_unit_group (unit_group)

get_object_from_data

Get object from data.

Parameters

VariableTypeDescription
datatableData.
namestrObject name.

Return

TypeDescription
objectObject.
cli.get_object_from_data (data, name)

is_point_in_area

Whether the point is within the region or not.

Parameters

VariableTypeDescription
pointpointpoint
areaareaarea

Return

TypeDescription
booleanWhether to be in the region.
cli.is_point_in_area (point, area)

string_to_bool

String to boolean.

Parameter

VariableTypeDescription
valuestrString.

Return

TypeDescription
boolBoolean value.
 cli.string_to_bool (value)

get_global_weather

Get global weather.

Return

TypeDescription
strWeather name.
cli.get_global_weather ()

player_keyboard_key_is_pressed

Whether the player keyboard key is pressed.

Parameters

VariableTypeDescription
playerplayerPlayer.
keynumberKeyboard key.

Return

TypeDescription
boolWhether to be pressed or not.
cli.player_keyboard_key_is_pressed (player, key)

player_mouse_key_is_pressed

Whether the player mouse is pressed.

Parameters

VariableTypeDescription
playerplayerPlayer.
keynumberMouse button.

Return

TypeDescription
boolWhether to be pressed or not.
cli.player_mouse_key_is_pressed (player, key)

check_tech_key_precondition

Check technology type preconditions.

Parameters

VariableTypeDescription
playerplayerPlayer.
tech_typenumberTechnology type ID.

Return

TypeDescription
boolWhether the condition is met.
cli.check_tech_key_precondition (player, tech_type)

joint_string

String concatenation.

Parameters

VariableTypeDescription
str1strString 1.
str2strString 2.

Return

TypeDescription
strConcatenated string.
cli.joint_string (str1, str2)

extract_string

Intercept string.

Parameters

VariableTypeDescription
strstrString.
start_posnumberStart position.
end_posnumberEnd position.

Return

TypeDescription
strIntercepted string.
cli.extract_string (str, start_pos, end_pos)

delete_sub_string

Remove substring.

Parameters

VariableTypeDescription
strstrString.
_sub_strstrSubstring.
is_onceboolOnly delete once.

Return

TypeDescription
strString with substrings removed.
cli.delete_sub_string (str, _sub_str, is_once)

get_text_config

Get multilingual content.

Parameter

VariableTypeDescription
strstrCustom multilingual key.

Return

TypeDescription
strCorresponding content in the multilingual table.
cli.get_text_config (str)

get_random_pool_probability

Get the weight probability of the specified integer in the random pool.

Parameters

VariableTypeDescription
pooltableRandom pool.
valuenumberSpecifies an integer.

Return

TypeDescription
numberWeight probability.
cli.get_random_pool_probability (pool, value)

get_int_value_from_random_pool

Get a random integer from the random pool.

Parameter

VariableTypeDescription
pooltableRandom pool.

Return

TypeDescription
numberRandom integer.
cli.get_int_value_from_random_pool (pool)

get_random_pool_all_weight

Get the total weight of the random pool.

Parameter

VariableTypeDescription
pooltableRandom pool.

Return

TypeDescription
numberTotal weight.
cli.get_random_pool_all_weight (pool)

get_random_pool_size

Get the number of integers in the random pool.

Parameter

VariableTypeDescription
pooltableRandom pool.

Return

TypeDescription
numberNumber of integers.
cli.get_random_pool_size (pool)

get_random_pool_pointed_weight

Get the weight of the specified integer in the random pool.

Parameters

VariableTypeDescription
pooltableRandom pool.
valuenumberSpecify an integer.

Return

TypeDescription
numberWeight.
cli.get_random_pool_pointed_weight (pool, value)

get_point_ground_height

Get the level of the map at this point.

Parameter

VariableTypeDescription
pointpointTarget point.

Return

TypeDescription
numberLevel.
cli.get_point_ground_height (point)

get_random_seed

Get random seed.

Return

TypeDescription
numberRandom seed.
cli.get_random_seed ()

get_game_init_time_stamp

Get the game start timestamp.

Return

TypeDescription
numberTimestamp.
cli.get_game_init_time_stamp ()

get_game_x_resolution

Get the initial horizontal resolution.

Return

TypeDescription
numberHorizontal resolution.
cli.get_game_x_resolution ()

get_game_y_resolution

Get the initial vertical resolution.

Return

TypeDescription
numberVertical resolution.
cli.get_game_y_resolution ()

get_graphics_quality

Get the initial game quality.

Return

TypeDescription
numberImage quality.
cli.get_graphics_quality ()

get_window_mode

Get the initialized window class.

Return

TypeDescription
numberWindow class.
cli.get_window_mode ()