Once I get that upgrade to 36-hour days, I will tackle that. – Mychaeel

UE2:GUIController (UE2Runtime)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
v • d • e
UE2Runtime Object >> Interactions >> Interaction >> BaseGUIController >> GUIController

Contents
Package: 
GUI
Known direct subclass:
RTGUIController
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: Engine.GUIController

The GUIController is a simple FILO menu stack. You have 3 things you can do. You can Open a menu which adds the menu to the top of the stack. You can Replace a menu which replaces the current menu with the new menu. And you can close a menu, which returns you to the last menu on the stack.

Written by Joe Wilcox (c) 2002, Epic Games, Inc. All Rights Reserved

[edit] Properties

[edit] ActiveControl

Type: GUIComponent

Which control is currently active

[edit] ActivePage

Type: GUIPage

Points to the currently active page

[edit] AltPressed

Type: bool

Alt key is being held

[edit] AutoLoad

Type: array<string>

Modifiers: config


[edit] bCurMenuInitialized

Type: bool

Has the current Menu Finished initialization

[edit] bDesignMode

Type: bool

Are we in design mode;

[edit] bEmulatedJoypad

Type: bool

Modifiers: config

Have the cursor keys emulate a XBox controller

[edit] bForceMouseCheck

Type: bool

HACK

[edit] bHideMouseCursor

Type: bool

Modifiers: config

When true, the mouse cursor will be hidden

[edit] bHighlightCurrent

Type: bool

Highlight the current control being edited

Default value: True

[edit] bIgnoreNextRelease

Type: bool

Used to make sure discard errant releases.

[edit] bIgnoreUntilPress

Type: bool

HACK

[edit] bJoyMouse

Type: bool

Modifiers: config

When true, right control stick acts as a 1 button mouse

[edit] bModAuthor

Type: bool

Modifiers: config

Allows bDesign Mode

[edit] ButtonRepeatDelay

Type: float

The amount of delay for faking button repeats

Default value: 0.25

[edit] ClickSound

Type: Sound


[edit] ControllerId

Type: byte

The current Controller ID #

[edit] ControllerMask

Type: byte

Used to mask input for various Controllers

Default value: 255

[edit] CtrlPressed

Type: bool

Ctrl key is being held

[edit] CursorFade

Type: float

How visible is the cursor

[edit] CursorStep

Type: int

Are we fading in or out

Default value: 1

[edit] DblClickWindow

Type: float

How long do you have for a double click

Default value: 0.5

[edit] DownSound

Type: Sound


[edit] EditSound

Type: Sound


[edit] FastCursorFade

Type: float

How visible is the cursor

[edit] FastCursorStep

Type: int

Are we fading in or out

Default value: 1

[edit] FocusedControl

Type: GUIComponent

Top most Focused control

[edit] FontStack

Type: array<GUIFont>

Modifiers: editinline

Holds all the possible fonts

Default value, index 0: fntMenuFont'GUI.GUIController.GUIMenuFont'

Default value, index 1: fntDefaultFont'GUI.GUIController.GUIDefaultFont'

Default value, index 2: fntLargeFont'GUI.GUIController.GUILargeFont'

Default value, index 3: fntHeaderFont'GUI.GUIController.GUIHeaderFont'

Default value, index 4: fntSmallFont'GUI.GUIController.GUISmallFont'

Default value, index 5: fntSmallHeaderFont'GUI.GUIController.GUISmallHeaderFont'

[edit] GameResolution

Type: string


[edit] JoyButtons

Type: byte

Array size: 64


[edit] JoyControlsDelta

Type: float

Array size: 16


[edit] JoyDeadZone

Type: float

Modifiers: config

The DeadZone for joysticks

Default value: 0.3

[edit] JoyLeftXAxis

Type: float

Array size: 4


[edit] JoyLeftYAxis

Type: float

Array size: 4


[edit] JoyRightXAxis

Type: float

Array size: 4


[edit] JoyRightYAxis

Type: float

Array size: 4


[edit] LastClickTime

Type: float

When did the last click occur

[edit] LastClickX

Type: int


[edit] LastClickY

Type: int

Who was the active component

[edit] LastMouseX

Type: float


[edit] LastMouseY

Type: float


[edit] MainNotWanted

Type: bool


[edit] MenuMouseSens

Type: float

Modifiers: config


Default value: 1.0

[edit] MenuStack

Type: array<GUIPage>

Modifiers: editinline, export

Holds the stack of menus

[edit] MouseCursorOffset

Type: array<Object.Vector>

Modifiers: editinline

Only X,Y used, between 0 and 1. 'Hot Spot' of cursor material.

[edit] MouseCursors

Type: array<Material>

Modifiers: editinline

Holds a list of all possible mouse

Default value, index 0: Texture'GUIContent.Menu.MouseCursor'

Default value, index 1: Texture'GUIContent.Menu.MouseCursor'

Default value, index 2: Texture'GUIContent.Menu.MouseCursor'

Default value, index 3: Texture'GUIContent.Menu.MouseCursor'

Default value, index 4: Texture'GUIContent.Menu.MouseCursor'

Default value, index 5: Texture'GUIContent.Menu.MouseCursor'

Default value, index 6: Texture'GUIContent.Menu.MouseCursor'

[edit] MouseOverSound

Type: Sound


[edit] MouseX

Type: float


[edit] MouseY

Type: float

Where is the mouse currently located

[edit] MoveControl

Type: GUIComponent

Used for visual design

[edit] PersistentStack

Type: array<GUIPage>

Holds the set of pages which are persistent across close/open

[edit] RepeatDelta

Type: float

Array size: 4

Data var

[edit] RepeatKey

Type: byte

Array size: 4

Used to determine what should repeat

[edit] RepeatTime

Type: float

Array size: 4

How long until the next repeat;

[edit] ShiftPressed

Type: bool

Shift key is being held

[edit] SkipControl

Type: GUIComponent

This control should be skipped over and drawn at the end

[edit] StyleNames

Type: array<string>

Holds the name of all styles to use

Default value, index 0: "GUI.STY_RoundButton"

Default value, index 1: "GUI.STY_RoundScaledButton"

Default value, index 10: "GUI.STY_SliderCaption"

Default value, index 11: "GUI.STY_SquareBar"

Default value, index 12: "GUI.STY_TextLabel"

Default value, index 13: "GUI.STY_ComboListBox"

Default value, index 14: "GUI.STY_SquareButton"

Default value, index 15: "GUI.STY_ListBox"

Default value, index 16: "GUI.STY_ScrollZone"

Default value, index 17: "GUI.STY_TextButton"

Default value, index 18: "GUI.STY_Header"

Default value, index 19: "GUI.STY_Footer"

Default value, index 20: "GUI.STY_TabButton"

Default value, index 21: "GUI.STY_NoBackground"

[edit] StyleStack

Type: array<GUIStyles>

Holds all of the possible styles

[edit] UpSound

Type: Sound


[edit] WhiteBorder

Type: Material


Default value: Texture'GUIContent.Menu.WhiteBorder'

[edit] Delegates

[edit] OnNeedRawKeyPress

delegate bool OnNeedRawKeyPress (byte NewKey)


[edit] Functions

[edit] Native functions

[edit] GetMenuFont

native event GUIFont GetMenuFont (string FontName)


[edit] GetStyle

native event GUIStyles GetStyle (string StyleName)


[edit] GetCurrentRes

native function string GetCurrentRes ()


[edit] GetMainMenuClass

native function string GetMainMenuClass ()


[edit] GetMapList

native function GetMapList (string Prefix, GUIList list)


[edit] MouseEmulation

native function MouseEmulation (bool On)


[edit] ResetKeyboard

native function ResetKeyboard ()


[edit] Events

[edit] AutoLoadMenus

event AutoLoadMenus ()

Overrides: BaseGUIController.AutoLoadMenus


[edit] ChangeFocus

event ChangeFocus (GUIComponent Who)


[edit] CloseAll

event CloseAll (bool bCancel)

Overrides: BaseGUIController.CloseAll


[edit] CloseMenu

event bool CloseMenu (optional bool bCanceled)

Overrides: BaseGUIController.CloseMenu


[edit] CreateMenu

event GUIPage CreateMenu (string NewMenuName)


[edit] InitializeController

event InitializeController ()

Overrides: BaseGUIController.InitializeController


[edit] MoveFocused

event MoveFocused (GUIComponent Ctrl, int bmLeft, int bmTop, int bmWidth, int bmHeight, float ClipX, float ClipY)


[edit] NeedsMenuResolution

event bool NeedsMenuResolution ()

Overrides: BaseGUIController.NeedsMenuResolution


[edit] NotifyLevelChange

event NotifyLevelChange ()


[edit] OpenMenu

event bool OpenMenu (string NewMenuName, optional string Param1, optional string Param2)

Overrides: BaseGUIController.OpenMenu


[edit] ReplaceMenu

event bool ReplaceMenu (string NewMenuName, optional string Param1, optional string Param2)

Overrides: BaseGUIController.ReplaceMenu


[edit] SetRequiredGameResolution

event SetRequiredGameResolution (string GameRes)

Overrides: BaseGUIController.SetRequiredGameResolution


[edit] Other instance functions

[edit] HasMouseMoved

function bool HasMouseMoved ()


[edit] RegisterStyle

function bool RegisterStyle (class<GUIStyles> StyleClass)


[edit] ResetFocus

function ResetFocus ()


[edit] SetControllerStatus

function SetControllerStatus (bool On)

Overrides: BaseGUIController.SetControllerStatus


[edit] TopPage

function GUIPage TopPage ()


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