Cogito, ergo sum

UE2:GUIPage (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT2004 Object >> GUI >> GUIComponent >> GUIMultiComponent >> GUIPage
Package: 
XInterface
Direct subclasses:
UT2K3GUIPage, GUIQuestionPage, TestPageBase, UT2K4GUIPage, UT2MusicManager, UT2ServerInfo, UtvWatcherMenu
This class in other games:
UE2Runtime, UT2003

Class: UT2K4UI.GUIPage

GUIPages are the base for a full page menu. They contain the Control stack for the page.

Written by Joe Wilcox (c) 2002, Epic Games, Inc. All Rights Reserved

Properties[edit]

Property group 'GUIPage'[edit]

Background[edit]

Type: Material

The background image for the menu

BackgroundColor[edit]

Type: Object.Color

The color of the background

Default value:

Member Value
A 255
B 255
G 255
R 255

BackgroundRStyle[edit]

Type: GUI.EMenuRenderStyle


Default value: MSTY_Normal

bAllowedAsLast[edit]

Type: bool

If this is true, closing this page will not bring up the main menu

bCaptureInput[edit]

Type: bool

Whether to allow input to be passed to pages lower on the menu stack.

Default value: True

bCheckResolution[edit]

Type: bool

obsolete

bDisconnectOnOpen[edit]

Type: bool

Should this menu for a disconnect when opened.

bPauseIfPossible[edit]

Type: bool

Should this menu pause the game if possible

bPersistent[edit]

Type: bool

If set, page is saved across open/close/reopen.

bRenderWorld[edit]

Type: bool

False - don't render anything behind this menu / True - render normally (everything)

bRequire640x480[edit]

Type: bool

Does this menu require at least 640x480

Default value: True

bRestorable[edit]

Type: bool

When the GUIController receives a call to CloseAll(), should it reopen this page the next time main is opened?

CloseSound[edit]

Type: Sound

Sound to play when closed

InactiveFadeColor[edit]

Type: Object.Color

Color Modulation for Inactive Page

Default value:

Member Value
A 255
B 64
G 64
R 64

OpenSound[edit]

Type: Sound

Sound to play when opened

ParentPage[edit]

Type: GUIPage

Modifiers: noexport, editconst

The page that exists before this one

Timers[edit]

Type: array<GUIComponent>

Modifiers: noexport, editconst, editconstarray, const


Default values[edit]

Property Value
bAcceptsInput True
bTabStop False
RenderWeight 1.0E-4

Delegates[edit]

OnCanClose[edit]

delegate bool OnCanClose (optional bool bCancelled)


OnClose[edit]

delegate OnClose (optional bool bCancelled)


OnOpen[edit]

delegate OnOpen ()


OnReOpen[edit]

delegate OnReOpen ()


Functions[edit]

Events[edit]

ChangeHint[edit]

event ChangeHint (string NewHint)


Closed[edit]

event Closed (GUIComponent Sender, bool bCancelled)

Overrides: GUIMultiComponent.Closed


Free[edit]

event Free ()

Overrides: GUIMultiComponent.Free


HandleParameters[edit]

event HandleParameters (string Param1, string Param2)


InitComponent[edit]

event InitComponent (GUIController MyController, GUIComponent MyOwner)

Overrides: GUIMultiComponent.InitComponent


SetFocus[edit]

event SetFocus (GUIComponent Who)

Overrides: GUIMultiComponent.SetFocus


Other instance functions[edit]

AllowOpen[edit]

function bool AllowOpen (string MenuClass)


CheckResolution[edit]

function CheckResolution (bool Closing, GUIController InController)


GetDataString[edit]

function string GetDataString ()


GetRestoreParams[edit]

function bool GetRestoreParams (out string Param1, out string Param2)


HandleObject[edit]

function HandleObject (Object Obj, optional Object OptionalObj_1, optional Object OptionalObj_2)


IsOpen[edit]

final function bool IsOpen ()


NotifyLevelChange[edit]

function bool NotifyLevelChange ()


PlayCloseSound[edit]

function PlayCloseSound ()


PlayOpenSound[edit]

function PlayOpenSound ()


SetDataString[edit]

function SetDataString (string Str)