Saints Row 2 Function Reference

Local functions

These functions are defined within the patch lua files. They are assumed to be only available within the file that defines them or by including the file in another script.

Some of these functions may essentially be global since their files are always loaded; which files (and which functions) haven't been determined yet.

Function name	Global	Defined in	Examples from patch (click blue number to expand)
`initialize_goo`	false	1 `bh03.lua, line 2000`	2 `bh03.lua, line 391: initialize_goo()` `bh03.lua, line 577: initialize_goo()`
`inv_item_add`	false	1 `ug_lib.lua, line 1369`	81 `bh01.lua, line 219: inv_item_add("twelve_gauge", 1, CHAR_MAERO)` `bh01.lua, line 220: inv_item_add("glock", 1, CHAR_CARLOS)` `bh01.lua, line 267: inv_item_add("nightstick", 1, npc)` `bh01.lua, line 270: inv_item_add("pepper_spray", 1, npc)` `bh01.lua, line 273: inv_item_add("stun_gun", 1, npc)` `bh01.lua, line 276: inv_item_add("flashbang", 5, npc)` `bh01.lua, line 310: inv_item_add("twelve_gauge", 1, CHAR_MAERO)` `bh01.lua, line 311: inv_item_add("glock", 1, CHAR_CARLOS)` `bh07.lua, line 557: inv_item_add("m16", 1, npc)` `bh07.lua, line 567: inv_item_add("m16", 1, npc)` `bh07.lua, line 698: inv_item_add("m16", 1, npc)` `bh07.lua, line 710: inv_item_add("m16", 1, npc)` `bh09.lua, line 558: inv_item_add("ak47", 1, npc)` `bh09.lua, line 573: inv_item_add( "ak47", 1, triggerer_name )` `bh09.lua, line 592: inv_item_add( "rpg_launcher", 1, triggerer_name )` `bh09.lua, line 624: inv_item_add("ak47", 1, LOCAL_PLAYER)` `bh09.lua, line 639: inv_item_add("rpg_launcher", 1, LOCAL_PLAYER)` `bh09.lua, line 1035: inv_item_add( HELI_ATTACKER_WEAPON, 1, member_name )` `bh10.lua, line 619: inv_item_add("rpg_launcher",1,npc)` `bh10.lua, line 907: inv_item_add("minigun", 1, CHAR_MAERO)` `bh10.lua, line 908: inv_item_add(Thrown_weapon, 1, CHAR_MAERO)` `bh10.lua, line 1301: inv_item_add("minigun", 1, CHAR_MAERO)` `bh10.lua, line 1306: inv_item_add(Thrown_weapon, 1, CHAR_MAERO)` `bh10.lua, line 1312: inv_item_add("minigun", 1, CHAR_MAERO)` `bh10.lua, line 1318: inv_item_add(Thrown_weapon, 1, CHAR_MAERO)` `bh10.lua, line 1336: inv_item_add("minigun", 1, CHAR_MAERO)` `bh10.lua, line 1337: inv_item_add(Thrown_weapon, 1, CHAR_MAERO)` `coop_test.lua, line 175: inv_item_add( "ar50_launcher", 100, REMOTE_PLAYER, true );` `em01.lua, line 343: inv_item_add("desert eagle", 1, CHARACTER_JULIUS)` `em01.lua, line 2467: inv_item_add("rpg_launcher", 1, "em01_$c054", true)` `em01.lua, line 2468: inv_item_add("rpg_launcher", 1, "em01_$c055", true)` `em01.lua, line 2469: inv_item_add("rpg_launcher", 1, "em01_$c056", true)` `rn06.lua, line 451: inv_item_add("dual_swords", 1, CHARACTER_JYUNICHI)` `rn07.lua, line 1026: inv_item_add("rpg_launcher",0,CHARACTER_RPG_GUY)` `rn07.lua, line 1972: inv_item_add("AR200",0,RONIN_HELICOPTER_MEMBERS[2])` `rn10.lua, line 902: inv_item_add("rpg_launcher", 0, ronin)` `rn10.lua, line 986: inv_item_add(thrown_weapon, 1, ronin)` `rn10.lua, line 1255: inv_item_add("samurai_sword", 1, CHARACTER_AKUJI)` `rn11.lua, line 418: inv_item_add("samurai_sword", 1, CHARACTER_AKUJI)` `rn11.lua, line 841: inv_item_add("samurai_sword", 1, CHARACTER_AKUJI)` `ss01.lua, line 470: inv_item_add( DEFAULT_PISTOL, 1, member_name )` `ss01.lua, line 476: inv_item_add( DEFAULT_PISTOL, 1, member_name )` `ss01.lua, line 483: inv_item_add( DEFAULT_SMG, 1, group_member_names[random_member_index] )` `ss02.lua, line 676: --inv_item_add( "beretta", 1, LAURA_NAME )` `ss06.lua, line 2047: inv_item_add( weapons[index], 1, member_name )` `ss08.lua, line 1387: inv_item_add( weapon_types[weapon_index], 1, member_name )` `ss09.lua, line 245: inv_item_add( SUNSHINE_MELEE_WEAPON, 1, MR_SUNSHINE_NAME )` `ss09.lua, line 252: inv_item_add( SUNSHINE_RANGED_WEAPON, 1, MR_SUNSHINE_NAME )` `ss10.lua, line 1550: inv_item_add( POLICE_PISTOL_NAME, 1, member )` `ss10.lua, line 1554: inv_item_add( POLICE_SHOTGUN_NAME, 1, member )` `ss10.lua, line 1572: inv_item_add( POLICE_PISTOL_NAME, 1, member )` `ss10.lua, line 1575: inv_item_add( POLICE_SHOTGUN_NAME, 1, member )` `ss11.lua, line 1359: inv_item_add( THE_GENERALS_SAW, 1, THE_GENERAL_NAME )` `tss01.lua, line 2448: inv_item_add("m16", 1, Tss01_random_guards[i], true)` `tss01.lua, line 2475: inv_item_add("m16", 1, Tss01_random_guards_coop[i], true)` `tss01.lua, line 3428: inv_item_add("m16", 1, Tss01_random_guards[i], true)` `tss01.lua, line 3455: inv_item_add("m16", 1, Tss01_random_guards_coop[i], true)` `tss01.lua, line 3495: inv_item_add("m16", 1, CHARACTER_CARLOS)` `tss01.lua, line 3678: inv_item_add("m16", 1, Tss01_random_guards[i], true)` `tss01.lua, line 3720: inv_item_add("m16", 1, Tss01_random_guards_coop[i], true)` `tss01.lua, line 3733: inv_item_add("glock", 1, CHARACTER_CARLOS)` `tss01.lua, line 4116: inv_item_add("m16", 1, Tss01_warden_rifle_guards[i], true)` `tss01.lua, line 4136: inv_item_add("m16", 1, Tss01_lighthouse_rifle_guards[i], true)` `tss01.lua, line 4578: inv_item_add("m16", 1, Tss01_boat4_table[i])` `tss01.lua, line 4584: inv_item_add("m16", 1, Tss01_boat5_table[i])` `tss01.lua, line 4590: inv_item_add("m16", 1, Tss01_heli2_table[i])` `tss01.lua, line 4596: inv_item_add("m16", 1, Tss01_heli3_table[i])` `tss01.lua, line 4610: inv_item_add("m16", 1, Tss01_boat1_table[i])` `tss01.lua, line 4616: inv_item_add("m16", 1, Tss01_boat2_table[i])` `tss01.lua, line 4622: inv_item_add("m16", 1, Tss01_boat3_table[i])` `tss01.lua, line 4628: inv_item_add("m16", 1, Tss01_heli1_table[i])` `tss02.lua, line 376: inv_item_add("baseball_bat", 1, "tss02_$c006")` `tss02.lua, line 377: inv_item_add("tire_iron", 1, "tss02_$c007")` `tss02.lua, line 1085: inv_item_add("glock", 2, human)` `tss02.lua, line 1093: inv_item_add("glock", 1, Tss02_police_need_pistols[i])` `tss03.lua, line 572: inv_item_add("molotov", 1, human)` `tss03_demo.lua, line 167: inv_item_add("beretta", 1, LOCAL_PLAYER)` `tss03_demo.lua, line 168: inv_item_add("as14", 1, LOCAL_PLAYER)` `tss03_demo.lua, line 169: inv_item_add("pipe_bomb", 1, LOCAL_PLAYER)` `tss03_demo.lua, line 174: inv_item_add("Holt_55", 1, CHARACTER_GAT)` `tss03_demo.lua, line 541: inv_item_add("molotov", 1, human)`
`inv_item_get_all`	false	1 `ug_lib.lua, line 1381`
`is_exploiting`	false	1 `bh10.lua, line 1201`
`is_hood_owner`	false	1 `ug_lib.lua, line 1385`
`is_player_in_flying_vehicle`	false	1 `ss10.lua, line 1213`	2 `ss10.lua, line 1223: local player_was_in_flying_vehicle = is_player_in_flying_vehicle()` `ss10.lua, line 1235: local player_is_in_flying_vehicle = is_player_in_flying_vehicle()`
`is_player_tag`	false	1 `ug_lib.lua, line 1394`	2 `ug_lib.lua, line 2169: if is_player_tag(arg[arg.n]) then` `ug_lib.lua, line 2180: if is_player_tag(arg[arg.n]) then`
`item_throw`	false	1 `ug_lib.lua, line 3050`	1 `ss08.lua, line 1656: item_throw( homie_name, BOX_LOADING_TARGET )`
`item_wield`	false	1 `ug_lib.lua, line 3062`	2 `ss08.lua, line 1645: item_wield( target_box, homie_name, false )` `ss10.lua, line 1279: item_wield( PACKAGE_NAME, SHAUNDI_REPAIR_VARIANT_NAME, false )`