Saints Row: The Third 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)
fade_get_percent true
    1
    fade_in true
      54
      fade_in_block true 1 43
      fade_out true
        94
        fade_out_block true 1 66
        filter_change_callback true
          1
          find_widest_text_element true 1 4
          flashlights_disable true
            1
            flashlights_enable true
              1
              flashpoints_enable true
                7
                flashpoint_mission_status true
                  2
                  flashpoint_start_mission true
                    1
                    flee true
                      2
                      flee_to_navpoint true
                        2
                        fn true
                          1
                          follower_is_unconscious true
                            1
                            • sh03.lua, line 1121: while ( (character_is_dead(KINZIE) == true) or (follower_is_unconscious(KINZIE) == true) ) do
                            follower_make_independent true
                              68
                              follower_remain_in_car true
                                10
                                follower_set_can_abandon true
                                  60
                                  force_fire true 1 5
                                  force_fire_do true
                                    1
                                    force_fire_target true 1
                                      force_fire_target_do true
                                        2
                                        force_throw true 1 1
                                        force_throw_char true 1 1
                                        force_throw_char_do true
                                          1
                                          force_throw_do true
                                            1
                                            format_cash true 1 21
                                            format_cash_add_padding true 1
                                              format_clock true 1 2
                                              format_distance true 1 2
                                              format_time true 1 3
                                              fov_check_xz_plane true
                                                3
                                                • m13.lua, line 2084: if fov_check_xz_plane(LOCAL_PLAYER, shaundi, M13_config.fov_to_shaundi) then
                                                • m13.lua, line 2090: elseif fov_check_xz_plane(LOCAL_PLAYER, cyrus, M13_config.fov_to_cyrus) then
                                                • sh04.lua, line 1490: --while( (fov_check_xz_plane(LOCAL_PLAYER, SH04_group.brute_g02.members[0]) == false ) or (fov_check_xz_plane(LOCAL_PLAYER, SH04_group.brute_g02.members[1]) == false) ) do --
                                                func true
                                                  1
                                                  function_ref true 6
                                                    func_name true
                                                      2