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)
action true
    1
    action_nodes_enable true
      12
      action_nodes_restrict_spawning true
        16
        action_play_custom_do true
          1
          action_play_do true
            1
            • ug_lib.lua, line 356: while not action_play_do(name, anim_name, morph_name, force_play, stand_still) do
            action_play_is_finished true
              3
              action_stop_custom true
                1
                airplane_fly_to_do true
                  2
                  airplane_land_do true
                    1
                    airplane_takeoff_do true
                      1
                      ambient_cop_spawn_enable true
                        4
                        ambient_gang_spawn_enable true
                          25
                          animation_is_state true
                            1
                            attack_do true
                              1
                              attack_heli_create true
                                2
                                attack_heli_destroy true
                                  2
                                  attack_heli_get_heli_name true
                                    2
                                    attack_heli_go true
                                      2
                                      attack_heli_init_weave_ai true
                                        2
                                        attack_heli_set_drop_accuracy true
                                          1
                                          attack_heli_update true
                                            1
                                            audio_fade_out true
                                              26
                                              audio_get_audio_id true
                                                92
                                                audio_get_id true
                                                  13
                                                  audio_is_playing true
                                                    13
                                                    audio_is_xmp_playing true
                                                      1
                                                      audio_play_do true
                                                        2
                                                        audio_play_emitting_id_for_navpoint true
                                                          9
                                                          • bh03.lua, line 1827: Outside_alarm_emitter_ids[alarm_index] = audio_play_emitting_id_for_navpoint( alarm_location, outside_audio_id )
                                                          • bh03.lua, line 1833: Inside_alarm_emitter_ids[alarm_index] = audio_play_emitting_id_for_navpoint( alarm_location, inside_audio_id )
                                                          • ss02.lua, line 297: Outside_alarm_emitter_ids[alarm_index] = audio_play_emitting_id_for_navpoint( alarm_location, outside_audio_id )
                                                          • ss02.lua, line 303: Inside_alarm_emitter_ids[alarm_index] = audio_play_emitting_id_for_navpoint( alarm_location, inside_audio_id )
                                                          • tss01.lua, line 1820: Tss01_audio_ext_inst[i] = audio_play_emitting_id_for_navpoint(Tss01_alarm_ext_pos[i], audio_ext_id)
                                                          • tss01.lua, line 1827: Tss01_audio_int_inst[i] = audio_play_emitting_id_for_navpoint(Tss01_alarm_int_pos[i], audio_int_id)
                                                          • tss01.lua, line 1843: Tss01_audio_prisoner_ext_inst[i] = audio_play_emitting_id_for_navpoint(Tss01_prisoner_audio_ext_pos[i], prisoner_audio_ext_id)
                                                          • tss01.lua, line 1850: Tss01_audio_prisoner_int_inst[i] = audio_play_emitting_id_for_navpoint(Tss01_prisoner_audio_int_pos[i], prisoner_audio_int_id)
                                                          • tss02.lua, line 1126: Alarm_audio_inst[i] = audio_play_emitting_id_for_navpoint(navpoint, audio_id)
                                                          audio_play_for_cellphone true
                                                            1
                                                            • mission_globals.lua, line 80: audio_play_for_cellphone( CELLPHONE_INCOMING, 4, 1.5, 0.25, "RON2_INTRO_L1", "", true, pickup_callback, "", true)
                                                            audio_play_for_character_do true
                                                              1
                                                              • ug_lib.lua, line 727: local handle, play_time = audio_play_for_character_do(new_audio_name, human_name, type_name, blocking, variant, voice_distance, cellphone_line, ignore_fade)
                                                              audio_play_for_character_weapon_do true
                                                                1
                                                                • ug_lib.lua, line 759: local handle = audio_play_for_character_weapon_do( audio_name, character, type_name)
                                                                audio_play_for_mover_do true
                                                                  1
                                                                  • ug_lib.lua, line 777: local handle = audio_play_for_mover_do( audio_name, script_mover, type_name )
                                                                  audio_play_for_navpoint true
                                                                    16
                                                                    • bh02.lua, line 683: bomb_planting_audio = audio_play_for_navpoint("SFX_DON_BOMBPLANTING", Current_bomb_target, "foley")
                                                                    • bh02.lua, line 715: audio_play_for_navpoint("SFX_DON_BOMBPLANTED", Current_bomb_target, "foley")
                                                                    • bh05.lua, line 510: Alarm_audio_id = audio_play_for_navpoint("SFX_BR5_BANK_ALARM", NAV_BANK_INTERIOR, "Foley")
                                                                    • bh05.lua, line 599: audio_play_for_navpoint("SFX_BR5_BANK_ALARM_OFF", TRIGGER_ALARM, "Foley")
                                                                    • bh05.lua, line 649: audio_play_for_navpoint("SFX_BR5_BANK_ALARM_OFF", TRIGGER_ALARM, "Foley")
                                                                    • bh05.lua, line 690: audio_play_for_navpoint("SFX_BR5_BANK_ALARM_OFF", TRIGGER_ALARM, "Foley")
                                                                    • bh05.lua, line 880: audio_play_for_navpoint("SFX_BR5_TRUNK_SLAM", NAV_TRUNK, "Foley")
                                                                    • coop_test.lua, line 317: Audio_handle = audio_play_for_navpoint("SFX_ALARM_5", "coop_test_$n000", "foley")
                                                                    • ep02.lua, line 472: local bomb_planting_audio = audio_play_for_navpoint("SFX_DON_BOMBPLANTING", trigger, "foley")
                                                                    • ep02.lua, line 475: audio_play_for_navpoint("SFX_DON_BOMBPLANTED", trigger, "foley")
                                                                    • ep02.lua, line 550: audio_play_for_navpoint("SFX_ALARM_5", NAV_ALARM_SOURCES, "foley")
                                                                    • ep02.lua, line 573: audio_play_for_navpoint("SFX_ALARM_5", NAV_ALARM_SOURCES, "foley")
                                                                    • rn01.lua, line 809: bomb_planting_audio = audio_play_for_navpoint("SFX_DON_BOMBPLANTING", target, "foley")
                                                                    • rn01.lua, line 820: audio_play_for_navpoint("SFX_DON_BOMBPLANTED", target, "foley")
                                                                    • rn08.lua, line 1329: audio_play_for_navpoint(FOLEY_BOMB_PLANT, bomb, "foley")
                                                                    • ss10.lua, line 1796: audio_play_for_navpoint( "SFX_POLICE_ALARM", ALARM_ORIGIN )
                                                                    audio_play_id_do true
                                                                      1
                                                                      audio_play_id_for_character_do true
                                                                        1
                                                                        • ug_lib.lua, line 830: local handle = audio_play_id_for_character_do(human_name, audio_id, type, blocking, variant, voice_distance)
                                                                        audio_play_id_for_navpoint_do true
                                                                          1
                                                                          audio_play_persona_line true
                                                                            22
                                                                            audio_play_prepared true
                                                                              4
                                                                              audio_prepare true
                                                                                4
                                                                                audio_stop true
                                                                                  18
                                                                                  audio_stop_emitting_id true
                                                                                    9
                                                                                    audio_suppress_ambient_player_lines true
                                                                                      8
                                                                                      audio_throttle_type true
                                                                                        2
                                                                                        award_style true
                                                                                          14