Cogito, ergo sum

UE3:UTUIFrontEnd_Settings (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
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[edit]

SETTINGS_OPTION_VIDEO[edit]

Value: 0


SETTINGS_OPTION_AUDIO[edit]

Value: 1


SETTINGS_OPTION_INPUT[edit]

Value: 2


SETTINGS_OPTION_NETWORK[edit]

Value: 3


SETTINGS_OPTION_WEAPONS[edit]

Value: 4


SETTINGS_OPTION_HUD[edit]

Value: 5


SETTINGS_OPTION_CREDITS[edit]

Value: 6


SETTINGS_OPTION_INSTALL[edit]

Value: 7


Properties[edit]

bDirty[edit]

Type: bool

Modifiers: private

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

bFromMidGameMenu[edit]

Type: bool

Modifiers: transient

Set if this menu was loaded from the mid game menu

CreditsScene[edit]

Type: string

Reference to credits screen.

Default value: "UI_Scenes_FrontEnd.Scenes.Credits"

SelectedPage[edit]

Type: int

Modifiers: transient

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

SettingsPanelsScene[edit]

Type: string

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

Default value: "UI_Scenes_ChrisBLayout.Scenes.SettingsPanels"

Default values[edit]

Property Value
bSaveSceneValuesOnClose False

Subobjects[edit]

SceneEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd_BasicMenu.SceneEventComponent

No new values.

Functions[edit]

Events[edit]

SceneActivated[edit]

event SceneActivated (bool bInitialActivation)

Overrides: UTUIFrontEnd.SceneActivated

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

Other instance functions[edit]

ConditionalSaveProfile[edit]

function ConditionalSaveProfile ()

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

GetTitleLabel[edit]

function UILabel GetTitleLabel ()

Overrides: UTUIFrontEnd.GetTitleLabel

(Description copied from UTUIFrontEnd.GetTitleLabel)


Returns:

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

MarkDirty[edit]

final function MarkDirty (optional bool bIsDirty)


MidGameMenuSetup[edit]

function MidGameMenuSetup ()


OnBack[edit]

function OnBack ()

Overrides: UTUIFrontEnd_BasicMenu.OnBack

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

OnPanelsSceneOpened[edit]

function OnPanelsSceneOpened (UIScene OpenedScene, bool bInitialActivation)

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

OnSaveProfileCompleted[edit]

function OnSaveProfileCompleted ()

Callback for when the profile save has completed.

OnSelectItem[edit]

function OnSelectItem (int PlayerIndex)

Overrides: UTUIFrontEnd_BasicMenu.OnSelectItem

Executes a action based on the currently selected menu item.

OnSettingValueChanged[edit]

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