Saints Row 2 Function Reference

Global functions

These functions are assumed to be globally available to all scripts since they aren't defined in the patch lua files.

This list is incomplete; additional functions could exist in the exe but not be used in the game lua, and some lua files may always be loaded (system_lib.lua?) making their functions essentially global.

Function name Global Defined in Examples from patch (click blue number to expand)
parachute_disable true
    1
    parachute_enable true
      3
      parking_spot_enable true
        14
        party_add_do true
          2
          party_allow_max_followers true
            6
            party_dismiss_all true
              22
              party_dismiss_do true
                1
                party_get_follower_index true
                  5
                  party_set_dismissable true
                    2
                    party_set_recruitable true
                      9
                      party_swap_follower_indices true
                        5
                        party_use_melee_weapons_only true
                          6
                          path_name_is_path true
                            2
                            patrol true
                              15
                              patrol_pause true
                                2
                                patrol_unpause true
                                  2
                                  pause_map_filter true
                                    2
                                    pause_menu_accept_options true
                                      1
                                      pause_menu_audio_play_preview true
                                        3
                                        pause_menu_can_swap true
                                          3
                                          pause_menu_change_control_scheme true
                                            2
                                            pause_menu_control_scheme_init true
                                              3
                                              pause_menu_error_message_while_saving_PS3 true
                                                1
                                                pause_menu_get_state true
                                                  5
                                                  pause_menu_init_options true
                                                    1
                                                    pause_menu_is_using_southpaw_control_scheme true
                                                      1
                                                      • vint_lib.lua, line 495: if pause_menu_is_using_southpaw_control_scheme() == true and is_local_player_in_vehicle() == false then
                                                      Pause_menu_main_close_ref true
                                                        1
                                                        pause_menu_open_achievements true
                                                          1
                                                          pause_menu_options_init_call true
                                                            1
                                                            pause_menu_options_is_dirty true
                                                              4
                                                              pause_menu_quit_game_internal true
                                                                1
                                                                pause_menu_release_camera true
                                                                  3
                                                                  pause_menu_restore_defaults true
                                                                    1
                                                                    Pause_menu_return_to_main true
                                                                      5
                                                                      pause_menu_revert_options true
                                                                        2
                                                                        pause_menu_select_target true
                                                                          2
                                                                          pause_menu_set_playlist_input_callback true
                                                                            2
                                                                            pause_menu_swap_with_map true
                                                                              2
                                                                              pause_menu_update_option true
                                                                                15
                                                                                pcr_about_to_do_intro_sequence true
                                                                                  1
                                                                                  pcr_add_default_clothing true
                                                                                    1
                                                                                    pcr_apply_morph_value true
                                                                                      7
                                                                                      pcr_apply_preset true
                                                                                        1
                                                                                        pcr_apply_regional_preset true
                                                                                          1
                                                                                          • pcr01.lua, line 576: pcr_apply_regional_preset("figure", Pcr01_current_preset_gender .. "_" .. Pcr01_current_preset_figure)
                                                                                          pcr_avatar_changed true
                                                                                            1
                                                                                            pcr_avatar_is_blank true
                                                                                              1
                                                                                              pcr_change_eye_color true
                                                                                                3
                                                                                                pcr_change_hair true
                                                                                                  2
                                                                                                  pcr_change_identity true
                                                                                                    1
                                                                                                    pcr_change_makeup true
                                                                                                      4
                                                                                                      • pcr01.lua, line 1482: pcr_change_makeup(Pcr01_current_makeup_area, item, variant, primary_color, secondary_color)
                                                                                                      • pcr01.lua, line 1527: pcr_change_makeup(Pcr01_current_makeup_area, item, variant, primary_color, secondary_color)
                                                                                                      • pcr01.lua, line 1570: pcr_change_makeup(Pcr01_current_makeup_area, item, variant, primary_color, secondary_color)
                                                                                                      • pcr01.lua, line 1593: pcr_change_makeup(area, item, variant, primary_color, secondary_color)
                                                                                                      pcr_change_skin_color true
                                                                                                        3
                                                                                                        pcr_get_current_voice_number true
                                                                                                          1
                                                                                                          pcr_get_hair_info true
                                                                                                            6
                                                                                                            pcr_get_makeup_info true
                                                                                                              1
                                                                                                              • pcr01.lua, line 195: Pcr01_current_makeup_item, Pcr01_current_makeup_variant, Pcr01_current_makeup_primary_color, Pcr01_current_makeup_secondary_color = pcr_get_makeup_info(area)
                                                                                                              pcr_get_morph_value true
                                                                                                                2
                                                                                                                pcr_get_player_preset true
                                                                                                                  1
                                                                                                                  • pcr01.lua, line 481: Pcr01_current_preset_gender, Pcr01_current_preset_race, Pcr01_current_preset_figure = pcr_get_player_preset()
                                                                                                                  pcr_hair_randomize true
                                                                                                                    1
                                                                                                                    • pcr01.lua, line 387: local item, primary_color, secondary_color = pcr_hair_randomize(Pcr01_hair_preview_area, -2, -1, -1)
                                                                                                                    pcr_hair_randomize_all true
                                                                                                                      1
                                                                                                                      pcr_is_plastic_surgeon true
                                                                                                                        6
                                                                                                                        pcr_is_streaming true
                                                                                                                          1
                                                                                                                          pcr_makeup_randomize true
                                                                                                                            3
                                                                                                                            • pcr01.lua, line 1406: local item, variant, primary_color, secondary_color = pcr_makeup_randomize(Pcr01_current_makeup_area, Pcr01_current_makeup_item, -1, -1, -1)
                                                                                                                            • pcr01.lua, line 1541: local item, variant, primary_color, secondary_color = pcr_makeup_randomize(Pcr01_current_makeup_area, -2, -1, -1, -1)
                                                                                                                            • pcr01.lua, line 1591: item, variant, primary_color, secondary_color = pcr_makeup_randomize(area, -2, -1, -1, -1)
                                                                                                                            pcr_mark_changed true
                                                                                                                              24
                                                                                                                              pcr_preview_anim true
                                                                                                                                3
                                                                                                                                pcr_release_camera true
                                                                                                                                  1
                                                                                                                                  pcr_report_anims true
                                                                                                                                    1
                                                                                                                                    pcr_report_avail_morphs true
                                                                                                                                      2
                                                                                                                                      pcr_report_eye_colors true
                                                                                                                                        1
                                                                                                                                        pcr_report_hair_colors true
                                                                                                                                          1
                                                                                                                                          • pcr01.lua, line 854: pcr_report_hair_colors(Pcr01_hair_preview_area, menu_data.is_primary, "pcr01_add_hair_color")
                                                                                                                                          pcr_report_hair_items true
                                                                                                                                            1
                                                                                                                                            pcr_report_makeup_colors true
                                                                                                                                              1
                                                                                                                                              • pcr01.lua, line 1200: pcr_report_makeup_colors(Pcr01_current_makeup_area, Pcr01_makeup_color_is_primary, "pcr01_makeup_add_color")
                                                                                                                                              pcr_report_makeup_items true
                                                                                                                                                1
                                                                                                                                                pcr_report_makeup_variants true
                                                                                                                                                  1
                                                                                                                                                  • pcr01.lua, line 1109: pcr_report_makeup_variants(Pcr01_current_makeup_item, "pcr01_makeup_variation_add_item")
                                                                                                                                                  pcr_report_skin_colors true
                                                                                                                                                    1
                                                                                                                                                    pcr_save_to_mp_storage true
                                                                                                                                                      3
                                                                                                                                                      pcr_set_anim true
                                                                                                                                                        3
                                                                                                                                                        pcr_set_voice true
                                                                                                                                                          3
                                                                                                                                                          pcr_stop_anim true
                                                                                                                                                            1
                                                                                                                                                            pcu_bra_required true
                                                                                                                                                              2
                                                                                                                                                              pcu_can_create_outfit true
                                                                                                                                                                1
                                                                                                                                                                pcu_category_nav_clear_slot true
                                                                                                                                                                  1
                                                                                                                                                                  pcu_clear_obscured_slots true
                                                                                                                                                                    1
                                                                                                                                                                    pcu_clear_preview_slot true
                                                                                                                                                                      4
                                                                                                                                                                      pcu_create_outfit true
                                                                                                                                                                        1
                                                                                                                                                                        pcu_delete_outfit true
                                                                                                                                                                          1
                                                                                                                                                                          pcu_discard_slot true
                                                                                                                                                                            2
                                                                                                                                                                            pcu_get_areas true
                                                                                                                                                                              1
                                                                                                                                                                              pcu_get_categories_in_area true
                                                                                                                                                                                1
                                                                                                                                                                                pcu_get_items_in_category true
                                                                                                                                                                                  1
                                                                                                                                                                                  pcu_get_item_defaults true
                                                                                                                                                                                    1
                                                                                                                                                                                    pcu_get_owned_item_info true
                                                                                                                                                                                      1
                                                                                                                                                                                      pcu_get_slot_info true
                                                                                                                                                                                        1
                                                                                                                                                                                        pcu_get_store_info true
                                                                                                                                                                                          1
                                                                                                                                                                                          • clothing_store.lua, line 81: Clothing_store_name, Clothing_store_display_name, Clothing_store_allow_wardrobe, start_wardrobe = pcu_get_store_info()
                                                                                                                                                                                          pcu_get_variants true
                                                                                                                                                                                            1
                                                                                                                                                                                            pcu_get_wear_options true
                                                                                                                                                                                              1
                                                                                                                                                                                              pcu_is_bra_category true
                                                                                                                                                                                                2
                                                                                                                                                                                                pcu_is_current_item_worn true
                                                                                                                                                                                                  1
                                                                                                                                                                                                  • clothing_store.lua, line 819: if pcu_is_current_item_worn(Clothing_store_item_info.slot_index, Clothing_store_item_info.wardrobe_instance) then
                                                                                                                                                                                                  pcu_is_item_needed_for_outfit true
                                                                                                                                                                                                    1
                                                                                                                                                                                                    pcu_is_item_owned true
                                                                                                                                                                                                      3
                                                                                                                                                                                                      pcu_is_streaming_done true
                                                                                                                                                                                                        10
                                                                                                                                                                                                        pcu_is_underwear_category true
                                                                                                                                                                                                          2
                                                                                                                                                                                                          pcu_is_wearing_item true
                                                                                                                                                                                                            1
                                                                                                                                                                                                            pcu_purchase_outfit true
                                                                                                                                                                                                              1
                                                                                                                                                                                                              pcu_purchase_slot true
                                                                                                                                                                                                                2
                                                                                                                                                                                                                pcu_remove_clothing true
                                                                                                                                                                                                                  1
                                                                                                                                                                                                                  pcu_report_avail_mp_badges true
                                                                                                                                                                                                                    1
                                                                                                                                                                                                                    pcu_report_item_colors true
                                                                                                                                                                                                                      1
                                                                                                                                                                                                                      pcu_report_logos true
                                                                                                                                                                                                                        1
                                                                                                                                                                                                                        pcu_report_outfits true
                                                                                                                                                                                                                          2
                                                                                                                                                                                                                          pcu_reset_handle true
                                                                                                                                                                                                                            1
                                                                                                                                                                                                                            pcu_set_active_category true
                                                                                                                                                                                                                              2
                                                                                                                                                                                                                              pcu_set_mp_badge true
                                                                                                                                                                                                                                1
                                                                                                                                                                                                                                pcu_set_slots_empty true
                                                                                                                                                                                                                                  3
                                                                                                                                                                                                                                  pcu_set_suits_active_category true
                                                                                                                                                                                                                                    1
                                                                                                                                                                                                                                    pcu_wear_current_clothing true
                                                                                                                                                                                                                                      1
                                                                                                                                                                                                                                      pcu_wear_outfit true
                                                                                                                                                                                                                                        3
                                                                                                                                                                                                                                        pcu_wear_store_outfit true
                                                                                                                                                                                                                                          1
                                                                                                                                                                                                                                          pc_capture_input_key true
                                                                                                                                                                                                                                            2
                                                                                                                                                                                                                                            pc_capture_input_key_get_result true
                                                                                                                                                                                                                                              1
                                                                                                                                                                                                                                              pc_capture_input_pad true
                                                                                                                                                                                                                                                1
                                                                                                                                                                                                                                                pc_capture_input_pad_get_result true
                                                                                                                                                                                                                                                  1
                                                                                                                                                                                                                                                  pc_get_action_key_pure_text true
                                                                                                                                                                                                                                                    3
                                                                                                                                                                                                                                                    pc_get_action_pad_pure_text true
                                                                                                                                                                                                                                                      3
                                                                                                                                                                                                                                                      • pause_menu.lua, line 6209: local action_key_text = pc_get_action_pad_pure_text( Pause_menu_pad_control_sub_menu_PC[i].actid )
                                                                                                                                                                                                                                                      • pause_menu.lua, line 6250: local action_key_text = pc_get_action_pad_pure_text( Pause_menu_pad_control_sub_menu_PC[i].actid )
                                                                                                                                                                                                                                                      • pause_menu.lua, line 6296: local action_key_text = pc_get_action_pad_pure_text( Pause_menu_pad_control_sub_menu_PC[i].actid )
                                                                                                                                                                                                                                                      pc_invoke_exit_game true
                                                                                                                                                                                                                                                        1
                                                                                                                                                                                                                                                        peg_load true
                                                                                                                                                                                                                                                          60
                                                                                                                                                                                                                                                          peg_unload true
                                                                                                                                                                                                                                                            78
                                                                                                                                                                                                                                                            persona_override_character_start_do true
                                                                                                                                                                                                                                                              2
                                                                                                                                                                                                                                                              • ug_lib.lua, line 2223: persona_override_character_start_do(character, persona_situation, trigger_prefix .. trigger, count)
                                                                                                                                                                                                                                                              • ug_lib.lua, line 2227: persona_override_character_start_do(character, situation, trigger_prefix .. trigger, count)
                                                                                                                                                                                                                                                              persona_override_character_stop_all true
                                                                                                                                                                                                                                                                11
                                                                                                                                                                                                                                                                persona_override_character_stop_do true
                                                                                                                                                                                                                                                                  2
                                                                                                                                                                                                                                                                  persona_override_persona_start_do true
                                                                                                                                                                                                                                                                    2
                                                                                                                                                                                                                                                                    persona_override_persona_stop_do true
                                                                                                                                                                                                                                                                      2
                                                                                                                                                                                                                                                                      player_button_just_pressed true
                                                                                                                                                                                                                                                                        2
                                                                                                                                                                                                                                                                        • bh09.lua, line 622: if (get_dist_char_to_nav(LOCAL_PLAYER, TRIGGER_AK47_AMMO) < 3) and player_button_just_pressed(3) then
                                                                                                                                                                                                                                                                        • bh09.lua, line 637: if (get_dist_char_to_nav(LOCAL_PLAYER, TRIGGER_RPG_AMMO) < 3) and player_button_just_pressed(3) then
                                                                                                                                                                                                                                                                        player_controls_disable true
                                                                                                                                                                                                                                                                          69
                                                                                                                                                                                                                                                                          player_controls_enable true
                                                                                                                                                                                                                                                                            74
                                                                                                                                                                                                                                                                            player_creation_is_open_do true
                                                                                                                                                                                                                                                                              1
                                                                                                                                                                                                                                                                              player_creation_open_do true
                                                                                                                                                                                                                                                                                1
                                                                                                                                                                                                                                                                                player_force_vehicle_seat true
                                                                                                                                                                                                                                                                                  8
                                                                                                                                                                                                                                                                                  player_get_custom_voice true
                                                                                                                                                                                                                                                                                    1
                                                                                                                                                                                                                                                                                    player_get_nearest_trigger_of_type true
                                                                                                                                                                                                                                                                                      2
                                                                                                                                                                                                                                                                                      • rn02.lua, line 735: local new_repair_trigger = player_get_nearest_trigger_of_type("car mechanic", player, false)
                                                                                                                                                                                                                                                                                      • rn02.lua, line 1781: local new_repair_trigger = player_get_nearest_trigger_of_type("car mechanic", player, false)
                                                                                                                                                                                                                                                                                      player_is_in_vehicle true
                                                                                                                                                                                                                                                                                        1
                                                                                                                                                                                                                                                                                        • bh11.lua, line 598: while(bh11_num_tribal_drivers_driving() > 3 and not player_is_in_vehicle("#PLAYER1#")) do
                                                                                                                                                                                                                                                                                        player_is_targeting_do true
                                                                                                                                                                                                                                                                                          2
                                                                                                                                                                                                                                                                                          player_names_get_all true
                                                                                                                                                                                                                                                                                            2
                                                                                                                                                                                                                                                                                            player_warp_to_shore_disable true
                                                                                                                                                                                                                                                                                              2
                                                                                                                                                                                                                                                                                              player_warp_to_shore_enable true
                                                                                                                                                                                                                                                                                                2
                                                                                                                                                                                                                                                                                                playlist_is_dirty true
                                                                                                                                                                                                                                                                                                  4
                                                                                                                                                                                                                                                                                                  playlist_is_playing true
                                                                                                                                                                                                                                                                                                    1
                                                                                                                                                                                                                                                                                                    playlist_play_track true
                                                                                                                                                                                                                                                                                                      6
                                                                                                                                                                                                                                                                                                      playlist_save_list true
                                                                                                                                                                                                                                                                                                        1
                                                                                                                                                                                                                                                                                                        position_is_in_trigger true
                                                                                                                                                                                                                                                                                                          2
                                                                                                                                                                                                                                                                                                          prison_blackout_nuke_zone true
                                                                                                                                                                                                                                                                                                            1
                                                                                                                                                                                                                                                                                                            prison_blackout_restore_everything true
                                                                                                                                                                                                                                                                                                              1
                                                                                                                                                                                                                                                                                                              prison_blackout_set_window_threshold true
                                                                                                                                                                                                                                                                                                                2
                                                                                                                                                                                                                                                                                                                prison_blackout_start true
                                                                                                                                                                                                                                                                                                                  1