lui_shared.csc File Reference

Go to the source code of this file.

Functions
function	__init__ ()
function private	_screen_close_menu ()
function private	_screen_fade (n_time, n_target_alpha, n_start_alpha, v_color, b_force_close_menu)
function	addMenuExploders (menu_name, localClientNum, exploder)
function	client_menus (localClientNum)
function	createCameraMenu (menu_name, localClientNum, target_name, xcam, sub_xcam, xcam_frame=undefined, custom_open_fn=undefined, custom_close_fn=undefined)
function	createCustomCameraMenu (menu_name, localClientNum, camera_function, has_state, custom_open_fn=undefined, custom_close_fn=undefined)
function	createCustomExtraCamXCamData (menu_name, localClientNum, extracam_index, camera_function)
function	createExtraCamXCamData (menu_name, localClientNum, extracam_index, target_name, xcam, sub_xcam, xcam_frame)
function	getCharacterDataForMenu (menu_name, localClientNum)
function	initMenuData (localClientNum)
function	linkToCustomCharacter (menu_name, localClientNum, target_name)
function	on_player_connect (localClientNum)
function	screen_close_menu ()
function	screen_fade (n_time, n_target_alpha=1, n_start_alpha=0, str_color="black", b_force_close_menu=false)
function	screen_fade_in (n_time, str_color)
function	screen_fade_out (n_time, str_color)
function	set_color (menu, color)
function	setup_menu (localClientNum, menu_data, previous_menu)

Function Documentation

__init__()

function __init__

(

)

Definition at line 17 of file lui_shared.csc.

References on_localclient_connect(), and on_player_connect().

_screen_close_menu()

function private _screen_close_menu

(

)

Definition at line 438 of file lui_shared.csc.

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
	)

Definition at line 464 of file lui_shared.csc.

References DEFAULT, and set_color().

Referenced by screen_fade().

addMenuExploders()

function addMenuExploders	(	menu_name	,
		localClientNum	,
		exploder
	)

Definition at line 61 of file lui_shared.csc.

References ARRAY_ADD, and exploder().

client_menus()

function client_menus

(

localClientNum

)

Definition at line 280 of file lui_shared.csc.

References array, DEFAULT, setup_menu(), and stateChange().

Referenced by on_player_connect().

createCameraMenu()

function createCameraMenu	(	menu_name	,
		localClientNum	,
		target_name	,
		xcam	,
		sub_xcam	,
		xcam_frame	= undefined,
		custom_open_fn	= undefined,
		custom_close_fn	= undefined
	)

Definition at line 108 of file lui_shared.csc.

createCustomCameraMenu()

function createCustomCameraMenu	(	menu_name	,
		localClientNum	,
		camera_function	,
		has_state	,
		custom_open_fn	= undefined,
		custom_close_fn	= undefined
	)

Definition at line 124 of file lui_shared.csc.

createCustomExtraCamXCamData()

function createCustomExtraCamXCamData	(	menu_name	,
		localClientNum	,
		extracam_index	,
		camera_function
	)

Definition at line 49 of file lui_shared.csc.

References ARRAY_ADD.

createExtraCamXCamData()

function createExtraCamXCamData	(	menu_name	,
		localClientNum	,
		extracam_index	,
		target_name	,
		xcam	,
		sub_xcam	,
		xcam_frame
	)

Definition at line 34 of file lui_shared.csc.

References ARRAY_ADD.

getCharacterDataForMenu()

function getCharacterDataForMenu	(	menu_name	,
		localClientNum
	)

Definition at line 98 of file lui_shared.csc.

initMenuData()

function initMenuData

(

localClientNum

)

Definition at line 28 of file lui_shared.csc.

linkToCustomCharacter()

function linkToCustomCharacter	(	menu_name	,
		localClientNum	,
		target_name
	)

Definition at line 80 of file lui_shared.csc.

References create_character_data_struct(), and spawn_model().

on_player_connect()

function on_player_connect

(

localClientNum

)

Definition at line 23 of file lui_shared.csc.

References client_menus().

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 423 of file lui_shared.csc.

References _screen_close_menu().

screen_fade()

function screen_fade	(	n_time	,
		n_target_alpha	= 1,
		n_start_alpha	= 0,
		str_color	= "black",
		b_force_close_menu	= false
	)

Description:
"Function Name: screen_fade( <n_time>, [n_target_alpha = 1], [str_color = "black"], [b_force_close_menu = false] )"
"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): str_color: "white" or "black" (defaults to black)."
"Optional Argument(s): b_force_close_menu: close the fade menu when done even if the alpha isn't 0."
"Example:level lui::screen_fade( 3, .5, "black" ); // fade to .5 alpha over 3 sec"

Definition at line 372 of file lui_shared.csc.

References _screen_fade().

Referenced by activation_flash(), finish_skip_scene(), screen_fade_in(), screen_fade_out(), skip_scene(), and stop_boost_camera_fx().

screen_fade_in()

function screen_fade_in	(	n_time	,
		str_color
	)

Description:
"Function Name: screen_fade_in( <n_time>, [str_color] )"
"Summary: fade the screen in" "CallOn: player or level (for all players)"
"Mandatory Argument(s): n_time: fade time"
"Optional Argument(s): str_color: "white" or "black" (defaults to black)."
"Example:level lui::screen_fade_in( 3 ); // fade in over 3 sec"

Definition at line 411 of file lui_shared.csc.

References screen_fade().

screen_fade_out()

function screen_fade_out	(	n_time	,
		str_color
	)

Description:
"Function Name: screen_fade_out( <n_time>, [str_color] )"
"Summary: fade the screen out" "CallOn: player or level (for all players)"
"Mandatory Argument(s): n_time: fade time"
"Optional Argument(s): str_color: "white" or "black" (defaults to black)."
"Example:level lui::screen_fade_out( 3 ); // fade out over 3 sec"

Definition at line 396 of file lui_shared.csc.

References screen_fade().

Referenced by fade_out_intro_screen_zm(), fade_to_black_for_x_sec(), FadeToBlackAndBackIn(), player_intermission(), postfx_igc_zombies(), and start_intro_screen_zm().

set_color()

function set_color	(	menu	,
		color
	)

Definition at line 537 of file lui_shared.csc.

Referenced by _screen_fade(), and error_on_screen().

setup_menu()

function setup_menu	(	localClientNum	,
		menu_data	,
		previous_menu
	)

Definition at line 138 of file lui_shared.csc.

References exploder(), extracam_init_index(), extracam_reset_index(), and get().

Referenced by client_menus().