Saints Row 2 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)
`imp_aggressive_tutorial_ai_enable`	true	2 `mmsummontutorial.lua, line 459: imp_aggressive_tutorial_ai_enable( false )` `mmsummontutorial.lua, line 550: imp_aggressive_tutorial_ai_enable( true )`
`imp_attack_face`	true	2 `mintrobb.lua, line 921: imp_attack_face(true)` `mintrobb.lua, line 990: imp_attack_face(false)`
`imp_jump_occasionals_enable`	true	4 `mintrobb.lua, line 641: imp_jump_occasionals_enable( true )` `mintrobb.lua, line 757: imp_jump_occasionals_enable( false )` `mmstomptutorial.lua, line 461: imp_jump_occasionals_enable( false )` `mmstomptutorial.lua, line 513: imp_jump_occasionals_enable( true )`
`ingame_effect_add_trigger`	true	1 `game_lib.lua, line 2267: ingame_effect_add_trigger(trigger_name, ingame_effect_name, sync_type)`
`ingame_effect_remove_trigger`	true	1 `game_lib.lua, line 2333: ingame_effect_remove_trigger(trigger_name, sync_type)`
`inv_has_item`	true	3 `mintrobb.lua, line 622: local_player_had_hammer = inv_has_item("Melee-Warhammer", LOCAL_PLAYER)` `mintrobb.lua, line 625: remote_player_had_hammer = inv_has_item("Melee-Warhammer", REMOTE_PLAYER)` `mintrobb.lua, line 1171: while not inv_has_item("Melee-Warhammer") do`
`inv_item_add_do`	true	2 `game_lib.lua, line 2072: inv_item_add_do(item_name[x], count[x], character, equip_now, upgrade_flags[x])` `game_lib.lua, line 2075: inv_item_add_do(item_name, count, character, equip_now, upgrade_flags)`
`inv_item_equip`	true	11 `game_lib.lua, line 964: inv_item_equip(nil,speaking_character)` `game_lib.lua, line 4863: inv_item_equip( last_weapon, LOCAL_PLAYER )` `game_lib.lua, line 4866: inv_item_equip( last_weapon, REMOTE_PLAYER )` `mmauratutorial.lua, line 578: inv_item_equip("Pistol-Gang", LOCAL_PLAYER)` `mmauratutorial.lua, line 581: inv_item_equip("Pistol-Gang", REMOTE_PLAYER)` `mmblasttutorial.lua, line 676: inv_item_equip("Pistol-Gang", LOCAL_PLAYER)` `mmblasttutorial.lua, line 679: inv_item_equip("Pistol-Gang", REMOTE_PLAYER)` `mmstomptutorial.lua, line 691: inv_item_equip("Pistol-Gang", LOCAL_PLAYER)` `mmstomptutorial.lua, line 694: inv_item_equip("Pistol-Gang", REMOTE_PLAYER)` `mmsummontutorial.lua, line 641: inv_item_equip("Pistol-Gang", LOCAL_PLAYER)` `mmsummontutorial.lua, line 644: inv_item_equip("Pistol-Gang", REMOTE_PLAYER)`
`inv_item_remove`	true	4 `mintrobb.lua, line 623: inv_item_remove("Melee-Warhammer", LOCAL_PLAYER)` `mintrobb.lua, line 626: inv_item_remove("Melee-Warhammer", REMOTE_PLAYER)` `mintrobb.lua, line 682: --inv_item_remove("Melee-Warhammer", LOCAL_PLAYER);` `mintrobb.lua, line 685: --inv_item_remove("Melee-Warhammer", REMOTE_PLAYER);`
`inv_item_remove_all`	true	2 `mintro.lua, line 550: inv_item_remove_all(LOCAL_PLAYER)` `mintro.lua, line 551: inv_item_remove_all(REMOTE_PLAYER)`
`inv_weapon_add_temporary`	true	20 `game_lib.lua, line 4853: inv_weapon_add_temporary(LOCAL_PLAYER, weapon, 1, true)` `game_lib.lua, line 4856: inv_weapon_add_temporary(REMOTE_PLAYER, weapon, 1, true)` `mintro.lua, line 417: --inv_weapon_add_temporary(LOCAL_PLAYER, weapon_name, count, unlimited, equip_now)` `mintro.lua, line 421: --inv_weapon_add_temporary(REMOTE_PLAYER, weapon_name, count, unlimited, equip_now)` `mintro.lua, line 432: inv_weapon_add_temporary(LOCAL_PLAYER, weapon_name, count, unlimited, equip_now)` `mintro.lua, line 439: inv_weapon_add_temporary(REMOTE_PLAYER, weapon_name, count, unlimited, equip_now)` `mintro.lua, line 450: inv_weapon_add_temporary(LOCAL_PLAYER, weapon_name, count, unlimited, equip_now)` `mintro.lua, line 453: inv_weapon_add_temporary(REMOTE_PLAYER, weapon_name, count, unlimited, equip_now)` `mintro.lua, line 463: inv_weapon_add_temporary(LOCAL_PLAYER, weapon_name, count, unlimited, equip_now)` `mintro.lua, line 466: inv_weapon_add_temporary(REMOTE_PLAYER, weapon_name, count, unlimited, equip_now)` `mintrobb.lua, line 1359: inv_weapon_add_temporary(LOCAL_PLAYER, weapon_name, count, unlimited, equip_now, dual_wielding, force_override, upgrade_flags, allow_downgrade)` `mintrobb.lua, line 1362: inv_weapon_add_temporary(REMOTE_PLAYER, weapon_name, count, unlimited, equip_now, dual_wielding, force_override, upgrade_flags, allow_downgrade)` `mmauratutorial.lua, line 577: inv_weapon_add_temporary( LOCAL_PLAYER, "Pistol-Gang", 100, true, true, false, true )` `mmauratutorial.lua, line 580: inv_weapon_add_temporary( REMOTE_PLAYER, "Pistol-Gang", 100, true, true, false, true )` `mmblasttutorial.lua, line 675: inv_weapon_add_temporary( LOCAL_PLAYER, "Pistol-Gang", 100, true, true, false, true )` `mmblasttutorial.lua, line 678: inv_weapon_add_temporary( REMOTE_PLAYER, "Pistol-Gang", 100, true, true, false, true )` `mmstomptutorial.lua, line 690: inv_weapon_add_temporary( LOCAL_PLAYER, "Pistol-Gang", 100, true, true, false, true )` `mmstomptutorial.lua, line 693: inv_weapon_add_temporary( REMOTE_PLAYER, "Pistol-Gang", 100, true, true, false, true )` `mmsummontutorial.lua, line 640: inv_weapon_add_temporary( LOCAL_PLAYER, "Pistol-Gang", 100, true, true, false, true )` `mmsummontutorial.lua, line 643: inv_weapon_add_temporary( REMOTE_PLAYER, "Pistol-Gang", 100, true, true, false, true )`
`inv_weapon_disable_all_but_this_slot`	true	6 `mmauratutorial.lua, line 583: inv_weapon_disable_all_but_this_slot( WEAPON_SLOT_PISTOL, true, SYNC_ALL )` `mmblasttutorial.lua, line 681: inv_weapon_disable_all_but_this_slot( WEAPON_SLOT_PISTOL, true, SYNC_ALL )` `mmstomptutorial.lua, line 519: inv_weapon_disable_all_but_this_slot( WEAPON_SLOT_PISTOL, true, SYNC_ALL )` `mmstomptutorial.lua, line 696: inv_weapon_disable_all_but_this_slot( WEAPON_SLOT_PISTOL, true, SYNC_ALL )` `mmstomptutorial.lua, line 702: --inv_weapon_disable_all_but_this_slot(WEAPON_SLOT_UNARMED)` `mmsummontutorial.lua, line 646: inv_weapon_disable_all_but_this_slot( WEAPON_SLOT_PISTOL, true, SYNC_ALL )`
`inv_weapon_disable_all_slots`	true	5 `mmauratutorial.lua, line 401: inv_weapon_disable_all_slots(false)` `mmauratutorial.lua, line 697: inv_weapon_disable_all_slots( false, SYNC_ALL )` `mmblasttutorial.lua, line 829: inv_weapon_disable_all_slots( false, SYNC_ALL )` `mmstomptutorial.lua, line 829: inv_weapon_disable_all_slots( false, SYNC_ALL )` `mmsummontutorial.lua, line 766: inv_weapon_disable_all_slots( false, SYNC_ALL )`
`inv_weapon_remove_temporary`	true	26 `game_lib.lua, line 1419: inv_weapon_remove_temporary(LOCAL_PLAYER, weapons)` `game_lib.lua, line 1423: inv_weapon_remove_temporary(REMOTE_PLAYER, weapons)` `game_lib.lua, line 4895: inv_weapon_remove_temporary(LOCAL_PLAYER, weapon)` `game_lib.lua, line 4898: inv_weapon_remove_temporary(REMOTE_PLAYER, weapon)` `mintro.lua, line 606: --inv_weapon_remove_temporary(LOCAL_PLAYER,"Pistol-Gang")` `mintro.lua, line 607: --inv_weapon_remove_temporary(LOCAL_PLAYER,"SMG-Brimstone_Uzi")` `mintro.lua, line 608: --inv_weapon_remove_temporary(LOCAL_PLAYER,"Rifle-LavaBolter")` `mintro.lua, line 611: --inv_weapon_remove_temporary(REMOTE_PLAYER,"Pistol-Gang")` `mintro.lua, line 612: --inv_weapon_remove_temporary(REMOTE_PLAYER,"SMG-Brimstone_Uzi")` `mintro.lua, line 613: --inv_weapon_remove_temporary(REMOTE_PLAYER,"Rifle-LavaBolter")` `mintrobb.lua, line 683: inv_weapon_remove_temporary(LOCAL_PLAYER,"Melee-Warhammer")` `mintrobb.lua, line 686: inv_weapon_remove_temporary(REMOTE_PLAYER,"Melee-Warhammer")` `mintrobb.lua, line 1013: inv_weapon_remove_temporary(LOCAL_PLAYER,"Melee-Warhammer")` `mintrobb.lua, line 1016: inv_weapon_remove_temporary(REMOTE_PLAYER,"Melee-Warhammer")` `mmauratutorial.lua, line 406: inv_weapon_remove_temporary( LOCAL_PLAYER, "Pistol-Gang")` `mmauratutorial.lua, line 408: inv_weapon_remove_temporary( REMOTE_PLAYER, "Pistol-Gang")` `mmauratutorial.lua, line 698: inv_weapon_remove_temporary( LOCAL_PLAYER, "Pistol-Gang" )` `mmauratutorial.lua, line 700: inv_weapon_remove_temporary( REMOTE_PLAYER, "Pistol-Gang" )` `mmblasttutorial.lua, line 822: inv_weapon_remove_temporary( LOCAL_PLAYER, "Pistol-Gang")` `mmblasttutorial.lua, line 824: inv_weapon_remove_temporary( REMOTE_PLAYER, "Pistol-Gang")` `mmblasttutorial.lua, line 830: inv_weapon_remove_temporary( LOCAL_PLAYER, "Pistol-Gang" )` `mmblasttutorial.lua, line 832: inv_weapon_remove_temporary( REMOTE_PLAYER, "Pistol-Gang" )` `mmstomptutorial.lua, line 830: inv_weapon_remove_temporary( LOCAL_PLAYER, "Pistol-Gang" )` `mmstomptutorial.lua, line 832: inv_weapon_remove_temporary( REMOTE_PLAYER, "Pistol-Gang" )` `mmsummontutorial.lua, line 468: inv_weapon_remove_temporary( LOCAL_PLAYER, "Pistol-Gang")` `mmsummontutorial.lua, line 470: inv_weapon_remove_temporary( REMOTE_PLAYER, "Pistol-Gang")`
`item_show`	true	1 `mflighttutorial.lua, line 2461: item_show( mFlightTutorial_group.soul_clusters.cluster04.name )`

Saints Row 2 Function Reference

Global functions