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)
`fade_out`	true		42 `game_lib.lua, line 2520: fade_out( fade_time )` `mflighttutorial.lua, line 923: fade_out(0)` `mflighttutorial.lua, line 1165: fade_out( 0.0 )` `mflighttutorial.lua, line 1471: --fade_out(1.0)` `mflighttutorial.lua, line 1911: fade_out( 0, 0, SYNC_LOCAL )` `mflighttutorial.lua, line 1964: fade_out( 0, 0, SYNC_REMOTE )` `mflighttutorial.lua, line 2043: fade_out( 0, 0, SYNC_LOCAL )` `mflighttutorial.lua, line 2162: fade_out( 0, 0, SYNC_REMOTE )` `mintro.lua, line 547: fade_out(0)` `mintro.lua, line 1128: fade_out(1.0, 0, teleport_sync)` `mintrobb.lua, line 611: fade_out(0)` `mintrobb.lua, line 791: fade_out(0.0)` `mintrobb.lua, line 976: fade_out(1)` `mintroshakes.lua, line 536: fade_out(0)` `mintroshakes.lua, line 686: fade_out(0.0)` `mintroshakes.lua, line 951: fade_out(1)` `mintrotwins.lua, line 542: fade_out(0)` `mintrotwins.lua, line 692: fade_out(0.0)` `mintrotwins.lua, line 943: fade_out(1)` `mintrovlad.lua, line 543: fade_out(0)` `mintrovlad.lua, line 1162: fade_out(1)` `mmauratutorial.lua, line 374: fade_out(0)` `mmauratutorial.lua, line 678: fade_out(0.0)` `mmauratutorial.lua, line 1060: fade_out( 0, 0, SYNC_LOCAL )` `mmauratutorial.lua, line 1076: fade_out( 0, 0, SYNC_REMOTE )` `mmblasttutorial.lua, line 474: fade_out(0)` `mmblasttutorial.lua, line 796: fade_out(0.0)` `mmblasttutorial.lua, line 1097: fade_out( 0, 0, SYNC_LOCAL )` `mmblasttutorial.lua, line 1113: fade_out( 0, 0, SYNC_REMOTE )` `mmstomptutorial.lua, line 494: fade_out(0)` `mmstomptutorial.lua, line 808: fade_out(0.0)` `mmstomptutorial.lua, line 1250: fade_out( 0, 0, SYNC_LOCAL )` `mmstomptutorial.lua, line 1266: fade_out( 0, 0, SYNC_REMOTE )` `mmsummontutorial.lua, line 439: fade_out(0)` `mmsummontutorial.lua, line 741: fade_out(0.0)` `mmsummontutorial.lua, line 1039: fade_out( 0, 0, SYNC_LOCAL )` `mmsummontutorial.lua, line 1054: fade_out( 0, 0, SYNC_REMOTE )` `msatan.lua, line 241: fade_out(0)` `msatan.lua, line 529: fade_out(0)` `sr4_5_city.lua, line 1076: fade_out(0.5, SFX_FADE_ALPHA_FADE, SYNC_LOCAL)` `sr4_5_city.lua, line 1096: fade_out(0.75, SFX_FADE_ALPHA_FADE, SYNC_LOCAL)` `tultor.lua, line 212: fade_out(0)`
`filter_change_callback`	true		1 `vdo_cell_filter.lua, line 282: self.filter_change_callback(filter_type)`
`find_widest_text_element`	true	1 `vint_lib.lua, line 1581`	4 `pause_map.lua, line 917: local widest_element_h, hood_width = find_widest_text_element(data)` `pause_map.lua, line 934: local widest_element_h, cash_width = find_widest_text_element(data)` `pause_map.lua, line 943: local widest_element_h, cash_value_width = find_widest_text_element(data)` `vdo_cell_filter.lua, line 249: local widest_filter_element_h, filter_element_width = find_widest_text_element(data)`
`finish`	true		2 `hud_msg.lua, line 1571: Hud_msg_back_things[ Hud_msg_back_current.q_type ].finish()` `hud_msg.lua, line 1612: Hud_msg_back_things[ Hud_msg_back_current.q_type ].finish()`
`finished_outro_selection`	true		3 `cte_outro_ending.lua, line 548: finished_outro_selection()` `cte_outro_ending.lua, line 599: finished_outro_selection()` `cte_outro_ending.lua, line 754: finished_outro_selection();`
`flight_tutorial_stamina`	true		10 `mflighttutorial.lua, line 956: flight_tutorial_stamina(false, LOCAL_PLAYER)` `mflighttutorial.lua, line 958: flight_tutorial_stamina(false, REMOTE_PLAYER)` `mflighttutorial.lua, line 1035: flight_tutorial_stamina(true, LOCAL_PLAYER)` `mflighttutorial.lua, line 1037: flight_tutorial_stamina(true, REMOTE_PLAYER)` `mflighttutorial.lua, line 1086: flight_tutorial_stamina(true, LOCAL_PLAYER)` `mflighttutorial.lua, line 1088: flight_tutorial_stamina(true, REMOTE_PLAYER)` `mflighttutorial.lua, line 1255: flight_tutorial_stamina(false, LOCAL_PLAYER)` `mflighttutorial.lua, line 1257: flight_tutorial_stamina(false, REMOTE_PLAYER)` `mflighttutorial.lua, line 3070: flight_tutorial_stamina(false, LOCAL_PLAYER)` `mflighttutorial.lua, line 3072: flight_tutorial_stamina(false, REMOTE_PLAYER)`
`fn`	true		1 `game_lib.lua, line 1892: fn(np)`
`follower_make_independent`	true		2 `game_lib.lua, line 4978: follower_make_independent(seat.character, npc_is_independent)` `game_lib.lua, line 5124: follower_make_independent(seat.character, npc_is_independent)`
`follower_remain_in_car`	true		3 `game_lib.lua, line 4980: follower_remain_in_car(seat.character, npc_stay_in_car)` `game_lib.lua, line 5127: follower_remain_in_car(seat.character, npc_stay_in_car)` `mintrobb.lua, line 1534: follower_remain_in_car(mIntroBB_homie.blackbeard, true)`
`follower_set_can_abandon`	true		7 `mintro.lua, line 1361: follower_set_can_abandon( mIntro_homie.kinzie, false )` `mintrotwins.lua, line 1032: follower_set_can_abandon( mIntroTwins_homie.kiki, true )` `mintrotwins.lua, line 1045: follower_set_can_abandon( mIntroTwins_homie.viola, true )` `mintrovlad.lua, line 1052: follower_set_can_abandon( mIntroVlad_homie.vlad, false )` `msatan.lua, line 381: follower_set_can_abandon( mSatan_homie.kinzie, false )` `msatan.lua, line 390: follower_set_can_abandon( mSatan_homie.johnny, false )` `msatan.lua, line 459: follower_set_can_abandon( mSatan_homie.kinzie, false )`
`force_fire_do`	true		1 `game_lib.lua, line 1577: if (force_fire_do(name, fire_at_navpoint, fire_once)) then`
`force_fire_target_do`	true		1 `game_lib.lua, line 1591: if (force_fire_target_do(name, fire_at_target, fire_once)) then`
`force_flap_player`	true		2 `mflighttutorial.lua, line 1889: force_flap_player(player_name)` `mflighttutorial.lua, line 1901: force_flap_player(player_name)`
`force_spawn_contacts`	true		4 `mintrobb.lua, line 978: force_spawn_contacts()` `mintroshakes.lua, line 953: force_spawn_contacts()` `mintrotwins.lua, line 946: force_spawn_contacts()` `mintrovlad.lua, line 1164: force_spawn_contacts()`
`force_throw_char_do`	true		1 `game_lib.lua, line 1619: if (force_throw_char_do(name, target)) then`
`force_throw_do`	true		1 `game_lib.lua, line 1606: if (force_throw_do(name, target_navp, throw_pitch, throw_speed)) then`
`format_cash`	true	1 `vint_lib.lua, line 589`	27 `building_purchase.lua, line 123: local insert_values = { [0] = building_name, [1] = format_cash(store_cost) }` `building_purchase.lua, line 173: values = { [0] = format_cash(Building_purchasing_data.profit)}` `cmp_common.lua, line 1424: local values_3 = {[0] = format_cash(district_cash_per_day)}` `hud_diversion.lua, line 415: local insert = { [0] = "{GAME_CASH}" .. format_cash(floor(Hud_diversions[index].cash)) }` `hud_diversion.lua, line 641: local insert = { [0] = format_cash(floor(Hud_challenge_data.cur_val)),` `hud_diversion.lua, line 642: [1] = format_cash(floor(Hud_challenge_data.max_val)), [2] = Hud_challenge_data.val_units }` `hud_mayhem.lua, line 525: amt = symbol .. "{GAME_CASH}" .. format_cash(floor(display_value))` `hud_mayhem.lua, line 528: amt = symbol .. format_cash(floor(display_value)) .. " {ACT_FRAUD_SCORE_UNIT}"` `store_stronghold.lua, line 414: local insert = { [0] = data.label, [1] = format_cash(data.price) }` `store_vehicle.lua, line 317: local insert = { [0] = menu_data.label, [1] = format_cash(menu_data.price) }` `store_vehicle.lua, line 1038: local insert = { [0] = format_cash(price) }` `store_vehicle.lua, line 1234: local insert = { [0] = Color_grid_data[idx].label, [1] = format_cash(Store_vehicle_color_price) }` `store_vehicle.lua, line 1407: local insert = { [0] = Color_grid_data[1].label, [1] = format_cash(Store_vehicle_color_price) }` `store_vehicle.lua, line 1778: local insert = { [0] = Color_grid_data[idx].label, [1] = format_cash(Store_vehicle_color_price) }` `store_vehicle.lua, line 1903: local insert = { [0] = Color_grid_data[idx].label, [1] = format_cash(Store_vehicle_color_price) }` `store_weapon.lua, line 2065: local insert = { [0] = menu_data.label, [1] = format_cash(menu_data.price) }` `store_weapon.lua, line 2463: local insert = { [0] = weapon_data.label_crc, [1] = format_cash(weapon_data.price) }` `store_weapon.lua, line 3341: local insert = { [0] = format_cash(Notoriety_level_clear_cost_data[player_notoriety_level].cost) }` `vdo_gsi_info.lua, line 71: info_value = "{GAME_CASH}" .. format_cash(tonumber(info_value))` `vdo_gsi_xy.lua, line 88: x_value_text = format_cash(x_value) .. " {ACT_FRAUD_SCORE_UNIT}"` `vdo_gsi_xy.lua, line 89: y_value_text = format_cash(y_value) .. " {ACT_FRAUD_SCORE_UNIT}"` `vdo_gsi_xy.lua, line 91: x_value_text = "{GAME_CASH}" .. format_cash(x_value)` `vdo_gsi_xy.lua, line 92: y_value_text = "{GAME_CASH}" .. format_cash(y_value)` `vdo_gsi_xy.lua, line 94: x_value_text = format_cash(x_value)` `vdo_gsi_xy.lua, line 95: y_value_text = format_cash(y_value)` `vdo_store_header.lua, line 219: insert_values = { [0] = format_cash(price) }` `vint_bugs.lua, line 247: local formated_value = format_cash(value)`
`format_cash_add_padding`	true	1 `vint_lib.lua, line 593`
`format_clock`	true	1 `vint_lib.lua, line 630`	2 `hud_btnmash.lua, line 429: local time_formatted = format_clock(timer_value, true)` `vint_bugs.lua, line 284: local formated_value = format_clock(value)`
`format_distance`	true	1 `vint_lib.lua, line 603`	2 `hud_diversion.lua, line 218: local insert = { [0] = message_two, [1] = format_distance(cur_value) }` `hud_mayhem.lua, line 516: amt = symbol .. format_distance(display_value)`
`format_time`	true	1 `vint_lib.lua, line 684`	9 `cmp_common.lua, line 1741: --format_time(time_in_seconds, show_ms, show_units)` `countdown.lua, line 166: insert_values = { [0] = "[format][color:#B08522]", [1] = format_time(gold_time, false, false, false, true)}` `countdown.lua, line 175: insert_values = { [0] = "[format][color:#909192]", [1] = format_time(silver_time, false, false, false, true)}` `countdown.lua, line 184: insert_values = { [0] = "[format][color:#9E6F54]", [1] = format_time(bronze_time, false, false, false, true)}` `hud_diversion.lua, line 247: local insert = { [0] = message_two, [1] = format_time(cur_value_floor / 1000, false, true) }` `hud_mayhem.lua, line 519: amt = symbol .. format_time(display_value, true, true)` `hud_mayhem.lua, line 522: amt = symbol .. format_time(display_value, false, true)` `main_menu_top.lua, line 677: local eta_text = format_time(chunk_eta, false, false, false, true)` `vint_lib.lua, line 673: -- Function format_time()`
`func_name`	true		2 `vdo_scrollbox.lua, line 272: object.func_name(object.object)` `vdo_scrollbox.lua, line 370: object.func_name(object.object)`

Saints Row 2 Function Reference

Global functions