Saints Row 2 Function Reference

Global functions

These functions are assumed to be globally available to all scripts (they aren't defined in the available Lua files, or are defined in files that are known to be always loaded).

This list is assumed incomplete; additional functions could exist in the exe but not be used in the game scripts, and there's no definitive list of Lua files that are always loaded.

Function name Global Defined in Examples from patch (click blue number to expand)
objective_text true
    		180
    objective_text_clear true
      		95
      object_destroy true
        		10
        on_alt_select true
          		2
          on_back true
            		4
            on_character_right_hand_hit true
              		3
              on_collision true
                		7
                on_damage true
                  		39
                  on_death true
                    		383
                    on_detection true
                      		17
                      on_dismiss true
                        		64
                        on_district_changed true
                          		16
                          on_door_opened true
                            		26
                            on_enter true
                              		2
                              on_exit true
                                		2
                                on_game_time_trigger true
                                  		3
                                  • rn06.lua, line 669: on_game_time_trigger("rn06_jyunichi_maybe_revive", JYUNICHI_PASSED_OUT_TIME_S * 40, 0, 0, 0, 0, 0)
                                  • rn11.lua, line 1755: on_game_time_trigger("rn11_wong_tick_next", trigger_time, 0, 0, 0, 0, 0)
                                  • rn11.lua, line 1778: on_game_time_trigger("rn11_akuji_maybe_revive", AKUJI_PASSED_OUT_TIME_S * 40, 0, 0, 0, 0, 0)
                                  on_horz_show true
                                    		1
                                    on_incapacitated true
                                      		8
                                      on_interior_enter true
                                        		2
                                        on_interior_exit true
                                          		2
                                          on_leave true
                                            		2
                                            on_map true
                                              		1
                                              on_mission_item_drop true
                                                		5
                                                on_mission_item_pickup true
                                                  		6
                                                  on_mover_destroyed true
                                                    		35
                                                    on_nav true
                                                      		26
                                                      on_nav_down true
                                                        		3
                                                        on_nav_left true
                                                          		3
                                                          on_nav_right true
                                                            		3
                                                            on_nav_up true
                                                              		3
                                                              on_notoriety_event true
                                                                		7
                                                                on_panic true
                                                                  		4
                                                                  on_pause true
                                                                    		1
                                                                    on_pickup true
                                                                      		6
                                                                      on_post_show true
                                                                        		2
                                                                        on_projectile_hit true
                                                                          		7
                                                                          on_purchase true
                                                                            		2
                                                                            on_random_human_killed true 1 1
                                                                            on_random_mover_killed true 1
                                                                              on_random_obj_killed true 4
                                                                                on_random_ods_killed true 1 11
                                                                                on_random_vehicle_killed true 1
                                                                                  on_release true
                                                                                    		2
                                                                                    on_respawn true
                                                                                      		17
                                                                                      on_revived true
                                                                                        		11
                                                                                        on_searchlight_track true
                                                                                          		16
                                                                                          on_select true
                                                                                            		10
                                                                                            on_show true
                                                                                              		5
                                                                                              on_tailing_good true
                                                                                                		20
                                                                                                on_tailing_too_far true
                                                                                                  		18
                                                                                                  on_trigger_exit true
                                                                                                    		82
                                                                                                    on_value_update true
                                                                                                      		4
                                                                                                      on_vehicle_destroyed true
                                                                                                        		159
                                                                                                        on_vehicle_enter true
                                                                                                          		109
                                                                                                          on_vehicle_exit true
                                                                                                            		52
                                                                                                            on_vehicle_hitched true
                                                                                                              		4
                                                                                                              on_vehicle_unhitched true
                                                                                                                		4
                                                                                                                on_weapon_equip true
                                                                                                                  		2
                                                                                                                  on_weapon_fired true
                                                                                                                    		49
                                                                                                                    on_weapon_pickup true
                                                                                                                      		6
                                                                                                                      open_vint_dialog true 1 1
                                                                                                                      • tss01.lua, line 1281: local path_choice = open_vint_dialog("tss01_choose", "tss01_body", "tss01_tutorial", "tss01_run_gun")
                                                                                                                      open_vint_dialog_check_done true
                                                                                                                        		2
                                                                                                                        open_vint_dialog_do true
                                                                                                                          		1