UE3:UTUIFrontEnd_SettingsPanels (UT3)

Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIFrontEnd >> UTUIFrontEnd_SettingsPanels

Package:

UTGame

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

Settings panels scene for UT3. Actually holds all of the configuration panels.

Properties

AudioTab

Type: UTUITabPage_Options

Modifiers: transient

bFromMidGameMenu

Type: bool

Modifiers: transient

Set if this menu was loaded from the mid game menu

bFullyInitialized

Type: bool

Modifiers: transient

Whether or not we have been fully initialized.

HUDTab

Type: UTUITabPage_Options

Modifiers: transient

InputTab

Type: UTUITabPage_Options

Modifiers: transient

ModSettingsScene

Type: string

The scene to load when the 'Mod Settings' button is clicked (differs depending upon whether this is the main menu settings or midgame settings)

Default value: "UI_Scenes_ChrisBLayout.Scenes.ModSettingsScene"

NetworkTab

Type: UTUITabPage_Options

Modifiers: transient

PlayerTab

Type: UTUITabPage_Options

Modifiers: transient

References to the tab control and pages.

VideoTab

Type: UTUITabPage_Options

Modifiers: transient

WeaponsTab

Type: UTUITabPage_Options

Modifiers: transient

Default values

Property	Value
bSaveSceneValuesOnClose	False

Subobjects

SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd.SceneEventComponent

No new values.

Delegates

OnMarkProfileDirty

delegate OnMarkProfileDirty (optional bool bDirty)

Delegate for when the profile has been modified by something other than the user changing the value of an option.

OnNotifyOptionChanged

delegate OnNotifyOptionChanged (UIScreenObject InObject, name OptionName, int PlayerIndex)

Delegate for when the user changes one of the options an option list.

Functions

Events

PostInitialize

event PostInitialize ()

Overrides: UTUIFrontEnd.PostInitialize

PostInitialize event - Sets delegates for the scene.

SceneActivated

event SceneActivated (bool bInitialActivation)

Overrides: UTUIFrontEnd.SceneActivated

Scene activation event, always sets focus to current tab page if activating the page for a second time.

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.

MidGameMenuSetup

function MidGameMenuSetup ()

OnBack

function OnBack ()

On back handler, saves profile settings.

OnButtonBar_Back

function bool OnButtonBar_Back (UIScreenObject InButton, int PlayerIndex)

Button bar callback.

OnButtonBar_ModSettings

function bool OnButtonBar_ModSettings (UIScreenObject InButton, int PlayerIndex)

OnOptionChanged

function OnOptionChanged (UIScreenObject InObject, name OptionName, int PlayerIndex)

Handler for the OnOptionChanged delegate of each panel; called when the user changes the value for an option in any panel

OnPageActivated

function OnPageActivated (UITabControl Sender, UITabPage NewlyActivePage, int PlayerIndex)

Overrides: UTUIFrontEnd.OnPageActivated

Handler for the tab control's OnPageActivated delegate. Sets the flag indicating that the player has viewed the network page when the network tab is activated.

Parameters:

• Sender - the tab control that activated the page
• NewlyActivePage - the page that was just activated
• PlayerIndex - the index [into the Engine.GamePlayers array] for the player that generated this event.

SetupButtonBar

function SetupButtonBar ()

Overrides: UTUIFrontEnd.SetupButtonBar

Setup the scene's button bar.