Saints Row: The Third Function Reference

These functions are assumed to be globally available to all scripts (they aren't defined in the available Lua files, or are defined in files that are known to be always loaded).

This list is assumed incomplete; additional functions could exist in the exe but not be used in the game scripts, and there's no definitive list of Lua files that are always loaded.

Function name	Global	Examples from patch (click blue number to expand)
`Back_callback`	true	1 `game_lobby.lua, line 1312: Back_callback()`
`base_jumping_enable`	true	6 `m05.lua, line 576: base_jumping_enable(true)` `m05.lua, line 641: base_jumping_enable(false)` `m08.lua, line 458: base_jumping_enable( true )` `m08.lua, line 596: base_jumping_enable( false )` `sh03.lua, line 612: base_jumping_enable(true)` `sh03.lua, line 1294: base_jumping_enable(false)`
`bink_play`	true	23 `m01.lua, line 1691: --bink_play(M01_scene.explosives)` `m05.lua, line 421: --bink_play(M05_CUTSCENE_MISSION_INTRO)` `m06.lua, line 743: --bink_play(M06_scene.intro)` `m06.lua, line 882: --bink_play(M06_scene.disarm_bomb)` `m06.lua, line 888: --bink_play(M06_scene.destroy_building)` `m06.lua, line 1378: --bink_play(M06_scene.oleg)` `m07.lua, line 757: bink_play("07_In_v2")` `m07.lua, line 845: bink_play("07_Out_v3")` `m07.lua, line 1735: --bink_play("07_z01")` `m07.lua, line 1934: --bink_play("07_z02")` `m07.lua, line 2212: bink_play("07_Z03")` `m10.lua, line 1080: --bink_play(M10_cutscenes.mission_intro)` `m10.lua, line 1574: --bink_play(M10_cutscenes.rooftop_intro)` `m17.lua, line 1324: --bink_play("17_Mid_Block_v01")` `m18.lua, line 1109: --bink_play(M18_cutscenes.mission_intro)` `m19.lua, line 556: bink_play("19_IN_v2")` `m19.lua, line 664: -- bink_play("19_Out_v2")` `m21.lua, line 680: --bink_play(M21_cutscenes.mission_intro)` `m23.lua, line 1079: -- bink_play(M23_cutscenes.outro)` `mm_p_06.lua, line 228: --bink_play( MM_P_06_cutscene.pierce_outro )` `mm_z_01.lua, line 103: --bink_play( MM_Z_01_cutscene.zimos_intro )` `mm_z_04.lua, line 95: --bink_play( MM_Z_04_cutscene.zimos_outro )` `sh01.lua, line 384: -- bink_play(SH01_CUTSCENE_MISSION_INTRO)`
`Bool`	true	1 `vdo_weapon_radial.lua, line 427: is_current_wpn Bool( Is Current Weapon )`
`boss_battle_kb_enable`	true	2 `m21.lua, line 746: boss_battle_kb_enable(DISABLE)` `m21.lua, line 934: boss_battle_kb_enable(ENABLE) -- Initializes everything, and forces the murderbrawl camera mode`
`boss_battle_kb_enable_crowd_props`	true	6 `m21.lua, line 747: boss_battle_kb_enable_crowd_props(DISABLE)` `m21.lua, line 1156: boss_battle_kb_enable_crowd_props(ENABLE, PHASE_DEFEND_RING)` `m21.lua, line 1219: boss_battle_kb_enable_crowd_props(DISABLE)` `m21.lua, line 1887: boss_battle_kb_enable_crowd_props(DISABLE, PHASE_FIGHT_KILLBANE)` `m21.lua, line 2037: boss_battle_kb_enable_crowd_props(ENABLE, PHASE_FIGHT_KILLBANE)` `m21.lua, line 2079: boss_battle_kb_enable_crowd_props(DISABLE)`
`boss_battle_mars_killbane_active`	true	2 `m24.lua, line 725: boss_battle_mars_killbane_active(DISABLE)` `m24.lua, line 1154: boss_battle_mars_killbane_active() -- Start the fight`
`boss_battle_matt_begin`	true	3 `m16.lua, line 2282: boss_battle_matt_begin(false) -- begin the fight, start cheats immediately` `m16.lua, line 2795: boss_battle_matt_begin() -- begin the fight, start cheats` `m16.lua, line 2805: boss_battle_matt_begin() -- begin the fight, start cheats`
`boss_battle_matt_cheats_start`	true	3 `m16.lua, line 1573: boss_battle_matt_cheats_start(M16_CHEAT_SLOW, FW1_SLOW_DURATION, FW1_CHEAT_PERIOD, false)` `m16.lua, line 1737: boss_battle_matt_cheats_start(M16_CHEAT_LAG, FW2_LAG_DURATION, FW2_CHEAT_PERIOD, false)` `m16.lua, line 2029: boss_battle_matt_cheats_start(M16_CHEAT_INVERTED, FW3_INVERT_DURATION, FW3_CHEAT_PERIOD, false)`
`boss_battle_matt_cheats_stop`	true	5 `m16.lua, line 1369: boss_battle_matt_cheats_stop()` `m16.lua, line 1555: boss_battle_matt_cheats_stop()` `m16.lua, line 1746: boss_battle_matt_cheats_stop() -- Stop the cheats` `m16.lua, line 2039: boss_battle_matt_cheats_stop() -- stop the cheats` `m16.lua, line 3317: boss_battle_matt_cheats_stop() -- stop cheats`
`boss_battle_matt_get_cheat`	true	3 `m16.lua, line 3559: local cheat = boss_battle_matt_get_cheat()` `m16.lua, line 3608: cheat = boss_battle_matt_get_cheat()` `m16.lua, line 3625: cheat = boss_battle_matt_get_cheat()`
`boss_battle_matt_hide_wings`	true	4 `m16.lua, line 2798: boss_battle_matt_hide_wings()` `m16.lua, line 2808: boss_battle_matt_hide_wings()` `m16.lua, line 2820: boss_battle_matt_hide_wings()` `m16.lua, line 2834: boss_battle_matt_hide_wings()`
`boss_battle_matt_qte_begin`	true	1 `m16.lua, line 3311: boss_battle_matt_qte_begin(LOCAL_PLAYER, play_at_nav)`
`boss_battle_matt_set_matt_flying`	true	10 `m16.lua, line 2255: boss_battle_matt_set_matt_flying(ENABLE)` `m16.lua, line 2311: boss_battle_matt_set_matt_flying(DISABLE)` `m16.lua, line 2422: boss_battle_matt_set_matt_flying(ENABLE) -- turn on flying so we can teleport him under the ground temporarily` `m16.lua, line 2446: boss_battle_matt_set_matt_flying(DISABLE)` `m16.lua, line 2467: boss_battle_matt_set_matt_flying(ENABLE)` `m16.lua, line 2483: boss_battle_matt_set_matt_flying(DISABLE)` `m16.lua, line 2796: boss_battle_matt_set_matt_flying(DISABLE)` `m16.lua, line 2806: boss_battle_matt_set_matt_flying(DISABLE)` `m16.lua, line 2818: boss_battle_matt_set_matt_flying(DISABLE)` `m16.lua, line 2832: boss_battle_matt_set_matt_flying(DISABLE)`
`boss_battle_matt_set_phase`	true	1 `m16.lua, line 2231: boss_battle_matt_set_phase(phase)`
`boss_battle_matt_set_player_as_avatar`	true	4 `m16.lua, line 1304: boss_battle_matt_set_player_as_avatar(DISABLE)` `m16.lua, line 2815: boss_battle_matt_set_player_as_avatar(ENABLE)` `m16.lua, line 2830: boss_battle_matt_set_player_as_avatar(ENABLE)` `m16.lua, line 3675: boss_battle_matt_set_player_as_avatar(ENABLE)`
`building_purchase_is_crib_being_purchased`	true	1 `building_purchase.lua, line 19: Building_purchase_is_crib = building_purchase_is_crib_being_purchased()`

Saints Row: The Third Function Reference

Global functions