Research: Parameters for commands & console commands

[Epistolary Richard]

Script commands
All taken from docudemon_commands.txt - see link for description of effects

1) Commands we know are working
Reason - Included in the vanilla game

declare_prologue	Sample use: declare_prologue
terminate_prologue	Sample use: terminate_prologue
move			Sample use: move Gaius Julius, 20, 44
replenish_action_points	Sample use: replenish_action_points Gaius Julius
replenish_units		Sample use: replenish_units Gaius Julius
script			Sample use: script
terminate_script	Sample use: terminate_script
spawn_battle		Sample use: spawn_battle custom/punic_1
if			Sample use: if TimerElapsed < 1000
while			Sample use: while TimerElapsed < 1000
monitor_conditions	Sample use: monitor_conditions not I_CharacterIsSelected Gaius Julius
monitor_event		Sample use: monitor_event IncomingMessage IncomingMessageType wonder_captured
terminate_monitor	Sample use: terminate_monitor
console_command		Sample use: console_command kill_character "Gaius Julius"
declare_counter		Sample use: declare_counter blib
inc_counter		Sample use: inc_counter blib -137
set_counter		Sample use: set_counter blib -137
prepare_for_battle	Sample use: prepare_for_battle
declare_show_me		Sample use: declare_show_me
campaign_wait		Sample use: campaign_wait 1.3
suspend_during_battle	Sample use: suspend_during_battle on
set_music_state		Sample use: set_music_state mobilize
point_at_character	Sample use: point_at_character Gaius Julius
point_at_settlement	Sample use: point_at_settlement Roma
point_at_strat_position	Sample use: point_at_strat_position 44, 55
point_at_message	Sample use: point_at_message 0
ui_flash_start		Sample use: ui_flash_start finances_button
ui_flash_stop		Sample use: ui_flash_stop
character_flash_start	Sample use: character_flash_start Gaius Julius
character_flash_stop	Sample use: character_flash_stop Gaius Julius
point_at_location	Sample use: point_at_location pos1
point_at_unit_pos	Sample use: point_at_unit_pos generals_unit
remove_battle_map_arrow	Sample use: remove_battle_map_arrow
point_at_unit_card	Sample use: point_at_card roman_archers
hide_ui			Sample use: hide_ui
show_ui			Sample use: show_ui
disable_ui		Sample use: disable_ui finances_button
enable_ui		Sample use: enable_ui finances_button
disable_entire_ui	Sample use: disable_entire_ui
enable_entire_ui	Sample use: enable_entire_ui
set_cards_selectable	Sample use: set_cards_selectable false
disable_cursor		Sample use: disable_cursor
enable_cursor		Sample use: enable_cursor
reveal_tile		Sample use: reveal_tile 25, 43
advance_advice_thread	Sample use: advance_advice_thread 0098_prologue_selection no_dismiss
dismiss_advice		Sample use: dismiss_advice
suspend_unscripted_advice	Sample use: suspend_unscripted_advice true
disable_shortcuts	Sample use: disable_shortcuts true - to disable, disable_shortcuts false - to enable them again
filter_unit_commands	Sample use: filter_unit_commands on velites_alpha change_formation
filter_unit_group_commands	Sample use: filter_unit_group_commands on storm_troopers change_formation
filter_unit_selection_commands	Sample use: filter_unit_selection_commands on change_formation
filter_all_ui_commands	Sample use: filter_all_ui_commands on
steal_esc_key		Sample use: 
ai_active_set		Sample use: ai_active_set off
release_unit		Sample use: release_unit
hiding_enabled_set	Sample use: hiding_enabled_set false
pause_battle		Sample use: pause_battle
unit_immediate_place	Sample use: unit_immediate_place archers1 big_hill 0
unit_order_move		Sample use: unit_order_move cohort1 100 60 run
unit_order_attack_unit	Sample use: unit_order_attack_unit cavalry1 enemy4 run
unit_order_attack_closest_unit	Sample use: unit_order_attack_closest_unit 15 run
unit_order_move_to_missile_range	Sample use: unit_order_move_to_missile_range roman_archers barb_swordsmen run
unit_set_morale		Sample use: unit_set_morale carthaginian_peasants wavering
unit_set_skirmish_mode	Sample use: unit_set_skirmish_mode velites1 off
unit_group_unset_morale	Sample use: unit_group_unset_morale infantry_group
move_strat_camera	Sample use: move_camera 20,35
snap_strat_camera	Sample use: snap_strat_camera 20,35
zoom_strat_camera	Sample use: zoom_camera 0.4
camera_restrictions_set	Sample use: camera_restrictions_set on
camera_default_mode_set	Sample use: camera_default_mode_set tw
battle_default_camera	Sample use: battle_default_camera
set_camera_bookmark	Sample use: set_camera_bookmark 1, 100, 0, 100, 100, 0, 0 - Will set the camera bookmark to position (100,0,100), looking straight back along the z axis
camera_position_at_bookmark	Sample use: camera_position_at_bookmark 0
camera_zoom_to_bookmark	Sample use: camera_zoom_to_bookmark 0 50
camera_position		Sample use: camera_position 0 0 0 0 0 -1
camera_zoom_to		Sample use: camera_zoom_to 0 0 0 0 0 -1 50
camera_look_at_unit	Sample use: camera_look_at_unit spearmen7
camera_track_unit	Sample use: camera_track_unit roman_cavalry1 left 20 10 -15
camera_zoom_to_unit	Sample use: camera_zoom_to_unit spearmen7
label_unit		Sample use: label_unit 0 2 4 julii_hastati_2
label_location		Sample use: label_location 35 58 the_big_hill
define_unit_group	Sample use: define_unit_group group1 archers1 archers2 archers3 spearmen1
declare_timer		Sample use: declare_timer rout_timer
restart_timer		Sample use: restart_timer
battle_wait		Sample use: battle_wait 1.3
play_sound_event	Sample use: play_sound_event PREBATTLE_TEST
stop_sound_event	Sample use: stop_sound_event PREBATTLE_TEST
unit_order_change_formation	Sample use: unit_order_change_formation legionary_cohort testudo
unit_group_order_relative_move_formed	Sample use: unit_group_order_relative_move_formed group6 100 -60 run
inhibit_camera_input	Sample use: inhibit_camera_input true
undefine_unit_group	Sample use: undefine_unit_group archer_group5

Reason - Tested

settlement_flash_start	Sample use: settlement_flash_start Tarquinii
settlement_flash_stop	Sample use: settlement_flash_stop Tarquinii
simulate_mouse_click	Sample use: simulate_mouse_click lclick_down
select_ui_element	Sample use: select_ui_element faction_button
wait			Sample use: wait 1.3
spawn_character		Sample use: spawn_character julii Gaius Antio, diplomat, command 0, influence 0, management 0, subterfuge 0, age 29, , x 94, y 77

2) Commands that have been tested and we believe are not working as documented

play_video		Sample use: play_video fmv/rome_intro.mpg
provoke_rebellion	Sample use: provoke_rebellion Segesta
call_object_shortcut	Sample use: call_object_shortcut strat_ui speedup_ai - will toggle the fast ai mode

spawn_army ... end
Sample use: spawn_army 
faction romans_julii
character Foedus Chaerea, general, command 0, influence 0, management 0, subterfuge 0, age 20, , x 54, y 124
unit roman generals guard cavalry soldiers 20 exp 9 armour 1 weapon_lvl 0
unit roman legionary first cohort ii soldiers 40 exp 0 armour 0 weapon_lvl 0
unit roman legionary cohort ii soldiers 60 exp 0 armour 0 weapon_lvl 0
unit roman praetorian cohort i soldiers 60 exp 0 armour 0 weapon_lvl 0
end	

3) Commands that have not been tested yet

reposition_character	Sample use: reposition_character Gaius Maximus, 14, 53
engage_armies		Sample use: engage_armies Gaius Julius, Epiroderix
senate_mission_help_player	Sample use: senate_mission_help_player one_best_buildable_unit
senate_mission_assassination	Sample use: senate_mission_assassination minor_reward Gaius Julius
senate_mission_cease_hostilities	Sample use: senate_mission_cease_hostilities two_minor_exotic_units Gauls
senate_mission_declare_war	Sample use: senate_mission_declare_war major_reward Gauls
senate_mission_broker_peace	Sample use: senate_mission_broker_peace major_reward Gauls
senate_mission_take_city	Sample use: senate_mission_assassination moderate_reward Tarquini
e_point_at_settlement	Sample use: 
point_at_unit_group_pos	Sample use: point_at_unit_group_pos infantry_group1
point_at_card		Sample use: point_at_card unit hastati 2 - to point at the second hastati card the game can find
e_point_at_unit_card	Sample use: e_point_at_unit_card
show_mouse_button_animation	Sample use: show_mouse_button_animation left true - start the animation showing the left mouse button being pressed. show_mouse_button_animation left false - stop the left mouse button animation. NOTE: Only 1 animation can be shown at a time
select_character	Sample use: select_character Gaius Julius
e_select_character	Sample use: e_select_character
select_settlement	Sample use: select_settlement Roma
e_select_settlement	Sample use: e_select_settlement
filter_settlement_commands	Sample use: filter_settlement_commands on Arretium change_formation
filter_character_commands	Sample use: filter_character_commands on Gaius Julius, change_formation (note comma)
ui_indicator		Sample use: ui_indicator 0 circle 500 500 colour 255 255 0 scale 2.0 period 2.0 loop
ui_indicator_remove	Sample use: ui_indicator_remove 0
unit_order_halt		Sample use: unit_order_halt cohort1
unit_order_move_relative	Sample use: unit_order_move_relative cohort1 0 60 run
unit_order_turn		Sample use: unit_order_turn roman_archers -20 relative (turns left 20 degrees)
unit_unset_morale	Sample use: unit_unset_morale peasants4
unit_set_weapon_upgrade	Sample use: unit_set_weapon_upgrade spearmen1 3
unit_set_armour_upgrade	Sample use: unit_set_armour_upgrade spearmen1 3
unit_set_experience	Sample use: unit_set_experience roman_general 7
kill_unit		Sample use: kill_unit carthaginians2
reduce_unit_strength	Sample use: reduce_unit_strength carthaginians2 50
unit_set_guard_mode	Sample use: unit_set_guard_mode roman_spearmen on
unit_set_fire_at_will_mode	Sample use: unit_set_fire_at_will_mode roman_archers on
unit_set_formation_spacing	Sample use: unit_set_formation_spacing roman_archers loose
unit_taunt		Sample use: unit_taunt barb_archers
unit_use_special_ability	Sample use: unit_use_special_ability barb_archers
unit_group_enable_automation	Sample use: unit_group_enable_automation
unit_group_immediate_place	Sample use: unit_group_immediate_place group6 100 -60 -20
unit_group_order_halt	Sample use: unit_group_order_halt group6
unit_group_order_move_formed	Sample use: unit_group_order_move_formed group6 100 -60 run
unit_group_order_move_unformed	Sample use: unit_group_order_move_unformed group6 100 -60 run
unit_group_order_relative_move_unformed	Sample use: unit_group_order_relative_move_unformed group6 100 -60 run
unit_group_move_to_missile_range_of_unit	Sample use: unit_group_move_to_missile_range_of_unit archer_group enemy_spearmen3
unit_group_move_to_missile_range_of_group	Sample use: unit_group_move_to_missile_range_of_group archer_group enemy_group
unit_group_order_attack_unit	Sample use: unit_group_order_attack_unit group1 enemy_unit4
unit_group_order_attack_group	Sample use: unit_group_order_attack_group cavalry_group1 enemy_archer_group
unit_group_order_change_group_formation	Sample use: unit_group_order_change_group_formation group2 ordered_triple_line_1
unit_group_order_turn	Sample use: unit_group_order_turn group2 90 (turns the group to 90 degrees)
unit_group_set_morale	Sample use: unit_set_morale infantry_group routing
unit_group_change_unit_formation	Sample use: unit_group_change_unit_formation hoplite_group phalanx
unit_group_set_guard_mode	Sample use: unit_group_set_guard_mode group2 off
unit_group_set_skirmish_mode	Sample use: unit_group_set_skirmish_mode archer_group on
unit_group_set_fire_at_will_mode	Sample use: unit_group_set_fire_at_will_mode group2 off
unit_group_set_formation_spacing	Sample use: unit_group_set_formation_spacing group1 loose
camera_event_cuts_active_set	Sample use: camera_event_cuts_active_set off
battle_general_camera	Sample use: battle_general_camera
camera_look_at_position	Sample use: camera_look_at_position 123.4 56.7
e_camera_zoom_to_unit	Sample use: e_camera_zoom_to_unit
remove_unit_from_group	Sample use: remove_unit_from_group group1 archers1
heed_pause		Sample use: heed_pause on