Saints Row: The Third Function Reference

These functions are defined in Lua files that aren't always loaded. They're probably only available in the file that defined them or by including that file in another script.

Function name	Global	Defined in	Examples from patch (click blue number to expand)
`back`	false	1 `vdo_dialog.lua, line 997`	3 `cell_saintsbook.lua, line 383: Active_screen.back()` `dialog.lua, line 167: if Dialog_objects[Dialog_current_idx]:back() then` `dialog.lua, line 448: if Dialog_objects[Dialog_current_idx]:back() then`
`back_to_normal`	false	1 `vdo_respect_meter.lua, line 331`	4 `vdo_respect_meter.lua, line 373: self:back_to_normal()` `vdo_respect_meter.lua, line 398: self:back_to_normal()` `vdo_respect_meter.lua, line 409: self:back_to_normal()` `vdo_respect_meter.lua, line 426: self:back_to_normal()`
`bg_saints_animate`	false	1 `bg_saints.lua, line 205`	2 `building_purchase.lua, line 226: bg_saints_animate()` `store_stronghold.lua, line 564: bg_saints_animate()`
`bg_saints_cleanup`	false	1 `bg_saints.lua, line 74`
`bg_saints_dimmer_show`	false	1 `bg_saints.lua, line 322`	2 `bg_saints.lua, line 61: bg_saints_dimmer_show(false)` `pause_menu_top.lua, line 238: bg_saints_dimmer_show(true) --Dim out the game...`
`bg_saints_init`	false	1 `bg_saints.lua, line 57`
`bg_saints_main_menu_cb`	false	1 `bg_saints.lua, line 409`
`bg_saints_main_menu_loop`	false	1 `bg_saints.lua, line 413`
`bg_saints_main_menu_setup`	false	1 `bg_saints.lua, line 387`	2 `main_menu_common.lua, line 121: bg_saints_main_menu_setup()` `main_menu_common.lua, line 183: bg_saints_main_menu_setup()`
`bg_saints_morph`	false	1 `bg_saints.lua, line 158`	1 `bg_saints.lua, line 142: bg_saints_morph( screen_type, size_x, anchor_x )`
`bg_saints_play_video`	false	1 `bg_saints.lua, line 340`	2 `main_menu_common.lua, line 118: bg_saints_play_video(true, "video_stopped")` `main_menu_common.lua, line 126: bg_saints_play_video(false, "video_stopped")`
`bg_saints_press_start_cb`	false	1 `bg_saints.lua, line 374`
`bg_saints_press_start_loop`	false	1 `bg_saints.lua, line 378`
`bg_saints_press_start_setup`	false	1 `bg_saints.lua, line 368`	1 `main_menu_common.lua, line 116: bg_saints_press_start_setup()`
`bg_saints_set_background`	false	1 `bg_saints.lua, line 313`	25 `bg_saints.lua, line 120: bg_saints_set_background(use_background)` `horde_results.lua, line 106: bg_saints_set_background(false)` `store_character.lua, line 3402: bg_saints_set_background(false)` `store_clothing.lua, line 235: bg_saints_set_background(false)` `store_clothing.lua, line 274: bg_saints_set_background(false)` `store_clothing.lua, line 466: bg_saints_set_background(true)` `store_clothing.lua, line 527: bg_saints_set_background(false)` `store_clothing.lua, line 1874: --bg_saints_set_background(true)` `store_clothing.lua, line 1900: bg_saints_set_background(false)` `store_crib.lua, line 366: bg_saints_set_background(false)` `store_gallery.lua, line 60: bg_saints_set_background(not Store_common_gallery_download_only)` `store_gallery.lua, line 451: bg_saints_set_background(true)` `store_gang.lua, line 104: bg_saints_set_background(false)` `store_gang.lua, line 498: bg_saints_set_background(false)` `store_gang.lua, line 643: bg_saints_set_background(is_loaded)` `store_stronghold.lua, line 218: bg_saints_set_background(false)` `store_vehicle.lua, line 183: bg_saints_set_background(false)` `store_vehicle.lua, line 2169: bg_saints_set_background(true)` `store_vehicle.lua, line 2541: bg_saints_set_background(false)` `store_vehicle.lua, line 3015: bg_saints_set_background(false)` `store_vehicle.lua, line 3030: bg_saints_set_background(true)` `store_vehicle.lua, line 3354: bg_saints_set_background(visible)` `store_weapon.lua, line 491: bg_saints_set_background(false)` `store_weapon.lua, line 1365: bg_saints_set_background(false)` `store_weapon.lua, line 1381: bg_saints_set_background(true)`
`bg_saints_set_type`	false	1 `bg_saints.lua, line 86`	31 `bg_saints.lua, line 64: bg_saints_set_type(BG_TYPE_DEFAULT, false)` `building_purchase.lua, line 43: bg_saints_set_type(BG_TYPE_COMPLETION)` `cat_mouse_results.lua, line 55: bg_saints_set_type(BG_TYPE_COMPLETION)` `cmp_fail.lua, line 98: bg_saints_set_type(BG_TYPE_CENTER,false,1280)` `game_lobby.lua, line 160: bg_saints_set_type(BG_TYPE_FULLSCREEN, false)` `horde_results.lua, line 101: bg_saints_set_type(BG_TYPE_DEFAULT, false, 1280, 0)` `horde_results.lua, line 103: bg_saints_set_type(BG_TYPE_DEFAULT, false)` `main_menu_common.lua, line 89: bg_saints_set_type(BG_TYPE_CENTER,true)` `main_menu_common.lua, line 281: bg_saints_set_type(BG_TYPE_CENTER, true, list_w)` `main_menu_common.lua, line 298: bg_saints_set_type(BG_TYPE_CENTER, false, list_w)` `main_menu_top.lua, line 329: bg_saints_set_type(BG_TYPE_CENTER,true)` `pause_ctrl_scheme.lua, line 115: bg_saints_set_type(BG_TYPE_CENTER, true, screen_width)` `pause_menu_common.lua, line 148: bg_saints_set_type(BG_TYPE_STRONGHOLD, true, list_w, bg_anchor)` `pause_menu_common.lua, line 161: bg_saints_set_type(BG_TYPE_STRONGHOLD, false, list_w, bg_anchor)` `pause_save_game.lua, line 117: bg_saints_set_type(BG_TYPE_CENTER, false, 1280)` `pause_save_game.lua, line 214: bg_saints_set_type(BG_TYPE_CENTER, true, SAVE_LOAD_WIDTH)` `player_choice_tutorial.lua, line 118: bg_saints_set_type(BG_TYPE_CENTER, false, 1290, false)` `store_clothing.lua, line 273: bg_saints_set_type(BG_TYPE_CENTER,true,1280)` `store_crib.lua, line 134: bg_saints_set_type(BG_TYPE_STRONGHOLD)` `store_crib.lua, line 269: bg_saints_set_type(BG_TYPE_STRONGHOLD,true)` `store_crib.lua, line 392: bg_saints_set_type(BG_TYPE_CENTER, true, 1280)` `store_crib.lua, line 516: bg_saints_set_type(BG_TYPE_STRONGHOLD,true)` `store_crib.lua, line 523: bg_saints_set_type(BG_TYPE_DEFAULT,true)` `store_demo.lua, line 44: bg_saints_set_type(BG_TYPE_CENTER, false, 1290, false)` `store_gallery.lua, line 59: bg_saints_set_type(BG_TYPE_FULLSCREEN)` `store_gang.lua, line 103: bg_saints_set_type(BG_TYPE_CENTER,true,1280)` `store_stronghold.lua, line 88: bg_saints_set_type(BG_TYPE_STRONGHOLD)` `store_vehicle.lua, line 2494: bg_saints_set_type(BG_TYPE_DEFAULT, true, 1280, 0)` `store_vehicle.lua, line 2496: bg_saints_set_type(BG_TYPE_DEFAULT, false, 1280, 0)` `store_vehicle.lua, line 2499: bg_saints_set_type(BG_TYPE_DEFAULT, true, 1280, 0)` `store_weapon.lua, line 293: bg_saints_set_type(BG_TYPE_CENTER,true,1280)`
`bg_saints_set_video`	false	1 `bg_saints.lua, line 331`	1 `main_menu_common.lua, line 114: bg_saints_set_video("main_menu_bg.bik")`
`bg_saints_show`	false	1 `bg_saints.lua, line 302`	21 `bg_saints.lua, line 219: bg_saints_show(true)` `bg_saints.lua, line 267: bg_saints_show(true)` `building_purchase.lua, line 29: bg_saints_show(false)` `building_purchase.lua, line 232: bg_saints_show(true)` `horde_results.lua, line 80: bg_saints_show(true)` `main_menu_common.lua, line 87: bg_saints_show(false)` `main_menu_top.lua, line 134: bg_saints_show(false)` `pause_menu_common.lua, line 78: bg_saints_show(false)` `pause_options_menu.lua, line 124: bg_saints_show(true)` `player_choice_tutorial.lua, line 21: bg_saints_show(false)` `player_choice_tutorial.lua, line 116: bg_saints_show(true)` `store_common.lua, line 83: bg_saints_show(false)` `store_crib.lua, line 348: bg_saints_show(true)` `store_demo.lua, line 43: bg_saints_show(true)` `store_gang.lua, line 114: bg_saints_show(true)` `store_gang.lua, line 139: bg_saints_show(false)` `store_vehicle.lua, line 2505: bg_saints_show(true)` `store_vehicle.lua, line 2510: bg_saints_show(false)` `store_vehicle.lua, line 2670: bg_saints_show(false)` `store_vehicle.lua, line 3142: bg_saints_show(true)` `store_vehicle.lua, line 3197: bg_saints_show(true)`
`bg_saints_slide_in`	false	1 `bg_saints.lua, line 225`	12 `horde_results.lua, line 463: bg_saints_slide_in()` `main_menu_campaign.lua, line 69: bg_saints_slide_in(495)` `main_menu_coop_top.lua, line 82: bg_saints_slide_in(Screen_width)` `main_menu_extras.lua, line 74: bg_saints_slide_in(Screen_width)` `main_menu_new_game.lua, line 72: bg_saints_slide_in(Screen_width)` `pause_menu_top.lua, line 237: bg_saints_slide_in(Screen_width, bg_anchor)` `pause_options_clip_select.lua, line 81: bg_saints_slide_in(Screen_width)` `pause_options_menu.lua, line 131: bg_saints_slide_in(Screen_width)` `pause_save_game.lua, line 192: bg_saints_slide_in(SAVE_LOAD_WIDTH)` `store_crib.lua, line 349: bg_saints_slide_in()` `store_gallery.lua, line 61: bg_saints_slide_in()` `store_vehicle.lua, line 2497: bg_saints_slide_in(1280, 0)`
`bg_saints_slide_out`	false	1 `bg_saints.lua, line 273`	24 `horde_results.lua, line 492: bg_saints_slide_out(1300)` `main_menu_campaign.lua, line 144: bg_saints_slide_out()` `main_menu_coop_top.lua, line 330: bg_saints_slide_out()` `main_menu_extras.lua, line 159: bg_saints_slide_out()` `main_menu_new_game.lua, line 194: bg_saints_slide_out()` `pause_co_op_menu.lua, line 280: bg_saints_slide_out()` `pause_ctrl_scheme.lua, line 401: bg_saints_slide_out()` `pause_invite_friends.lua, line 618: bg_saints_slide_out()` `pause_menu_top.lua, line 444: -- bg_saints_slide_out()` `pause_menu_top.lua, line 518: bg_saints_slide_out()` `pause_options_audio.lua, line 354: bg_saints_slide_out()` `pause_options_controls.lua, line 306: bg_saints_slide_out()` `pause_options_difficulty.lua, line 297: bg_saints_slide_out()` `pause_options_display.lua, line 215: bg_saints_slide_out()` `pause_options_display_cal.lua, line 318: bg_saints_slide_out()` `pause_options_display_pc.lua, line 904: bg_saints_slide_out()` `pause_options_menu.lua, line 244: bg_saints_slide_out()` `pause_options_record_mode.lua, line 205: bg_saints_slide_out()` `pause_options_record_mode.lua, line 241: bg_saints_slide_out()` `pause_save_game.lua, line 522: bg_saints_slide_out()` `pause_save_game.lua, line 545: bg_saints_slide_out()` `pause_save_game.lua, line 941: bg_saints_slide_out()` `store_gallery.lua, line 69: bg_saints_slide_out(-1300)` `store_vehicle.lua, line 3435: bg_saints_slide_out(1300)`
`bg_saints_stronghold_drop_out`	false	1 `bg_saints.lua, line 357`	1 `store_stronghold.lua, line 510: bg_saints_stronghold_drop_out()`
`build`	false	1 `vdo_newsticker.lua, line 61`	2 `vdo_newsticker.lua, line 133: Current_ticker:build()` `vdo_newsticker.lua, line 137: Current_ticker:build()`
`building_not_enough_money`	false	1 `building_purchase.lua, line 68`
`building_purchased`	false	1 `building_purchase.lua, line 144`
`building_purchase_clean`	false	1 `building_purchase.lua, line 59`	1 `building_purchase.lua, line 260: building_purchase_clean()`
`building_purchase_cleanup`	false	1 `building_purchase.lua, line 72`
`building_purchase_control_anim`	false	1 `building_purchase.lua, line 255`
`building_purchase_init`	false	1 `building_purchase.lua, line 16`
`building_purchase_mouse_click`	false	1 `building_purchase.lua, line 259`
`building_purchase_mouse_move`	false	1 `building_purchase.lua, line 263`
`building_purchase_pause`	false	1 `building_purchase.lua, line 55`
`building_purchase_play_audio`	false	1 `building_purchase.lua, line 250`
`build_hint_bar`	false	2 `game_lobby.lua, line 97` `pause_invite_friends.lua, line 52`	9 `game_lobby.lua, line 204: build_hint_bar()` `game_lobby.lua, line 307: build_hint_bar()` `game_lobby.lua, line 364: build_hint_bar()` `game_lobby.lua, line 729: build_hint_bar()` `game_lobby.lua, line 1193: build_hint_bar(true, true)` `game_lobby.lua, line 1224: build_hint_bar(true)` `pause_invite_friends.lua, line 125: build_hint_bar()` `pause_invite_friends.lua, line 273: build_hint_bar(true)` `pause_invite_friends.lua, line 303: build_hint_bar()`
`build_list`	false	2 `main_menu_extras.lua, line 14` `pause_options_display_pc.lua, line 78`	6 `main_menu_extras.lua, line 42: build_list()` `pause_options_display_pc.lua, line 415: build_list()` `pause_options_display_pc.lua, line 506: build_list()` `pause_options_display_pc.lua, line 648: build_list()` `pause_options_display_pc.lua, line 703: build_list()` `pause_options_display_pc.lua, line 886: build_list()`
`button_a`	false	3 `vdo_grid_list.lua, line 724` `vdo_mega_list.lua, line 1492` `vdo_pause_mega_list.lua, line 452`	15 `cell_music_menu.lua, line 102: Station_grid:button_a() -- should change it to checked` `cmp_fail.lua, line 266: List:button_a()` `main_menu_coop.lua, line 208: --List:button_a()` `main_menu_extras.lua, line 129: --List:button_a()` `main_menu_top.lua, line 382: Main_menu_list:button_a()` `pause_ctrl_scheme.lua, line 171: --Control_list:button_a()` `pause_menu_top.lua, line 348: List:button_a()` `pause_menu_top.lua, line 375: List:button_a()` `pause_menu_top.lua, line 396: List:button_a()` `pause_menu_top.lua, line 401: List:button_a()` `pause_options_controls.lua, line 252: List:button_a()` `pause_options_display_pc.lua, line 783: List:button_a()` `pause_options_menu.lua, line 189: List:button_a()` `pause_options_mouse.lua, line 203: List:button_a()` `pause_options_remap.lua, line 347: List:button_a()`
`button_b`	false	3 `vdo_grid_list.lua, line 737` `vdo_mega_list.lua, line 1534` `vdo_pause_mega_list.lua, line 482`	21 `main_menu_campaign.lua, line 137: List:button_b()` `main_menu_coop.lua, line 250: List:button_b()` `main_menu_coop_top.lua, line 321: List:button_b()` `main_menu_extras.lua, line 151: List:button_b()` `main_menu_new_game.lua, line 177: List:button_b()` `pause_co_op_menu.lua, line 268: List:button_b()` `pause_ctrl_scheme.lua, line 193: Control_list:button_b()` `pause_invite_friends.lua, line 536: List:button_b()` `pause_menu_top.lua, line 516: List:button_b()` `pause_options_audio.lua, line 316: List:button_b()` `pause_options_clip_select.lua, line 139: List:button_b()` `pause_options_controls.lua, line 264: List:button_b()` `pause_options_difficulty.lua, line 254: List:button_b()` `pause_options_display.lua, line 176: List:button_b()` `pause_options_display.lua, line 180: List:button_b()` `pause_options_display_cal.lua, line 226: Display_list:button_b()` `pause_options_display_pc.lua, line 824: List:button_b()` `pause_options_menu.lua, line 224: List:button_b()` `pause_options_mouse.lua, line 225: List:button_b()` `pause_options_record_mode.lua, line 193: List:button_b()` `pause_options_remap.lua, line 304: List:button_b()`

Saints Row: The Third Function Reference

Local functions