Saints Row: The Third 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)
`radio_block`	true	18 `_a_ga_dt_03.lua, line 469: radio_block(_A_GA_DT_03_groups.heli_group.vehicle)` `_a_ga_nw_01.lua, line 1145: radio_block(_A_GA_NW_01_groups.heli_group.vehicle)` `dlc2_m01.lua, line 2109: radio_block(Dlc2_m01_groups.armory_player_heli.heli.vehicle)` `dlc2_m03.lua, line 2281: radio_block(group.vehicle)` `m05.lua, line 657: radio_block( M05_groups.pierce.heli )` `m06.lua, line 1196: radio_block(M06_group.bomb_truck.vehicle)` `m06.lua, line 1213: radio_block(M06_group.saints_backup.vehicle)` `m06.lua, line 1747: radio_block(M06_group.escape_truck.vehicle)` `m09.lua, line 2505: radio_block(M09_group.player_rail.vehicle)` `m09.lua, line 2506: radio_block(M09_group.girls_heli.vehicle)` `m14.lua, line 596: radio_block( M14_vehicle.spotlight_heli, true )` `m14.lua, line 853: radio_block( M14_vehicle.spotlight_heli, true )` `m14.lua, line 1023: radio_block( M14_vehicle.spotlight_heli, true )` `m14.lua, line 1329: radio_block( M14_vehicle.spotlight_heli, true )` `m14.lua, line 1362: radio_block( M14_vehicle.spotlight_heli, true )` `m22.lua, line 2085: radio_block(M22_groups.Statue_Boats.members[1])` `m22.lua, line 2086: radio_block(M22_groups.Statue_Boats.members[2])` `m24.lua, line 902: radio_block(vehicle)`
`radio_clear_sing_along_track`	true	1 `m04.lua, line 434: radio_clear_sing_along_track("MIX_Sublime___What_I_Got")`
`radio_get_station`	true	2 `m04.lua, line 994: test = radio_get_station(get_char_vehicle_name(LOCAL_PLAYER))` `m04.lua, line 1004: test = radio_get_station(LOCAL_PLAYER)`
`radio_global_block`	true	6 `dlc2_m01.lua, line 1292: radio_global_block(false)` `dlc2_m01.lua, line 1392: radio_global_block(true)` `dlc2_m02.lua, line 1154: radio_global_block( false )` `dlc2_m02.lua, line 1558: radio_global_block( true )` `m14.lua, line 458: radio_global_block( false )` `m14.lua, line 1754: radio_global_block( true )`
`radio_newsbreak`	true	5 `m03.lua, line 1348: radio_newsbreak("m02")` `m03.lua, line 3088: radio_newsbreak("m01")` `m07.lua, line 2039: radio_newsbreak("M06_Building_Gone")` `m07.lua, line 2041: radio_newsbreak("M06_Building_Stay")` `m23.lua, line 1780: radio_newsbreak("M22_Kill_Killbane")`
`radio_newsbreak_clear`	true	1 `m03.lua, line 921: radio_newsbreak_clear()`
`radio_set_sing_along_allowed_during_missions`	true	2 `m04.lua, line 435: radio_set_sing_along_allowed_during_missions(false)` `m04.lua, line 1010: radio_set_sing_along_allowed_during_missions(true)`
`radio_set_sing_along_track`	true	1 `m04.lua, line 1015: radio_set_sing_along_track("MIX_Sublime___What_I_Got", "M04_SINGALONG_WM_PLAYER")`
`radio_set_station`	true	3 `m04.lua, line 997: radio_set_station(LOCAL_PLAYER, 4)` `m04.lua, line 999: radio_set_station(LOCAL_PLAYER, 6)` `m04.lua, line 1001: radio_set_station(LOCAL_PLAYER, 10)`
`radio_unblock`	true	1 `dlc2_m03.lua, line 2392: radio_unblock(vehicle_name)`
`rappel_enter`	true	2 `_a_ga_dt_03.lua, line 648: rappel_enter(REMOTE_PLAYER, true, _A_GA_DT_03_navs.remote_rappel_point, _A_GA_DT_03_tweak_params.sniper_weapon_slot)` `_a_ga_dt_03.lua, line 654: rappel_enter(LOCAL_PLAYER, true, _A_GA_DT_03_navs.local_rappel_point, _A_GA_DT_03_tweak_params.sniper_weapon_slot)`
`rappel_exit`	true	2 `_a_ga_nw_01.lua, line 1207: rappel_exit(REMOTE_PLAYER, false)` `_a_ga_nw_01.lua, line 1213: rappel_exit(LOCAL_PLAYER, false)`
`rc_set_max_signal_range`	true	2 `m20.lua, line 525: rc_set_max_signal_range( M20_previous_rc_range )` `m20.lua, line 1794: M20_previous_rc_range = rc_set_max_signal_range( M20_RC_RANGE )`
`refraction_situation_clear`	true	6 `m16.lua, line 1319: refraction_situation_clear()` `m16.lua, line 1425: refraction_situation_clear()` `m19.lua, line 820: refraction_situation_clear()` `m19.lua, line 1380: refraction_situation_clear()` `sh02.lua, line 1709: refraction_situation_clear()` `sh02.lua, line 1715: refraction_situation_clear()`
`refraction_situation_set`	true	11 `m16.lua, line 2763: refraction_situation_set("cyber_m16")` `m19.lua, line 1198: refraction_situation_set("drug weak")` `m19.lua, line 1251: -- refraction_situation_set("drug medium")` `m19.lua, line 1308: refraction_situation_set("drug medium")` `m19.lua, line 1318: --refraction_situation_set("drug strongest")` `m19.lua, line 1371: refraction_situation_set("drug medium")` `m19.lua, line 1374: --refraction_situation_set("drug medium")` `m19.lua, line 1377: refraction_situation_set("drug weak")` `sh02.lua, line 1701: refraction_situation_set("drug strong")` `sh02.lua, line 1704: refraction_situation_set("drug weak")` `sh02.lua, line 1706: refraction_situation_set("drug weakest")`
`release_to_world`	true	125 `dlc2_m01.lua, line 1765: release_to_world(vehicle)` `dlc2_m01.lua, line 2350: release_to_world(Dlc2_m01_groups.armory_player_heli.heli.vehicle)` `dlc2_m01.lua, line 3266: release_to_world(Dlc2_m01_groups.ng_bridge_roadblock.name)` `dlc2_m01.lua, line 3441: release_to_world(Dlc2_m01_groups.ng_bridge_roadblock.name)` `dlc2_m01.lua, line 4109: release_to_world(ambush.group.name)` `dlc2_m01.lua, line 4779: release_to_world(npc_table.npc)` `dlc2_m01.lua, line 4962: release_to_world(vehicle_table.vehicle)` `dlc2_m01.lua, line 4964: release_to_world(npc)` `dlc2_m01.lua, line 5002: release_to_world(heli_group.heli.vehicle)` `dlc2_m01.lua, line 5004: release_to_world(pilot)` `dlc2_m03.lua, line 1510: release_to_world(DLC2_M03_group.starting_camera.name)` `dlc2_m03.lua, line 1651: release_to_world(DLC2_M03_group.trap.name)` `dlc2_m03.lua, line 2267: release_to_world(group.name)` `m01.lua, line 3926: release_to_world(transport_group.name)` `m01.lua, line 4741: release_to_world(pair_table.name)` `m03.lua, line 1227: release_to_world(M03_group.starting_vehicle.name)` `m03.lua, line 1687: release_to_world(group.name)` `m03.lua, line 2320: release_to_world(group.name)` `m03.lua, line 2369: release_to_world(spawn_group.name)` `m03.lua, line 2813: release_to_world(sat_group.name)` `m03.lua, line 3252: release_to_world(spawn_group.name)` `m04.lua, line 631: --release_to_world(M04_group.backup_vehicle.vehicle )` `m04.lua, line 1054: release_to_world(M04_group.backup_vehicle.vehicle )` `m04.lua, line 1104: release_to_world(M04_group.starting_vehicle.name)` `m04.lua, line 1119: --release_to_world(M04_group.starting_vehicle.vehicle )` `m04.lua, line 1120: --release_to_world(M04_group.backup_vehicle.vehicle )` `m05.lua, line 1221: release_to_world(M05_groups.targets.name)` `m05.lua, line 1223: release_to_world(M05_groups.party_2.name)` `m05.lua, line 1224: release_to_world(M05_groups.party_1.name)` `m05.lua, line 1338: release_to_world(M05_groups.barricade.name)` `m05.lua, line 1367: release_to_world(M05_groups.backup_1.name)` `m05.lua, line 1392: release_to_world( group.name )` `m05.lua, line 2069: release_to_world(M05_groups.elevator.name)` `m06.lua, line 2002: release_to_world(M06_group.start_homies.vehicle)` `m07.lua, line 1371: release_to_world(M07_group.bdp_guards.name, true)` `m07.lua, line 1372: release_to_world(M07_group.bds_guards.name, true)` `m07.lua, line 1373: release_to_world(M07_group.bbp_guards.name, true)` `m08.lua, line 774: release_to_world( g.name )` `m09.lua, line 3144: release_to_world(M09_active_roof_group.name)` `m09.lua, line 3479: release_to_world(attacker.name)` `m09.lua, line 3534: release_to_world(attacker.soldier_group.name)` `m09.lua, line 3549: release_to_world(attacker.name)` `m09.lua, line 4078: release_to_world(attacker)` `m09.lua, line 4147: release_to_world(boat.name)` `m09.lua, line 5044: release_to_world(attacker.heli_group.name)` `m10.lua, line 1508: release_to_world(char)` `m10.lua, line 1934: --release_to_world(vtol_table.name)` `m10.lua, line 3620: release_to_world(transport_table.vtol)` `m10.lua, line 3622: release_to_world(pilot)` `m11.lua, line 1832: release_to_world(M11_groups.oleg_battle.waves[1].name)` `m11.lua, line 1877: release_to_world(M11_groups.oleg_battle.waves[2].name)` `m11.lua, line 2012: release_to_world(base.vehicle_group)` `m11.lua, line 2018: release_to_world(base.name)` `m11.lua, line 2114: --release_to_world(vehicle_name)` `m11.lua, line 2125: --release_to_world(vehicle_name)` `m11.lua, line 2136: --release_to_world(vehicle_name)` `m11.lua, line 2147: --release_to_world(vehicle_name)` `m11.lua, line 2158: --release_to_world(vehicle_name)` `m11.lua, line 2254: release_to_world(base_left.vehicle_group)` `m11.lua, line 2715: release_to_world(lander.name)` `m11.lua, line 2716: release_to_world(lander.pilot)` `m11.lua, line 2888: release_to_world(roadblock.name)` `m12.lua, line 1595: release_to_world(M12_groups.stag_window_rush.name)` `m12.lua, line 1598: release_to_world(M12_groups.stag_studio_rush_01.name)` `m12.lua, line 1600: release_to_world(M12_groups.stag_studio_rush_02.name)` `m13.lua, line 1609: release_to_world(M13_groups.pr_static.name)` `m13.lua, line 3236: release_to_world(target_vehicle)` `m13.lua, line 3237: release_to_world(pierce)` `m13.lua, line 3508: release_to_world(group.name)` `m13.lua, line 3824: release_to_world(driver)` `m13.lua, line 3826: release_to_world(group.vehicle)` `m13.lua, line 4031: release_to_world(driver)` `m13.lua, line 4034: release_to_world(vehicle)` `m13.lua, line 4133: release_to_world( group_name )` `m15.lua, line 1142: release_to_world(M15_groups.extra_homies.name)` `m15.lua, line 1311: release_to_world(M15_groups.garage.name)` `m15.lua, line 1688: release_to_world(vehicle)` `m15.lua, line 2061: release_to_world(trigger.name)` `m15.lua, line 2117: release_to_world(victim)` `m15.lua, line 2230: release_to_world(trigger.name)` `m15.lua, line 2413: release_to_world(group.name)` `m15.lua, line 2550: release_to_world(group.name)` `m17.lua, line 854: release_to_world(M17_group.vtol_reward.name)` `m17.lua, line 1727: release_to_world(M17_group.ambush.name)` `m17.lua, line 1832: --release_to_world(M17_group.tanks.name) -- Don't release the tanks; they freak out after the mission is over` `m17.lua, line 1834: release_to_world(M17_group.jailors.name)` `m17.lua, line 2004: release_to_world(M17_group.barricade.name)` `m17.lua, line 2005: release_to_world(M17_group.reactor_hall.name)` `m17.lua, line 2134: release_to_world(M17_group.reactor.name)` `m17.lua, line 2196: release_to_world(M17_group.ehall.name)` `m21.lua, line 1239: release_to_world(group.name)` `m21.lua, line 1628: release_to_world(M21_groups.angel_stompers.name)` `m21.lua, line 1629: release_to_world(M21_groups.chainsaw_wave_01.name)` `m21.lua, line 1630: release_to_world(M21_groups.chainsaw_wave_02.name)` `m21.lua, line 2300: release_to_world(enemy)` `m21.lua, line 2471: release_to_world(npc_name)` `m22.lua, line 1866: release_to_world(Current_bz.zone.saints_group.name)` `m22.lua, line 3099: release_to_world(battle_zone_group.saints_group.name)` `m22.lua, line 3125: release_to_world(battle_zone.initial_vehicles.name)` `m22.lua, line 3746: release_to_world(npc)` `m22.lua, line 3789: release_to_world(npc)` `m22.lua, line 3910: release_to_world(Current_bz.zone.courtesy_vehicles.name)` `m22.lua, line 4683: release_to_world(M22_groups.Kia_Vtol1.name)` `m22.lua, line 4902: release_to_world(M22_groups.vtol_coop_reinforcement.name)` `m23.lua, line 3267: release_to_world(dog_fight_group.name)` `m23.lua, line 3513: release_to_world(M23_groups.transport_vtol_01.name)` `m24.lua, line 651: release_to_world(M24_groups.luchadores.name)` `m24.lua, line 660: release_to_world(group.name)` `mm_p_03.lua, line 550: --release_to_world(MM_P_03_group.vehicles.name)` `sh02.lua, line 1478: release_to_world(sh02_group.collection_guards.name)` `sh02.lua, line 1484: release_to_world(sh02_group.collection_wave.name)` `sh02.lua, line 1488: release_to_world(sh02_group.lounge_guards.name)` `sh02.lua, line 1492: release_to_world(sh02_group.lounge_snipers.name)` `sh02.lua, line 1498: release_to_world(sh02_group.jailcell01_guards.name)` `sh02.lua, line 1502: release_to_world(sh02_group.jailcell01_wave.name)` `sh02.lua, line 1506: release_to_world(sh02_group.jailcell02_guards.name)` `sh02.lua, line 1510: release_to_world(sh02_group.jailcell02_wave.name)` `sh02.lua, line 1574: release_to_world(sh02_group.lounge_flee01.name)` `sh02.lua, line 1577: release_to_world(sh02_group.lounge_flee02.name)` `sh02.lua, line 1580: release_to_world(sh02_group.lounge_flee03.name)` `sh02.lua, line 1583: release_to_world(sh02_group.lounge_flee04.name)` `sh03.lua, line 907: release_to_world( grp.name )` `sh03.lua, line 2003: release_to_world( char )` `sh04.lua, line 1685: release_to_world( group.name )` `sh04.lua, line 2223: release_to_world( char )`
`remove_tween_end_callback`	true	3 `vdo_grid_list.lua, line 811: remove_tween_end_callback( vint_object_find("grid_group_anchor_tween") )` `vdo_mega_list.lua, line 14: --remove_tween_end_callback( vint_object_find("toggle_group_anchor_tween") )` `vdo_pause_mega_list.lua, line 20: remove_tween_end_callback( vint_object_find("toggle_group_anchor_tween") )`
`reticle_override_clear`	true	7 `m14.lua, line 2525: reticle_override_clear(SYNC_ALL)` `m14.lua, line 2538: reticle_override_clear(SYNC_LOCAL)` `m14.lua, line 2542: reticle_override_clear(SYNC_REMOTE)` `m14.lua, line 2545: reticle_override_clear(SYNC_ALL)` `m14.lua, line 2549: reticle_override_clear(SYNC_REMOTE)` `m14.lua, line 2551: reticle_override_clear(SYNC_LOCAL)` `m14.lua, line 2554: reticle_override_clear(SYNC_ALL)`
`reticle_override_set`	true	4 `m14.lua, line 2539: reticle_override_set(HUD_FAKE_RETICLE_WEAPON_NAME, HUD_FAKE_RETICLE_WEAPON_CATEGORY_NAME, SYNC_REMOTE)` `m14.lua, line 2541: reticle_override_set(HUD_FAKE_RETICLE_WEAPON_NAME, HUD_FAKE_RETICLE_WEAPON_CATEGORY_NAME, SYNC_LOCAL)` `m14.lua, line 2548: reticle_override_set(HUD_FAKE_RETICLE_WEAPON_NAME, HUD_FAKE_RETICLE_WEAPON_CATEGORY_NAME, SYNC_LOCAL)` `m14.lua, line 2552: reticle_override_set(HUD_FAKE_RETICLE_WEAPON_NAME, HUD_FAKE_RETICLE_WEAPON_CATEGORY_NAME, SYNC_REMOTE)`
`Reward_granted_end_cb`	true	1 `reward_granted.lua, line 213: Reward_granted_end_cb()`
`roadblocks_ambient_traffic_enable`	true	2 `m22.lua, line 1279: roadblocks_ambient_traffic_enable(true)` `m22.lua, line 3380: roadblocks_ambient_traffic_enable(false)`
`roadblocks_enable`	true	12 `dlc2_m01.lua, line 1275: roadblocks_enable(true)` `dlc2_m01.lua, line 1395: roadblocks_enable(false)` `m10.lua, line 1267: roadblocks_enable(true)` `m10.lua, line 1360: roadblocks_enable(false)` `m10.lua, line 1377: roadblocks_enable(false)` `m10.lua, line 1402: roadblocks_enable(false)` `m10.lua, line 2508: roadblocks_enable(true)` `m15.lua, line 869: roadblocks_enable(true)` `m15.lua, line 1192: roadblocks_enable(M15_ROADBLOCKS_ENABLED)` `m15.lua, line 1304: roadblocks_enable(M15_ROADBLOCKS_ENABLED)` `m22.lua, line 1280: roadblocks_enable(true)` `m22.lua, line 2327: roadblocks_enable(false)`
`roadblock_create`	true	1 `m22.lua, line 3390: roadblock.handle = roadblock_create(roadblock.layout, roadblock.navpoint)`
`roadblock_destroy`	true	1 `m22.lua, line 1306: roadblock_destroy(roadblock.handle)`
`round`	true	1 `vdo_scrollbar.lua, line 132: local start_index = round(scroll_pct * (max_index - 1)) + 1`

Saints Row: The Third Function Reference

Global functions