Saints Row 2 Function Reference

Local functions

These functions are defined in Lua files that aren't always loaded. They're probably only available in the file that defined them or by including that file in another script.

Function name Global Defined in Examples from patch (click blue number to expand)
em01_apc_ram1 false 1
    em01_apc_ram2 false 1
      em01_assault_killed false 1
        em01_blast_oh_shit false 1
          em01_can_run_for_it false 1
            em01_church_abandoned false 1
              em01_church_abandonment_interior false 1
                em01_church_abandonment_perimeter false 1
                  em01_church_abandon_interior_cleanup false 1 1
                  em01_church_abandon_perimeter_cleanup false 1 1
                  em01_church_assault false 1
                    em01_cleanup false 1
                      em01_clear_objective false 1 6
                      em01_complete false 1 1
                      em01_defend_1_killed false 1
                        em01_defend_2_killed false 1
                          em01_defend_church_part1 false 1 1
                          em01_defend_church_part2 false 1 1
                          em01_defend_church_part2_reveal_human false 1 2
                          • em01.lua, line 835: em01_defend_church_part2_reveal_human(GROUP_DEFEND_2_B, Em01_ultor_defend_02_b)
                          • em01.lua, line 836: em01_defend_church_part2_reveal_human(GROUP_DEFEND_2_C, Em01_ultor_defend_02_c)
                          em01_defend_release_to_world false 1
                            em01_east_killed false 1
                              em01_east_perimeter_vehicle_pathfind false 1
                                em01_ensure_julius_is_driver false 1
                                  em01_entered_church false 1
                                    em01_execute_pattern false 1 1
                                    em01_exited_church false 1
                                      em01_exploring_is_weak_sauce false 1
                                        em01_fire_missiles_at_vehicle false 1
                                          em01_fire_missile_at_church false 1
                                            em01_fire_missile_at_vehicle_cancel false 1
                                              em01_fire_rpg_at_vehicle false 1
                                                em01_gotcha_heli false 1
                                                  em01_heli_destroyed false 1
                                                    em01_heli_killed false 1
                                                      em01_heli_perimeter_vehicle_pathfind false 1
                                                        em01_hit_path_chase_trigger false 1
                                                          em01_index_from_trigger_name false 1 1
                                                          em01_julius_abondoned false 1
                                                            em01_julius_car_health_watch false 1
                                                              em01_julius_died false 1
                                                                em01_lamb_to_the_slaughter false 1
                                                                  em01_last_stand_a false 1
                                                                    em01_last_stand_attack false 1
                                                                      em01_last_stand_b false 1
                                                                        em01_last_stand_heli_destroyed false 1
                                                                          em01_last_stand_julius false 1
                                                                            em01_last_stand_objective false 1 2
                                                                            em01_last_stand_show false 1
                                                                              em01_make_a_run_for_it false 1 1
                                                                              em01_missile_attack_sequence false 1 6
                                                                              • em01.lua, line 1451: em01_missile_attack_sequence(HELI_ATTACK_VEHICLE, {LOCAL_PLAYER, CHARACTER_JULIUS}, Em01_missile_sequence[rand_int(1, Num_em01_missile_sequence)])
                                                                              • em01.lua, line 1453: em01_missile_attack_sequence(HELI_ATTACK_VEHICLE, {LOCAL_PLAYER, CHARACTER_JULIUS, REMOTE_PLAYER}, Em01_missile_sequence[rand_int(1, Num_em01_missile_sequence)])
                                                                              • em01.lua, line 2513: em01_missile_attack_sequence(LAST_STAND_HELI_A, {LOCAL_PLAYER, CHARACTER_JULIUS}, Em01_missile_sequence[rand_int(1, Num_em01_missile_sequence)])
                                                                              • em01.lua, line 2515: em01_missile_attack_sequence(LAST_STAND_HELI_A, {LOCAL_PLAYER, CHARACTER_JULIUS, REMOTE_PLAYER}, Em01_missile_sequence[rand_int(1, Num_em01_missile_sequence)])
                                                                              • em01.lua, line 2570: em01_missile_attack_sequence(LAST_STAND_HELI_B, {LOCAL_PLAYER, CHARACTER_JULIUS}, Em01_missile_sequence[rand_int(1, Num_em01_missile_sequence)])
                                                                              • em01.lua, line 2572: em01_missile_attack_sequence(LAST_STAND_HELI_B, {LOCAL_PLAYER, CHARACTER_JULIUS, REMOTE_PLAYER}, Em01_missile_sequence[rand_int(1, Num_em01_missile_sequence)])
                                                                              em01_move_julius_to_point false 1
                                                                                em01_oh_shit_a_execute false 1
                                                                                  em01_oh_shit_b_execute false 1
                                                                                    em01_path_chase_setup false 1 1
                                                                                    em01_path_chase_vehicle_chase false 1
                                                                                      em01_peel_off false 1
                                                                                        em01_perimeter_attack_heli false 1 1
                                                                                        em01_perimeter_east false 1 1
                                                                                        em01_perimeter_south false 1 1
                                                                                        em01_perimeter_west false 1 1
                                                                                        em01_protect_julius_car false 1 1
                                                                                        em01_protect_vehicle_exchange false 1
                                                                                          em01_setup_julius_vehicle false 1 1
                                                                                          em01_smoke_it_up false 1
                                                                                            em01_south_killed false 1
                                                                                              em01_south_perimeter_vehicle_pathfind false 1
                                                                                                em01_start false 1
                                                                                                  em01_success false 1
                                                                                                    em01_they_have_helicopters false 1
                                                                                                      em01_vehicle_destroyed false 1
                                                                                                        em01_vehicle_entered false 1
                                                                                                          em01_vehicle_exited false 1
                                                                                                            em01_wait_for_car_load false 1
                                                                                                              em01_weak_destroyed false 1
                                                                                                                em01_west_killed false 1
                                                                                                                  em01_west_perimeter_vehicle_pathfind false 1
                                                                                                                    em02_cleanup false 1
                                                                                                                      em02_start false 1
                                                                                                                        em02_success false 1
                                                                                                                          enter_annex false 1
                                                                                                                            ep01_call_received false 1
                                                                                                                              ep01_cleanup false 1
                                                                                                                                ep01_cleanup_club_trigger false 1 4
                                                                                                                                ep01_club_entered false 1
                                                                                                                                  ep01_club_exited false 1
                                                                                                                                    ep01_complete false 1 1
                                                                                                                                    ep01_display_pierce_health false 1
                                                                                                                                      ep01_enemy_killed false 1
                                                                                                                                        ep01_enter_ltnt_trigger false 1
                                                                                                                                          ep01_escort_driver_killed false 1
                                                                                                                                            ep01_escort_vehicle_disabled false 1 1
                                                                                                                                            ep01_exit_club false 1 1
                                                                                                                                            ep01_failure_pierce_abandoned false 1
                                                                                                                                              ep01_failure_pierce_died false 1 2
                                                                                                                                              ep01_failure_shaundi_abandoned false 1
                                                                                                                                                ep01_failure_shaundi_died false 1 2
                                                                                                                                                ep01_get_parameter_value false 1 20
                                                                                                                                                • ep01.lua, line 379: local blitz_chance = ep01_get_parameter_value("ULTOR_BLITZ_CHANCE")
                                                                                                                                                • ep01.lua, line 380: local attack_npc_chance = ep01_get_parameter_value("ULTOR_ATTACK_NPC_CHANCE")
                                                                                                                                                • ep01.lua, line 803: local saved_notoriety_level = ep01_get_parameter_value("MIN_POLICE_NOTORIETY")
                                                                                                                                                • ep01.lua, line 1050: local van_disabled_health_percent = ep01_get_parameter_value("VAN_DISABLED_PERCENT_HEALTH")
                                                                                                                                                • ep01.lua, line 1051: local van_max_hit_points = ep01_get_parameter_value("VAN_HIT_POINTS")
                                                                                                                                                • ep01.lua, line 1104: local van_disabled_health_percent = ep01_get_parameter_value("VAN_DISABLED_PERCENT_HEALTH")
                                                                                                                                                • ep01.lua, line 1105: local van_hit_points = ep01_get_parameter_value("VAN_HIT_POINTS")
                                                                                                                                                • ep01.lua, line 1233: local speed_initial = ep01_get_parameter_value("VAN_MAX_SPEED_INITIAL")
                                                                                                                                                • ep01.lua, line 1234: local speed_damaged = ep01_get_parameter_value("VAN_MAX_SPEED_DAMAGED")
                                                                                                                                                • ep01.lua, line 1235: local range_ratio = ep01_get_parameter_value("VAN_OUT_OF_RANGE_SPEED_RATIO")
                                                                                                                                                • ep01.lua, line 1236: local range_dist_m = ep01_get_parameter_value("VAN_OUT_OF_RANGE_DIST_M")
                                                                                                                                                • ep01.lua, line 1395: local van_max_hit_points = ep01_get_parameter_value("VAN_HIT_POINTS")
                                                                                                                                                • ep01.lua, line 1396: local van_disabled_health_percent = ep01_get_parameter_value("VAN_DISABLED_PERCENT_HEALTH")
                                                                                                                                                • ep01.lua, line 1397: local van_hit_points = ep01_get_parameter_value("VAN_HIT_POINTS")
                                                                                                                                                • ep01.lua, line 1588: local pierce_max_hit_points = ep01_get_parameter_value("PIERCE_MAX_HIT_POINTS")
                                                                                                                                                • ep01.lua, line 1593: hit_points = pierce_max_hit_points * ep01_get_parameter_value("PIERCE_PERCENT_HEALTH")
                                                                                                                                                • ep01.lua, line 1686: local pierce_max_hit_points = ep01_get_parameter_value("PIERCE_MAX_HIT_POINTS")
                                                                                                                                                • ep01.lua, line 1687: local pierce_percent_health = ep01_get_parameter_value("PIERCE_PERCENT_HEALTH")
                                                                                                                                                • ep01.lua, line 1715: local survival_ticks = ep01_get_parameter_value("PIERCE_SURVIVAL_TICKS")
                                                                                                                                                • ep01.lua, line 1716: local survival_time_s= ep01_get_parameter_value("PIERCE_SURVIVAL_TIME_S")
                                                                                                                                                ep01_get_sequence_sync false 1 11
                                                                                                                                                ep01_group_create_maybe_coop false 1 2
                                                                                                                                                • ep01.lua, line 369: ep01_group_create_maybe_coop(GROUP_CLUB_ULTOR, GROUP_CLUB_ULTOR_COOP, true)
                                                                                                                                                • ep01.lua, line 370: ep01_group_create_maybe_coop(GROUP_CLUB_ULTOR_OUTSIDE, GROUP_CLUB_ULTOR_OUTSIDE_COOP, true)
                                                                                                                                                ep01_initialize false 1 1
                                                                                                                                                ep01_initialize_checkpoint false 1 1
                                                                                                                                                ep01_initialize_common false 1 1
                                                                                                                                                ep01_join_pierce false 1
                                                                                                                                                  ep01_join_shaundi false 1 1
                                                                                                                                                  ep01_join_shaundi_monitor false 1
                                                                                                                                                    ep01_masako_team_attack false 1 2
                                                                                                                                                    ep01_masako_team_a_attack false 1
                                                                                                                                                      ep01_masako_team_b_attack false 1
                                                                                                                                                        ep01_notoriety_thread false 1
                                                                                                                                                          ep01_override_shaundi_persona false 1 2
                                                                                                                                                          ep01_phone_call false 1
                                                                                                                                                            ep01_pierce_maybe_damaged false 1 2
                                                                                                                                                            ep01_pierce_ultor_patrol false 1
                                                                                                                                                              ep01_player_entered_pierce_cutscene_area false 1
                                                                                                                                                                ep01_prepare_ltnt_triggers false 1 1
                                                                                                                                                                ep01_process_enemy_set false 1
                                                                                                                                                                  ep01_process_escort_2 false 1
                                                                                                                                                                    ep01_process_van_chase false 1 1
                                                                                                                                                                    ep01_release_to_world_maybe_coop false 1 1
                                                                                                                                                                    • ep01.lua, line 570: ep01_release_to_world_maybe_coop(GROUP_CLUB_ULTOR, GROUP_CLUB_ULTOR_COOP)
                                                                                                                                                                    ep01_save_pierce false 1
                                                                                                                                                                      ep01_save_shaundi false 1
                                                                                                                                                                        ep01_setup_club_trigger false 1 4
                                                                                                                                                                        • ep01.lua, line 543: ep01_setup_club_trigger(TRIGGER_CLUB_FRONT_EXIT, "ep01_club_exited", true)
                                                                                                                                                                        • ep01.lua, line 544: ep01_setup_club_trigger(TRIGGER_CLUB_REAR_EXIT, "ep01_club_exited", true)
                                                                                                                                                                        • ep01.lua, line 546: ep01_setup_club_trigger(TRIGGER_CLUB_FRONT_ENTRANCE, "ep01_club_entered", false)
                                                                                                                                                                        • ep01.lua, line 547: ep01_setup_club_trigger(TRIGGER_CLUB_REAR_ENTRANCE, "ep01_club_entered", false)
                                                                                                                                                                        ep01_setup_masako_teams false 1 1
                                                                                                                                                                        ep01_setup_shaundi false 1
                                                                                                                                                                          ep01_start false 1
                                                                                                                                                                            ep01_success false 1
                                                                                                                                                                              ep01_van_damaged false 1
                                                                                                                                                                                ep01_van_disabled false 1 1
                                                                                                                                                                                ep01_van_speed false 1
                                                                                                                                                                                  ep01_waypoint_thread false 1
                                                                                                                                                                                    ep02_breadcrumb_reached false 1
                                                                                                                                                                                      ep02_breadcrumb_to_location false 1 2
                                                                                                                                                                                      • ep02.lua, line 378: ep02_breadcrumb_to_location( TRIGGERS_BASE_ENTRY_BREADCRUMBS, INGAME_EFFECT_LOCATION, TEXT_MEET_GAT)
                                                                                                                                                                                      • ep02.lua, line 406: ep02_breadcrumb_to_location( TRIGGERS_KEY_BREADCRUMBS, INGAME_EFFECT_LOCATION, TEXT_GET_KEY)
                                                                                                                                                                                      ep02_cleanup false 1
                                                                                                                                                                                        ep02_cutscene false 1
                                                                                                                                                                                          ep02_district_changed false 1
                                                                                                                                                                                            ep02_elevator_keys_acquired false 1
                                                                                                                                                                                              ep02_enter_ultor_base false 1 1
                                                                                                                                                                                              ep02_escape false 1 2
                                                                                                                                                                                              ep02_failure_bomb_timer false 1
                                                                                                                                                                                                ep02_failure_gat_died false 1
                                                                                                                                                                                                  ep02_failure_gat_dismissed false 1
                                                                                                                                                                                                    ep02_failure_out_of_row false 1
                                                                                                                                                                                                      ep02_failure_wrong_exit false 1
                                                                                                                                                                                                        ep02_final_breadcrumb_triggered false 1
                                                                                                                                                                                                          ep02_initialize false 1 1
                                                                                                                                                                                                          ep02_initialize_checkpoint false 1 1
                                                                                                                                                                                                          ep02_initialize_common false 1 1
                                                                                                                                                                                                          ep02_open_lab_door false 1
                                                                                                                                                                                                            ep02_piss_off_the_ultor false 1 1
                                                                                                                                                                                                            ep02_plant_bomb false 1
                                                                                                                                                                                                              ep02_prereq_low_notoriety false 1
                                                                                                                                                                                                                ep02_send_to_location false 1
                                                                                                                                                                                                                  ep02_start false 1
                                                                                                                                                                                                                    ep02_success false 1
                                                                                                                                                                                                                      ep02_success_base_escaped false 1 1
                                                                                                                                                                                                                      ep02_toggle_location_reached false 1
                                                                                                                                                                                                                        ep02_ultor_base false 1 2
                                                                                                                                                                                                                        ep02_update_waypoint false 1 11
                                                                                                                                                                                                                        ep02_wrong_exit_warning false 1
                                                                                                                                                                                                                          ep03_board_getaway_boat false 1 1
                                                                                                                                                                                                                          ep03_boat_destroyed false 1
                                                                                                                                                                                                                            ep03_boat_jacked false 1
                                                                                                                                                                                                                              ep03_character_in_vehicle_of_correct_type false 1 2
                                                                                                                                                                                                                              • ep03.lua, line 169: ep03_character_in_vehicle_of_correct_type( LOCAL_PLAYER ) or
                                                                                                                                                                                                                              • ep03.lua, line 170: ( coop_is_active() and ep03_character_in_vehicle_of_correct_type( REMOTE_PLAYER ) ) )
                                                                                                                                                                                                                              ep03_cleanup false 1
                                                                                                                                                                                                                                ep03_end_patrol_start_chase false 1
                                                                                                                                                                                                                                  ep03_exec_flee false 1
                                                                                                                                                                                                                                    ep03_exec_killed false 1
                                                                                                                                                                                                                                      ep03_failure_ultor_safety false 1 1
                                                                                                                                                                                                                                      ep03_getaway_boat_destroyed false 1
                                                                                                                                                                                                                                        ep03_get_on_wavecraft false 1 1
                                                                                                                                                                                                                                        ep03_get_to_the_yacht false 1 1
                                                                                                                                                                                                                                        ep03_heli_chase false 1
                                                                                                                                                                                                                                          ep03_heli_watch false 1
                                                                                                                                                                                                                                            ep03_kill_final_exec false 1
                                                                                                                                                                                                                                              ep03_kill_ultor_execs false 1 1
                                                                                                                                                                                                                                              ep03_mid_mission_cutscene false 1 1
                                                                                                                                                                                                                                              ep03_send_attack_helicopter false 1 2
                                                                                                                                                                                                                                              ep03_start false 1
                                                                                                                                                                                                                                                ep03_success false 1
                                                                                                                                                                                                                                                  ep03_success_final_exec_killed false 1
                                                                                                                                                                                                                                                    ep03_ultor_getaway false 1
                                                                                                                                                                                                                                                      ep03_yacht_patrol false 1
                                                                                                                                                                                                                                                        ep03_yacht_patrol_pathfind false 1
                                                                                                                                                                                                                                                          ep04_all_players_too_far_from_limo false 1 1
                                                                                                                                                                                                                                                          ep04_cleanup false 1
                                                                                                                                                                                                                                                            ep04_enemy_heli_spawn_and_attack false 1 1
                                                                                                                                                                                                                                                            ep04_entered_attack_heli_tower_attack false 1
                                                                                                                                                                                                                                                              ep04_entered_vehicle_attack_tower false 1
                                                                                                                                                                                                                                                                ep04_entered_vehicle_initial false 1
                                                                                                                                                                                                                                                                  ep04_gat_and_player_converse false 1
                                                                                                                                                                                                                                                                    ep04_gat_call_received false 1
                                                                                                                                                                                                                                                                      ep04_get_next_heli_warp_point false 1 1
                                                                                                                                                                                                                                                                      ep04_get_next_living_node false 1 1
                                                                                                                                                                                                                                                                      • ep04.lua, line 806: local next_living_node = ep04_get_next_living_node( security_node_name )
                                                                                                                                                                                                                                                                      ep04_good_distance_from_limo false 1
                                                                                                                                                                                                                                                                        ep04_helicopter_destroyed false 1
                                                                                                                                                                                                                                                                          ep04_left_attack_heli_tower_attack false 1
                                                                                                                                                                                                                                                                            ep04_limo_damage_handler false 1 2
                                                                                                                                                                                                                                                                            ep04_limo_loop_pathfind false 1
                                                                                                                                                                                                                                                                              ep04_limo_return_to_tower_pathfind false 1
                                                                                                                                                                                                                                                                                ep04_next_heli_spawn false 1
                                                                                                                                                                                                                                                                                  ep04_node1_defenders_attack false 1
                                                                                                                                                                                                                                                                                    ep04_node2_defenders_attack false 1
                                                                                                                                                                                                                                                                                      ep04_node3_defenders_attack false 1
                                                                                                                                                                                                                                                                                        ep04_node4_defenders_attack false 1
                                                                                                                                                                                                                                                                                          ep04_node_defenders_attack false 1 4
                                                                                                                                                                                                                                                                                          ep04_no_player_in_helicopter false 1 2
                                                                                                                                                                                                                                                                                          ep04_reached_top_of_tower false 1
                                                                                                                                                                                                                                                                                            ep04_reached_vogels_limo_initial false 1
                                                                                                                                                                                                                                                                                              ep04_security_node_destroyed false 1
                                                                                                                                                                                                                                                                                                ep04_setup_state false 1 5
                                                                                                                                                                                                                                                                                                ep04_setup_vogel_limo false 1 1
                                                                                                                                                                                                                                                                                                ep04_setup_vogel_limo_tracking false 1 1
                                                                                                                                                                                                                                                                                                ep04_start false 1
                                                                                                                                                                                                                                                                                                  ep04_start_or_resume_from_checkpoint false 1 1
                                                                                                                                                                                                                                                                                                  ep04_stop_heli_attack false 1 1
                                                                                                                                                                                                                                                                                                  ep04_success false 1
                                                                                                                                                                                                                                                                                                    ep04_too_far_from_vogels_limo false 1
                                                                                                                                                                                                                                                                                                      ep04_vogel_damaged false 1
                                                                                                                                                                                                                                                                                                        ep04_vogel_died false 1
                                                                                                                                                                                                                                                                                                          ep04_vogel_fail_help_text_timer false 1
                                                                                                                                                                                                                                                                                                            ep04_vogel_flee false 1
                                                                                                                                                                                                                                                                                                              ep04_vogel_limo_collision false 1
                                                                                                                                                                                                                                                                                                                ep04_vogel_limo_damaged false 1 1
                                                                                                                                                                                                                                                                                                                • ep04.lua, line 882: ep04_vogel_limo_damaged( attacked_object_name, attacker_name, percent_hp_remaining_after_attack )
                                                                                                                                                                                                                                                                                                                ep04_vogel_limo_initial_damage false 1
                                                                                                                                                                                                                                                                                                                  escort_attack false 1 2