Gah - a solution with more questions. – EntropicLqd

UE2:GUIPage (UE2Runtime)

From Unreal Wiki, The Unreal Engine Documentation Site

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

Contents
Package: 
GUI
Direct subclasses:
DeferChangeRes, MainMenu, MidGameMenu, MyMainMenu, MyNetworkStatusMsg, MyQuitPage, MyTest2Page, MyTestPage, PerformWarn, QuitPage, SettingsMenu, VideoChangeOK
This class in other games:
UT2003, UT2004
This is an auto-generated page and may need human attention.
Please remove this tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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

[edit] Properties

[edit] Property group 'Menu'

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

Type: bool

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

[edit] bPauseIfPossible

Type: bool

Should this menu pause the game if possible

[edit] bRenderWorld

Type: bool

Should this menu hide the world

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

[edit] OpenSound

Type: Sound

Sound to play when opened

[edit] Internal variables

[edit] bAllowedAsLast

Type: bool


[edit] bDisconnectOnOpen

Type: bool


[edit] bPersistent

Type: bool

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

[edit] bRequire640x480

Type: bool

Does this menu require at least 640x480

Default value: True

[edit] ParentPage

Type: GUIPage

The page that exists before this one

[edit] Timers

Type: array<GUIComponent>

Modifiers: const

List of components with Active Timers

[edit] Default values

Property Value
bAcceptsInput True
bTabStop False

[edit] Delegates

[edit] OnCanClose

delegate bool OnCanClose (optional bool bCancelled)


[edit] OnClose

delegate OnClose (optional bool bCancelled)


[edit] OnOpen

delegate OnOpen ()


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

event MenuStateChange (GUI.eMenuState Newstate)

Overrides: GUIMultiComponent.MenuStateChange


[edit] NotifyLevelChange

event NotifyLevelChange ()


[edit] Opened

event Opened (GUIComponent Sender)

Overrides: GUIMultiComponent.Opened


[edit] SetFocus

event SetFocus (GUIComponent Who)

Overrides: GUIMultiComponent.SetFocus


[edit] Other instance functions

[edit] CheckResolution

function CheckResolution (bool Closing)


[edit] InitComponent

function InitComponent (GUIController MyController, GUIComponent MyOwner)

Overrides: GUIMultiComponent.InitComponent


[edit] PageLoadINI

function PageLoadINI ()


[edit] PageSaveINI

function PageSaveINI ()


[edit] PlayCloseSound

function PlayCloseSound ()


[edit] PlayOpenSound

function PlayOpenSound ()


Retrieved from "http://wiki.beyondunreal.com/UE2:GUIPage_(UE2Runtime)"