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)
`nav_cb`	true	4 `store_weapon.lua, line 2947: Store_weapon_inventory.nav_cb(slot)` `store_weapon.lua, line 3058: Store_weapon_inventory.nav_cb(selected_slot)` `store_weapon.lua, line 3167: Store_weapon_inventory.nav_cb(selected_weapon_index)` `store_weapon.lua, line 3496: Store_weapon_inventory.nav_cb(weapon_index)`
`notoriety_force_no_spawn`	true	2 `mintro.lua, line 529: --notoriety_force_no_spawn(true)` `msatan.lua, line 429: notoriety_force_no_spawn(true)`
`notoriety_reset`	true	2 `mintro.lua, line 1089: notoriety_reset("police")` `mintroshakes.lua, line 570: notoriety_reset("police")`
`notoriety_set`	true	3 `mintro.lua, line 1090: notoriety_set("police", 0)` `mintroshakes.lua, line 741: notoriety_set("police", 0)` `mintroshakes.lua, line 905: notoriety_set("police", 0)`
`notoriety_set_can_decay`	true	2 `mintrobb.lua, line 901: notoriety_set_can_decay(true)` `mintroshakes.lua, line 571: notoriety_set_can_decay(true)`
`notoriety_set_max`	true	2 `mintro.lua, line 806: notoriety_set_max("police", 2)` `mintrobb.lua, line 900: notoriety_set_max("police", 0)`
`notoriety_set_min_and_max`	true	30 `mintrobb.lua, line 664: notoriety_set_min_and_max("police", 0, MAX_NOTORIETY_LEVEL)` `mintrobb.lua, line 755: notoriety_set_min_and_max("police", 0, 4)` `mintrobb.lua, line 1002: notoriety_set_min_and_max("police", 0, MAX_NOTORIETY_LEVEL)` `mintroshakes.lua, line 569: notoriety_set_min_and_max("police", 0, MAX_NOTORIETY_LEVEL)` `mintroshakes.lua, line 639: notoriety_set_min_and_max("police", 0, 1)` `mintroshakes.lua, line 740: notoriety_set_min_and_max("police", 0, 0)` `mintroshakes.lua, line 904: notoriety_set_min_and_max("police", 0, 0)` `mintrotwins.lua, line 574: notoriety_set_min_and_max("police", 0, MAX_NOTORIETY_LEVEL)` `mintrotwins.lua, line 649: notoriety_set_min_and_max("police", 0, 1)` `mintrotwins.lua, line 794: notoriety_set_min_and_max("police", 1, 1)` `mintrovlad.lua, line 583: notoriety_set_min_and_max( "luchadores", 0, MAX_NOTORIETY_LEVEL )` `mintrovlad.lua, line 584: notoriety_set_min_and_max( "police", 0, MAX_NOTORIETY_LEVEL )` `mintrovlad.lua, line 665: notoriety_set_min_and_max( "luchadores", 0, 0 )` `mintrovlad.lua, line 666: notoriety_set_min_and_max( "police", 0, 0 )` `mmauratutorial.lua, line 567: notoriety_set_min_and_max( "luchadores", 0, 0 )` `mmauratutorial.lua, line 568: notoriety_set_min_and_max( "police", 0, 0 )` `mmauratutorial.lua, line 727: notoriety_set_min_and_max( "luchadores", 0, MAX_NOTORIETY_LEVEL )` `mmauratutorial.lua, line 728: notoriety_set_min_and_max( "police", 0, MAX_NOTORIETY_LEVEL )` `mmblasttutorial.lua, line 659: notoriety_set_min_and_max( "luchadores", 0, 0 )` `mmblasttutorial.lua, line 660: notoriety_set_min_and_max( "police", 0, 0 )` `mmblasttutorial.lua, line 863: notoriety_set_min_and_max( "luchadores", 0, MAX_NOTORIETY_LEVEL )` `mmblasttutorial.lua, line 864: notoriety_set_min_and_max( "police", 0, MAX_NOTORIETY_LEVEL )` `mmstomptutorial.lua, line 678: notoriety_set_min_and_max( "luchadores", 0, 0 )` `mmstomptutorial.lua, line 679: notoriety_set_min_and_max( "police", 0, 0 )` `mmstomptutorial.lua, line 863: notoriety_set_min_and_max( "luchadores", 0, MAX_NOTORIETY_LEVEL )` `mmstomptutorial.lua, line 864: notoriety_set_min_and_max( "police", 0, MAX_NOTORIETY_LEVEL )` `mmsummontutorial.lua, line 628: notoriety_set_min_and_max( "luchadores", 0, 0 )` `mmsummontutorial.lua, line 629: notoriety_set_min_and_max( "police", 0, 0 )` `mmsummontutorial.lua, line 793: notoriety_set_min_and_max( "luchadores", 0, MAX_NOTORIETY_LEVEL )` `mmsummontutorial.lua, line 794: notoriety_set_min_and_max( "police", 0, MAX_NOTORIETY_LEVEL )`
`npc_fade_out`	true	7 `mmauratutorial.lua, line 874: npc_fade_out( wave_member, 0.1, true, 0 )` `mmauratutorial.lua, line 893: npc_fade_out( wave_member, 0.1, true, 0 )` `mmauratutorial.lua, line 936: npc_fade_out( npc, 1.0, false, 0 )` `mmblasttutorial.lua, line 1012: npc_fade_out( npc, 1.0, false, 0 )` `mmstomptutorial.lua, line 1059: npc_fade_out( npc, 1.0, false, 0 )` `mmstomptutorial.lua, line 1108: npc_fade_out( npc, 1.0, false, 0 )` `mmsummontutorial.lua, line 919: npc_fade_out( npc, 1.0, false, 0 )`
`npc_leash_remove`	true	3 `mintroshakes.lua, line 923: npc_leash_remove( mIntroShakes_group.shakespeare_npc.shakes )` `mintrotwins.lua, line 913: npc_leash_remove( mIntroTwins_homie.kiki )` `mintrotwins.lua, line 914: npc_leash_remove( mIntroTwins_homie.viola )`
`npc_leash_to_nav`	true	31 `mintro.lua, line 812: npc_leash_to_nav(mIntro_group.dane_npc.npcs[1],"dane_mark<001>",0.0)` `mintrobb.lua, line 946: npc_leash_to_nav( mIntroBB_homie.blackbeard, "Blackbeard_point", 1)` `mintroshakes.lua, line 762: --npc_leash_to_nav(mIntroShakes_group.shakespeare_npc.shakes, "shakes_anchor", 0.1, false)` `mintrotwins.lua, line 791: npc_leash_to_nav( mIntroTwins_homie.kiki, "leash_kiki", 75)` `mintrotwins.lua, line 792: npc_leash_to_nav( mIntroTwins_homie.viola, "leash_viola", 75)` `mintrotwins.lua, line 842: npc_leash_to_nav( mIntroTwins_group.w2_squad_02.members[1], "flight_nav<001>", 15.0)` `mintrotwins.lua, line 843: npc_leash_to_nav( mIntroTwins_group.w2_squad_04.members[1], "flight_nav<002>", 15.0)` `mintrotwins.lua, line 869: npc_leash_to_nav( mIntroTwins_group.w3_squad_01.members[1], "flight_nav<003>", 15.0)` `mintrotwins.lua, line 870: npc_leash_to_nav( mIntroTwins_group.w3_squad_02.members[1], "flight_nav<004>", 15.0)` `mintrotwins.lua, line 915: npc_leash_to_nav( mIntroTwins_homie.kiki, "kiki_nav", 1)` `mintrotwins.lua, line 916: npc_leash_to_nav( mIntroTwins_homie.viola, "viola_nav", 1)` `mintrovlad.lua, line 724: npc_leash_to_nav("demon_dj<001>", "Nav<007>", 1.0, false)` `mintrovlad.lua, line 725: npc_leash_to_nav("demon_guard<001>", "Nav<001>", 2.0, false)` `mintrovlad.lua, line 726: npc_leash_to_nav("demon_guard<002>", "Nav<002>", 2.0, false)` `mintrovlad.lua, line 727: npc_leash_to_nav("demon_guard<003>", "Nav<003>", 2.0, false)` `mintrovlad.lua, line 728: npc_leash_to_nav("demon_guard<004>", "Nav<004>", 2.0, false)` `mintrovlad.lua, line 729: npc_leash_to_nav("demon_guard<005>", "Nav<005>", 2.0, false)` `mintrovlad.lua, line 730: npc_leash_to_nav("demon_guard<006>", "Nav<006>", 2.0, false)` `mintrovlad.lua, line 1003: npc_leash_to_nav("demon_dj<001>", "Nav<007>", 1.0, false)` `mintrovlad.lua, line 1004: npc_leash_to_nav("demon_guard<001>", "Nav<001>", 2.0, false)` `mintrovlad.lua, line 1005: npc_leash_to_nav("demon_guard<002>", "Nav<002>", 2.0, false)` `mintrovlad.lua, line 1006: npc_leash_to_nav("demon_guard<003>", "Nav<003>", 2.0, false)` `mintrovlad.lua, line 1007: npc_leash_to_nav("demon_guard<004>", "Nav<004>", 2.0, false)` `mintrovlad.lua, line 1008: npc_leash_to_nav("demon_guard<005>", "Nav<005>", 2.0, false)` `mintrovlad.lua, line 1009: npc_leash_to_nav("demon_guard<006>", "Nav<006>", 2.0, false)` `mmauratutorial.lua, line 655: npc_leash_to_nav(mmAuraTutorial_group.wave_4.members[1], mmAuraTutorial_get_npc_leash_navpoint(mmAuraTutorial_group.wave_4.members[1]), 4.0)` `mmsummontutorial.lua, line 667: npc_leash_to_nav("Demon_Grunt<001>", "Respawn_Navpoint<001>", 1.0, false)` `mmsummontutorial.lua, line 669: npc_leash_to_nav("Demon_Grunt<002>", "Respawn_Navpoint<002>", 1.0, false)` `mmsummontutorial.lua, line 685: npc_leash_to_nav("Demon_Grunt<003>", "Respawn_Navpoint<003>", 0.5, false)` `mmsummontutorial.lua, line 687: npc_leash_to_nav("Demon_Grunt<004>", "Respawn_Navpoint<004>", 0.5, false)` `mmsummontutorial.lua, line 942: npc_leash_to_nav(npc, mmSummonTutorial_get_npc_respawn_navpoint(npc), 0.5, false )`
`npc_never_die`	true	1 `mintro.lua, line 1364: npc_never_die(mIntro_homie.kinzie, true)`
`npc_respawn_after_death`	true	7 `mmauratutorial.lua, line 790: --npc_respawn_after_death( wave_member, true )` `mmblasttutorial.lua, line 894: npc_respawn_after_death( wave_member, true )` `mmblasttutorial.lua, line 914: npc_respawn_after_death( wave_member, true )` `mmstomptutorial.lua, line 894: --npc_respawn_after_death( wave_member, true )` `mmstomptutorial.lua, line 917: --npc_respawn_after_death( wave_member, true )` `mmstomptutorial.lua, line 949: --npc_respawn_after_death( wave_member, true )` `mmstomptutorial.lua, line 972: --npc_respawn_after_death( wave_member, true )`
`npc_respawn_after_death_time_override`	true	7 `mmauratutorial.lua, line 791: --npc_respawn_after_death_time_override( wave_member, 10, true )` `mmblasttutorial.lua, line 895: npc_respawn_after_death_time_override( wave_member, 10, true )` `mmblasttutorial.lua, line 915: npc_respawn_after_death_time_override( wave_member, 10, true )` `mmstomptutorial.lua, line 895: --npc_respawn_after_death_time_override( wave_member, 10, true )` `mmstomptutorial.lua, line 918: --npc_respawn_after_death_time_override( wave_member, 10, true )` `mmstomptutorial.lua, line 950: --npc_respawn_after_death_time_override( wave_member, 10, true )` `mmstomptutorial.lua, line 973: --npc_respawn_after_death_time_override( wave_member, 10, true )`
`npc_respawn_dist_override`	true	2 `mmblasttutorial.lua, line 879: npc_respawn_dist_override( 100000.0 )` `mmsummontutorial.lua, line 809: npc_respawn_dist_override( 100000.0 )`
`npc_respawn_dist_reset`	true	7 `mmauratutorial.lua, line 422: npc_respawn_dist_reset()` `mmauratutorial.lua, line 717: npc_respawn_dist_reset()` `mmblasttutorial.lua, line 503: npc_respawn_dist_reset()` `mmblasttutorial.lua, line 855: npc_respawn_dist_reset()` `mmstomptutorial.lua, line 533: npc_respawn_dist_reset()` `mmstomptutorial.lua, line 853: npc_respawn_dist_reset()` `mmsummontutorial.lua, line 785: npc_respawn_dist_reset()`
`npc_revive`	true	6 `mintrobb.lua, line 1214: npc_revive(imp_name)` `mmauratutorial.lua, line 950: npc_revive( npc )` `mmblasttutorial.lua, line 1025: npc_revive( npc )` `mmstomptutorial.lua, line 1067: npc_revive( npc )` `mmstomptutorial.lua, line 1117: npc_revive( npc )` `mmsummontutorial.lua, line 934: npc_revive( npc )`
`npc_suppress_persona`	true	2 `game_lib.lua, line 1088: npc_suppress_persona(human_name, true)` `game_lib.lua, line 1103: npc_suppress_persona(human_name, true)`
`npc_ultra_shield_enable`	true	1 `mmblasttutorial.lua, line 1059: npc_ultra_shield_enable( npc, true )`
`npc_use_closest_action_node_of_type`	true	2 `sr4_5_city.lua, line 1100: npc_use_closest_action_node_of_type(npc, active_node, 200, true )` `sr4_5_city.lua, line 1554: npc_use_closest_action_node_of_type( npc, action_node, 200, teleport_bool )`

Saints Row 2 Function Reference

Global functions