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

UE2:GUIPage (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT2004 Object >> GUI >> GUIComponent >> GUIMultiComponent >> GUIPage

Contents

Package: 
XInterface
Direct subclasses:
GUIQuestionPage, TestPageBase, UT2K3GUIPage, 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

[edit] Properties

[edit] Property group 'GUIPage'

[edit] Background

Type: Material

The background image for the menu

[edit] BackgroundColor

Type: Object.Color

The color of the background

Default value:

Member Value
A 255
B 255
G 255
R 255

[edit] BackgroundRStyle

Type: GUI.EMenuRenderStyle


Default value: MSTY_Normal

[edit] bAllowedAsLast

Type: bool

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

[edit] bCaptureInput

Type: bool

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

Default value: True

[edit] bCheckResolution

Type: bool

obsolete

[edit] bDisconnectOnOpen

Type: bool

Should this menu for a disconnect when opened.

[edit] bPauseIfPossible

Type: bool

Should this menu pause the game if possible

[edit] bPersistent

Type: bool

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

[edit] bRenderWorld

Type: bool

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

[edit] bRequire640x480

Type: bool

Does this menu require at least 640x480

Default value: True

[edit] bRestorable

Type: bool

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

[edit] CloseSound

Type: Sound

Sound to play when closed

[edit] InactiveFadeColor

Type: Object.Color

Color Modulation for Inactive Page

Default value:

Member Value
A 255
B 64
G 64
R 64

[edit] OpenSound

Type: Sound

Sound to play when opened

[edit] ParentPage

Type: GUIPage

Modifiers: noexport, editconst

The page that exists before this one

[edit] Timers

Type: array<GUIComponent>

Modifiers: noexport, editconst, editconstarray, const


[edit] Default values

Property Value
bAcceptsInput True
bTabStop False
RenderWeight 1.0E-4

[edit] Delegates

[edit] OnCanClose

delegate bool OnCanClose (optional bool bCancelled)


[edit] OnClose

delegate OnClose (optional bool bCancelled)


[edit] OnOpen

delegate OnOpen ()


[edit] OnReOpen

delegate OnReOpen ()


[edit] Functions

[edit] Events

[edit] ChangeHint

event ChangeHint (string NewHint)


[edit] Closed

event Closed (GUIComponent Sender, bool bCancelled)

Overrides: GUIMultiComponent.Closed


[edit] Free

event Free ()

Overrides: GUIMultiComponent.Free


[edit] HandleParameters

event HandleParameters (string Param1, string Param2)


[edit] InitComponent

event InitComponent (GUIController MyController, GUIComponent MyOwner)

Overrides: GUIMultiComponent.InitComponent


[edit] SetFocus

event SetFocus (GUIComponent Who)

Overrides: GUIMultiComponent.SetFocus


[edit] Other instance functions

[edit] AllowOpen

function bool AllowOpen (string MenuClass)


[edit] CheckResolution

function CheckResolution (bool Closing, GUIController InController)


[edit] GetDataString

function string GetDataString ()


[edit] GetRestoreParams

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


[edit] HandleObject

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


[edit] IsOpen

final function bool IsOpen ()


[edit] NotifyLevelChange

function bool NotifyLevelChange ()


[edit] PlayCloseSound

function PlayCloseSound ()


[edit] PlayOpenSound

function PlayOpenSound ()


[edit] SetDataString

function SetDataString (string Str)