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	Defined in	Examples from patch (click blue number to expand)
`ui_audio_post_event`	true	1 `vint_lib.lua, line 573`	163 `cell_camera.lua, line 212: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_camera.lua, line 223: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_cheats.lua, line 301: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_cheats.lua, line 316: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_cheats.lua, line 383: ui_audio_post_event("UI_Hub_Menu_Forward")` `cell_extras.lua, line 91: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_extras.lua, line 97: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_extras.lua, line 139: ui_audio_post_event("UI_Hub_Navigate")` `cell_extras.lua, line 144: ui_audio_post_event("UI_Hub_Navigate")` `cell_extras.lua, line 155: ui_audio_post_event("UI_Hub_Menu_Forward")` `cell_extras.lua, line 158: ui_audio_post_event("UI_Hub_Menu_Forward")` `cell_extras.lua, line 161: ui_audio_post_event("UI_Hub_Menu_Forward")` `cell_foreground.lua, line 533: ui_audio_post_event("UI_Hub_Enter")` `cell_menu_main.lua, line 299: ui_audio_post_event("UI_Hub_Exit")` `cell_menu_main.lua, line 464: ui_audio_post_event("UI_Hub_Menu_Forward")` `cell_menu_main.lua, line 467: ui_audio_post_event("UI_Hub_Menu_Forward")` `cell_menu_main.lua, line 470: ui_audio_post_event("UI_Hub_Menu_Forward")` `cell_menu_main.lua, line 473: ui_audio_post_event("UI_Hub_Menu_Forward")` `cell_menu_main.lua, line 477: -- ui_audio_post_event("UI_Hub_Menu_Forward")` `cell_menu_main.lua, line 479: -- ui_audio_post_event("UI_Hub_Menu_Forward")` `cell_menu_main.lua, line 483: -- ui_audio_post_event("UI_Hub_Menu_Forward")` `cell_menu_main.lua, line 486: ui_audio_post_event("UI_Hub_Menu_Forward")` `cell_menu_main.lua, line 489: ui_audio_post_event("UI_Hub_Menu_Forward")` `cell_menu_main.lua, line 493: ui_audio_post_event("UI_Hub_Menu_Forward")` `cell_menu_main.lua, line 496: ui_audio_post_event("UI_Hub_Menu_Forward")` `cell_missions.lua, line 1659: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_missions.lua, line 1680: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_missions.lua, line 1766: ui_audio_post_event("ui_quest_forward")` `cell_missions.lua, line 1808: ui_audio_post_event("ui_quest_back")` `cell_missions.lua, line 2136: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_music_menu.lua, line 89: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_music_menu.lua, line 94: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_music_menu.lua, line 114: ui_audio_post_event("ui_radio_toggle_on")` `cell_music_menu.lua, line 148: --ui_audio_post_event("UI_Hub_Navigate")` `cell_music_sub.lua, line 88: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_music_sub.lua, line 95: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_music_sub.lua, line 148: ui_audio_post_event("UI_Hub_Menu_Forward")` `cell_music_sub.lua, line 152: ui_audio_post_event("UI_Hub_Menu_Forward")` `cell_phone.lua, line 774: ui_audio_post_event("ui_call_homie")` `cell_phone.lua, line 1015: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_phone.lua, line 1019: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_playlist.lua, line 381: ui_audio_post_event("ui_radio_toggle_on")` `cell_playlist.lua, line 638: ui_audio_post_event("ui_radio_toggle_off")` `cell_playlist.lua, line 940: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_playlist.lua, line 948: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_rewards.lua, line 426: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_rewards.lua, line 431: ui_audio_post_event("UI_Hub_Menu_Forward")` `cell_rewards.lua, line 567: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_rewards.lua, line 573: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_rewards.lua, line 580: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_saintsbook.lua, line 272: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_saintsbook.lua, line 276: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_stats.lua, line 203: ui_audio_post_event("UI_Hub_Navigate")` `cell_stats.lua, line 211: ui_audio_post_event("UI_Hub_Navigate")` `cell_stats.lua, line 219: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_stats.lua, line 227: ui_audio_post_event("UI_Hub_Menu_Back")` `cell_stats.lua, line 236: ui_audio_post_event("UI_Hub_Menu_Back")` `cmp_common.lua, line 2347: ui_audio_post_event("UI_Mission_Complete_Banner")` `cmp_common.lua, line 2354: ui_audio_post_event("UI_Mission_Complete_Slam")` `cmp_common.lua, line 2368: ui_audio_post_event("UI_Activity_Medal_Banner")` `cmp_common.lua, line 2375: ui_audio_post_event("UI_Activity_Medal_Slam")` `cmp_common.lua, line 2382: ui_audio_post_event("UI_Cache_Ramp")` `cmp_common.lua, line 2389: ui_audio_post_event("UI_Cache_Slam")` `cmp_common.lua, line 2395: ui_audio_post_event("UI_Cache_Bonus_Ramp")` `cmp_common.lua, line 2400: ui_audio_post_event("UI_XP_Ramp")` `cmp_common.lua, line 2407: ui_audio_post_event("UI_XP_Slam")` `cmp_common.lua, line 2413: ui_audio_post_event("UI_XP_Bonus_Ramp")` `cmp_common.lua, line 2418: ui_audio_post_event("UI_District_Ramp")` `cmp_common.lua, line 2425: ui_audio_post_event("UI_Cache_Slam") --CHANGE THIS` `cmp_fail.lua, line 228: ui_audio_post_event("m11_UI_Mission_Fail")` `cmp_fail.lua, line 230: ui_audio_post_event("Mission_Fail")` `col_main.lua, line 489: ui_audio_post_event("ui_tod_toggle")` `countdown.lua, line 205: ui_audio_post_event("UI_Activity_Medal_Tiers")` `credits.lua, line 478: ui_audio_post_event("Credits_Music_M06")` `credits.lua, line 486: ui_audio_post_event("Credits_End_1")` `credits.lua, line 545: ui_audio_post_event("Credits_Stop")` `cte_outro_ending.lua, line 390: -- ui_audio_post_event( "UI_Hub_Navigate" )` `cte_outro_ending.lua, line 472: ui_audio_post_event("UI_Hub_Navigate")` `cte_outro_ending.lua, line 518: ui_audio_post_event("UI_Hub_Navigate")` `hack_main_sticks.lua, line 286: ui_audio_post_event( "UI_Hacking_On" )` `hud.lua, line 1179: ui_audio_post_event("UI_Weapon_Radial_Pause")` `hud.lua, line 1281: ui_audio_post_event("UI_Weapon_Radial_Unpause")` `hud.lua, line 1586: ui_audio_post_event("ui_radio_switch")` `hud_collection.lua, line 681: ui_audio_post_event("ui_generic_band_anim_in")` `hud_collection.lua, line 719: ui_audio_post_event("ui_generic_band_anim_out")` `hud_msg.lua, line 1306: ui_audio_post_event("ui_objective_complete")` `main_menu_common.lua, line 349: ui_audio_post_event("UI_Hub_Menu_Forward")` `main_menu_top.lua, line 148: ui_audio_post_event("UI_Hub_Menu_Back")` `main_menu_top.lua, line 663: ui_audio_post_event("clothing_purchase")` `msn_text_adventure.lua, line 987: ui_audio_post_event("Music_Text_Adv") -- This is overriding our conversations` `msn_text_adventure.lua, line 1035: ui_audio_post_event("Music_Text_Adv_Stop")` `pause_map.lua, line 655: ui_audio_post_event("UI_Hub_Menu_Back")` `pause_map.lua, line 660: ui_audio_post_event("UI_Hub_Menu_Back")` `pause_map.lua, line 877: ui_audio_post_event("UI_Hub_Navigate")` `pause_map.lua, line 1810: ui_audio_post_event("UI_Hub_Menu_Back")` `pause_map.lua, line 1831: --ui_audio_post_event("UI_Hub_Menu_Forward")` `pause_menu_top.lua, line 109: ui_audio_post_event("ui_pause")` `pause_menu_top.lua, line 303: ui_audio_post_event("ui_unpause")` `pause_menu_top.lua, line 518: ui_audio_post_event("ui_unpause")` `pause_options_audio.lua, line 186: ui_audio_post_event("Main_Menu_Music_Mute")` `pause_options_audio.lua, line 207: ui_audio_post_event("Main_Menu_Music_Unmute")` `pause_voice_tut.lua, line 211: ui_audio_post_event("UI_Hub_Navigate")` `pause_voice_tut.lua, line 219: ui_audio_post_event("UI_Hub_Navigate")` `pause_voice_tut.lua, line 227: ui_audio_post_event("UI_Hub_Menu_Back")` `pause_voice_tut.lua, line 235: ui_audio_post_event("UI_Hub_Menu_Back")` `powers_main.lua, line 358: ui_audio_post_event("UI_Hub_Menu_Back")` `powers_main.lua, line 475: ui_audio_post_event("UI_Hub_Menu_Forward")` `powers_main.lua, line 514: ui_audio_post_event("UI_Hub_Menu_Forward")` `powers_main.lua, line 529: ui_audio_post_event("UI_Hub_Menu_Forward")` `powers_main.lua, line 571: ui_audio_post_event("ui_powers_menu_nav")` `powers_main.lua, line 623: ui_audio_post_event("ui_powers_menu_nav")` `powers_main.lua, line 678: ui_audio_post_event("ui_powers_menu_nav")` `powers_main.lua, line 714: ui_audio_post_event("ui_powers_menu_nav")` `powers_main.lua, line 899: ui_audio_post_event("ui_powers_menu_nav")` `powers_main.lua, line 903: ui_audio_post_event("ui_powers_menu_nav")` `powers_sub.lua, line 612: ui_audio_post_event("UI_Hub_Menu_Back")` `powers_sub.lua, line 620: ui_audio_post_event("UI_Hub_Menu_Back")` `powers_sub.lua, line 624: ui_audio_post_event("UI_Hub_Menu_Forward")` `powers_sub.lua, line 753: ui_audio_post_event("UI_Hub_Menu_Back")` `powers_sub.lua, line 770: ui_audio_post_event("UI_Hub_Menu_Back")` `reward_granted.lua, line 311: ui_audio_post_event("UI_Reward_Bonus")` `reward_granted.lua, line 312: ui_audio_post_event("UI_Reward_Loop")` `reward_granted.lua, line 323: ui_audio_post_event("UI_Reward_Loop_Stop")` `store_character.lua, line 2647: ui_audio_post_event("enter_image_as_designed")` `store_character.lua, line 3025: ui_audio_post_event("UI_Store_Exit")` `store_character.lua, line 3487: ui_audio_post_event("Police_Lineup")` `store_clothing.lua, line 337: ui_audio_post_event("enter_lets_pretend")` `store_clothing.lua, line 362: ui_audio_post_event("enter_nobody_loves_me")` `store_clothing.lua, line 383: ui_audio_post_event("enter_leatherlace")` `store_clothing.lua, line 407: ui_audio_post_event("enter_planet_saints")` `store_clothing.lua, line 594: ui_audio_post_event("UI_Store_Exit")` `store_clothing.lua, line 1570: ui_audio_post_event("clothing_purchase")` `store_crib.lua, line 185: ui_audio_post_event("enter_gateway")` `store_crib_cash.lua, line 289: ui_audio_post_event("ui_cache_transfer")` `store_crib_cash.lua, line 355: ui_audio_post_event("ui_cache_transfer_stop")` `store_crib_cash.lua, line 375: ui_audio_post_event("UI_Hub_Menu_Back")` `store_crib_cash.lua, line 381: ui_audio_post_event("UI_Hub_Menu_Back")` `store_dlc.lua, line 46: ui_audio_post_event("UI_Hub_Menu_Forward")` `store_tattoo.lua, line 205: ui_audio_post_event("tattoo_purchase")` `store_tattoo.lua, line 411: ui_audio_post_event("UI_Store_Exit")` `store_tattoo.lua, line 611: ui_audio_post_event("enter_rustys_needle")` `store_vehicle.lua, line 599: ui_audio_post_event("vehicle_purchase")` `store_vehicle.lua, line 1079: ui_audio_post_event("vehicle_purchase")` `store_vehicle.lua, line 1325: ui_audio_post_event("vehicle_purchase")` `store_vehicle.lua, line 1988: ui_audio_post_event("vehicle_purchase")` `store_vehicle.lua, line 2076: ui_audio_post_event("vehicle_purchase")` `store_vehicle.lua, line 2507: ui_audio_post_event("Enter_Garage")` `store_vehicle.lua, line 2511: ui_audio_post_event("enter_rim_jobs")` `store_vehicle.lua, line 3367: ui_audio_post_event("rim_job_camera_zoom")` `store_vehicle.lua, line 3412: ui_audio_post_event("UI_Store_Exit")` `store_vendor.lua, line 135: ui_audio_post_event("Drug_Dealer_Purchase")` `store_weapon.lua, line 557: ui_audio_post_event("enter_friendly_fire")` `store_weapon.lua, line 825: ui_audio_post_event("UI_Store_Exit")` `store_weapon.lua, line 1484: ui_audio_post_event("ammo_purchase")` `store_weapon.lua, line 2143: ui_audio_post_event("weapon_purchase")` `store_weapon.lua, line 2766: ui_audio_post_event("weapon_purchase")` `store_weapon.lua, line 2787: ui_audio_post_event("weapon_purchase")` `store_weapon.lua, line 3404: ui_audio_post_event("ammo_purchase")` `vdo_cell_menu.lua, line 153: ui_audio_post_event("UI_Hub_Navigate")` `vdo_cell_menu.lua, line 187: ui_audio_post_event("UI_Hub_Navigate")` `vdo_cell_menu.lua, line 220: ui_audio_post_event("UI_Hub_Navigate")` `vdo_cell_menu.lua, line 253: ui_audio_post_event("UI_Hub_Navigate")` `vdo_gsi.lua, line 1178: ui_audio_post_event("ui_hud_generic_div_complete")`
`ui_hud_display_commit_state`	true		3 `hud.lua, line 1200: ui_hud_display_commit_state(Hud_inventory_hud_state_h, true)` `hud.lua, line 2518: ui_hud_display_commit_state(hud_state_h, false)` `vint_lib.lua, line 50: ui_hud_display_commit_state(MY_HUD_STATE)`
`ui_hud_display_create_state`	true		3 `hud.lua, line 1194: Hud_inventory_hud_state_h = ui_hud_display_create_state()` `hud.lua, line 2515: local hud_state_h = ui_hud_display_create_state()` `vint_lib.lua, line 48: MY_HUD_STATE = ui_hud_display_create_state()`
`ui_hud_display_remove_state`	true		6 `hud.lua, line 968: ui_hud_display_remove_state(Hud_weapon_status.hud_state_h, false)` `hud.lua, line 973: ui_hud_display_remove_state(Hud_inventory_hud_state_h, false)` `hud.lua, line 1276: ui_hud_display_remove_state(Hud_inventory_hud_state_h, false)` `hud.lua, line 2497: ui_hud_display_remove_state(Hud_weapon_status.hud_state_h, false)` `hud.lua, line 2511: ui_hud_display_remove_state(Hud_weapon_status.hud_state_h, false)` `vint_lib.lua, line 54: ui_hud_display_remove_state(MY_HUD_STATE)`
`ui_hud_display_set_element`	true		5 `hud.lua, line 1196: ui_hud_display_set_element(Hud_inventory_hud_state_h, HUD_ALL_ELEM, HUD_FADE_HIDDEN)` `hud.lua, line 1197: ui_hud_display_set_element(Hud_inventory_hud_state_h, HUD_ELEM_RADIO_STATION, HUD_FADE_VISIBLE)` `hud.lua, line 2516: ui_hud_display_set_element(hud_state_h, HUD_ALL_ELEM, HUD_FADE_NO_CHANGE)` `hud.lua, line 2517: ui_hud_display_set_element(hud_state_h, HUD_ELEM_WEAPONS, HUD_FADE_HIDDEN)` `vint_lib.lua, line 49: ui_hud_display_set_element(MY_HUD_STATE, HUD_ELEM_RADIAL, HUD_FADE_HIDDEN)`
`ui_hud_get_weapon_upgrade_info`	true		1 `vdo_weapon_radial.lua, line 306: local upgrade_name_crc, current_level, max_level, attribute_id, is_ultimate, upgrade_idx, fully_upgraded = ui_hud_get_weapon_upgrade_info(slot_num, i)`
`ui_hud_is_weapon_fully_upgraded`	true		1 `vdo_weapon_radial_slot.lua, line 206: if ui_hud_is_weapon_fully_upgraded(weapon_name) then`
`ui_hud_set_current_challenge`	true		11 `cell_missions.lua, line 1858: ui_hud_set_current_challenge(Curr_tracked_challenge.name) -- HVS_RCK - For some reason "name" is the id number of the challenge` `cell_missions.lua, line 1918: ui_hud_set_current_challenge(-1)` `cell_missions.lua, line 2161: ui_hud_set_current_challenge(-1)` `mmauratutorial.lua, line 343: ui_hud_set_current_challenge(-1)` `mmauratutorial.lua, line 398: ui_hud_set_current_challenge(-2)` `mmblasttutorial.lua, line 446: ui_hud_set_current_challenge(-1)` `mmblasttutorial.lua, line 512: ui_hud_set_current_challenge(-2)` `mmstomptutorial.lua, line 463: ui_hud_set_current_challenge(-1)` `mmstomptutorial.lua, line 518: ui_hud_set_current_challenge(-2)` `mmsummontutorial.lua, line 412: ui_hud_set_current_challenge(-1)` `mmsummontutorial.lua, line 462: ui_hud_set_current_challenge(-2)`
`ui_play_pain_audio`	true	1 `vint_lib.lua, line 569`
`unlockable_lock`	true		1 `mflighttutorial.lua, line 968: unlockable_lock("Glide_Power_2", SYNC_ALL)`
`unlockable_unlock`	true		2 `mflighttutorial.lua, line 1081: unlockable_unlock("Glide_Power_2", true, SYNC_ALL)` `sr4_5_city.lua, line 79: unlockable_unlock("ragdoll_recovery") -- Air Recovery`
`unpack`	true		2 `game_lib.lua, line 3310: npcs = { unpack(arg[1]) }` `game_lib.lua, line 3340: npcs = { unpack(arg[1]) }`
`update_x`	true		1 `vdo_cell_menu.lua, line 143: cur_x = update_x(cur_x)`
`update_y`	true		1 `vdo_cell_menu.lua, line 144: cur_y = update_y(cur_y)`

Saints Row 2 Function Reference

Global functions