Saints Row 2 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 1034`	3 `cell_saintsbook.lua, line 403: Active_screen.back()` `dialog.lua, line 171: if Dialog_objects[Dialog_current_idx]:back() then` `dialog.lua, line 455: 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 203: bg_saints_animate()` `store_stronghold.lua, line 557: bg_saints_animate()`
`bg_saints_cleanup`	false	1 `bg_saints.lua, line 153`
`bg_saints_dimmer_show`	false	1 `bg_saints.lua, line 329`	1 `pause_menu_top.lua, line 226: bg_saints_dimmer_show(true) --Dim out the game...`
`bg_saints_init`	false	1 `bg_saints.lua, line 105`
`bg_saints_main_menu_cb`	false	1 `bg_saints.lua, line 414`
`bg_saints_main_menu_loop`	false	1 `bg_saints.lua, line 418`
`bg_saints_main_menu_setup`	false	1 `bg_saints.lua, line 392`	2 `main_menu_common.lua, line 158: --bg_saints_main_menu_setup()` `main_menu_common.lua, line 229: bg_saints_main_menu_setup()`
`bg_saints_morph`	false	1 `bg_saints.lua, line 198`
`bg_saints_play_video`	false	1 `bg_saints.lua, line 346`	2 `main_menu_common.lua, line 155: bg_saints_play_video(true, "video_stopped")` `main_menu_common.lua, line 163: bg_saints_play_video(false, "video_stopped")`
`bg_saints_press_start_cb`	false	1 `bg_saints.lua, line 379`
`bg_saints_press_start_loop`	false	1 `bg_saints.lua, line 383`
`bg_saints_press_start_setup`	false	1 `bg_saints.lua, line 373`	1 `main_menu_common.lua, line 153: --bg_saints_press_start_setup()`
`bg_saints_reset`	false	1 `bg_saints.lua, line 425`
`bg_saints_set_background`	false	1 `bg_saints.lua, line 321`	23 `bg_saints.lua, line 188: bg_saints_set_background(use_background)` `store_character.lua, line 3592: bg_saints_set_background(false)` `store_clothing.lua, line 255: bg_saints_set_background(false)` `store_clothing.lua, line 293: bg_saints_set_background(false)` `store_clothing.lua, line 479: bg_saints_set_background(true)` `store_clothing.lua, line 540: bg_saints_set_background(false)` `store_clothing.lua, line 1913: --bg_saints_set_background(true)` `store_clothing.lua, line 1939: bg_saints_set_background(false)` `store_crib.lua, line 346: bg_saints_set_background(false)` `store_gallery.lua, line 62: bg_saints_set_background(not Store_common_gallery_download_only)` `store_gallery.lua, line 454: bg_saints_set_background(true)` `store_gang.lua, line 104: bg_saints_set_background(false)` `store_gang.lua, line 502: bg_saints_set_background(false)` `store_gang.lua, line 647: bg_saints_set_background(is_loaded)` `store_stronghold.lua, line 211: bg_saints_set_background(false)` `store_vehicle.lua, line 173: bg_saints_set_background(false)` `store_vehicle.lua, line 2174: bg_saints_set_background(true)` `store_vehicle.lua, line 2540: bg_saints_set_background(false)` `store_vehicle.lua, line 3009: bg_saints_set_background(false)` `store_vehicle.lua, line 3024: bg_saints_set_background(true)` `store_vehicle.lua, line 3352: bg_saints_set_background(visible)` `store_weapon.lua, line 763: bg_saints_set_background(false)` `store_weapon.lua, line 1809: bg_saints_set_background(true)`
`bg_saints_set_type`	false	1 `bg_saints.lua, line 167`	30 `bg_saints.lua, line 150: bg_saints_set_type(BG_TYPE_PAUSE, false)` `building_purchase.lua, line 35: bg_saints_set_type(BG_TYPE_COMPLETION)` `cat_mouse_results.lua, line 58: bg_saints_set_type(BG_TYPE_PAUSE)` `cmp_fail.lua, line 104: bg_saints_set_type(BG_TYPE_FAIL)` `game_lobby.lua, line 140: bg_saints_set_type(BG_TYPE_PAUSE, false)` `main_menu_common.lua, line 105: bg_saints_set_type(BG_TYPE_VIDEO,true)` `main_menu_common.lua, line 330: bg_saints_set_type(BG_TYPE_PAUSE, true, list_w)` `main_menu_common.lua, line 347: bg_saints_set_type(BG_TYPE_PAUSE, false, list_w)` `main_menu_top.lua, line 155: bg_saints_set_type(BG_TYPE_VIDEO, true)` `main_menu_top.lua, line 165: bg_saints_set_type(BG_TYPE_VIDEO, true)` `main_menu_top.lua, line 390: bg_saints_set_type(BG_TYPE_VIDEO,true)` `pause_ctrl_scheme.lua, line 130: bg_saints_set_type(BG_TYPE_PAUSE, true, Screen_width)` `pause_menu_common.lua, line 165: bg_saints_set_type(BG_TYPE_PAUSE, true, list_w, bg_anchor)` `pause_menu_common.lua, line 178: bg_saints_set_type(BG_TYPE_PAUSE, false, list_w, bg_anchor)` `pause_save_game.lua, line 97: bg_saints_set_type(BG_TYPE_PAUSE, false, 1280)` `player_choice_tutorial.lua, line 118: bg_saints_set_type(BG_TYPE_CENTER, false, 1290, false)` `store_clothing.lua, line 292: bg_saints_set_type(BG_TYPE_CRIB,true,1280)` `store_crib.lua, line 128: bg_saints_set_type(BG_TYPE_CRIB)` `store_crib.lua, line 256: bg_saints_set_type(BG_TYPE_CRIB,true)` `store_crib.lua, line 370: bg_saints_set_type(BG_TYPE_CRIB, true, 1280)` `store_crib.lua, line 493: bg_saints_set_type(BG_TYPE_CRIB,true)` `store_crib.lua, line 500: bg_saints_set_type(BG_TYPE_CRIB_USE,true)` `store_demo.lua, line 44: bg_saints_set_type(BG_TYPE_CENTER, false, 1290, false)` `store_gallery.lua, line 61: bg_saints_set_type(BG_TYPE_PAUSE)` `store_gang.lua, line 103: bg_saints_set_type(BG_TYPE_CRIB,true,1280)` `store_stronghold.lua, line 88: bg_saints_set_type(BG_TYPE_STRONGHOLD)` `store_vehicle.lua, line 2493: bg_saints_set_type(BG_TYPE_CRIB_USE, true, 1280, 0)` `store_vehicle.lua, line 2495: bg_saints_set_type(BG_TYPE_CRIB_USE, false, 1280, 0)` `store_vehicle.lua, line 2498: bg_saints_set_type(BG_TYPE_CRIB_USE, true, 1280, 0)` `store_weapon.lua, line 489: bg_saints_set_type(BG_TYPE_CRIB,true,1280)`
`bg_saints_set_video`	false	1 `bg_saints.lua, line 337`	2 `main_menu_common.lua, line 149: --bg_saints_set_video("main_menu_bg.bik")` `main_menu_common.lua, line 151: bg_saints_set_video("main_menu_bg.bk2")`
`bg_saints_show`	false	1 `bg_saints.lua, line 229`	32 `bg_saints.lua, line 207: bg_saints_show(true)` `bg_saints.lua, line 215: bg_saints_show(true)` `building_purchase.lua, line 25: bg_saints_show(false)` `building_purchase.lua, line 209: bg_saints_show(true)` `cmp_fail.lua, line 105: bg_saints_show(true)` `game_lobby.lua, line 141: bg_saints_show(true)` `main_menu_load.lua, line 67: bg_saints_show(true)` `main_menu_silverlink.lua, line 111: bg_saints_show(true)` `main_menu_top.lua, line 156: bg_saints_show(true)` `main_menu_top.lua, line 166: bg_saints_show(true)` `main_menu_top.lua, line 279: bg_saints_show(true)` `main_sl_about.lua, line 42: bg_saints_show(true)` `main_sl_rewards.lua, line 60: bg_saints_show(true)` `main_sl_rewards_list.lua, line 92: bg_saints_show(true)` `main_sl_settings.lua, line 70: bg_saints_show(true)` `pause_menu_common.lua, line 87: bg_saints_show(false)` `pause_options_menu.lua, line 129: 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_character.lua, line 3379: bg_saints_show(false)` `store_clothing.lua, line 622: bg_saints_show(false)` `store_common.lua, line 89: bg_saints_show(false)` `store_crib.lua, line 328: bg_saints_show(true)` `store_demo.lua, line 43: bg_saints_show(true)` `store_gallery.lua, line 38: bg_saints_show(false)` `store_gang.lua, line 114: bg_saints_show(true)` `store_gang.lua, line 139: bg_saints_show(false)` `store_vehicle.lua, line 2504: bg_saints_show(true)` `store_vehicle.lua, line 2509: bg_saints_show(false)` `store_vehicle.lua, line 2669: bg_saints_show(false)` `store_vehicle.lua, line 3136: bg_saints_show(true)` `store_vehicle.lua, line 3195: bg_saints_show(true)`
`bg_saints_slide_in`	false	1 `bg_saints.lua, line 213`	16 `cat_mouse_results.lua, line 59: bg_saints_slide_in()` `cmp_fail.lua, line 106: bg_saints_slide_in()` `main_menu_campaign.lua, line 77: bg_saints_slide_in(495)` `main_menu_coop_top.lua, line 74: bg_saints_slide_in(Screen_width)` `main_menu_extras.lua, line 83: bg_saints_slide_in(Screen_width)` `main_menu_new_game.lua, line 77: bg_saints_slide_in(Screen_width)` `main_menu_silverlink.lua, line 127: bg_saints_slide_in(Screen_width)` `main_sl_rewards.lua, line 69: bg_saints_slide_in(Screen_width)` `main_sl_rewards_list.lua, line 107: bg_saints_slide_in(Screen_width)` `main_sl_settings.lua, line 79: bg_saints_slide_in(Screen_width)` `pause_menu_top.lua, line 225: 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 136: bg_saints_slide_in(Screen_width)` `store_crib.lua, line 329: bg_saints_slide_in()` `store_gallery.lua, line 63: bg_saints_slide_in()` `store_vehicle.lua, line 2496: bg_saints_slide_in(1280, 0)`
`bg_saints_slide_out`	false	1 `bg_saints.lua, line 221`	26 `main_menu_campaign.lua, line 162: bg_saints_slide_out()` `main_menu_coop_top.lua, line 335: bg_saints_slide_out()` `main_menu_extras.lua, line 170: bg_saints_slide_out()` `main_menu_new_game.lua, line 199: bg_saints_slide_out()` `main_menu_silverlink.lua, line 229: bg_saints_slide_out()` `main_sl_rewards.lua, line 152: bg_saints_slide_out()` `main_sl_settings.lua, line 164: bg_saints_slide_out()` `pause_co_op_menu.lua, line 318: -- bg_saints_slide_out()` `pause_ctrl_scheme.lua, line 423: bg_saints_slide_out()` `pause_invite_friends.lua, line 669: bg_saints_slide_out()` `pause_menu_top.lua, line 466: -- bg_saints_slide_out()` `pause_menu_top.lua, line 516: bg_saints_slide_out()` `pause_options_audio.lua, line 390: bg_saints_slide_out()` `pause_options_controls.lua, line 439: bg_saints_slide_out()` `pause_options_difficulty.lua, line 334: bg_saints_slide_out()` `pause_options_display.lua, line 231: bg_saints_slide_out()` `pause_options_display_cal.lua, line 346: bg_saints_slide_out()` `pause_options_display_pc.lua, line 938: bg_saints_slide_out()` `pause_options_menu.lua, line 249: bg_saints_slide_out()` `pause_options_record_mode.lua, line 210: bg_saints_slide_out()` `pause_options_record_mode.lua, line 246: bg_saints_slide_out()` `pause_save_game.lua, line 504: bg_saints_slide_out()` `pause_save_game.lua, line 528: bg_saints_slide_out()` `pause_save_game.lua, line 916: bg_saints_slide_out()` `store_gallery.lua, line 71: bg_saints_slide_out(-1300)` `store_vehicle.lua, line 3414: bg_saints_slide_out(1300)`
`bg_saints_stronghold_drop_out`	false	1 `bg_saints.lua, line 363`	1 `store_stronghold.lua, line 503: bg_saints_stronghold_drop_out()`
`blink`	false	1 `vdo_gsi.lua, line 1146`	1 `vdo_gsi.lua, line 339: self:blink()`
`blink_complete`	false	1 `vdo_gsi.lua, line 1191`
`blink_queue`	false	1 `vdo_gsi.lua, line 1187`	10 `vdo_gsi.lua, line 894: self:blink_queue(true)` `vdo_gsi_capture_meter.lua, line 138: -- self.parent:blink_queue(true)` `vdo_gsi_capture_meter.lua, line 143: -- self.parent:blink_queue(true)` `vdo_gsi_info.lua, line 63: self.parent:blink_queue(true)` `vdo_gsi_info.lua, line 80: self.parent:blink_queue(true)` `vdo_gsi_info.lua, line 88: self.parent:blink_queue(true)` `vdo_gsi_meter.lua, line 114: self.parent:blink_queue(true)` `vdo_gsi_meter.lua, line 126: self.parent:blink_queue(true)` `vdo_gsi_xy.lua, line 56: self.parent:blink_queue(true)` `vdo_gsi_xy.lua, line 58: --self.parent:blink_queue(true)`
`build`	false	1 `vdo_newsticker.lua, line 61`	3 `vdo_newsticker.lua, line 169: Current_ticker:build()` `vdo_newsticker.lua, line 173: Current_ticker:build()` `vdo_newsticker.lua, line 229: Current_ticker:build()`
`building_not_enough_money`	false	1 `building_purchase.lua, line 60`
`building_purchased`	false	1 `building_purchase.lua, line 129`
`building_purchase_clean`	false	1 `building_purchase.lua, line 51`	1 `building_purchase.lua, line 232: building_purchase_clean()`
`building_purchase_cleanup`	false	1 `building_purchase.lua, line 64`
`building_purchase_control_anim`	false	1 `building_purchase.lua, line 227`
`building_purchase_init`	false	1 `building_purchase.lua, line 15`
`building_purchase_mouse_click`	false	1 `building_purchase.lua, line 231`
`building_purchase_mouse_move`	false	1 `building_purchase.lua, line 235`
`building_purchase_pause`	false	1 `building_purchase.lua, line 47`
`building_purchase_play_audio`	false	1 `building_purchase.lua, line 222`
`build_hint_bar`	false	2 `game_lobby.lua, line 68` `pause_invite_friends.lua, line 58`	9 `game_lobby.lua, line 185: build_hint_bar()` `game_lobby.lua, line 294: build_hint_bar()` `game_lobby.lua, line 339: build_hint_bar()` `game_lobby.lua, line 423: build_hint_bar()` `game_lobby.lua, line 789: build_hint_bar(true)` `game_lobby.lua, line 811: build_hint_bar(true)` `pause_invite_friends.lua, line 131: build_hint_bar()` `pause_invite_friends.lua, line 295: build_hint_bar(true)` `pause_invite_friends.lua, line 332: build_hint_bar()`
`build_list`	false	2 `main_menu_extras.lua, line 12` `pause_options_display_pc.lua, line 78`	6 `main_menu_extras.lua, line 51: build_list()` `pause_options_display_pc.lua, line 428: build_list()` `pause_options_display_pc.lua, line 526: build_list()` `pause_options_display_pc.lua, line 683: build_list(true)` `pause_options_display_pc.lua, line 738: build_list()` `pause_options_display_pc.lua, line 920: build_list()`
`button_a`	false	3 `vdo_grid_list.lua, line 746` `vdo_mega_list.lua, line 1830` `vdo_pause_mega_list.lua, line 452`	18 `cell_music_menu.lua, line 113: Station_grid:button_a() -- should change it to checked` `cmp_fail.lua, line 285: List:button_a()` `main_menu_coop.lua, line 202: --List:button_a()` `main_menu_extras.lua, line 138: --List:button_a()` `main_menu_silverlink.lua, line 183: List:button_a()` `main_menu_top.lua, line 726: --Main_menu_list:button_a()` `main_sl_rewards.lua, line 123: List:button_a()` `main_sl_settings.lua, line 133: List:button_a()` `pause_ctrl_scheme.lua, line 188: --Control_list:button_a()` `pause_menu_top.lua, line 359: List:button_a()` `pause_menu_top.lua, line 391: List:button_a()` `pause_menu_top.lua, line 412: List:button_a()` `pause_menu_top.lua, line 417: List:button_a()` `pause_options_controls.lua, line 373: List:button_a()` `pause_options_display_pc.lua, line 817: List:button_a()` `pause_options_menu.lua, line 194: List:button_a()` `pause_options_mouse.lua, line 251: List:button_a()` `pause_options_remap.lua, line 367: List:button_a()`
`button_b`	false	3 `vdo_grid_list.lua, line 759` `vdo_mega_list.lua, line 1872` `vdo_pause_mega_list.lua, line 482`	26 `main_menu_campaign.lua, line 155: List:button_b()` `main_menu_coop.lua, line 241: List:button_b()` `main_menu_coop_top.lua, line 326: List:button_b()` `main_menu_extras.lua, line 162: List:button_b()` `main_menu_new_game.lua, line 182: List:button_b()` `main_menu_silverlink.lua, line 208: List:button_b()` `main_sl_about.lua, line 108: List:button_b()` `main_sl_rewards.lua, line 138: List:button_b()` `main_sl_rewards_list.lua, line 188: List:button_b()` `main_sl_settings.lua, line 147: List:button_b()` `pause_co_op_menu.lua, line 305: List:button_b()` `pause_ctrl_scheme.lua, line 210: Control_list:button_b()` `pause_invite_friends.lua, line 587: List:button_b()` `pause_menu_top.lua, line 514: List:button_b()` `pause_options_audio.lua, line 352: List:button_b()` `pause_options_clip_select.lua, line 139: List:button_b()` `pause_options_controls.lua, line 397: List:button_b()` `pause_options_difficulty.lua, line 291: List:button_b()` `pause_options_display.lua, line 192: List:button_b()` `pause_options_display.lua, line 196: List:button_b()` `pause_options_display_cal.lua, line 252: Display_list:button_b()` `pause_options_display_pc.lua, line 858: List:button_b()` `pause_options_menu.lua, line 229: List:button_b()` `pause_options_mouse.lua, line 275: List:button_b()` `pause_options_record_mode.lua, line 198: List:button_b()` `pause_options_remap.lua, line 324: List:button_b()`

Saints Row 2 Function Reference

Local functions