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	Examples from patch (click blue number to expand)
`fade_get_percent`	true	6 `bh01.lua, line 591: while (fade_get_percent() < 1.0) do` `bh01.lua, line 614: while (fade_get_percent() > 0.5) do` `em01.lua, line 1692: while (fade_get_percent() < 1.0) do` `ep03.lua, line 326: while (fade_get_percent() < 1.0) do` `ep03.lua, line 362: while (fade_get_percent() > 0.5) do` `rn07.lua, line 1606: if ( (not Gat_in_cardiac_arrest) and (fade_get_percent() == 0.0)) then`
`fade_in`	true	51 `bh01.lua, line 613: fade_in(1.0)` `bh03.lua, line 418: fade_in( 1 )` `bh03.lua, line 1455: fade_in( 1 )` `bh05.lua, line 891: fade_in( 1.0 )` `bh06.lua, line 408: fade_in(1.0)` `bh10.lua, line 844: fade_in(1.0, SYNC_ALL)` `coop_test.lua, line 14: fade_in( 0 )` `em01.lua, line 1756: fade_in(1.0)` `ep01.lua, line 1529: fade_in(1.0, SYNC_LOCAL)` `ep01.lua, line 1532: fade_in(1.0, SYNC_REMOTE)` `ep03.lua, line 360: fade_in(2.0)` `ep04.lua, line 509: fade_in( 1.0 )` `ep04.lua, line 609: fade_in( AFTER_CHUNK_SWAP_FADE_IN_TIME_SECONDS )` `rn02.lua, line 386: fade_in(1.0, SYNC_ALL)` `rn02.lua, line 903: fade_in(1.0, SYNC_ALL)` `rn04.lua, line 492: fade_in(1.0, SYNC_ALL)` `rn06.lua, line 194: fade_in(1.0,SYNC_ALL)` `rn07.lua, line 830: fade_in(1.0, SYNC_LOCAL)` `rn07.lua, line 903: fade_in(1.0, SYNC_ALL)` `rn07.lua, line 946: fade_in(1.0, SYNC_LOCAL)` `rn07.lua, line 983: fade_in(1.0, SYNC_LOCAL)` `rn07.lua, line 1193: fade_in(1.0, SYNC_REMOTE)` `rn08.lua, line 1440: fade_in(1.0, SYNC_ALL)` `rn09.lua, line 249: fade_in(1.0, SYNC_ALL)` `rn09.lua, line 430: fade_in(1.0, SYNC_ALL)` `sh_bh_airport.lua, line 93: fade_in(1)` `sh_bh_apartments.lua, line 74: fade_in(1)` `sh_bh_chinatown.lua, line 86: fade_in(1)` `sh_bh_docks.lua, line 54: fade_in(1)` `sh_rn_sciencemuseum.lua, line 59: fade_in(1)` `sh_rn_stripclub.lua, line 357: fade_in(.5)` `sh_ss_crackhouse.lua, line 90: fade_in(1)` `sh_ss_fishingdock.lua, line 125: fade_in(.5)` `sh_ss_student_union.lua, line 85: fade_in(.2)` `sh_ss_trailerpark.lua, line 81: fade_in(1)` `sh_tss_caverns.lua, line 96: fade_in(1)` `sh_tss_caverns.lua, line 402: --fade_in(3)` `sh_tss_ugmall.lua, line 85: fade_in(1)` `ss03.lua, line 1512: fade_in( 0 )` `ss04.lua, line 622: fade_in( 1 )` `ss04.lua, line 701: fade_in( 1.0 )` `ss05.lua, line 1653: fade_in( 1.0 )` `ss09.lua, line 545: fade_in( 1.0 )` `ss10.lua, line 960: fade_in( CLOTHES_SWITCH_FADE_TIME_SECONDS )` `ss11.lua, line 491: fade_in( MISSION_START_FADED_TIME_SECONDS )` `ss11.lua, line 713: fade_in( 1.0 )` `ss11.lua, line 778: fade_in( 0 )` `ss11.lua, line 1075: fade_in( 1.0 )` `tss01.lua, line 4274: fade_in(0.5)` `ug_lib.lua, line 995: fade_in(0.5)` `ug_lib.lua, line 1825: fade_in( START_FADE_IN_TIME )`
`fade_out`	true	51 `bh01.lua, line 590: fade_out(1.0)` `bh03.lua, line 1265: fade_out( 1 )` `bh04.lua, line 190: fade_out(0)` `bh05.lua, line 862: fade_out( 0 )` `bh06.lua, line 337: fade_out(1.0)` `bh07.lua, line 265: fade_out(0)` `bh09.lua, line 481: fade_out( 0 )` `bh10.lua, line 808: fade_out(0.0,{0,0,0}, SYNC_ALL)` `em01.lua, line 325: fade_out( 0 )` `em01.lua, line 1691: fade_out(1.0)` `ep01.lua, line 271: fade_out(0)` `ep01.lua, line 1495: fade_out(1.0,{0,0,0}, SYNC_LOCAL)` `ep01.lua, line 1498: fade_out(1.0,{0,0,0}, SYNC_REMOTE)` `ep03.lua, line 292: fade_out(3.0)` `ep03.lua, line 324: fade_out(2.0)` `ep04.lua, line 572: fade_out( 0 )` `rn02.lua, line 361: fade_out(1.0,{0,0,0}, SYNC_ALL)` `rn02.lua, line 895: fade_out(0.0,{0,0,0}, SYNC_ALL)` `rn03.lua, line 269: fade_out(0)` `rn04.lua, line 474: fade_out(0.0,{0,0,0}, SYNC_ALL)` `rn06.lua, line 162: fade_out(0)` `rn06.lua, line 176: fade_out(1.0,{0,0,0}, SYNC_ALL)` `rn07.lua, line 825: fade_out(1.0,{0,0,0}, SYNC_LOCAL)` `rn07.lua, line 892: fade_out(1.0,{0,0,0}, SYNC_ALL)` `rn07.lua, line 939: fade_out(1.0,{0,0,0}, SYNC_LOCAL)` `rn07.lua, line 973: fade_out(1.0,{0,0,0}, SYNC_LOCAL)` `rn07.lua, line 1188: fade_out(1.0,{0,0,0}, SYNC_REMOTE)` `rn08.lua, line 752: fade_out(0)` `rn08.lua, line 1410: fade_out(1.0, {0,0,0}, SYNC_ALL)` `rn09.lua, line 223: fade_out(0.0,{0,0,0}, SYNC_ALL)` `rn09.lua, line 397: fade_out(0.5, {0,0,0}, SYNC_ALL)` `rn09.lua, line 418: fade_out(0.0, {0,0,0}, SYNC_ALL)` `rn10.lua, line 412: fade_out(0)` `rn11.lua, line 496: fade_out(0)` `sh_rn_rec_center.lua, line 69: fade_out(.1)` `sh_rn_stripclub.lua, line 59: --fade_out(.5)` `sh_rn_stripclub.lua, line 354: fade_out(.5)` `sh_tss_caverns.lua, line 91: fade_out(1)` `sh_tss_caverns.lua, line 400: --fade_out(.1)` `ss04.lua, line 569: fade_out( 0 )` `ss04.lua, line 600: fade_out( 0 )` `ss05.lua, line 1630: fade_out( 0 )` `ss08.lua, line 854: fade_out( 0 )` `ss10.lua, line 906: fade_out( CLOTHES_SWITCH_FADE_TIME_SECONDS )` `ss10.lua, line 1088: fade_out( 0 )` `ss11.lua, line 413: fade_out( 0 )` `ss11.lua, line 709: fade_out( 0 )` `ss11.lua, line 757: fade_out( 0 )` `tss01.lua, line 4267: fade_out(1)` `ug_lib.lua, line 959: fade_out(1.0)` `ug_lib.lua, line 1807: fade_out( START_FADE_OUT_TIME )`
`feedback_start`	true	1 `bh03.lua, line 1945: feedback_start(GEIGER_FEEDBACK, GEIGER_MIN_FEEDBACK + ratio * (1 - GEIGER_MIN_FEEDBACK), false, sync)`
`finishers_disable`	true	1 `coop_test.lua, line 200: finishers_disable()`
`finishers_enable`	true	1 `coop_test.lua, line 206: finishers_enable()`
`flee`	true	7 `ep03.lua, line 259: flee(npc, LOCAL_PLAYER, true, true)` `ep03.lua, line 269: flee(npc, LOCAL_PLAYER, false, true)` `ep03.lua, line 286: flee(npc, LOCAL_PLAYER, false, true)` `sh_tss_ugmall.lua, line 139: flee(char,LOCAL_PLAYER,false,true)` `ss05.lua, line 1345: flee( LAB_FOUR_ESCAPEE_TECH, player_name )` `ss06.lua, line 1131: flee( member_name, LOCAL_PLAYER, false, true )` `ss10.lua, line 754: flee( REPAIR_MAN_NAME, player_name, false )`
`flee_to_navpoint`	true	2 `rn05.lua, line 919: flee_to_navpoint(passenger, destination)` `ss04.lua, line 853: flee_to_navpoint( SHAUNDI_NAME, FLOOR_LEASH_LOCATION, VETERAN_CHILD_NAME, true )`
`follower_is_unconscious`	true	10 `em01.lua, line 992: if (follower_is_unconscious(CHARACTER_JULIUS)) then` `em01.lua, line 996: while (follower_is_unconscious(CHARACTER_JULIUS)) do` `em01.lua, line 1042: while (follower_is_unconscious(CHARACTER_JULIUS)) do` `em01.lua, line 1128: while (follower_is_unconscious(CHARACTER_JULIUS)) do` `em01.lua, line 1218: while (follower_is_unconscious(CHARACTER_JULIUS)) do` `tss01.lua, line 1587: while (follower_is_unconscious(CHARACTER_CARLOS)) do` `tss01.lua, line 1658: while (follower_is_unconscious(CHARACTER_CARLOS)) do` `tss01.lua, line 4018: and (not follower_is_unconscious(CHARACTER_CARLOS))` `tss01.lua, line 4218: while (follower_is_unconscious(CHARACTER_CARLOS)) do` `tss04.lua, line 641: if (follower_is_unconscious(lieutenant)) then`
`follower_make_independent`	true	47 `bh01.lua, line 588: follower_make_independent( CHAR_CARLOS, true )` `bh01.lua, line 589: follower_make_independent( CHAR_MAERO, true )` `bh01.lua, line 609: follower_make_independent( CHAR_CARLOS, false )` `bh01.lua, line 610: follower_make_independent( CHAR_MAERO, false )` `bh02.lua, line 405: follower_make_independent(CHAR_DONNIE, true)` `bh02.lua, line 420: follower_make_independent(CHAR_DONNIE, false)` `bh02.lua, line 432: follower_make_independent(CHAR_DONNIE, true)` `bh02.lua, line 445: follower_make_independent(CHAR_DONNIE, false)` `bh02.lua, line 454: follower_make_independent(CHAR_DONNIE, true)` `bh02.lua, line 475: follower_make_independent(CHAR_DONNIE, false)` `bh05.lua, line 587: follower_make_independent( CHAR_JESSICA, true )` `bh05.lua, line 601: follower_make_independent( CHAR_JESSICA, false )` `bh06.lua, line 375: follower_make_independent(CHAR_PIERCE, true)` `bh06.lua, line 385: follower_make_independent(CHAR_PIERCE, false)` `em01.lua, line 1034: follower_make_independent(CHARACTER_JULIUS, true)` `em01.lua, line 1477: follower_make_independent(CHARACTER_JULIUS, false)` `em01.lua, line 1657: follower_make_independent(CHARACTER_JULIUS, true)` `em01.lua, line 2251: follower_make_independent(CHARACTER_JULIUS, true)` `rn01.lua, line 828: follower_make_independent(CHARACTER_GAT, true)` `rn01.lua, line 836: follower_make_independent(CHARACTER_GAT, false)` `rn02.lua, line 1012: follower_make_independent(CHARACTER_FENCE, true)` `rn04.lua, line 842: follower_make_independent(CHARACTER_HOMIE, true)` `rn04.lua, line 843: follower_make_independent(CHARACTER_GAT, true)` `rn09.lua, line 447: --follower_make_independent(CHARACTER_GAT,true)` `ss07.lua, line 353: follower_make_independent( PIERCE_NAME, true )` `ss07.lua, line 391: follower_make_independent( PIERCE_NAME, true )` `ss07.lua, line 428: follower_make_independent( PIERCE_NAME, true )` `ss08.lua, line 610: follower_make_independent( PIERCE_NAME, true )` `ss08.lua, line 611: follower_make_independent( SHAUNDI_NAME, true )` `ss08.lua, line 751: follower_make_independent( PIERCE_NAME, true )` `ss08.lua, line 773: follower_make_independent( SHAUNDI_NAME, true )` `ss08.lua, line 907: follower_make_independent( PIERCE_NAME, true )` `ss08.lua, line 908: follower_make_independent( SHAUNDI_NAME, true )` `ss10.lua, line 907: follower_make_independent( SHAUNDI_NAME, true )` `ss10.lua, line 1170: follower_make_independent( SHAUNDI_REPAIR_VARIANT_NAME, false )` `ss10.lua, line 2010: follower_make_independent( SHAUNDI_REPAIR_VARIANT_NAME, true )` `ss10.lua, line 2123: follower_make_independent( SHAUNDI_NAME, true )` `tss01.lua, line 1577: follower_make_independent(CHARACTER_CARLOS, false)` `tss01.lua, line 1663: follower_make_independent(CHARACTER_CARLOS, true)` `tss01.lua, line 2856: follower_make_independent(human, true)` `tss01.lua, line 4041: follower_make_independent(CHARACTER_CARLOS, true)` `tss01.lua, line 4077: follower_make_independent(CHARACTER_CARLOS, false)` `tss01.lua, line 4340: follower_make_independent(CHARACTER_CARLOS, true)` `tss03_demo.lua, line 212: follower_make_independent(CHARACTER_GAT, true)` `tss03_demo.lua, line 214: follower_make_independent(CHARACTER_GAT, false)` `tss04.lua, line 991: follower_make_independent(Tss04_3_phase_table[TOWTRUCK_INDEX][CHARACTER_INDEX], true)` `tss04.lua, line 1461: follower_make_independent(Tss04_3_phase_table[TOWTRUCK_INDEX][CHARACTER_INDEX], false)`
`force_ai_mode_check_done`	true	4 `bh10.lua, line 1351: if (force_ai_mode_check_done(CHAR_MAERO)) then` `bh10.lua, line 1366: if (force_ai_mode_check_done(CHAR_MAERO)) then` `bh10.lua, line 1387: if (force_ai_mode_check_done(CHAR_MAERO)) then` `ug_lib.lua, line 1070: while ( not ( force_ai_mode_check_done( name ) ) ) do`
`force_fire_do`	true	1 `ug_lib.lua, line 1055: if (force_fire_do(name, fire_at_navpoint, fire_once)) then`
`force_fire_object_position_do`	true	1 `ug_lib.lua, line 1069: if ( force_fire_object_position_do( name, fire_at_object, fire_once ) ) then`
`force_fire_pull_alt_trigger`	true	1 `bh10.lua, line 1419: force_fire_pull_alt_trigger(CHAR_MAERO)`
`force_fire_target_do`	true	2 `bh10.lua, line 1352: force_fire_target_do(CHAR_MAERO, Bh10_maero_target, false)` `ug_lib.lua, line 1083: if (force_fire_target_do(name, fire_at_target, fire_once)) then`
`force_melee`	true	1 `bh07.lua, line 948: force_melee(npc, 2)`
`force_throw_char_do`	true	2 `bh10.lua, line 1367: force_throw_char_do(CHAR_MAERO, Bh10_maero_target)` `ug_lib.lua, line 1110: if (force_throw_char_do(name, target)) then`
`force_throw_do`	true	2 `bh10.lua, line 1486: force_throw_do(CHAR_MAERO, target, angle, speed)` `ug_lib.lua, line 1098: if (force_throw_do(name, target_navp, throw_pitch, throw_speed)) then`
`force_throw_from_vehicle`	true	3 `bh07.lua, line 520: force_throw_from_vehicle(CHAR_FIREBOMBERS[1], true)` `bh07.lua, line 525: force_throw_from_vehicle(CHAR_FIREBOMBERS[2], true)` `bh07.lua, line 530: force_throw_from_vehicle(CHAR_FIREBOMBERS[3], true)`
`format_int_to_string`	true	1 `vint_lib.lua, line 266: return format_int_to_string(cash)`
`fov_check`	true	2 `tss03.lua, line 477: if (not PERFORMING_COMPLIMENT and (fov_check(name, LOCAL_PLAYER) > 0.0) and los_check(name, LOCAL_PLAYER)) then` `tss03_demo.lua, line 447: if (not PERFORMING_COMPLIMENT and (fov_check(name, LOCAL_PLAYER) > 0.0) and los_check(name, LOCAL_PLAYER)) then`
`fov_check_xz_plane`	true	1 `em01.lua, line 1355: while (vehicle_exists(heli) and character_exists(target_human) and not fov_check_xz_plane(heli, target_human, 10.0)) do`
`framerate_get_dump_tag`	true	16 `fr_checkAI.lua, line 47: local dump_tag = framerate_get_dump_tag("AI")` `fr_checkAP.lua, line 47: local dump_tag = framerate_get_dump_tag("AP")` `fr_checkAR.lua, line 47: local dump_tag = framerate_get_dump_tag("AR")` `fr_checkBA.lua, line 47: local dump_tag = framerate_get_dump_tag("BA")` `fr_checkCT.lua, line 47: local dump_tag = framerate_get_dump_tag("CT")` `fr_checkDK.lua, line 47: local dump_tag = framerate_get_dump_tag("DK")` `fr_checkDT.lua, line 47: local dump_tag = framerate_get_dump_tag("DT")` `fr_checkFA.lua, line 47: local dump_tag = framerate_get_dump_tag("FA")` `fr_checkHE.lua, line 47: local dump_tag = framerate_get_dump_tag("HE")` `fr_checkMA.lua, line 47: local dump_tag = framerate_get_dump_tag("MA")` `fr_checkMU.lua, line 47: local dump_tag = framerate_get_dump_tag("MU")` `fr_checkPR.lua, line 47: local dump_tag = framerate_get_dump_tag("PR")` `fr_checkSE.lua, line 47: local dump_tag = framerate_get_dump_tag("SE")` `fr_checkSR.lua, line 47: local dump_tag = framerate_get_dump_tag("SR")` `fr_checkSU.lua, line 47: local dump_tag = framerate_get_dump_tag("SU")` `fr_checkTY.lua, line 47: local dump_tag = framerate_get_dump_tag("TY")`
`framerate_test_should_play_effects`	true	32 `fr_checkAI.lua, line 33: if (framerate_test_should_play_effects()) then` `fr_checkAI.lua, line 53: if (framerate_test_should_play_effects()) then` `fr_checkAP.lua, line 33: if (framerate_test_should_play_effects()) then` `fr_checkAP.lua, line 53: if (framerate_test_should_play_effects()) then` `fr_checkAR.lua, line 33: if (framerate_test_should_play_effects()) then` `fr_checkAR.lua, line 53: if (framerate_test_should_play_effects()) then` `fr_checkBA.lua, line 33: if (framerate_test_should_play_effects()) then` `fr_checkBA.lua, line 53: if (framerate_test_should_play_effects()) then` `fr_checkCT.lua, line 33: if (framerate_test_should_play_effects()) then` `fr_checkCT.lua, line 53: if (framerate_test_should_play_effects()) then` `fr_checkDK.lua, line 33: if (framerate_test_should_play_effects()) then` `fr_checkDK.lua, line 53: if (framerate_test_should_play_effects()) then` `fr_checkDT.lua, line 33: if (framerate_test_should_play_effects()) then` `fr_checkDT.lua, line 53: if (framerate_test_should_play_effects()) then` `fr_checkFA.lua, line 33: if (framerate_test_should_play_effects()) then` `fr_checkFA.lua, line 53: if (framerate_test_should_play_effects()) then` `fr_checkHE.lua, line 33: if (framerate_test_should_play_effects()) then` `fr_checkHE.lua, line 53: if (framerate_test_should_play_effects()) then` `fr_checkMA.lua, line 33: if (framerate_test_should_play_effects()) then` `fr_checkMA.lua, line 53: if (framerate_test_should_play_effects()) then` `fr_checkMU.lua, line 33: if (framerate_test_should_play_effects()) then` `fr_checkMU.lua, line 53: if (framerate_test_should_play_effects()) then` `fr_checkPR.lua, line 33: if (framerate_test_should_play_effects()) then` `fr_checkPR.lua, line 53: if (framerate_test_should_play_effects()) then` `fr_checkSE.lua, line 33: if (framerate_test_should_play_effects()) then` `fr_checkSE.lua, line 53: if (framerate_test_should_play_effects()) then` `fr_checkSR.lua, line 33: if (framerate_test_should_play_effects()) then` `fr_checkSR.lua, line 53: if (framerate_test_should_play_effects()) then` `fr_checkSU.lua, line 33: if (framerate_test_should_play_effects()) then` `fr_checkSU.lua, line 53: if (framerate_test_should_play_effects()) then` `fr_checkTY.lua, line 33: if (framerate_test_should_play_effects()) then` `fr_checkTY.lua, line 53: if (framerate_test_should_play_effects()) then`
`framerate_test_should_run_continuously`	true	16 `fr_checkAI.lua, line 41: if (framerate_test_should_run_continuously()) then` `fr_checkAP.lua, line 41: if (framerate_test_should_run_continuously()) then` `fr_checkAR.lua, line 41: if (framerate_test_should_run_continuously()) then` `fr_checkBA.lua, line 41: if (framerate_test_should_run_continuously()) then` `fr_checkCT.lua, line 41: if (framerate_test_should_run_continuously()) then` `fr_checkDK.lua, line 41: if (framerate_test_should_run_continuously()) then` `fr_checkDT.lua, line 41: if (framerate_test_should_run_continuously()) then` `fr_checkFA.lua, line 41: if (framerate_test_should_run_continuously()) then` `fr_checkHE.lua, line 41: if (framerate_test_should_run_continuously()) then` `fr_checkMA.lua, line 41: if (framerate_test_should_run_continuously()) then` `fr_checkMU.lua, line 41: if (framerate_test_should_run_continuously()) then` `fr_checkPR.lua, line 41: if (framerate_test_should_run_continuously()) then` `fr_checkSE.lua, line 41: if (framerate_test_should_run_continuously()) then` `fr_checkSR.lua, line 41: if (framerate_test_should_run_continuously()) then` `fr_checkSU.lua, line 41: if (framerate_test_should_run_continuously()) then` `fr_checkTY.lua, line 41: if (framerate_test_should_run_continuously()) then`