I don't need to test my programs. I have an error-correcting modem.

UE2:GUIPage (UT2003)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT2003 Object >> GUI >> GUIComponent >> GUIMultiComponent >> GUIPage
Package: 
XInterface
Direct subclasses:
Browser_OpenIP, UT2PerformWarn, Browser_AddBuddy, Browser_IconKey, TestGFXButtonPage, UT2DeferChangeRes, JoeTest, GUIQuestionPage, IRC_NewNick, IngameChat, InvasionWaveConfig, ListTest, UT2VideoChangeOK, UT2DemoQuitPage, ServerBrowser, TestImagePage, UT2MainMenu, UT2AdminMenu, UT2ArenaConfig, UT2BadCDKeyMsg, UT2BotConfigPage, UT2BotInfoPage, UT2Congratulations, UT2DraftTeam, UT2GetPassword, UT2InstantActionPage, UT2QuitPage, UT2LoadingWeaponsArena, UT2LoadingWeapons, UT2MidGameMenu, UT2MultiplayerHostPage, UT2MusicManager, UT2NetworkStatusMsg, UT2SP_LadderEventPage, UT2ServerInfo, UT2SettingsPage, UT2SinglePlayerMain, UT2StatsPrompt, UT2StatusMsg, VignetteTest
This class in other games:
UE2Runtime, UT2004

Class: xInterface.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

Delegates

OnCanClose

delegate bool OnCanClose (optional bool bCanceled)


OnClose

delegate OnClose (optional bool bCanceled)


OnOpen

delegate OnOpen ()


OnReOpen

delegate OnReOpen ()


Functions

Events

ChangeHint

event ChangeHint (string NewHint)


HandleParameters

event HandleParameters (string Param1, string Param2)


MenuStateChange

event MenuStateChange (GUI.eMenuState Newstate)

Overrides: GUIMultiComponent.MenuStateChange


NotifyLevelChange

event NotifyLevelChange ()


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 ()