Cogito, ergo sum

UE3:UTUIFrontEnd_Settings (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 06:18, 16 August 2009 by Wormbo (Talk | contribs) (added missing members)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
UT3 Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIFrontEnd >> UTUIFrontEnd_BasicMenu >> UTUIFrontEnd_Settings
Package: 
UTGame

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

Settings scene for UT3.

Constants

SETTINGS_OPTION_VIDEO

Value: 0


SETTINGS_OPTION_AUDIO

Value: 1


SETTINGS_OPTION_INPUT

Value: 2


SETTINGS_OPTION_NETWORK

Value: 3


SETTINGS_OPTION_WEAPONS

Value: 4


SETTINGS_OPTION_HUD

Value: 5


SETTINGS_OPTION_CREDITS

Value: 6


SETTINGS_OPTION_INSTALL

Value: 7


Properties

bDirty

Type: bool

Modifiers: private

TRUE if the value for any options in the scene have changed

bFromMidGameMenu

Type: bool

Modifiers: transient

Set if this menu was loaded from the mid game menu

CreditsScene

Type: string

Reference to credits screen.

Default value: "UI_Scenes_FrontEnd.Scenes.Credits"

SelectedPage

Type: int

Modifiers: transient

Index of the tabpage to show after the settings panels scene is opened.

SettingsPanelsScene

Type: string

Reference to the actual scene that holds all of the settings panels.

Default value: "UI_Scenes_ChrisBLayout.Scenes.SettingsPanels"

Default values

Property Value
bSaveSceneValuesOnClose False

Subobjects

SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd_BasicMenu.SceneEventComponent

No new values.

Functions

Events

SceneActivated

event SceneActivated (bool bInitialActivation)

Overrides: UTUIFrontEnd.SceneActivated

Scene activated event, sets up the title for the scene.

Other instance functions

ConditionalSaveProfile

function ConditionalSaveProfile ()

Saves and reloads the player profile if any values were changed.

GetTitleLabel

function UILabel GetTitleLabel ()

Overrides: UTUIFrontEnd.GetTitleLabel

(Description copied from UTUIFrontEnd.GetTitleLabel)


Returns:

Returns the title label that is located on the background scene.

MarkDirty

final function MarkDirty (optional bool bIsDirty)


MidGameMenuSetup

function MidGameMenuSetup ()


OnBack

function OnBack ()

Overrides: UTUIFrontEnd_BasicMenu.OnBack

override this to save the profile if the user changed any settings

OnPanelsSceneOpened

function OnPanelsSceneOpened (UIScene OpenedScene, bool bInitialActivation)

Callback for when the settings scene has opened after its intro animation.

OnSaveProfileCompleted

function OnSaveProfileCompleted ()

Callback for when the profile save has completed.

OnSelectItem

function OnSelectItem (int PlayerIndex)

Overrides: UTUIFrontEnd_BasicMenu.OnSelectItem

Executes a action based on the currently selected menu item.

OnSettingValueChanged

function OnSettingValueChanged (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