XInterface.GUIController

Extends: BaseGUIController
Modifiers: DependsOn ( GUI ) Config ( User ) Abstract Native

Core.Object
|   
+-- Engine.Interactions
   |   
   +-- Engine.Interaction
      |   
      +-- Engine.BaseGUIController
         |   
         +-- XInterface.GUIController

Direct Known Subclasses:

UT2K4GUIController

Constants Summary
DoCounter	=	1

Variables Summary
GUIComponent	ActiveControl
GUIPage	ActivePage
bool	AltPressed
string	ArrayPropertyMenu
array<AutoLoadMenu>	AutoLoad
bool	bAutoRefreshBrowser
bool	bCurMenuInitialized
bool	bDesignMode
bool	bDesignModeToolTips
bool	bDrawFullPaths
bool	bECEEdition
bool	bExpertMode
bool	bFixedMouseSize
bool	bForceMouseCheck
bool	bHighlightCurrent
bool	bIgnoreNextRelease
bool	bIgnoreUntilPress
bool	bInteractiveMode
bool	bModAuthor
bool	bModulateStackedMenus
bool	bNoToolTips
bool	bQuietMenu
bool	bSnapCursor
float	ButtonRepeatDelay
sound	ClickSound
GUIContextMenu	ContextMenu
bool	CtrlPressed
float	CursorFade
int	CursorStep
int	CURSOR_NUM
float	DblClickWindow
Array<string>	DefaultStyleNames
pointer	Designer
string	DesignerMenu
array<DesignModeHint>	DesignModeHints
sound	DownSound
sound	DragSound
GUIComponent	DropSource
GUIComponent	DropTarget
string	DynArrayPropertyMenu
string	EditFavoriteMenu
sound	EditSound
sound	FadeSound
float	FastCursorFade
int	FastCursorStep
string	FilterMenu
GUIComponent	FocusedControl
Array<GUIFont>	FontStack
int	FONT_NUM
string	GameResolution
array<material>	ImageList
byte	KeyDown[255]
string	KickVotingMenu
float	LastClickTime
int	LastClickX
int	LastClickY
string	LastGameType
float	LastMouseX
float	LastMouseY
float	LastRenderTime
array<string>	MainMenuOptions
bool	MainNotWanted
string	MapVotingMenu
string	MatchSetupMenu
int	MaxSimultaneousPings
float	MenuMouseSens
array<GUIPage>	MenuStack
floatbox	MouseCursorBounds
Array<vector>	MouseCursorOffset
Array<Material>	MouseCursors
GUIToolTip	MouseOver
sound	MouseOverSound
float	MouseX
float	MouseY
GUIComponent	MoveControl
Array<GUIPage>	PersistentStack
array<ProfileStruct>	Profilers
array<class<GUIComponent>>	RegisteredClasses
float	RenderDelta
float	RepeatDelta
byte	RepeatKey
float	RepeatTime
string	RequestDataMenu
array<RestoreMenuItem>	RestoreMenus
int	ResX
int	ResY
bool	ShiftPressed
GUIComponent	SkipControl
Array<string>	StyleNames
Array<GUIStyles>	StyleStack
int	STYLE_NUM
sound	UpSound
Material	WhiteBorder

Inherited Variables from Engine.BaseGUIController
DefaultPens[3], NetworkMsgMenu, QuestionMenuClass

Inherited Variables from Engine.Interaction
bActive, bNativeEvents, bRequiresTick, bVisible, Master, ViewportOwner

Structures Summary
AutoLoadMenu MenuClassName, bPreInitialize
DesignModeHint Key, Description
eOwnageMap RLevel, MapName, MapDesc, MapURL
ProfileStruct ProfileName, ProfileSeconds
RestoreMenuItem MenuClassName, Param1, Param2

Delegates Summary
		AddBuddy (optional string NewBuddyName)
	bool	OnNeedRawKeyPress (byte NewKey)

Inherited Delegates from Engine.BaseGUIController
OnAdminReply

Functions Summary
	class<GUIComponent>	AddComponentClass (string ClassName)
	bool	AuthroizeFirewall ()
		AutoLoadMenus ()
	bool	CanShowHints ()
		ChangeFocus (GUIComponent Who)
	bool	CheckFirewall ()
	bool	CheckForECE ()
		CloseAll (bool bCancel, optional bool bForced)
	bool	CloseMenu (optional bool bCancelled)
		CloseOverlays ()
		ConsolidateMenus ()
	int	Count ()
	GUIPage	CreateMenu (string NewMenuName)
	GUIPage	FindMenuByClass (class<GUIPage> PageClass)
	int	FindMenuIndex (GUIPage Menu)
	int	FindMenuIndexByName (string MenuClass)
	GUIPage	FindPersistentMenuByClass (class<GUIPage> PageClass)
	GUIPage	FindPersistentMenuByName (string MenuClass)
	int	FindPersistentMenuIndex (GUIPage Menu)
	bool	GetAssignedKeys (string BindAlias, out array<string> BindKeyNames, out array<string> LocalizedBindKeyNames)
	bool	GetCurrentBind (string BindKeyName, out string BindKeyValue)
	string	GetCurrentRes ()
	bool	GetDEMHeader (string DemoName, out string MapName, out string GameType, out int ScoreLimit, out int TimeLimit, out int ClientSide, out string RecordedBy, out string Timestamp, out String ReqPackages)
		GetDEMList (out array<string> DEMFiles)
	string	GetInstantActionPage ()
	string	GetMainMenuClass ()
		GetMapList (string Prefix, GUIList list, optional bool bDecoText)
	GUIFont	GetMenuFont (string FontName)
	string	GetModPage ()
	string	GetMultiplayerPage ()
		GetOGGList (out array<string> OGGFiles)
		GetOwnageList (out array<int> RLevel, out array<string> MNames, out array<string> MDesc, out array<string> mURL)
		GetProfileList (string Prefix, out array<string> ProfileList)
	string	GetQuitPage ()
	string	GetServerBrowserPage ()
	string	GetSettingsPage ()
	string	GetSinglePlayerPage ()
	GUIStyles	GetStyle (string StyleName, out GUI.eFontScale FontScale)
		GetTeamSymbolList (out array<string> SymbolNames, optional bool bNoSinglePlayer)
		GetWeaponList (out array > WeaponClass, out array<string> WeaponDesc)
	bool	HasMouseMoved (optional float ErrorMargin)
		InitializeController ()
	bool	KeyNameFromIndex (byte iKey, out string KeyName, out string LocalizedKeyName)
	bool	KeyPressed (EInputKey iKey)
		LaunchURL (string URL)
	string	LoadDecoText (string PackageName, string DecoTextName)
		MoveFocused (GUIComponent C, int bmLeft, int bmTop, int bmWidth, int bmHeight, float ClipX, float ClipY, float Val)
	bool	NeedsMenuResolution ()
		NotifyLevelChange ()
	bool	OpenMenu (string NewMenuName, optional string Param1, optional string Param2)
		PerformRestore ()
		PlayInterfaceSound (GUIComponent.EClickSound SoundType)
		PopMenu (int Index, GUIPage CurMenu, optional bool bCancelled)
		PrecachePlayerRecords ()
		Profile (string ProfileName)
		PurgeComponentClasses ()
		PurgeObjectReferences ()
		PushMenu (int Index, GUIPage NewMenu, optional string Param1, optional string Param2)
	bool	RegisterStyle (class<GUIStyles> StyleClass, optional bool bTemporary)
	bool	RemoveMenu (GUIPage Menu, optional bool bCancelled)
	bool	RemoveMenuAt (int Index, optional bool bCancelled)
	bool	ReplaceMenu (string NewMenuName, optional string Param1, optional string Param2, optional bool bCancelled)
		ResetDesigner ()
		ResetFocus ()
		ResetInput ()
		ResetKeyboard ()
		SaveOwnageList (array<eOwnageMap> Maps)
		SaveRestorePages ()
	bool	SearchBinds (string BindAliasMask, out array<string> BindAliases)
		SetControllerStatus (bool On)
	bool	SetKeyBind (string BindKeyName, string BindKeyValue)
		SetMoveControl (GUIComponent C)
	bool	SetRenderDevice (string NewRenderDevice)
		SetRequiredGameResolution (string GameRes)
	GUIQuestionPage	ShowQuestionDialog (string Question, optional byte Buttons, optional byte defButton)
	GUIPage	TopPage ()
		Validate ()
		VerifyStack ()

Inherited Functions from Engine.BaseGUIController
AutoLoadMenus, CloseAll, CloseMenu, InitializeController, NeedsMenuResolution, OpenMenu, ReplaceMenu, SetControllerStatus, SetRequiredGameResolution

Inherited Functions from Engine.Interaction
ConsoleCommand, Initialize, Initialized, KeyEvent, KeyType, Message, NotifyLevelChange, NotifyMusicChange, PostRender, PreRender, ScreenToWorld, SetFocus, StreamFinished, Tick, WorldToScreen

Constants Detail

DoCounter Source code

const DoCounter = 1;

Variables Detail

ActiveControl Source code

var GUIComponent ActiveControl;

ArrayPropertyMenu Source code

var config string ArrayPropertyMenu;

AutoLoad Source code

var config array<AutoLoadMenu> AutoLoad;

bAutoRefreshBrowser Source code

var globalconfig bool bAutoRefreshBrowser;

bCurMenuInitialized Source code

var bool bCurMenuInitialized;

bDesignMode Source code

var globalconfig bool bDesignMode;

bDesignModeToolTips Source code

var globalconfig bool bDesignModeToolTips;

bDrawFullPaths Source code

var globalconfig bool bDrawFullPaths;

bECEEdition Source code

var bool bECEEdition;

bExpertMode Source code

var globalconfig bool bExpertMode;

bFixedMouseSize Source code

var config bool bFixedMouseSize;

bForceMouseCheck Source code

var bool bForceMouseCheck;

bHighlightCurrent Source code

var globalconfig bool bHighlightCurrent;

bIgnoreNextRelease Source code

var bool bIgnoreNextRelease;

bIgnoreUntilPress Source code

var bool bIgnoreUntilPress;

bInteractiveMode Source code

var bool bInteractiveMode;

bModulateStackedMenus Source code

var bool bModulateStackedMenus;

bNoToolTips Source code

var globalconfig bool bNoToolTips;

bSnapCursor Source code

var bool bSnapCursor;

ButtonRepeatDelay Source code

var float ButtonRepeatDelay;

ContextMenu Source code

var GUIContextMenu ContextMenu;

CtrlPressed Source code

var bool CtrlPressed;

DblClickWindow Source code

var float DblClickWindow;

DefaultStyleNames Source code

var Array<string> DefaultStyleNames;

DesignerMenu Source code

var globalconfig string DesignerMenu;

DesignModeHints Source code

var array<DesignModeHint> DesignModeHints;

DynArrayPropertyMenu Source code

var config string DynArrayPropertyMenu;

EditFavoriteMenu Source code

var config string EditFavoriteMenu;

FastCursorFade Source code

var float FastCursorFade;

FastCursorStep Source code

var int FastCursorStep;

FocusedControl Source code

var GUIComponent FocusedControl;

FontStack Source code

var editinline protected Array<GUIFont> FontStack;

GameResolution Source code

var string GameResolution;

KeyDown[255] Source code

var const byte KeyDown[255];

KickVotingMenu Source code

var config string KickVotingMenu;

LastClickTime Source code

var float LastClickTime;

LastGameType Source code

var transient string LastGameType;

LastRenderTime Source code

var float LastRenderTime;

MainMenuOptions Source code

var array<string> MainMenuOptions;

MainNotWanted Source code

var bool MainNotWanted;

MapVotingMenu Source code

var config string MapVotingMenu;

MatchSetupMenu Source code

var config string MatchSetupMenu;

MaxSimultaneousPings Source code

var globalconfig int MaxSimultaneousPings;

MenuMouseSens Source code

var config float MenuMouseSens;

MenuStack Source code

var editinline export protected array<GUIPage> MenuStack;

MouseCursorBounds Source code

var const floatbox MouseCursorBounds;

MouseCursorOffset Source code

var editinline Array<vector> MouseCursorOffset;

MouseCursors Source code

var editinline protected Array<Material> MouseCursors;

MouseOverSound Source code

var sound MouseOverSound;

MoveControl Source code

var GUIComponent MoveControl;

PersistentStack Source code

var protected Array<GUIPage> PersistentStack;

RegisteredClasses Source code

var array<class<GUIComponent>> RegisteredClasses;

RenderDelta Source code

var float RenderDelta;

RepeatDelta Source code

var float RepeatDelta;

RequestDataMenu Source code

var config string RequestDataMenu;

RestoreMenus Source code

var array<RestoreMenuItem> RestoreMenus;

ShiftPressed Source code

var bool ShiftPressed;

SkipControl Source code

var deprecated GUIComponent SkipControl;

StyleStack Source code

var protected Array<GUIStyles> StyleStack;

WhiteBorder Source code

var Material WhiteBorder;

Structures Detail

AutoLoadMenu Source code

struct AutoLoadMenu
{

var bool bPreInitialize;
var string MenuClassName;

};

DesignModeHint Source code

struct DesignModeHint
{

var(GUIController) localized string Description;
var(GUIController) localized string Key;

};

eOwnageMap Source code

struct eOwnageMap
{

var string MapDesc;
var string MapName;
var string MapURL;
var int RLevel;

};

ProfileStruct Source code

struct ProfileStruct
{

var string ProfileName;
var float ProfileSeconds;

};

RestoreMenuItem Source code

struct native RestoreMenuItem
{

var(GUIController) string MenuClassName;
var(GUIController) string Param1;
var(GUIController) string Param2;

};

Delegates Detail

AddBuddy Source code

delegate AddBuddy ( optional string NewBuddyName )

OnNeedRawKeyPress Source code

delegate bool OnNeedRawKeyPress ( byte NewKey )

Functions Detail

AddComponentClass Source code

event class<GUIComponent> AddComponentClass ( string ClassName )

AuthroizeFirewall Source code

native function bool AuthroizeFirewall ( )

AutoLoadMenus Source code

event AutoLoadMenus ( )

CanShowHints Source code

event bool CanShowHints ( )

ChangeFocus Source code

event ChangeFocus ( GUIComponent Who )

CheckFirewall Source code

native function bool CheckFirewall ( )

CheckForECE Source code

native function bool CheckForECE ( )

CloseAll Source code

event CloseAll ( bool bCancel, optional bool bForced )

CloseMenu Source code

event bool CloseMenu ( optional bool bCancelled )

CloseOverlays Source code

function CloseOverlays ( )

ConsolidateMenus Source code

function ConsolidateMenus ( )

CreateMenu Source code

event GUIPage CreateMenu ( string NewMenuName )

FindMenuByClass Source code

function GUIPage FindMenuByClass ( class<GUIPage> PageClass )

FindMenuIndex Source code

event int FindMenuIndex ( GUIPage Menu )

FindMenuIndexByName Source code

event int FindMenuIndexByName ( string MenuClass )

FindPersistentMenuByClass Source code

function GUIPage FindPersistentMenuByClass ( class<GUIPage> PageClass )

FindPersistentMenuByName Source code

event GUIPage FindPersistentMenuByName ( string MenuClass )

FindPersistentMenuIndex Source code

event int FindPersistentMenuIndex ( GUIPage Menu )

GetAssignedKeys Source code

final function bool GetAssignedKeys ( string BindAlias, out array<string> BindKeyNames, out array<string> LocalizedBindKeyNames )

GetCurrentBind Source code

final function bool GetCurrentBind ( string BindKeyName, out string BindKeyValue )

GetCurrentRes Source code

native final function string GetCurrentRes ( )

GetDEMHeader Source code

native function bool GetDEMHeader ( string DemoName, out string MapName, out string GameType, out int ScoreLimit, out int TimeLimit, out int ClientSide, out string RecordedBy, out string Timestamp, out String ReqPackages )

GetDEMList Source code

native function GetDEMList ( out array<string> DEMFiles )

GetInstantActionPage Source code

static function string GetInstantActionPage ( )

GetMainMenuClass Source code

native static final function string GetMainMenuClass ( )

GetMapList Source code

native final function GetMapList ( string Prefix, GUIList list, optional bool bDecoText )

GetMenuFont Source code

native event GUIFont GetMenuFont ( string FontName )

GetModPage Source code

static function string GetModPage ( )

GetMultiplayerPage Source code

static function string GetMultiplayerPage ( )

GetOGGList Source code

native final function GetOGGList ( out array<string> OGGFiles )

GetOwnageList Source code

native function GetOwnageList ( out array<int> RLevel, out array<string> MNames, out array<string> MDesc, out array<string> mURL )

GetProfileList Source code

native final function GetProfileList ( string Prefix, out array<string> ProfileList )

GetQuitPage Source code

static function string GetQuitPage ( )

GetServerBrowserPage Source code

static function string GetServerBrowserPage ( )

GetSettingsPage Source code

static function string GetSettingsPage ( )

GetSinglePlayerPage Source code

static function string GetSinglePlayerPage ( )

GetStyle Source code

native event GUIStyles GetStyle ( string StyleName, out GUI.eFontScale FontScale )

GetTeamSymbolList Source code

final function GetTeamSymbolList ( out array<string> SymbolNames, optional bool bNoSinglePlayer )

GetWeaponList Source code

native final function GetWeaponList ( out array<class<Weapon> > WeaponClass, out array<string> WeaponDesc )

HasMouseMoved Source code

function bool HasMouseMoved ( optional float ErrorMargin )

InitializeController Source code

event InitializeController ( )

KeyNameFromIndex Source code

final function bool KeyNameFromIndex ( byte iKey, out string KeyName, out string LocalizedKeyName )

KeyPressed Source code

final function bool KeyPressed ( EInputKey iKey )

LaunchURL Source code

native function LaunchURL ( string URL )

LoadDecoText Source code

function string LoadDecoText ( string PackageName, string DecoTextName )

MoveFocused Source code

event MoveFocused ( GUIComponent C, int bmLeft, int bmTop, int bmWidth, int bmHeight, float ClipX, float ClipY, float Val )

NeedsMenuResolution Source code

event bool NeedsMenuResolution ( )

NotifyLevelChange Source code

event NotifyLevelChange ( )

OpenMenu Source code

event bool OpenMenu ( string NewMenuName, optional string Param1, optional string Param2 )

PerformRestore Source code

function PerformRestore ( )

PlayInterfaceSound Source code

native final function PlayInterfaceSound ( GUIComponent.EClickSound SoundType )

PopMenu Source code

protected event PopMenu ( int Index, GUIPage CurMenu, optional bool bCancelled )

PrecachePlayerRecords Source code

function PrecachePlayerRecords ( )

Profile Source code

native function Profile ( string ProfileName )

PurgeComponentClasses Source code

function PurgeComponentClasses ( )

PurgeObjectReferences Source code

function PurgeObjectReferences ( )

PushMenu Source code

protected event PushMenu ( int Index, GUIPage NewMenu, optional string Param1, optional string Param2 )

RegisterStyle Source code

function bool RegisterStyle ( class<GUIStyles> StyleClass, optional bool bTemporary )

RemoveMenu Source code

event bool RemoveMenu ( GUIPage Menu, optional bool bCancelled )

RemoveMenuAt Source code

function bool RemoveMenuAt ( int Index, optional bool bCancelled )

ReplaceMenu Source code

event bool ReplaceMenu ( string NewMenuName, optional string Param1, optional string Param2, optional bool bCancelled )

ResetDesigner Source code

native private final function ResetDesigner ( )

ResetFocus Source code

function ResetFocus ( )

ResetInput Source code

native final function ResetInput ( )

XInterface.GUIController

Direct Known Subclasses:

DoCounter Source code

ActiveControl Source code

ActivePage Source code

AltPressed Source code

ArrayPropertyMenu Source code

AutoLoad Source code

bAutoRefreshBrowser Source code

bCurMenuInitialized Source code

bDesignMode Source code

bDesignModeToolTips Source code

bDrawFullPaths Source code

bECEEdition Source code

bExpertMode Source code

bFixedMouseSize Source code

bForceMouseCheck Source code

bHighlightCurrent Source code

bIgnoreNextRelease Source code

bIgnoreUntilPress Source code

bInteractiveMode Source code

bModAuthor Source code

bModulateStackedMenus Source code

bNoToolTips Source code

bQuietMenu Source code

bSnapCursor Source code

ButtonRepeatDelay Source code

ClickSound Source code

ContextMenu Source code

CtrlPressed Source code

CursorFade Source code

CursorStep Source code

CURSOR_NUM Source code

DblClickWindow Source code

DefaultStyleNames Source code

Designer Source code

DesignerMenu Source code

DesignModeHints Source code

DownSound Source code

DragSound Source code

DropSource Source code

DropTarget Source code

DynArrayPropertyMenu Source code

EditFavoriteMenu Source code

EditSound Source code

FadeSound Source code

FastCursorFade Source code

FastCursorStep Source code

FilterMenu Source code

FocusedControl Source code

FontStack Source code

FONT_NUM Source code

GameResolution Source code

ImageList Source code

KeyDown[255] Source code

KickVotingMenu Source code

LastClickTime Source code

LastClickX Source code

LastClickY Source code