UE2:GUIPage (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

Property group 'GUIPage'

Background

Type: Material

The background image for the menu

BackgroundColor

Type: Object.Color

The color of the background

Default value:

Member	Value
A	255
B	255
G	255
R	255

BackgroundRStyle

Type: GUI.EMenuRenderStyle

Default value: MSTY_Normal

bAllowedAsLast

Type: bool

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

bCaptureInput

Type: bool

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

Default value: True

bCheckResolution

Type: bool

obsolete

bDisconnectOnOpen

Type: bool

Should this menu for a disconnect when opened.

bPauseIfPossible

Type: bool

Should this menu pause the game if possible

bPersistent

Type: bool

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

bRenderWorld

Type: bool

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

bRequire640x480

Type: bool

Does this menu require at least 640x480

Default value: True

bRestorable

Type: bool

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

CloseSound

Type: Sound

Sound to play when closed

InactiveFadeColor

Type: Object.Color

Color Modulation for Inactive Page

Default value:

Member	Value
A	255
B	64
G	64
R	64

OpenSound

Type: Sound

Sound to play when opened

ParentPage

Type: GUIPage

Modifiers: noexport, editconst

The page that exists before this one

Timers

Type: array<GUIComponent>

Modifiers: noexport, editconst, editconstarray, const

Default values

Property	Value
bAcceptsInput	True
bTabStop	False
RenderWeight	1.0E-4

Delegates

OnCanClose

delegate bool OnCanClose (optional bool bCancelled)

OnClose

delegate OnClose (optional bool bCancelled)

OnOpen

delegate OnOpen ()

OnReOpen

delegate OnReOpen ()

Functions

Events

ChangeHint

event ChangeHint (string NewHint)

Closed

event Closed (GUIComponent Sender, bool bCancelled)

Overrides: GUIMultiComponent.Closed

Free

event Free ()

Overrides: GUIMultiComponent.Free

HandleParameters

event HandleParameters (string Param1, string Param2)

InitComponent

event InitComponent (GUIController MyController, GUIComponent MyOwner)

Overrides: GUIMultiComponent.InitComponent

SetFocus

event SetFocus (GUIComponent Who)

Overrides: GUIMultiComponent.SetFocus

Other instance functions

AllowOpen

function bool AllowOpen (string MenuClass)

CheckResolution

function CheckResolution (bool Closing, GUIController InController)

GetDataString

function string GetDataString ()

GetRestoreParams

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

HandleObject

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

IsOpen

final function bool IsOpen ()

NotifyLevelChange

function bool NotifyLevelChange ()

PlayCloseSound

function PlayCloseSound ()

PlayOpenSound

function PlayOpenSound ()

SetDataString

function SetDataString (string Str)