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)
mesh_mover_hide true
    1
    mesh_mover_show true
      1
      mesh_mover_wielding true
        1
        message true
          28
          message_remove true
            1
            message_remove_all true
              17
              minimap_icon_add_do true
                3
                minimap_icon_add_radius_do true
                  1
                  minimap_icon_add_script_group_do true
                    2
                    • game_lib.lua, line 2213: minimap_icon_add_script_group_do( group_name, minimap_icon_name, "", 0, sync_type )
                    • game_lib.lua, line 2386: minimap_icon_add_script_group_do(group_name, minimap_icon_name, bitmap_glow_name, radius, sync_type)
                    minimap_icon_remove_do true
                      3
                      minimap_icon_remove_radius_do true
                        1
                        minimap_icon_remove_script_group_do true
                          2
                          mip_streaming_pause true
                            2
                            mission_end_failure true
                              17
                              mission_end_success true
                                17
                                mission_help_table_do true
                                  2
                                  mission_is_active true
                                    20
                                    mission_is_complete true
                                      46
                                      mission_is_failed true
                                        10
                                        mission_set_cancel_warp_location true
                                          6
                                          mission_set_checkpoint true
                                            1
                                            • game_lib.lua, line 4779: mission_set_checkpoint(cur_checkpoint.name, cur_checkpoint.ignore_vehicles, cur_checkpoint.ignore_notoriety)
                                            morph_complete_cb true
                                              1
                                              move_to_do true
                                                4
                                                mp_is_enabled true 1 1
                                                msn_killbane_get_option_text true
                                                  1
                                                  msn_killbane_selected_option true
                                                    1
                                                    msn_text_adventure_set_screen true
                                                      2