lui_shared.gsc File Reference

Go to the source code of this file.

Functions
function	__init__ ()
function private	_one_screen_fade_per_network_frame (s_menu)
function private	_play_movie_for_player (str_movie, str_type, show_black_screen, b_looping, str_key)
function private	_play_movie_for_player_with_timeout (str_movie, str_type, timeout, show_black_screen, b_looping, str_key)
function private	_screen_close_menu ()
function private	_screen_fade (n_time, n_target_alpha, n_start_alpha, v_color, b_force_close_menu, str_menu_id="default")
function	open_generic_script_dialog (title, description)
function	open_script_dialog (dialog_name)
function	play_animation (menu, str_anim)
function	play_movie (str_movie, str_type, show_black_screen=false, b_looping=false, str_key="")
function	play_movie_with_timeout (str_movie, str_type, timeout, show_black_screen=false, b_looping=false, str_key="")
function	prime_movie (str_movie, b_looping=false, str_key="")
function private	refresh_menu_values ()
function	screen_close_menu ()
function	screen_fade (n_time, n_target_alpha=1, n_start_alpha=0, v_color, b_force_close_menu=false, str_menu_id)
function	screen_fade_in (n_time, v_color, str_menu_id)
function	screen_fade_out (n_time, v_color, str_menu_id)
function	screen_flash (n_fadein_time, n_hold_time, n_fadeout_time, n_target_alpha=1, v_color, b_force_close_menu=false)
function	set_color (menu, color)
function	set_global (str_menu_id, str_variable_id, value)
function	set_value_for_player (str_menu_id, str_variable_id, value)
function	timer (n_time, str_endon, x, y, height)

Function Documentation

__init__()

function __init__

(

)

Definition at line 56 of file lui_shared.gsc.

References on_spawned(), and refresh_menu_values().

_one_screen_fade_per_network_frame()

function private _one_screen_fade_per_network_frame

(

s_menu

)

Definition at line 639 of file lui_shared.gsc.

References wait_network_frame().

Referenced by _screen_fade().

_play_movie_for_player()

function private _play_movie_for_player	(	str_movie	,
		str_type	,
		show_black_screen	,
		b_looping	,
		str_key
	)

Definition at line 273 of file lui_shared.gsc.

Referenced by play_movie().

_play_movie_for_player_with_timeout()

function private _play_movie_for_player_with_timeout	(	str_movie	,
		str_type	,
		timeout	,
		show_black_screen	,
		b_looping	,
		str_key
	)

Definition at line 375 of file lui_shared.gsc.

References timeout().

Referenced by play_movie_with_timeout().

_screen_close_menu()

function private _screen_close_menu

(

)

Definition at line 537 of file lui_shared.gsc.

Referenced by screen_close_menu().

_screen_fade()

function private _screen_fade	(	n_time	,
		n_target_alpha	,
		n_start_alpha	,
		v_color	,
		b_force_close_menu	,
		str_menu_id	= "default"
	)

Definition at line 553 of file lui_shared.gsc.

References _one_screen_fade_per_network_frame(), DEFAULT, and set_color().

Referenced by screen_fade(), and screen_flash().

open_generic_script_dialog()

function open_generic_script_dialog	(	title	,
		description
	)

Description:
"Function Name: open_generic_script_dialog( title, description )"
"Summary: Opens up a generic script dialog." "CallOn: player"
"Mandatory Argument(s): title: the precached title of the popup."
"Mandatory Argument(s): description: the precached description of the popup"
"Example:player lui::open_generic_script_dialog( &"MENU_GENERIC_TITLE", &"MENU_GENERIC_DESCRIPTION" );"

Definition at line 658 of file lui_shared.gsc.

open_script_dialog()

function open_script_dialog

(

dialog_name

)

Description:
"Function Name: open_script_dialog( dialog_name )"
"Summary: Opens up a specific script dialog." "CallOn: player"
"Mandatory Argument(s): dialog_name: the precached menu_name of the overlay."
"Example:player lui::open_script_dialog( "MyCustomDialog" );"

Definition at line 683 of file lui_shared.gsc.

play_animation()

function play_animation	(	menu	,
		str_anim
	)

Description:
"Function Name: play_animation( menu, str_anim )"
"Summary: Play an animation clip on a lui menu (create the animation in the UI Editor)." "CallOn: N/A"
"Mandatory Argument(s): menu : the menu."
"Mandatory Argument(s): str_anim : the clip name."
"Example:play_animation( menu, "on_focus_cool_anim" );"

Definition at line 93 of file lui_shared.gsc.

Referenced by hide_hint_text(), and show_hint_text().

play_movie()

function play_movie	(	str_movie	,
		str_type	,
		show_black_screen	= false,
		b_looping	= false,
		str_key	= ""
	)

Description:
"Function Name: play_movie( str_movie, str_type )"
"Summary: Play a movie. Currently supports fullscreen or PIP formats." "CallOn: player or level (for all players)"
"Mandatory Argument(s): str_movie: the movie name."
"Mandatory Argument(s): str_type: "pip", "fullscreen", "fullscreen_additive" (defaults to fullscreen)."
"Optional Argument(s): show_black_screen: this shows a black screen behind the movie till the movie finishes streaming and starts playing"
"Example:level lui::play_movie( "cairotroops", "pip" );"

Definition at line 220 of file lui_shared.gsc.

References _play_movie_for_player(), clear(), set(), show_hud(), and wait_till().

Referenced by endGame().

play_movie_with_timeout()

function play_movie_with_timeout	(	str_movie	,
		str_type	,
		timeout	,
		show_black_screen	= false,
		b_looping	= false,
		str_key	= ""
	)

Description:
"Function Name: play_movie_with_timeout( str_movie, str_type, show_black_screen = false, b_looping = false, timeout )"
"Summary: Play a movie and times out if the duration is exceeded. Currently supports fullscreen or PIP formats." "CallOn: level (for all players)"
"Mandatory Argument(s): str_movie: the movie name."
"Mandatory Argument(s): str_type: "pip", "fullscreen", "fullscreen_additive" (defaults to fullscreen)."
"Mandatory Argument(s): timeout: the duration after which the movie will automatically be ended."
"Optional Argument(s): show_black_screen: this shows a black screen behind the movie till the movie finishes streaming and starts playing"
"Optional Argument(s): b_looping: loops the movie"
"Example:level lui::play_movie( "cairotroops", "pip" );"

Definition at line 341 of file lui_shared.gsc.

References _play_movie_for_player_with_timeout(), clear(), set(), show_hud(), timeout(), and wait_till().

prime_movie()

function prime_movie	(	str_movie	,
		b_looping	= false,
		str_key	= ""
	)

Description:
"Function Name: prime_movie( str_movie )"
"Summary: Start priming a movie, so we dont get any hitches and its ready when we start playing it." "CallOn: player or level (for all players)"
"Mandatory Argument(s): str_movie: the movie name."
"Example:level lui::prime_movie( "cairotroops" );"

Definition at line 195 of file lui_shared.gsc.

refresh_menu_values()

function private refresh_menu_values

(

)

Definition at line 63 of file lui_shared.gsc.

References set_value_for_player().

Referenced by __init__().

screen_close_menu()

function screen_close_menu

(

)

Description:
"Function Name: screen_close_menu()"
"Summary: foce closes the menu regardless of the current alpha value" "CallOn: player or level (for all players)"

Definition at line 522 of file lui_shared.gsc.

References _screen_close_menu().

screen_fade()

function screen_fade	(	n_time	,
		n_target_alpha	= 1,
		n_start_alpha	= 0,
		v_color	,
		b_force_close_menu	= false,
		str_menu_id
	)

Description:
"Function Name: screen_fade( <n_time>, [n_target_alpha = 1], [v_color = "black"], [b_force_close_menu = false], [str_menu_id] )"
"Summary: fade the screen in/out" "CallOn: player or level (for all players)"
"Mandatory Argument(s): n_time: fade time"
"Optional Argument(s): n_target_alpha: end alpha (defaults to 1)"
"Optional Argument(s): v_color: the fade color (defaults to black or (0,0,0) )."
"Optional Argument(s): b_force_close_menu: close the fade menu when done even if the alpha isn't 0."
"Optional Argument(s): str_menu_id: unique menu ID instead of the default black and white ones."
"Example:level lui::screen_fade( 3, .5, "black" ); // fade to .5 alpha over 3 sec"

Definition at line 469 of file lui_shared.gsc.

References _screen_fade().

Referenced by screen_fade_in(), and screen_fade_out().

screen_fade_in()

function screen_fade_in	(	n_time	,
		v_color	,
		str_menu_id
	)

Description:
"Function Name: screen_fade_in( <n_time>, [v_color], [str_menu_id] )"
"Summary: fade the screen in" "CallOn: player or level (for all players)"
"Mandatory Argument(s): n_time: fade time"
"Optional Argument(s): v_color: the fade color (defaults to black or (0,0,0) )."
"Optional Argument(s): str_menu_id: unique menu ID instead of the default black and white ones."
"Example:level lui::screen_fade_in( 3 ); // fade in over 3 sec"

Definition at line 510 of file lui_shared.gsc.

References screen_fade().

screen_fade_out()

function screen_fade_out	(	n_time	,
		v_color	,
		str_menu_id
	)

Description:
"Function Name: screen_fade_out( <n_time>, [v_color], [str_menu_id] )"
"Summary: fade the screen out" "CallOn: player or level (for all players)"
"Mandatory Argument(s): n_time: fade time"
"Optional Argument(s): v_color: "white" or "black" (defaults to black)."
"Optional Argument(s): str_menu_id: unique menu ID instead of the default black and white ones."
"Example:level lui::screen_fade_out( 3 ); // fade out over 3 sec"

Definition at line 494 of file lui_shared.gsc.

References screen_fade().

screen_flash()

function screen_flash	(	n_fadein_time	,
		n_hold_time	,
		n_fadeout_time	,
		n_target_alpha	= 1,
		v_color	,
		b_force_close_menu	= false
	)

Description:
"Function Name: screen_flash( <n_fadein_time>, <n_hold_time>, <n_fadeout_time>, [n_target_alpha = 1], [v_color = "black"], [b_force_close_menu = false] )"
"Summary: fade the screen to the given color, hold for a moment, then fade back in" "CallOn: player or level (for all players)"
"Mandatory Argument(s): n_time: fade time"
"Mandatory Argument(s): n_hold_time: hold time (at target alpha)"
"Mandatory Argument(s): n_fadeout_time: fade back out time"
"Optional Argument(s): n_target_alpha: end alpha (defaults to 1)"
"Optional Argument(s): v_color: the fade color (defaults to black or (0,0,0) )."
"Optional Argument(s): b_force_close_menu: close the fade menu when done even if the alpha isn't 0."
"Example:level lui::screen_flash( 0.2, 0.1, .5, 1.0, "white" ); // fade to 1.0 alpha white over 0.2s, hold for 0.5s, and fade back in over 1.0s"

Definition at line 438 of file lui_shared.gsc.

References _screen_fade().

Referenced by nuke_flash().

set_color()

function set_color	(	menu	,
		color
	)

Definition at line 109 of file lui_shared.gsc.

Referenced by _screen_fade().

set_global()

function set_global	(	str_menu_id	,
		str_variable_id	,
		value
	)

Definition at line 133 of file lui_shared.gsc.

References DEFAULT, and set_value_for_player().

set_value_for_player()

function set_value_for_player	(	str_menu_id	,
		str_variable_id	,
		value
	)

Definition at line 122 of file lui_shared.gsc.

References DEFAULT.

Referenced by refresh_menu_values(), and set_global().

timer()

function timer	(	n_time	,
		str_endon	,
		x	,
		y	,
		height
	)

Description:
"Function Name: timer( n_time, str_endon, x, y, height )"
"Summary: Throw up a quick debug/blockout timer. Returns when the time is up." "CallOn: player"
"Mandatory Argument(s): n_time : the amount of time."
"Optional Argument(s): str_endon: kill notify."
"Optional Argument(s): x: the x position of the UI."
"Optional Argument(s): y: the y position of the UI."
"Optional Argument(s): height: the size of the UI."
"Example:level.players[0] timer( 10 );"

Definition at line 163 of file lui_shared.gsc.

References DEFAULT, SCREEN_WIDTH, and waittill_notify_or_timeout().

Referenced by _burnBody(), _burnCorpse(), _hint_print_wait(), ambient_flak_think(), damageInFireArea(), damageInPoisonArea(), do_player_general_vox(), draw_debug_line(), drawStringTime(), electric_perks_dialog(), end_on_timer(), endOnTimer(), fontScaler(), general_vox_timer(), ignore_triggers(), perk_start_up(), play_door_dialog(), playerInvul(), print3dtime(), print_resume_speed(), revive_do_revive(), sawEnemyMove(), showDebugProc(), sndStopBurnLoop(), start_perk_bottle_cycling(), suicide_do_suicide(), timer_actual(), trap_dialog(), wait_for_killanimscript_or_time(), wait_till_stable(), waittill_notify_or_timeout(), and zombie_faller_watch_player().