The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

UE2:GUIPage (UT2003)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 09:10, 17 May 2008 by Wormbo (Talk | contribs) (Auto-generated page)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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
This is an auto-generated page and may need human attention.
Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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[edit]

Property group 'Menu'[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

bCheckResolution[edit]

Type: bool

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

bPauseIfPossible[edit]

Type: bool

Should this menu pause the game if possible

bRenderWorld[edit]

Type: bool

Should this menu hide the world

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 128
G 128
R 128

OpenSound[edit]

Type: Sound

Sound to play when opened

Internal variables[edit]

bAllowedAsLast[edit]

Type: bool


bDisconnectOnOpen[edit]

Type: bool


bPersistent[edit]

Type: bool

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

bRequire640x480[edit]

Type: bool

Does this menu require at least 640x480

Default value: True

ParentPage[edit]

Type: GUIPage

The page that exists before this one

Timers[edit]

Type: array<GUIComponent>

Modifiers: const

List of components with Active Timers

Default values[edit]

Property Value
bAcceptsInput True

Delegates[edit]

OnCanClose[edit]

delegate bool OnCanClose (optional bool bCanceled)


OnClose[edit]

delegate OnClose (optional bool bCanceled)


OnOpen[edit]

delegate OnOpen ()


OnReOpen[edit]

delegate OnReOpen ()


Functions[edit]

Events[edit]

ChangeHint[edit]

event ChangeHint (string NewHint)


HandleParameters[edit]

event HandleParameters (string Param1, string Param2)


MenuStateChange[edit]

event MenuStateChange (GUI.eMenuState Newstate)

Overrides: GUIMultiComponent.MenuStateChange


NotifyLevelChange[edit]

event NotifyLevelChange ()


SetFocus[edit]

event SetFocus (GUIComponent Who)

Overrides: GUIMultiComponent.SetFocus


Other instance functions[edit]

CheckResolution[edit]

function CheckResolution (bool Closing)


InitComponent[edit]

function InitComponent (GUIController MyController, GUIComponent MyOwner)

Overrides: GUIMultiComponent.InitComponent


PageLoadINI[edit]

function PageLoadINI ()


PageSaveINI[edit]

function PageSaveINI ()


PlayCloseSound[edit]

function PlayCloseSound ()


PlayOpenSound[edit]

function PlayOpenSound ()


Retrieved from "https://wiki.beyondunreal.com/UE2:GUIPage_(UT2003)?oldid=20208"