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)
rail_cleanup false 1 1
rail_drive_thread false 1
    rail_pause false 1
      rail_play false 1
        rail_resume false 1
          rail_segment_cleanup false 1 2
          rail_setup false 1
            rail_shutdown false 1 1
            rail_vehicle_setup false 1
              rank_up false 1 1
              rank_upgrade_cb false 1
                rank_up_and_upgrade false 1 1
                rank_up_cb false 1
                  record_mode_confirm false 1
                    recursive_mod false 1 2
                    redraw false 1 3
                    reformat_and_resize false 1 7
                    refresh_single_item false 1 1
                    refresh_values false 2
                      release_scrolltab false 1 22
                      remove_all false 1 148
                      remove_input false 1 25
                      remove_input_by_object_handle false 1 4
                      remove_new_flag false 1 10
                      reset false 2 2
                      ResetLocalPlayerStuff false 1 2
                      ResetRemotePlayerStuff false 1 2
                      reset_child_tween_object false 1
                        reset_config false 1 2
                        reset_first_update false 1 1
                        reset_width false 1 1
                        resize false 1 1
                        resize_options false 1 1
                        respect_meter_hide false 1
                          respect_meter_show false 1 1
                          respect_total_update false 1 4
                          respect_up_cb false 1
                            return_complete_cb false 1
                              return_data false 3 23
                              return_selected_cat false 1 1
                              return_selected_data false 3 38
                              return_selected_index false 1 29
                              return_size false 2
                                return_state false 1 1
                                reward_granted_add false 1
                                  reward_granted_add_upgrades_descriptions false 1 4
                                  • reward_granted.lua, line 184: --[[reward_granted_add_upgrades_descriptions("Test ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt.", 1)
                                  • reward_granted.lua, line 185: reward_granted_add_upgrades_descriptions("Lorem ipsum dolor sit amet, consectetur adipisicing elit.", 2)
                                  • reward_granted.lua, line 186: reward_granted_add_upgrades_descriptions("Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt.", 3)
                                  • reward_granted.lua, line 187: reward_granted_add_upgrades_descriptions("Lorem ipsum dolor sit amet, consectetur adipisicing elit.", 2)]]
                                  reward_granted_button_press false 1 2
                                  reward_granted_cleanup false 1
                                    reward_granted_init false 1
                                      reward_granted_inputs_unsubscribe false 1 2
                                      reward_granted_mouse_click false 1
                                        reward_granted_mouse_move false 1
                                          reward_granted_next_cb false 1
                                            reward_granted_next_screen false 1 1
                                            reward_granted_set_reward_count false 1 2
                                            reward_granted_start false 1 2
                                            reward_screen_fade_cb false 1 2
                                            roll_credits false 1
                                              row_down_wrap false 1 2
                                              row_get_column_positions false 1 1
                                              row_up_wrap false 1 2
                                              run_text false 1
                                                r_add_respect false 1
                                                  r_add_respect_double false 1
                                                    r_remove_respect false 1
                                                      r_remove_respect_double false 1
                                                        r_update_respect false 1 6