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)
dark_inciter_disable_summon true
    1
    dark_inciter_kill_summons_on_death true
      1
      dark_inciter_ultra_shield_only_vulnerable_to_superpowers true
        7
        dataitem_to_debug true 1 2
        • pause_map.lua, line 1051: --dataitem_to_debug(di_h, "icon_bmp_name", "text_line_1", "text_line_2", "text_line_3", "text_line_4", "is_highlighted", "is_gps_target", "taxi_available")
        • vint_lib.lua, line 476: -- Example: dataitem_to_debug(di_h, "icon_bmp_name", "coord_x", "coord_y")
        debug_print true 1 324
        default_on_back true
          1
          default_on_nav true
            3
            default_on_sub_menu_fill true
              1
              delay true 1 236
              dialog_box_create_internal true
                1
                • dialog.lua, line 399: local handle = dialog_box_create_internal(header, body, callback, priority, is_confirmation, is_spinner, options[0], options[1], options[2], options[3], default, is_close_on_death, is_close_on_damage, is_close_on_mission_end, back_option)
                dialog_box_disconnect true
                  5
                  dialog_box_force_close true
                    4
                    dialog_box_force_close_all true
                      1
                      dialog_box_set_body true
                        1
                        dialog_box_set_current_option true
                          1
                          dialog_box_set_result true
                            2
                            dialog_close_finished true
                              1
                              dialog_open_pause_display true
                                4
                                dialog_option_accept_kbd_input true
                                  1
                                  dialog_option_end_kbd_input true
                                    1
                                    dialog_pause_unpause true
                                      1
                                      disable_diversions true
                                        8
                                        doc true
                                          1
                                          • cmp_common.lua, line 84: Cmp_specific_doc = -1 -- Handle of specific completion screen doc(mission, activity, stronghold)
                                          door_lock true
                                            6
                                            door_open true
                                              1
                                              • mintrobb.lua, line 1164: door_open("whammer_crate_mover", false, true, human, "open crate", "chest_anim_sync_nav")
                                              do_nothing true 1