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)
callback_on_first_damage true
    1
    camera_begin_script_do true
      1
      camera_end_look_through true
        6
        camera_look_through_do true
          1
          camera_script_is_finished true
            1
            camera_shake_start true
              3
              cash_add true
                7
                cash_remove true
                  3
                  cb true
                    6
                    cdl_car_loaded true
                      1
                      cdl_preview_car true
                        1
                        cdl_preview_color true
                          1
                          cdl_purchase_car true
                            1
                            cdl_store_info true
                              1
                              cellphone_activate_cheat true
                                2
                                cellphone_animate_start_do true
                                  4
                                  cellphone_animate_stop_do true
                                    2
                                    cellphone_choose_vehicle true
                                      3
                                      cellphone_clear_between_call_delay true
                                        2
                                        cellphone_dial true
                                          1
                                          • cellphone.lua, line 1099: cellphone_dial(menu_data.book_type, index, "cellphone_dial_connection_cb", "cellphone_call_hangup")
                                          cellphone_dial_number true
                                            1
                                            cellphone_end_call true
                                              1
                                              cellphone_get_time true
                                                1
                                                cellphone_has_received_call true
                                                  2
                                                  cellphone_receive_call true
                                                    6
                                                    cellphone_remove true
                                                      3
                                                      cellphone_reset_call true
                                                        1
                                                        cell_spawns_enable true
                                                          2
                                                          chainsaw_disable true
                                                            3
                                                            chainsaw_enable true
                                                              3
                                                              character_add_vehicle true
                                                                12
                                                                character_allow_ragdoll true
                                                                  31
                                                                  character_check_resource_loaded true
                                                                    3
                                                                    character_damage true
                                                                      3
                                                                      character_destroy true
                                                                        3
                                                                        character_disallow_ragdoll true
                                                                          2
                                                                          character_evacuate_from_all_vehicles true
                                                                            38
                                                                            character_exists true
                                                                              41
                                                                              character_get_human_shield_name true
                                                                                1
                                                                                • ss01.lua, line 1102: local human_shield_name = character_get_human_shield_name( triggerer_name )
                                                                                character_has_human_shield true
                                                                                  3
                                                                                  character_has_specific_human_shield true
                                                                                    23
                                                                                    • bh04.lua, line 476: elseif (IN_COOP and character_has_specific_human_shield(REMOTE_PLAYER, CHAR_DONNIE)) then
                                                                                    • bh05.lua, line 612: if (character_has_specific_human_shield(triggerer, CHAR_JESSICA)) then
                                                                                    • bh05.lua, line 848: if (not character_has_specific_human_shield(triggerer, CHAR_JESSICA)) then
                                                                                    • bh05.lua, line 1118: return ((character_has_specific_human_shield(LOCAL_PLAYER, CHAR_JESSICA)) or
                                                                                    • bh05.lua, line 1119: (coop_is_active() and character_has_specific_human_shield(REMOTE_PLAYER, CHAR_JESSICA)))
                                                                                    • bh07.lua, line 588: if (character_has_specific_human_shield(LOCAL_PLAYER,npc) ) then
                                                                                    • bh07.lua, line 590: elseif ( IN_COOP and character_has_specific_human_shield(REMOTE_PLAYER,npc) ) then
                                                                                    • bh07.lua, line 837: if (character_has_specific_human_shield(LOCAL_PLAYER,npc) ) then
                                                                                    • bh07.lua, line 839: elseif ( IN_COOP and character_has_specific_human_shield(REMOTE_PLAYER,npc) ) then
                                                                                    • bh07.lua, line 848: if (character_has_specific_human_shield(LOCAL_PLAYER,npc) ) then
                                                                                    • bh07.lua, line 850: elseif ( IN_COOP and character_has_specific_human_shield(REMOTE_PLAYER,npc) ) then
                                                                                    • rn07.lua, line 766: return character_has_specific_human_shield(LOCAL_PLAYER, CHARACTER_GAT)
                                                                                    • rn07.lua, line 800: while (not character_has_specific_human_shield(LOCAL_PLAYER, CHARACTER_GAT)) do
                                                                                    • rn07.lua, line 817: local has_gat = character_has_specific_human_shield(LOCAL_PLAYER, CHARACTER_GAT)
                                                                                    • rn07.lua, line 932: local has_gat = character_has_specific_human_shield(LOCAL_PLAYER, CHARACTER_GAT)
                                                                                    • rn07.lua, line 1813: return (Pushing_gat and (not character_has_specific_human_shield(LOCAL_PLAYER, CHARACTER_GAT)))
                                                                                    • ss04.lua, line 715: until ( character_has_specific_human_shield( VETERAN_CHILD_NAME, SHAUNDI_NAME ) )
                                                                                    • ss04.lua, line 721: if ( character_has_specific_human_shield( VETERAN_CHILD_NAME, SHAUNDI_NAME ) == false and
                                                                                    • ss04.lua, line 734: until ( character_has_specific_human_shield( VETERAN_CHILD_NAME, SHAUNDI_NAME ) or Num_panic_instances > 0 )
                                                                                    • ss04.lua, line 737: if ( character_has_specific_human_shield( VETERAN_CHILD_NAME, SHAUNDI_NAME ) ) then
                                                                                    • ss04.lua, line 818: if ( character_has_specific_human_shield( VETERAN_CHILD_NAME, SHAUNDI_NAME ) ) then
                                                                                    • ss04.lua, line 834: if ( character_has_specific_human_shield( VETERAN_CHILD_NAME, SHAUNDI_NAME ) ) then
                                                                                    • ss04.lua, line 927: until ( character_has_specific_human_shield( VETERAN_CHILD_NAME, SHAUNDI_NAME ) )
                                                                                    character_hidden true
                                                                                      6
                                                                                      • em01.lua, line 1855: if (character_hidden(Em01_weak_sauce_heli[1])) then
                                                                                      • rn04.lua, line 667: if ( (Spawnable_ronin[ronin] == false) and (not character_is_dead(ronin)) and (not character_hidden(ronin))) then
                                                                                      • tss03.lua, line 876: if (character_hidden(Tss03_bum_characters[i])) then
                                                                                      • tss03.lua, line 901: if (character_hidden(Tss03_bum_characters_coop[i])) then
                                                                                      • tss03.lua, line 933: if (not character_is_dead(Tss03_bum_characters[i]) and not character_hidden(Tss03_bum_characters[i])) then
                                                                                      • tss03.lua, line 945: if (not character_is_dead(Tss03_bum_characters_coop[i]) and not character_hidden(Tss03_bum_characters_coop[i])) then
                                                                                      character_hide true
                                                                                        23
                                                                                        character_ignite true
                                                                                          2
                                                                                          character_is_combat_ready true
                                                                                            1
                                                                                            character_is_dead true
                                                                                              237
                                                                                              character_is_in_a_driver_seat true
                                                                                                7
                                                                                                • em01.lua, line 1668: local julius = (character_is_in_vehicle(CHARACTER_JULIUS, JULIUS_VEHICLE) and character_is_in_a_driver_seat(CHARACTER_JULIUS))
                                                                                                • em01.lua, line 1680: julius = (character_is_in_vehicle(CHARACTER_JULIUS, JULIUS_VEHICLE) and character_is_in_a_driver_seat(CHARACTER_JULIUS))
                                                                                                • em01.lua, line 1769: while (not character_is_in_vehicle(CHARACTER_JULIUS, JULIUS_VEHICLE) and not character_is_in_a_driver_seat(CHARACTER_JULIUS)) do
                                                                                                • ep01.lua, line 779: local local_driving = (character_is_in_a_driver_seat(LOCAL_PLAYER))
                                                                                                • ep01.lua, line 780: local remote_driving = (IN_COOP and character_is_in_a_driver_seat(REMOTE_PLAYER))
                                                                                                • rn02.lua, line 928: if (not character_is_in_a_driver_seat(LOCAL_PLAYER)) then
                                                                                                • rn02.lua, line 934: if (not character_is_in_a_driver_seat(REMOTE_PLAYER)) then
                                                                                                character_is_in_vehicle true
                                                                                                  118
                                                                                                  character_is_in_vehicle_transation true
                                                                                                    1
                                                                                                    • ss10.lua, line 1258: until ( character_is_in_vehicle_transation( SHAUNDI_REPAIR_VARIANT_NAME ) or
                                                                                                    character_is_on_fire true
                                                                                                      3
                                                                                                      character_is_panicking true
                                                                                                        3
                                                                                                        • ss04.lua, line 847: until ( character_is_panicking( stunned_char_name ) == false )
                                                                                                        • ss04.lua, line 917: until ( character_is_panicking( stunned_char_name ) == false )
                                                                                                        • tss02.lua, line 1207: if ( (not character_exists(npc)) or character_is_dead(npc) or character_is_panicking(npc) ) then
                                                                                                        character_is_player true
                                                                                                          12
                                                                                                          character_is_ragdolled true
                                                                                                            6
                                                                                                            character_is_ready true
                                                                                                              9
                                                                                                              character_is_released true
                                                                                                                10
                                                                                                                character_is_swimming true
                                                                                                                  3
                                                                                                                  character_kill true
                                                                                                                    31
                                                                                                                    character_make_priority_target true
                                                                                                                      3
                                                                                                                      character_prevent_explosion_fling true
                                                                                                                        25
                                                                                                                        character_prevent_flinching true
                                                                                                                          34
                                                                                                                          character_prevent_kneecapping true
                                                                                                                            17
                                                                                                                            character_ragdoll true
                                                                                                                              24
                                                                                                                              character_release_human_shield true
                                                                                                                                9
                                                                                                                                character_remove_vehicle true
                                                                                                                                  2
                                                                                                                                  character_set_all_civilians_fleeing true
                                                                                                                                    1
                                                                                                                                    character_set_cannot_be_grabbed true
                                                                                                                                      15
                                                                                                                                      character_set_cannot_be_grabbed_by_player true
                                                                                                                                        2
                                                                                                                                        character_set_cannot_wield_havok_weapon true
                                                                                                                                          7
                                                                                                                                          character_set_combat_ready true
                                                                                                                                            8
                                                                                                                                            character_set_damage_multiplier true
                                                                                                                                              20
                                                                                                                                              character_set_injured true
                                                                                                                                                3
                                                                                                                                                character_set_no_satchel_panic true
                                                                                                                                                  3
                                                                                                                                                  character_set_only_scripted_grabs true
                                                                                                                                                    3
                                                                                                                                                    character_set_run_variant true
                                                                                                                                                      1
                                                                                                                                                      character_set_stand_variant true
                                                                                                                                                        1
                                                                                                                                                        • ss10.lua, line 1289: character_set_stand_variant( SHAUNDI_REPAIR_VARIANT_NAME, "Stand Ready Hacking" )
                                                                                                                                                        character_set_unrevivable true
                                                                                                                                                          1
                                                                                                                                                          character_set_walk_variant true
                                                                                                                                                            1
                                                                                                                                                            • ss10.lua, line 1288: character_set_walk_variant( SHAUNDI_REPAIR_VARIANT_NAME, "Walk Hacking" )
                                                                                                                                                            character_show true
                                                                                                                                                              30
                                                                                                                                                              character_slots_cap_for_team true
                                                                                                                                                                9
                                                                                                                                                                character_slots_clear_caps true
                                                                                                                                                                  2
                                                                                                                                                                  character_suppress_human_shield_idles true
                                                                                                                                                                    2
                                                                                                                                                                    character_suppress_squirted_reaction true
                                                                                                                                                                      2
                                                                                                                                                                      character_take_human_shield_check_done true
                                                                                                                                                                        1
                                                                                                                                                                        character_take_human_shield_do true
                                                                                                                                                                          1
                                                                                                                                                                          character_throw_havok_weapon true
                                                                                                                                                                            2
                                                                                                                                                                            character_void_is_playing true
                                                                                                                                                                              1
                                                                                                                                                                              character_wield_havok_weapon true
                                                                                                                                                                                2
                                                                                                                                                                                check_animation_state true
                                                                                                                                                                                  7
                                                                                                                                                                                  chunk_enable_ambient_streaming true
                                                                                                                                                                                    2
                                                                                                                                                                                    chunk_swap_sequence_make_permanent true
                                                                                                                                                                                      2
                                                                                                                                                                                      chunk_swap_sequence_restore_saved true
                                                                                                                                                                                        1
                                                                                                                                                                                        chunk_swap_sequence_revert true
                                                                                                                                                                                          1
                                                                                                                                                                                          chunk_swap_sequence_save_and_revert true
                                                                                                                                                                                            1
                                                                                                                                                                                            chunk_swap_sequence_start true
                                                                                                                                                                                              2
                                                                                                                                                                                              city_chunk_set_all_civilians_fleeing true
                                                                                                                                                                                                13
                                                                                                                                                                                                city_chunk_swap true
                                                                                                                                                                                                  21
                                                                                                                                                                                                  cleanup true
                                                                                                                                                                                                    1
                                                                                                                                                                                                    clear_animation_state true
                                                                                                                                                                                                      21
                                                                                                                                                                                                      combat_enable_sword_parries true
                                                                                                                                                                                                        2
                                                                                                                                                                                                        combat_enable_sword_strafing true
                                                                                                                                                                                                          2
                                                                                                                                                                                                          completion_call_callback true
                                                                                                                                                                                                            10
                                                                                                                                                                                                            Completion_finalize_fade true
                                                                                                                                                                                                              1
                                                                                                                                                                                                              Completion_reset_respect_screen true
                                                                                                                                                                                                                2
                                                                                                                                                                                                                confessionals_allow_free_one true
                                                                                                                                                                                                                  1
                                                                                                                                                                                                                  confessionals_enable true
                                                                                                                                                                                                                    1
                                                                                                                                                                                                                    confessionals_get_nearest_trigger true
                                                                                                                                                                                                                      2
                                                                                                                                                                                                                      conversion true
                                                                                                                                                                                                                        6
                                                                                                                                                                                                                        coop_is_active true
                                                                                                                                                                                                                          353
                                                                                                                                                                                                                          coop_kick_player true
                                                                                                                                                                                                                            1
                                                                                                                                                                                                                            coop_start_new_live true
                                                                                                                                                                                                                              3
                                                                                                                                                                                                                              cower true
                                                                                                                                                                                                                                2
                                                                                                                                                                                                                                credits_are_finished true
                                                                                                                                                                                                                                  1
                                                                                                                                                                                                                                  credits_force_close true
                                                                                                                                                                                                                                    2
                                                                                                                                                                                                                                    credits_in_cutscene true
                                                                                                                                                                                                                                      2
                                                                                                                                                                                                                                      credits_roll_credits true
                                                                                                                                                                                                                                        1
                                                                                                                                                                                                                                        credits_were_skipped true
                                                                                                                                                                                                                                          2
                                                                                                                                                                                                                                          crib_customization_revert_prop true
                                                                                                                                                                                                                                            1
                                                                                                                                                                                                                                            crib_customization_update_camera true
                                                                                                                                                                                                                                              1
                                                                                                                                                                                                                                              crib_customization_update_preview true
                                                                                                                                                                                                                                                1
                                                                                                                                                                                                                                                • crib_cust.lua, line 77: crib_customization_update_preview(Crib_cust_current_set_selected, Crib_cust_level_menu.highlighted_item)
                                                                                                                                                                                                                                                crib_is_unlocked true
                                                                                                                                                                                                                                                  3
                                                                                                                                                                                                                                                  crib_purchase_purchase_crib true
                                                                                                                                                                                                                                                    1
                                                                                                                                                                                                                                                    crib_purchasing_unlock true
                                                                                                                                                                                                                                                      1
                                                                                                                                                                                                                                                      crouch_is_crouching true
                                                                                                                                                                                                                                                        13
                                                                                                                                                                                                                                                        crouch_start true
                                                                                                                                                                                                                                                          17
                                                                                                                                                                                                                                                          crouch_stop true
                                                                                                                                                                                                                                                            20
                                                                                                                                                                                                                                                            customization_item_revert true
                                                                                                                                                                                                                                                              6
                                                                                                                                                                                                                                                              customization_item_wear true
                                                                                                                                                                                                                                                                3
                                                                                                                                                                                                                                                                • coop_test.lua, line 333: customization_item_wear(FREE_CLOTHING_NAME,FREE_CLOTHING_WEAR_OPTION,FREE_CLOTHING_VARIANT_NAME, SYNC_LOCAL)
                                                                                                                                                                                                                                                                • coop_test.lua, line 337: customization_item_wear(FREE_CLOTHING_NAME,FREE_CLOTHING_WEAR_OPTION,FREE_CLOTHING_VARIANT_NAME, SYNC_REMOTE)
                                                                                                                                                                                                                                                                • rn02.lua, line 897: customization_item_wear(FREE_CLOTHING_NAME,FREE_CLOTHING_WEAR_OPTION,FREE_CLOTHING_VARIANT_NAME, PLAYER_SYNC[player])
                                                                                                                                                                                                                                                                customization_outfit_wear true
                                                                                                                                                                                                                                                                  4
                                                                                                                                                                                                                                                                  cutscene_play_do true
                                                                                                                                                                                                                                                                    1