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)
`identity`	false	1 `vdo_cell_menu.lua, line 133`
`image_streamer_add_image`	false	1 `image_streamer.lua, line 31`	9 `store_character.lua, line 2708: image_streamer_add_image("ui_store_lineup_mugshot_04")` `store_character.lua, line 2709: image_streamer_add_image("ui_store_lineup_mugshot_05")` `store_character.lua, line 2710: image_streamer_add_image("ui_store_lineup_mugshot_02")` `store_character.lua, line 2711: image_streamer_add_image("ui_store_lineup_mugshot_03")` `store_character.lua, line 2712: image_streamer_add_image("ui_store_lineup_mugshot_07")` `store_character.lua, line 2713: image_streamer_add_image("ui_store_lineup_mugshot_01")` `store_character.lua, line 2714: image_streamer_add_image("ui_store_lineup_mugshot_08")` `store_character.lua, line 2715: image_streamer_add_image("ui_store_lineup_mugshot_06")` `store_character.lua, line 2716: image_streamer_add_image("ui_store_lineup_mugshot_09")`
`image_streamer_end_streaming`	false	1 `image_streamer.lua, line 97`	3 `store_character.lua, line 2815: image_streamer_end_streaming()` `store_character.lua, line 3362: image_streamer_end_streaming()` `store_character.lua, line 3603: image_streamer_end_streaming()`
`image_streamer_get_images`	false	1 `image_streamer.lua, line 191`
`image_streamer_is_stream_in_progress`	false	1 `image_streamer.lua, line 120`	2 `store_character.lua, line 3251: if not image_streamer_is_stream_in_progress() and not Susan_object:is_in_progress() and Susan_object:get_index() > 1 then` `store_character.lua, line 3259: if not image_streamer_is_stream_in_progress() and not Susan_object:is_in_progress() and Susan_object:get_index() < STORE_CHARACTER_NUM_LINEUP_IMAGES then`
`image_streamer_load_cb`	false	1 `image_streamer.lua, line 18`
`image_streamer_nav_index`	false	1 `image_streamer.lua, line 129`	2 `store_character.lua, line 3254: if image_streamer_nav_index(-1) == false then` `store_character.lua, line 3262: if image_streamer_nav_index(1) == false then`
`image_streamer_remove_all_images`	false	1 `image_streamer.lua, line 47`	1 `store_character.lua, line 2816: image_streamer_remove_all_images()`
`image_streamer_start_streaming`	false	1 `image_streamer.lua, line 66`	3 `store_character.lua, line 2723: image_streamer_start_streaming(STORE_CHARACTER_NUM_LINEUP_IMAGES - 1, STORE_CHARACTER_NUM_LINEUP_IMAGES_LOADED, store_character_lineup_images_loaded)` `store_character.lua, line 3570: image_streamer_start_streaming(index, STORE_CHARACTER_NUM_LINEUP_IMAGES_LOADED)` `store_character.lua, line 3673: image_streamer_start_streaming(index, STORE_CHARACTER_NUM_LINEUP_IMAGES_LOADED)`
`image_streamer_unwrap`	false	1 `image_streamer.lua, line 10`	1 `image_streamer.lua, line 12: return arguments[start + 1], image_streamer_unwrap(arguments, start + 1)`
`init`	false	52 `vdo_bitmap_viewer.lua, line 10` `vdo_button_header.lua, line 22` `vdo_button_highlight.lua, line 24` `vdo_button_pc.lua, line 65` `vdo_button_pip.lua, line 22` `vdo_button_remap.lua, line 21` `vdo_button_toggle.lua, line 46` `vdo_cell_filter.lua, line 45` `vdo_cell_menu.lua, line 17` `vdo_cell_menu_button.lua, line 16` `vdo_cell_title.lua, line 11` `vdo_city_control.lua, line 14` `vdo_dialog.lua, line 53` `vdo_export_progress_meter.lua, line 12` `vdo_grid_button_canceled.lua, line 7` `vdo_grid_button_check.lua, line 11` `vdo_grid_list.lua, line 27` `vdo_gsi.lua, line 217` `vdo_gsi_capture_meter.lua, line 28` `vdo_gsi_combo.lua, line 18` `vdo_gsi_info.lua, line 22` `vdo_gsi_lite.lua, line 14` `vdo_gsi_meter.lua, line 19` `vdo_gsi_timer.lua, line 28` `vdo_gsi_xy.lua, line 19` `vdo_hint_bar.lua, line 33` `vdo_hint_button.lua, line 14` `vdo_item_stats.lua, line 14` `vdo_level_meter.lua, line 13` `vdo_mega_list.lua, line 45` `vdo_newsticker.lua, line 26` `vdo_pause_button_highlight.lua, line 22` `vdo_pause_button_toggle.lua, line 25` `vdo_pause_header.lua, line 31` `vdo_pause_header_mini.lua, line 28` `vdo_pause_mega_list.lua, line 31` `vdo_powers_button.lua, line 23` `vdo_qte_key.lua, line 22` `vdo_respect_meter.lua, line 29` `vdo_row.lua, line 17` `vdo_scrollbar.lua, line 17` `vdo_scrollbox.lua, line 22` `vdo_spinner.lua, line 16` `vdo_store_header.lua, line 22` `vdo_store_popup.lua, line 19` `vdo_susan.lua, line 38` `vdo_toggle.lua, line 15` `vdo_toggle_color.lua, line 16` `vdo_triangle_select.lua, line 62` `vdo_weapon_pips.lua, line 16` `vdo_weapon_radial.lua, line 33` `vdo_weapon_radial_slot.lua, line 37`	14 `hud.lua, line 1964: --This is triggered by a callback setup in the init()` `hud.lua, line 1982: --This is triggered by a callback setup in the init()` `hud.lua, line 2664: --This is triggered by a callback setup in the init()` `mflighttutorial.lua, line 137: -- init = "mFlightTutorial_fcp_init", -- init(bool mission_restart)` `mflighttutorial.lua, line 151: init = "mFlightTutorial_orb_init", -- init(bool mission_restart)` `mintro.lua, line 98: init = "mIntro_gtu_init", -- init(bool mission_restart)` `mmauratutorial.lua, line 165: init = "mmAuraTutorial_fcp_init", -- init(bool mission_restart)` `mmblasttutorial.lua, line 225: init = "mmBlastTutorial_fcp_init", -- init(bool mission_restart)` `mmstomptutorial.lua, line 256: init = "mmStompTutorial_fcp_init", -- init(bool mission_restart)` `mmsummontutorial.lua, line 196: init = "mmSummonTutorial_fcp_init", -- init(bool mission_restart)` `msatanflight.lua, line 44: init = "mSatanFlight_gtb_init", -- init(bool mission_restart)` `tultor.lua, line 53: init = "tUltor_fcp_init", -- init(bool mission_restart)` `vdo_base_object.lua, line 18: obj:init()` `vdo_weapon_radial_slot.lua, line 178: --Reposition to stored values in init()`
`init_anim_complete`	false	1 `vdo_susan.lua, line 318`
`init_morphs`	false	1 `vdo_triangle_select.lua, line 127`	1 `store_character.lua, line 898: Triangle_select:init_morphs(Store_character_strength, Store_character_skinny, Store_character_fat, Store_character_build_cursor_x, Store_character_build_cursor_y)`
`input_from_stick_value_and_speed`	false	1 `store_character.lua, line 805`	2 `store_character.lua, line 816: Left_stick_current_input_x = input_from_stick_value_and_speed(value, LEFT_STICK_PIXELS_PER_FRAME)` `store_character.lua, line 820: Left_stick_current_input_y = input_from_stick_value_and_speed(value, LEFT_STICK_PIXELS_PER_FRAME)`
`interrogate_cleanup`	false	1 `game_lib.lua, line 4666`	1 `game_lib.lua, line 4576: interrogate_cleanup()`
`interrogate_shutdown`	false	1 `game_lib.lua, line 4575`	1 `game_lib.lua, line 4712: interrogate_shutdown()`
`interrogate_startup`	false	1 `game_lib.lua, line 4571`	9 `game_lib.lua, line 4701: -- not common - requires manual setup in script interrogate_startup(interrogate_list)` `mflighttutorial.lua, line 910: --interrogate_startup(mFlightTutorial_interrogate)` `mintro.lua, line 534: --interrogate_startup(mIntro_interrogate)` `mintrobb.lua, line 588: --interrogate_startup(mIntroBB_interrogate)` `mintrotwins.lua, line 524: --interrogate_startup(mIntroTwins_interrogate)` `mintrovlad.lua, line 524: --interrogate_startup(mIntroVlad_interrogate)` `mmblasttutorial.lua, line 461: --interrogate_startup(mmBlastTutorial_interrogate)` `mmsummontutorial.lua, line 426: --interrogate_startup(mmSummonTutorial_interrogate)` `tultor.lua, line 199: --interrogate_startup(tUltor_interrogate)`
`interrogate_target`	false	1 `game_lib.lua, line 4584`
`intro_anim_cb`	false	1 `vdo_mega_list.lua, line 2047`
`intro_done`	false	1 `vdo_susan.lua, line 311`
`inv_add_temp_loadout`	false	1 `game_lib.lua, line 4838`	1 `game_lib.lua, line 4823: inv_add_temp_loadout( _PLAYER_LOADOUT )`
`inv_item_add`	false	1 `game_lib.lua, line 2067`	12 `mintro.lua, line 418: inv_item_add(weapon_name, count, LOCAL_PLAYER, equip_now)` `mintro.lua, line 422: inv_item_add(weapon_name, count, REMOTE_PLAYER, equip_now)` `mintrobb.lua, line 697: inv_item_add("Melee-Warhammer", 1, LOCAL_PLAYER, true, 0)` `mintrobb.lua, line 702: inv_item_add("Melee-Warhammer", 1, REMOTE_PLAYER, true, 0)` `mintrobb.lua, line 802: inv_item_add( "Pistol-HandCrossbow", 1, mIntroBB_homie.blackbeard, true )` `mintrobb.lua, line 1020: inv_item_add("Melee-Warhammer", 1, LOCAL_PLAYER, true, 0)` `mintrobb.lua, line 1025: inv_item_add("Melee-Warhammer", 1, REMOTE_PLAYER, true, 0)` `mintrobb.lua, line 1528: inv_item_add( "Pistol-HandCrossbow", 1, blackbeard_group.blackbeard, true )` `mmauratutorial.lua, line 953: inv_item_add( "Rifle-LavaBolter", 1, npc, true )` `mmblasttutorial.lua, line 1028: inv_item_add( "Rifle-LavaBolter", 1, npc, true )` `mmstomptutorial.lua, line 1069: inv_item_add( "Rifle-LavaBolter", 1, npc, true )` `mmsummontutorial.lua, line 940: inv_item_add( "Rifle-LavaBolter", 1, npc, true )`
`inv_remove_temp_loadout`	false	1 `game_lib.lua, line 4880`	1 `game_lib.lua, line 4826: inv_remove_temp_loadout( _PLAYER_LOADOUT )`
`is_active`	false	1 `vdo_button_pc.lua, line 378`	3 `cinema_clip_editor.lua, line 626: if CCE_buttons[i].button:is_active() and CCE_buttons[i].button:get_visible() then` `cinema_clip_editor.lua, line 647: if CCE_buttons[i].button:is_active() and CCE_buttons[i].button:get_visible() then` `cinema_clip_editor.lua, line 747: if CCE_buttons[i].button:is_active() and CCE_buttons[i].button:get_visible() then`
`is_active_get`	false	1 `vdo_gsi.lua, line 1106`	1 `screen_fade.lua, line 333: if Hud_gsi:is_active_get() then`
`is_active_set`	false	1 `vdo_gsi.lua, line 1101`
`is_control_blocked`	false	1 `reward_granted.lua, line 384`	1 `reward_granted.lua, line 132: if is_control_blocked() == false then`
`is_in_progress`	false	1 `vdo_susan.lua, line 289`	2 `store_character.lua, line 3251: if not image_streamer_is_stream_in_progress() and not Susan_object:is_in_progress() and Susan_object:get_index() > 1 then` `store_character.lua, line 3259: if not image_streamer_is_stream_in_progress() and not Susan_object:is_in_progress() and Susan_object:get_index() < STORE_CHARACTER_NUM_LINEUP_IMAGES then`
`is_left_arrow`	false	1 `vdo_mega_list.lua, line 2391`	14 `cell_camera.lua, line 272: if Camera_list:is_left_arrow(target_handle) then` `game_lobby.lua, line 983: if Game_lobby_list:is_left_arrow(target_handle) then` `pause_co_op_menu.lua, line 340: if List:is_left_arrow(target_handle) then` `pause_ctrl_scheme.lua, line 483: if Control_list:is_left_arrow(target_handle) then` `pause_options_audio.lua, line 408: if List:is_left_arrow(target_handle) then` `pause_options_controls.lua, line 457: if List:is_left_arrow(target_handle) then` `pause_options_difficulty.lua, line 353: if List:is_left_arrow(target_handle) then` `pause_options_display_cal.lua, line 416: if Display_list:is_left_arrow(target_handle) then` `pause_options_display_pc.lua, line 956: elseif List:is_left_arrow(target_handle) then` `pause_options_mouse.lua, line 328: if List:is_left_arrow(target_handle) then` `pause_options_record_mode.lua, line 265: if List:is_left_arrow(target_handle) then` `pause_options_remap.lua, line 447: if List:is_left_arrow(target_handle) then` `store_character.lua, line 3179: if Active_list:is_left_arrow(target_handle) then` `store_common.lua, line 761: if Active_list:is_left_arrow(target_handle) then`
`is_player_tag`	false	1 `game_lib.lua, line 2085`	3 `game_lib.lua, line 2933: if is_player_tag(arg[arg.n]) then` `game_lib.lua, line 2949: if is_player_tag(arg[arg.n]) then` `game_lib.lua, line 2960: if is_player_tag(arg[arg.n]) then`
`is_right_arrow`	false	1 `vdo_mega_list.lua, line 2401`	8 `game_lobby.lua, line 988: elseif Game_lobby_list:is_right_arrow(target_handle) then` `pause_options_audio.lua, line 411: elseif List:is_right_arrow(target_handle) then` `pause_options_controls.lua, line 460: elseif List:is_right_arrow(target_handle) then` `pause_options_display_cal.lua, line 419: elseif Display_list:is_right_arrow(target_handle) then` `pause_options_display_pc.lua, line 958: elseif List:is_right_arrow(target_handle) then` `pause_options_mouse.lua, line 331: elseif List:is_right_arrow(target_handle) then` `store_character.lua, line 3181: elseif Active_list:is_right_arrow(target_handle) then` `store_common.lua, line 763: elseif Active_list:is_right_arrow(target_handle) then`
`is_slider`	false	1 `vdo_mega_list.lua, line 2433`	12 `game_lobby.lua, line 994: if Game_lobby_list:is_slider(target_handle) then` `pause_options_audio.lua, line 415: if List:is_slider(target_handle) then` `pause_options_audio.lua, line 437: if List:is_slider(target_handle) then` `pause_options_controls.lua, line 464: if List:is_slider(target_handle) then` `pause_options_controls.lua, line 487: if List:is_slider(target_handle) then` `pause_options_controls.lua, line 511: if List:is_slider(target_handle) then` `pause_options_display_cal.lua, line 423: if Display_list:is_slider(target_handle) then` `pause_options_display_cal.lua, line 456: if Display_list:is_slider(target_handle) then` `pause_options_mouse.lua, line 335: if List:is_slider(target_handle) then` `pause_options_mouse.lua, line 357: if List:is_slider(target_handle) then` `store_common.lua, line 726: if Active_list:is_slider(target_handle) then` `store_common.lua, line 833: elseif Active_list:is_slider(target_handle) then`
`is_tween_done`	false	2 `vdo_grid_list.lua, line 827` `vdo_mega_list.lua, line 2011`

Saints Row 2 Function Reference

Local functions