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)
`waiting_for_player_dialog`	true	2 `ug_lib.lua, line 2440: waiting_for_player_dialog( true )` `ug_lib.lua, line 2445: waiting_for_player_dialog( false )`
`wander_start`	true	33 `bh03.lua, line 413: wander_start(npc, npc, 15.0)` `bh03.lua, line 567: wander_start(NUKE_GUARDS[i], NUKE_GUARDS[i], 15.0)` `bh03.lua, line 2028: wander_start(npc, npc, 15.0)` `bh05.lua, line 305: wander_start(npc, npc, 10)` `bh05.lua, line 316: wander_start(npc, npc, 10)` `bh05.lua, line 361: wander_start(npc, npc, 10)` `ep01.lua, line 1637: wander_start(goon,goon,rand_float(6,12))` `rn07.lua, line 1429: wander_start(lieutenant, PATROL_NAVPOINT_TABLES[floor][patrol_navpoint_index], rand_float(8,16))` `rn07.lua, line 1490: wander_start(lieutenant, PATROL_NAVPOINT_TABLES[floor][patrol_navpoint_index], rand_float(10,25))` `sh_bh_chinatown.lua, line 536: wander_start(peds[i], peds[i], 15)` `sh_rn_museum_pier.lua, line 74: wander_start(GroupTwo[i], GroupTwo[i], 10)` `sh_rn_sciencemuseum.lua, line 54: wander_start(group_one[i], group_one[i], 40)` `sh_rn_sciencemuseum.lua, line 68: wander_start(peds[i], peds[i], 20)` `sh_tss_ugmall.lua, line 96: wander_start(wander[i], wander[i], 20)` `ss01.lua, line 539: wander_start(member_name, member_name, WANDER_RADIUS_METERS)` `ss01.lua, line 546: wander_start(member_name, member_name, WANDER_RADIUS_METERS)` `ss02.lua, line 580: wander_start( member_name, member_name, WANDERING_GUARDS_WANDER_RADIUS_METERS )` `ss02.lua, line 595: wander_start( member_name, member_name, WANDERING_GUARDS_WANDER_RADIUS_METERS )` `ss05.lua, line 607: wander_start( LAB_TWO_LOBBY_GUARD, LAB_TWO_LOBBY_GUARD, LOBBY_GUARD_WANDER_RADIUS_METERS )` `ss05.lua, line 1054: wander_start( LAB_TWO_LOBBY_GUARD, LAB_TWO_LOBBY_GUARD, LOBBY_GUARD_WANDER_RADIUS_METERS )` `ss05.lua, line 1256: wander_start( name, name, LAB_FOUR_ENTRYWAY_NPCS_WANDER_RADIUS_METERS )` `ss09.lua, line 444: wander_start( member_name, member_name, WANDER_RADIUS_METERS )` `ss09.lua, line 498: wander_start( member_name, member_name, WANDER_RADIUS_METERS )` `tss01.lua, line 693: wander_start(Tss01_cafe_guards[i], Tss01_cafe_guards[i], 2.0)` `tss01.lua, line 2374: wander_start(Tss01_courtyard_guards[i], Tss01_courtyard_guards[i], 5.0)` `tss01.lua, line 2384: wander_start(Tss01_courtyard_guards_coop[i], Tss01_courtyard_guards_coop[i], 5.0)` `tss01.lua, line 2699: wander_start(Tss01_rooftop_guards[i], Tss01_rooftop_guards[i], 3.0)` `tss01.lua, line 3336: wander_start(Tss01_courtyard_guards[i], Tss01_courtyard_guards[i], 5.0)` `tss01.lua, line 3347: wander_start(Tss01_courtyard_guards_coop[i], Tss01_courtyard_guards_coop[i], 5.0)` `tss02.lua, line 832: -- wander_start(Tss02_police_group_01[i], Tss02_police_group_01[i], 10.0)` `tss04.lua, line 1524: wander_start(Tss04_ronin_group1[1], Tss04_ronin_group1[1], 10.0)` `tss04.lua, line 1525: wander_start(Tss04_ronin_group2[1], Tss04_ronin_group2[1], 10.0)` `tss04.lua, line 1526: wander_start(Tss04_ronin_group3[1], Tss04_ronin_group3[1], 30.0)`
`wander_stop`	true	3 `ep01.lua, line 1639: wander_stop(goon)` `rn07.lua, line 1431: wander_stop(lieutenant)` `rn07.lua, line 1492: wander_stop(lieutenant)`
`waypoint_add`	true	56 `bh02.lua, line 907: waypoint_add( target1, SYNC_ALL )` `bh03.lua, line 513: waypoint_add(WEAPON_STORE)` `bh03.lua, line 537: waypoint_add( MP.."boat_spawn1", SYNC_ALL )` `bh03.lua, line 587: waypoint_add( NAVPOINT_NUKE_ISLAND, SYNC_ALL )` `bh03.lua, line 761: waypoint_add( NAVPOINT_HQ, SYNC_ALL )` `bh03.lua, line 1017: waypoint_add( HELIPAD_AREA, SYNC_ALL )` `bh05.lua, line 338: waypoint_add(NAV_BANK, SYNC_ALL)` `bh05.lua, line 907: waypoint_add( VEH_JESSICAS_CAR, SYNC_ALL )` `bh05.lua, line 927: waypoint_add(TRIGGER_ARENA, SYNC_ALL)` `bh05.lua, line 983: waypoint_add(TRIGGER_ARENA, SYNC_ALL )` `bh05.lua, line 1010: waypoint_add( VEH_JESSICAS_CAR, SYNC_ALL )` `em01.lua, line 1598: waypoint_add(JULIUS_VEHICLE, SYNC_ALL)` `ep03.lua, line 163: waypoint_add(WAVECRAFT, SYNC_ALL)` `rn01.lua, line 1681: waypoint_add(waypoint, PLAYER_SYNC[player])` `ss01.lua, line 265: waypoint_add( UNIVERSITY_LOCATION_NAVPOINT_NAME, SYNC_ALL )` `ss01.lua, line 754: waypoint_add( MISSION_END_POINT_TRIGGER, SYNC_ALL )` `ss01.lua, line 773: waypoint_add( FINAL_DRUG_DEALER_GROUP_NAVPOINT_NAME, SYNC_ALL )` `ss01.lua, line 951: waypoint_add( FINAL_DEALER_GROUP_VEHICLE_NAME, SYNC_ALL )` `ss01.lua, line 1306: waypoint_add( closest_nav_local, SYNC_LOCAL )` `ss01.lua, line 1317: waypoint_add( closest_nav_remote, SYNC_REMOTE )` `ss02.lua, line 588: waypoint_add( MP.."Dock_Location", SYNC_ALL )` `ss02.lua, line 645: waypoint_add( PRISON_GATE_TRIGGER_NAME, SYNC_ALL )` `ss02.lua, line 896: waypoint_add( HELIPAD_HELICOPTER, SYNC_ALL )` `ss04.lua, line 466: waypoint_add( STOCKS_ENTRANCE, SYNC_ALL )` `ss04.lua, line 521: waypoint_add( ON_TRACK_ENTRANCES[1], SYNC_ALL )` `ss04.lua, line 1130: waypoint_add( ON_TRACK_ENTRANCES[1], SYNC_ALL )` `ss05.lua, line 836: waypoint_add( LAB_THREE_LOCATION_TRIGGER, SYNC_ALL )` `ss05.lua, line 999: waypoint_add( LAB_ONE_LOCATION_TRIGGER, SYNC_ALL )` `ss05.lua, line 1042: waypoint_add( LAB_TWO_LOCATION_TRIGGER, SYNC_ALL )` `ss05.lua, line 1082: waypoint_add( LAB_THREE_ENTRANCE_TRIGGER, SYNC_ALL )` `ss05.lua, line 1134: waypoint_add( LAB_FOUR_NEAR_TRIGGER, SYNC_ALL )` `ss06.lua, line 1246: waypoint_add( SAINTS_HQ_POS, SYNC_ALL )` `ss06.lua, line 1564: waypoint_add( SAINTS_HQ_AREA, sync_type )` `ss06.lua, line 2091: waypoint_add( SAINTS_HQ_AREA, sync_type )` `ss08.lua, line 942: waypoint_add( ESCAPE_CAR_NAME, SYNC_ALL )` `ss09.lua, line 339: waypoint_add( WAREHOUSE_ENTRANCE_TRIGGER, SYNC_ALL )` `ss09.lua, line 456: waypoint_add( WAREHOUSE_ENTRANCE_TRIGGER, SYNC_ALL )` `ss10.lua, line 782: waypoint_add( REPAIR_VAN_NAME, SYNC_ALL )` `ss10.lua, line 980: waypoint_add( PARKING_SPOT_TRIGGER, SYNC_ALL )` `ss10.lua, line 1016: waypoint_add( POLICE_STATION_TRIGGER_NAME, SYNC_ALL )` `ss10.lua, line 1229: waypoint_add( trigger_to_mark, SYNC_ALL )` `ss10.lua, line 1242: waypoint_add( SAINTS_HQ_TRIGGER_NAMES[AIR_HQ_TRIGGER_INDEX] )` `ss10.lua, line 1246: waypoint_add( SAINTS_HQ_TRIGGER_NAMES[GROUND_HQ_TRIGGER_INDEX] )` `ss10.lua, line 2154: waypoint_add( PARKING_SPOT_TRIGGER, sync_type )` `ss11.lua, line 704: waypoint_add( AMBUSH_LOCATION_TRIGGER, SYNC_ALL )` `tss02.lua, line 424: waypoint_add(NAVPOINT_OUTSIDE_SLOPPY_SECONDS, sync)` `tss02.lua, line 477: waypoint_add(NAVPOINT_TEENAY_PARKING, sync)` `tss02.lua, line 758: waypoint_add(TRIGGER_GPSFIX, SYNC_ALL)` `tss02.lua, line 765: waypoint_add(TRIGGER_COURTHOUSE_ENTER, SYNC_ALL)` `tss02.lua, line 1269: waypoint_add(TRIGGER_FORGIVE_FORGET, SYNC_ALL)` `tss02.lua, line 1294: waypoint_add(TRIGGER_MISSION_COMPLETE, SYNC_ALL)` `tss04.lua, line 235: waypoint_add(SUBURBS_TRIGGER, SYNC_ALL)` `tss04.lua, line 950: waypoint_add(LOCAL_TOWED_VEHICLE, SYNC_LOCAL)` `tss04.lua, line 953: waypoint_add(REMOTE_TOWED_VEHICLE, SYNC_REMOTE)` `tss04.lua, line 1134: waypoint_add(TOWED_VEHICLE_TRIGGER, sync_type)` `ug_lib.lua, line 1851: Mission_waypoint = waypoint_add(navpoint, sync_type)`
`waypoint_remove`	true	57 `bh02.lua, line 977: waypoint_remove( SYNC_ALL )` `bh03.lua, line 533: waypoint_remove()` `bh03.lua, line 599: waypoint_remove( SYNC_ALL )` `bh03.lua, line 789: waypoint_remove( SYNC_ALL )` `bh03.lua, line 1031: waypoint_remove( SYNC_ALL )` `bh03.lua, line 1781: waypoint_remove( SYNC_ALL )` `bh05.lua, line 346: waypoint_remove(SYNC_ALL)` `bh05.lua, line 924: waypoint_remove( SYNC_ALL )` `bh05.lua, line 1151: waypoint_remove(SYNC_ALL)` `bh05.lua, line 1192: waypoint_remove(SYNC_ALL)` `em01.lua, line 1697: waypoint_remove( SYNC_ALL)` `ep03.lua, line 172: waypoint_remove( SYNC_ALL )` `rn01.lua, line 1677: waypoint_remove(PLAYER_SYNC[player])` `ss01.lua, line 404: waypoint_remove( sync_type )` `ss01.lua, line 669: waypoint_remove( SYNC_ALL )` `ss01.lua, line 1141: waypoint_remove( SYNC_ALL )` `ss01.lua, line 1216: waypoint_remove( SYNC_ALL )` `ss01.lua, line 1305: waypoint_remove( SYNC_LOCAL )` `ss01.lua, line 1316: waypoint_remove( SYNC_REMOTE )` `ss01.lua, line 1350: waypoint_remove( SYNC_ALL )` `ss02.lua, line 411: waypoint_remove( SYNC_ALL )` `ss02.lua, line 587: waypoint_remove( SYNC_ALL )` `ss02.lua, line 956: waypoint_remove( SYNC_ALL )` `ss02.lua, line 1453: waypoint_remove( SYNC_ALL )` `ss04.lua, line 1093: waypoint_remove( SYNC_ALL )` `ss04.lua, line 1144: waypoint_remove( SYNC_ALL )` `ss05.lua, line 1010: waypoint_remove( SYNC_ALL )` `ss05.lua, line 1060: waypoint_remove( SYNC_ALL )` `ss05.lua, line 1100: waypoint_remove( SYNC_ALL )` `ss05.lua, line 1140: waypoint_remove( SYNC_ALL )` `ss05.lua, line 1266: waypoint_remove( SYNC_ALL )` `ss05.lua, line 1428: waypoint_remove( SYNC_ALL )` `ss06.lua, line 1586: waypoint_remove( SYNC_ALL )` `ss06.lua, line 2074: waypoint_remove( sync_type )` `ss08.lua, line 1181: waypoint_remove( SYNC_ALL )` `ss09.lua, line 492: waypoint_remove( SYNC_ALL )` `ss10.lua, line 2165: waypoint_remove( sync_type )` `ss10.lua, line 2279: waypoint_remove( SYNC_ALL )` `ss11.lua, line 1677: waypoint_remove( SYNC_ALL )` `tss02.lua, line 434: waypoint_remove(sync)` `tss02.lua, line 483: waypoint_remove(sync)` `tss02.lua, line 534: waypoint_remove(SYNC_LOCAL)` `tss02.lua, line 542: waypoint_remove(SYNC_REMOTE)` `tss02.lua, line 764: waypoint_remove(SYNC_ALL)` `tss02.lua, line 928: waypoint_remove(SYNC_ALL)` `tss02.lua, line 1289: waypoint_remove(SYNC_ALL)` `tss02.lua, line 1341: waypoint_remove(SYNC_ALL)` `tss04.lua, line 304: waypoint_remove(SYNC_ALL)` `tss04.lua, line 403: waypoint_remove(SYNC_ALL)` `tss04.lua, line 960: waypoint_remove(SYNC_LOCAL)` `tss04.lua, line 963: waypoint_remove(SYNC_REMOTE)` `tss04.lua, line 1078: waypoint_remove(SYNC_LOCAL)` `tss04.lua, line 1084: waypoint_remove(SYNC_REMOTE)` `tss04.lua, line 1209: waypoint_remove( sync_type )` `tss04.lua, line 1273: waypoint_remove( sync_type )` `tss04.lua, line 1475: waypoint_remove(SYNC_ALL)` `ug_lib.lua, line 1856: waypoint_remove(sync_type)`
`weapon_store_change_weapon`	true	4 `weapon_store.lua, line 175: weapon_store_change_weapon(category, swatches[idx].id, swatches[idx].dual_wield)` `weapon_store.lua, line 190: weapon_store_change_weapon(category, swatches[idx].id, false)` `weapon_store.lua, line 393: weapon_store_change_weapon(category, menu_item.swatches[0].id, menu_item.swatches[0].dual_wield)` `weapon_store.lua, line 748: weapon_store_change_weapon("ammo", menu_item.swatches[0].id, false)`
`weapon_store_get_is_cache`	true	1 `weapon_store.lua, line 54: Weapon_menu_cache_only = weapon_store_get_is_cache()`
`weapon_store_is_melee_store`	true	1 `weapon_store.lua, line 60: if weapon_store_is_melee_store() == true then`
`weapon_store_purchase_ammo`	true	1 `weapon_store.lua, line 806: weapon_store_purchase_ammo(swatches[idx].id)`
`weapon_store_purchase_weapon`	true	3 `weapon_store.lua, line 317: weapon_store_purchase_weapon(Weapon_menu_active_horz_menu[Weapon_menu_active_horz_menu.current_selection].category, swatches[idx].id)` `weapon_store.lua, line 572: weapon_store_purchase_weapon(category, Weapon_category_to_purchase[Weapon_index_of_purchase].id)` `weapon_store.lua, line 643: weapon_store_purchase_weapon(category, swatches[idx].id)`
`weapon_store_set_cache`	true	1 `weapon_store.lua, line 143: weapon_store_set_cache(Weapon_menu_is_cache_menu)`

Saints Row 2 Function Reference

Global functions