UE3:UTUIFrontEnd_BasicMenu (UDK)

Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIFrontEnd >> UTUIFrontEnd_BasicMenu

Package: 

UTGame

Direct subclasses:

UTUIFrontEnd_MainMenu, UTUIFrontEnd_Multiplayer

This class in other games:

UT3

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.

Basic Menu Scene for UT3, contains a menu list and a description label.

Properties

bSupportBackButton

Type: bool

Whether or not to support a back button for this scene.

Default value: True

DescriptionLabel

Type: UILabel

Modifiers: transient

Reference to the description label for this scene.

MenuList

Type: UTUIMenuList

Modifiers: transient

Reference to the menu list for this scene.

Subobjects

SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd.SceneEventComponent

No new values.

Functions

Events

PostInitialize

event PostInitialize ()

Overrides: UTUIFrontEnd.PostInitialize

Post initialize callback.

Other instance functions

HandleInputKey

function bool HandleInputKey (const out UIRoot.InputEventParameters EventParms)

Overrides: UTUIFrontEnd.HandleInputKey

Provides a hook for unrealscript to respond to input using actual input key names (i.e. Left, Tab, etc.)

Called when an input key event is received which this widget responds to and is in the correct state to process. The keys and states widgets receive input for is managed through the UI editor's key binding dialog (F8).

This delegate is called BEFORE kismet is given a chance to process the input.

Parameters:

• EventParms - information about the input event.

Returns:

TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

OnBack

function OnBack ()

Callback for when the user wants to back out of this screen.

OnButtonBar_Back

function bool OnButtonBar_Back (UIScreenObject InButton, int InPlayerIndex)

Buttonbar Callbacks.

OnButtonBar_Select

function bool OnButtonBar_Select (UIScreenObject InButton, int InPlayerIndex)

Buttonbar Callbacks.

OnMenu_SubmitSelection

function OnMenu_SubmitSelection (UIObject Sender, optional int PlayerIndex)

Called when the user presses Enter (or any other action bound to UIKey_SubmitListSelection) while this list has focus.

Parameters:

• Sender - the list that is submitting the selection

OnMenu_ValueChanged

function OnMenu_ValueChanged (UIObject Sender, optional int PlayerIndex)

Called when the user changes the currently selected list item.

OnSelectItem

function OnSelectItem (int PlayerIndex)

Executes a action based on the currently selected menu item.

SetupButtonBar

function SetupButtonBar ()

Overrides: UTUIFrontEnd.SetupButtonBar

Setup the scene's buttonbar.