UE2:GUIPage (UE2Runtime)

Object >> GUI >> GUIComponent >> GUIMultiComponent >> GUIPage

Package:

GUI

Direct subclasses:

DeferChangeRes, MainMenu, MidGameMenu, MyMainMenu, MyNetworkStatusMsg, MyQuitPage, MyTest2Page, MyTestPage, PerformWarn, QuitPage, SettingsMenu, VideoChangeOK

This class in other games:

UT2003, UT2004

Class: GUI.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 'Menu'

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

bCheckResolution

Type: bool

If true, the menu will be force to run at least 640x480

bPauseIfPossible

Type: bool

Should this menu pause the game if possible

bRenderWorld

Type: bool

Should this menu hide the world

CloseSound

Type: Sound

Sound to play when closed

InactiveFadeColor

Type: Object.Color

Color Modulation for Inactive Page

Default value:

Member	Value
A	255
B	128
G	128
R	128

OpenSound

Type: Sound

Sound to play when opened

Internal variables

bAllowedAsLast

Type: bool

bDisconnectOnOpen

Type: bool

bPersistent

Type: bool

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

bRequire640x480

Type: bool

Does this menu require at least 640x480

Default value: True

ParentPage

Type: GUIPage

The page that exists before this one

Timers

Type: array<GUIComponent>

Modifiers: const

List of components with Active Timers

Default values

Property	Value
bAcceptsInput	True
bTabStop	False

Delegates

OnCanClose

delegate bool OnCanClose (optional bool bCancelled)

OnClose

delegate OnClose (optional bool bCancelled)

OnOpen

delegate OnOpen ()

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)

MenuStateChange

event MenuStateChange (GUI.eMenuState Newstate)

Overrides: GUIMultiComponent.MenuStateChange

NotifyLevelChange

event NotifyLevelChange ()

Opened

event Opened (GUIComponent Sender)

Overrides: GUIMultiComponent.Opened

SetFocus

event SetFocus (GUIComponent Who)

Overrides: GUIMultiComponent.SetFocus

Other instance functions

CheckResolution

function CheckResolution (bool Closing)

InitComponent

function InitComponent (GUIController MyController, GUIComponent MyOwner)

Overrides: GUIMultiComponent.InitComponent

PageLoadINI

function PageLoadINI ()

PageSaveINI

function PageSaveINI ()

PlayCloseSound

function PlayCloseSound ()

PlayOpenSound

function PlayOpenSound ()