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)
hacking_begin_player_voice true
    		1
    hacking_procedural_get_puzzle true
      		1
      hacking_screen_exit true
        		2
        hacking_screen_report true
          		2
          hacking_use_procedural_generation true
            		1
            health_pickups_enable true
              		12
              helicopter_fly_to_do true
                		2
                • game_lib.lua, line 633: if (helicopter_fly_to_do(name, speed, direct, follow, continue_at_goal, path, follow_dist, directly_above, loop_path, start_full_speed, reverse_sp, override_player_control)) then
                • game_lib.lua, line 1968: if (helicopter_fly_to_do(name, speed, direct, follow, continue_at_goal, path, follow_dist, directly_above, loop_path)) then
                hotspot_reset true
                  		1
                  hud_bar_off true
                    		3
                    hud_bar_on true
                      		1
                      • game_lib.lua, line 5388: hud_bar_on(hud_index, "Default", generator.objective, target_progress, sync, OI_ASSET_USE)
                      hud_bar_set_ship_health_percent true
                        		4
                        hud_bar_set_value true
                          		1
                          hud_collection_done true
                            		1
                            hud_critical_timer_set true
                              		1
                              • mintrobb.lua, line 1498: hud_critical_timer_set(mIntroBB_hud_time_ms, "GM_IMPFEST_OBJ_WARN_CLOSER", "mIntroBB_too_far_cb")
                              hud_critical_timer_stop true
                                		2
                                hud_diversion_remove_callback true
                                  		2
                                  hud_gsi_supress_popout true
                                    		2
                                    hud_hide_test_1 true 1
                                      hud_hide_test_2 true 1
                                        hud_inventory_disable true
                                          		8
                                          hud_is_screen_on_stack true
                                            		1
                                            hud_on_foot_radio_next_station true
                                              		1
                                              hud_on_foot_radio_prev_station true
                                                		1
                                                hud_prompt true
                                                  		17
                                                  hud_prompt_clear true
                                                    		26
                                                    hud_prompt_clear_all true
                                                      		2
                                                      hud_push_screen true
                                                        		1
                                                        human_add_teleport_navpoint true
                                                          		6
                                                          human_allow_freefall true
                                                            		5
                                                            human_all_stop_dropping_cash true
                                                              		11
                                                              human_all_stop_dropping_weapons true
                                                                		11
                                                                human_clear_teleport_navpoints true
                                                                  		6
                                                                  human_enter_downed true
                                                                    		1
                                                                    human_get_pos_y true
                                                                      		2
                                                                      human_gravity_enable true
                                                                        		32
                                                                        human_ignore_next_death_anim true
                                                                          		1
                                                                          human_is_downed true
                                                                            		1
                                                                            human_is_frozen true
                                                                              		3
                                                                              human_set_invulnerable_to_freeze true
                                                                                		2
                                                                                human_use_teleport_navpoints true
                                                                                  		5
                                                                                  hvs_voice_controls_active true
                                                                                    		1
                                                                                    hvs_xb1_voice_snap_help true
                                                                                      		2
                                                                                      hvUnlockLoadout true
                                                                                        		7