Saints Row 2 Function Reference

Local functions

These functions are defined within the patch lua files. They are assumed to be only available within the file that defines them or by including the file in another script.

Some of these functions may essentially be global since their files are always loaded; which files (and which functions) haven't been determined yet.

Function name	Global	Defined in	Examples from patch (click blue number to expand)
`factories_init`	false	1 `factories.lua, line 6`	1 `sr2_city.lua, line 43: factories_init()`
`factories_main`	false	1 `factories.lua, line 9`
`fade_in_block`	false	1 `ug_lib.lua, line 1032`	12 `bh03.lua, line 1456: fade_in_block()` `bh06.lua, line 409: fade_in_block()` `em01.lua, line 1757: fade_in_block()` `rn02.lua, line 387: fade_in_block()` `rn04.lua, line 493: fade_in_block()` `rn07.lua, line 904: fade_in_block()` `rn09.lua, line 250: fade_in_block()` `ss09.lua, line 546: fade_in_block()` `ss10.lua, line 961: fade_in_block()` `tss01.lua, line 4275: fade_in_block()` `ug_lib.lua, line 996: fade_in_block()` `ug_lib.lua, line 1826: fade_in_block()`
`fade_out_block`	false	1 `ug_lib.lua, line 1040`	15 `bh03.lua, line 1271: fade_out_block()` `bh06.lua, line 338: fade_out_block()` `rn02.lua, line 362: fade_out_block()` `rn04.lua, line 475: fade_out_block()` `rn06.lua, line 177: fade_out_block()` `rn07.lua, line 826: fade_out_block()` `rn07.lua, line 893: fade_out_block()` `rn07.lua, line 941: fade_out_block()` `rn07.lua, line 974: fade_out_block()` `rn08.lua, line 1431: fade_out_block()` `rn09.lua, line 398: fade_out_block()` `sh_rn_stripclub.lua, line 355: fade_out_block()` `tss01.lua, line 4268: fade_out_block()` `ug_lib.lua, line 960: fade_out_block()` `ug_lib.lua, line 1813: fade_out_block()`
`failure_brotherhood_notoriety`	false	1 `bh01.lua, line 789`	1 `bh01.lua, line 410: failure_brotherhood_notoriety()`
`failure_carlos_death`	false	1 `bh01.lua, line 781`
`failure_carlos_dismiss`	false	1 `bh01.lua, line 785`
`failure_donnie_dismiss`	false	1 `bh02.lua, line 1080`
`failure_maero_death`	false	1 `bh01.lua, line 773`
`failure_maero_dismiss`	false	1 `bh01.lua, line 777`
`failure_vehicle_death`	false	1 `bh02.lua, line 1085`	3 `bh02.lua, line 934: failure_vehicle_death(target2)` `bh02.lua, line 946: failure_vehicle_death(target1)` `bh02.lua, line 984: failure_vehicle_death(target1)`
`failure_vehicle_donnie_death`	false	1 `bh02.lua, line 1090`
`find_score_percent`	false	1 `hud_multi_prototype.lua, line 80`	4 `hud_multi_prototype.lua, line 151: percent = find_score_percent(friend_score, Score_bars_info.score_limit)` `hud_multi_prototype.lua, line 155: percent = find_score_percent(foe_score, Score_bars_info.score_limit)` `hud_multi_prototype.lua, line 165: percent = find_score_percent(friend_score, highest_score)` `hud_multi_prototype.lua, line 169: percent = find_score_percent(foe_score, highest_score)`
`find_server_control_create_scroll_bar`	false	1 `main_menu.lua, line 2521`	1 `main_menu.lua, line 2672: find_server_control_create_scroll_bar(menu_label, menu_data)`
`find_server_control_get_height`	false	1 `main_menu.lua, line 1334`
`find_server_control_get_width`	false	1 `main_menu.lua, line 1330`
`find_server_control_nav_down`	false	1 `main_menu.lua, line 2706`
`find_server_control_nav_up`	false	1 `main_menu.lua, line 2697`
`find_server_control_release`	false	1 `main_menu.lua, line 2454`
`find_server_control_resize_select_bar`	false	1 `main_menu.lua, line 2475`	1 `main_menu.lua, line 2694: find_server_control_resize_select_bar()`
`find_server_control_set_bar_height`	false	1 `main_menu.lua, line 2586`	1 `main_menu.lua, line 2552: find_server_control_set_bar_height(menu_data, 400)`
`find_server_control_set_thumb_pos_scroll_bar`	false	1 `main_menu.lua, line 2608`	1 `main_menu.lua, line 2575: find_server_control_set_thumb_pos_scroll_bar(menu_data, first_vis_item/(num_items - FIND_SERVER_MAX_ITEMS))--pause_menu_playlist_set_thumb_pos_scroll_bar(active_pane, first_vis_item / active_pane.num_items)`
`find_server_control_set_thumb_size_scroll_bar`	false	1 `main_menu.lua, line 2596`	1 `main_menu.lua, line 2553: find_server_control_set_thumb_size_scroll_bar(menu_data, thumb_size)`
`find_server_control_show`	false	1 `main_menu.lua, line 2392`
`find_server_control_show_scroll_bar`	false	1 `main_menu.lua, line 2581`	1 `main_menu.lua, line 2551: find_server_control_show_scroll_bar(menu_data)`
`find_server_control_update`	false	1 `main_menu.lua, line 2638`	5 `main_menu.lua, line 1296: find_server_control_update(Menu_option_labels[0], Menu_active[0]);` `main_menu.lua, line 2445: find_server_control_update(menu_label, menu_data)` `main_menu.lua, line 2450: find_server_control_update(Menu_option_labels[0], Menu_active[0] )` `main_menu.lua, line 2703: find_server_control_update(menu_label, menu_data)` `main_menu.lua, line 2712: find_server_control_update(menu_label, menu_data)`
`find_server_control_update_highlight`	false	1 `main_menu.lua, line 2508`	1 `main_menu.lua, line 2693: find_server_control_update_highlight(menu_label, menu_data)`
`find_server_control_update_scroll_bar`	false	1 `main_menu.lua, line 2562`	1 `main_menu.lua, line 2673: menu_label.first_vis_item = find_server_control_update_scroll_bar(menu_label, menu_data)`
`find_server_control_update_scroll_bar_scroll_bar`	false	1 `main_menu.lua, line 2621`	3 `main_menu.lua, line 2593: find_server_control_update_scroll_bar_scroll_bar(menu_data, scroll_data)` `main_menu.lua, line 2605: find_server_control_update_scroll_bar_scroll_bar(menu_data, scroll_data)` `main_menu.lua, line 2616: find_server_control_update_scroll_bar_scroll_bar(menu_data, scroll_data)`
`fine_tuning_menu_show`	false	1 `pcr01.lua, line 2016`
`finish_new_line`	false	1 `tutorial_subtitles.lua, line 70`
`fof_scores_change`	false	1 `hud_multi_prototype.lua, line 143`
`force_fire`	false	1 `ug_lib.lua, line 1054`	10 `em01.lua, line 2427: force_fire("em01_$c054", "em01_$n132", true)` `em01.lua, line 2432: force_fire("em01_$c055", "em01_$n133", true)` `em01.lua, line 2437: force_fire("em01_$c056", "em01_$n134", true)` `ep01.lua, line 1654: force_fire(goon, NAVPOINT_PIERCE_LOCATION, true)` `ep01.lua, line 1673: force_fire(goon, NAVPOINT_PIERCE_LOCATION, true)` `rn02.lua, line 1599: force_fire(npc, target, true)` `rn04.lua, line 1914: force_fire(npc, target, true)` `rn07.lua, line 1140: force_fire(CHARACTER_RPG_GUY, VEHICLE_AMBULANCE, true)` `rn10.lua, line 1000: force_fire(ronin, objective_target, true)` `ss04.lua, line 1171: force_fire( STOCKS_OFFICE_LIEUTENANT, window_name, fire_once )`
`force_fire_object_position`	false	1 `ug_lib.lua, line 1068`	1 `bh09.lua, line 531: force_fire_object_position( member_name, attack_heli, false )`
`force_fire_target`	false	1 `ug_lib.lua, line 1082`	1 `bh10.lua, line 535: force_fire_target(CHAR_FIRST_ROCKETEER, CHAR_FIRST_ROCKETEE, false)`
`force_throw`	false	1 `ug_lib.lua, line 1097`	3 `bh01.lua, line 355: force_throw(CHAR_FLASHBANG_COP, NAVPOINT_FLASHBANG_1, 23)` `rn10.lua, line 988: force_throw(ronin, objective_target)` `sh_tss_caverns.lua, line 339: force_throw("sh_tss_caverns_$c036", "sh_tss_caverns_$nattack1 (0)", 45, 4)`
`force_throw_char`	false	1 `ug_lib.lua, line 1109`	11 `sh_ss_student_union.lua, line 116: force_throw_char("sh_ss_student_union_$c044", "#PLAYER#", 0)` `sh_ss_student_union.lua, line 126: force_throw_char("sh_ss_student_union_$c023", "#PLAYER#", 0)` `sh_tss_caverns.lua, line 173: force_throw_char("sh_tss_caverns_$c002 (0)","#PLAYER#", 45, 4)` `ss11.lua, line 1387: force_throw_char( GENERALS_RIDE_DRIVER_NAME, target )` `tss02.lua, line 1217: force_throw_char("tss02_$cop27", CHARACTER_GAT)` `tss02.lua, line 1221: force_throw_char("tss02_$cop27", player)` `tss02.lua, line 1229: force_throw_char("tss02_$cop29", LOCAL_PLAYER)` `tss02.lua, line 1233: force_throw_char("tss02_$cop29", player)` `tss03.lua, line 586: force_throw_char(human, LOCAL_PLAYER)` `tss03.lua, line 596: force_throw_char(human, REMOTE_PLAYER)` `tss03_demo.lua, line 552: force_throw_char(human, LOCAL_PLAYER)`
`format_cash`	false	1 `vint_lib.lua, line 265`	35 `building_purchase.lua, line 79: local insert_values = { [0] = building_name, [1] = format_cash(store_cost) }` `cdl01.lua, line 83: price = "$"..format_cash(car_item.price)` `cdl01.lua, line 114: price = "$"..format_cash(car_item.price)` `crib_cust.lua, line 191: local insert = { [0] = Crib_cust_level_menu.header_label_str, [1] = format_cash(menu_data.price) }` `hud_gsi.lua, line 1335: info_value = "$" .. format_cash(tonumber(info_value))` `hud_gsi.lua, line 1664: x_value_text = "$" .. format_cash(x_value)` `hud_gsi.lua, line 1665: y_value_text = "$" .. format_cash(y_value)` `hud_mayhem.lua, line 118: local cash = format_cash(multiplier)` `liquor_store.lua, line 234: local price = format_cash(swatches[Liquor_store_current_selection].price)` `liquor_store.lua, line 246: local price = format_cash(swatches[Liquor_store_current_selection].price)` `menu_base.lua, line 4203: vint_set_property(vint_object_find("cash_text", Style_cluster_cash_style_grp_h), "text_tag", "$"..format_cash(Style_cluster_displayed_cash))` `menu_base.lua, line 4209: vint_set_property(vint_object_find("cash_text", Style_cluster_cash_style_grp_h), "text_tag", "$"..format_cash(Style_cluster_displayed_cash))` `mp_completion.lua, line 748: cash_awarded = "$" .. format_cash(cash_awarded)` `mp_completion.lua, line 820: current.score = format_cash(score)` `mp_completion.lua, line 826: current.kills = format_cash(kills)` `mp_completion.lua, line 827: current.deaths = format_cash(deaths)` `mp_completion.lua, line 830: current.suicides = format_cash(suicides)` `mp_hud.lua, line 395: local cash_str = "$" .. format_cash(friendly_cash)` `mp_hud.lua, line 403: local cash_str = "$" .. format_cash(opponent_cash)` `mp_leaderboards.lua, line 626: return "$" .. format_cash(value)` `mp_leaderboards.lua, line 631: return format_cash(value)` `mp_server_browser.lua, line 639: return "$" .. format_cash(value)` `mp_server_browser.lua, line 644: return format_cash(value)` `music_store.lua, line 463: -- local body = "Do you wish to purchase " .. menu_data.artist_name .. " - " .. menu_data.track_name .. " for " .. format_cash(menu_data.price) .. "?"` `music_store.lua, line 464: local insertion_values = { [0] = menu_data.artist_name, [1] = menu_data.track_name, [2] = format_cash(menu_data.price) }` `pause_menu.lua, line 874: Pause_info_diversions_stat_menu[idx].value = "$" .. format_cash(data)` `pause_menu.lua, line 904: Pause_info_diversions_stat_sub_menu[idx].value = "$" .. format_cash(data)` `pause_menu.lua, line 1068: specific_label_top = "CHOP_SHOP_CASH", specific_text_top = format_cash(cash),` `vehicle_cust.lua, line 721: -- local body = "Do you wish to purchase " .. menu_data.label .. " for $" .. format_cash(menu_data.price) .. "?"` `vehicle_cust.lua, line 722: local insert = { [0] = menu_data.label, [1] = format_cash(menu_data.price) }` `vehicle_cust.lua, line 1052: -- local body = "Do you wish to purchase " .. Vehicle_cust_color_swatch_to_purchase.label .. " for $" .. format_cash(Vehicle_cust_color_swatch_to_purchase.price) .. "?"` `vehicle_cust.lua, line 1053: local insert = { [0] = Vehicle_cust_color_swatch_to_purchase.label, [1] = format_cash(Vehicle_cust_color_swatch_to_purchase.price) }` `vehicle_cust.lua, line 1535: local insert = { [0] = format_cash(Vehicle_cust_wheel_price) }` `weapon_store.lua, line 612: local insert = { [0] = swatches[idx].label_str, [1] = format_cash(swatches[idx].price) }` `weapon_store.lua, line 633: local insert = { [0] = swatches[idx].label_str, [1] = format_cash(swatches[idx].price) }`
`format_cash_add_padding`	false	1 `vint_lib.lua, line 269`
`format_clock`	false	1 `vint_lib.lua, line 279`
`format_time`	false	1 `pause_menu.lua, line 147`	2 `pause_menu.lua, line 878: Pause_info_diversions_stat_menu[idx].value = format_time(data)` `pause_menu.lua, line 908: Pause_info_diversions_stat_sub_menu[idx].value = format_time(data)`
`fr_checkAI_start`	false	1 `fr_checkAI.lua, line 12`
`fr_checkAI_success`	false	1 `fr_checkAI.lua, line 69`
`fr_checkAP_start`	false	1 `fr_checkAP.lua, line 12`
`fr_checkAP_success`	false	1 `fr_checkAP.lua, line 69`
`fr_checkAR_start`	false	1 `fr_checkAR.lua, line 12`
`fr_checkAR_success`	false	1 `fr_checkAR.lua, line 69`
`fr_checkBA_start`	false	1 `fr_checkBA.lua, line 12`
`fr_checkBA_success`	false	1 `fr_checkBA.lua, line 69`
`fr_checkCT_start`	false	1 `fr_checkCT.lua, line 12`
`fr_checkCT_success`	false	1 `fr_checkCT.lua, line 69`
`fr_checkDK_start`	false	1 `fr_checkDK.lua, line 12`
`fr_checkDK_success`	false	1 `fr_checkDK.lua, line 69`
`fr_checkDT_start`	false	1 `fr_checkDT.lua, line 12`
`fr_checkDT_success`	false	1 `fr_checkDT.lua, line 69`
`fr_checkFA_start`	false	1 `fr_checkFA.lua, line 12`
`fr_checkFA_success`	false	1 `fr_checkFA.lua, line 69`
`fr_checkHE_start`	false	1 `fr_checkHE.lua, line 12`
`fr_checkHE_success`	false	1 `fr_checkHE.lua, line 69`
`fr_checkMA_start`	false	1 `fr_checkMA.lua, line 12`
`fr_checkMA_success`	false	1 `fr_checkMA.lua, line 69`
`fr_checkMU_start`	false	1 `fr_checkMU.lua, line 12`
`fr_checkMU_success`	false	1 `fr_checkMU.lua, line 69`
`fr_checkPR_start`	false	1 `fr_checkPR.lua, line 12`
`fr_checkPR_success`	false	1 `fr_checkPR.lua, line 69`
`fr_checkSE_start`	false	1 `fr_checkSE.lua, line 12`
`fr_checkSE_success`	false	1 `fr_checkSE.lua, line 69`
`fr_checkSR_start`	false	1 `fr_checkSR.lua, line 12`
`fr_checkSR_success`	false	1 `fr_checkSR.lua, line 69`
`fr_checkSU_start`	false	1 `fr_checkSU.lua, line 12`
`fr_checkSU_success`	false	1 `fr_checkSU.lua, line 69`
`fr_checkTY_start`	false	1 `fr_checkTY.lua, line 12`
`fr_checkTY_success`	false	1 `fr_checkTY.lua, line 69`