Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

UTGame.UTUIFrontEnd_Settings

Extends
UTUIFrontEnd_BasicMenu

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. Settings scene for UT3.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIScene
         |   
         +-- UTGame.UTUIScene
            |   
            +-- UTGame.UTUIFrontEnd
               |   
               +-- UTGame.UTUIFrontEnd_BasicMenu
                  |   
                  +-- UTGame.UTUIFrontEnd_Settings

Constants Summary
SETTINGS_OPTION_AUDIO=1
SETTINGS_OPTION_CREDITS=6
SETTINGS_OPTION_HUD=5
SETTINGS_OPTION_INPUT=2
SETTINGS_OPTION_INSTALL=7
SETTINGS_OPTION_NETWORK=3
SETTINGS_OPTION_VIDEO=0
SETTINGS_OPTION_WEAPONS=4

Variables Summary
boolbDirty
boolbFromMidGameMenu
stringCreditsScene
intSelectedPage
stringSettingsPanelsScene
Inherited Variables from UTGame.UTUIFrontEnd_BasicMenu
bSupportBackButton, DescriptionLabel, MenuList
Inherited Variables from UTGame.UTUIFrontEnd
bCancellingInstallPS3, bInstallingPS3, ButtonBar, CurrentPageIndex, ImportingMessageBoxReference, ImportState, LastURL, PreviousPageIndex, TabControl, TitleMarkupString, VersionFont, VersionPos, VersionText

Enumerations Summary
Inherited Enumerations from UTGame.UTUIFrontEnd
EModImport

Functions Summary
function ConditionalSaveProfile ()))
functionUILabel GetTitleLabel ()))
function MarkDirty (optional bool bIsDirty=true ))
function MidGameMenuSetup ()))
function OnBack ()))
function OnPanelsSceneOpened (UIScene OpenedScene, bool bInitialActivation))
function OnSaveProfileCompleted ()))
function OnSelectItem (int PlayerIndex=0))
function OnSettingValueChanged (UIScreenObject InObject, name OptionName, int PlayerIndex))
event SceneActivated (bool bInitialActivation))
Inherited Functions from UTGame.UTUIFrontEnd_BasicMenu
HandleInputKey, OnBack, OnButtonBar_Back, OnButtonBar_Select, OnMenu_SubmitSelection, OnMenu_ValueChanged, OnSelectItem, PostInitialize, SetupButtonBar
Inherited Functions from UTGame.UTUIFrontEnd
BeginHideAnimation, BeginImportMod, BeginInstallPS3, BeginShowAnimation, CancelInstallPS3, CheckForFrontEndError, ChildSceneOpened, GetTitleLabel, HandleInputKey, ImportMod, InstallPS3, OnCancelInstallPS3, OnCancelMessageClosed, OnImportModFinished, OnInstallMessageClosed, OnLoginError_Confirm, OnMainRegion_Show_UIAnimEnd, OnPageActivated, OnRetryPasswordDialog_Closed, OnTabPage_Hide_UIAnimEnd, OnTabPage_Show_UIAnimEnd, PostInitialize, PromptForPassword, SavePassword, SceneActivated, SetTitle, SetupButtonBar, UpdateModState, UpdatePS3InstallState


Constants Detail

SETTINGS_OPTION_AUDIO Source code

const SETTINGS_OPTION_AUDIO = 1;

SETTINGS_OPTION_CREDITS Source code

const SETTINGS_OPTION_CREDITS = 6;

SETTINGS_OPTION_HUD Source code

const SETTINGS_OPTION_HUD = 5;

SETTINGS_OPTION_INPUT Source code

const SETTINGS_OPTION_INPUT = 2;

SETTINGS_OPTION_INSTALL Source code

const SETTINGS_OPTION_INSTALL = 7;

SETTINGS_OPTION_NETWORK Source code

const SETTINGS_OPTION_NETWORK = 3;

SETTINGS_OPTION_VIDEO Source code

const SETTINGS_OPTION_VIDEO = 0;

SETTINGS_OPTION_WEAPONS Source code

const SETTINGS_OPTION_WEAPONS = 4;


Variables Detail

bDirty Source code

var private bool bDirty;
TRUE if the value for any options in the scene have changed

bFromMidGameMenu Source code

var transient bool bFromMidGameMenu;
Set if this menu was loaded from the mid game menu

CreditsScene Source code

var string CreditsScene;
Reference to credits screen.

SelectedPage Source code

var transient int SelectedPage;
Index of the tabpage to show after the settings panels scene is opened.

SettingsPanelsScene Source code

var string SettingsPanelsScene;
Reference to the actual scene that holds all of the settings panels.


Functions Detail

ConditionalSaveProfile Source code

function ConditionalSaveProfile ( ) )
Saves and reloads the player profile if any values were changed.

GetTitleLabel Source code

function UILabel GetTitleLabel ( ) )

MarkDirty Source code

final function MarkDirty ( optional bool bIsDirty=true ) )

MidGameMenuSetup Source code

function MidGameMenuSetup ( ) )

OnBack Source code

function OnBack ( ) )
override this to save the profile if the user changed any settings

OnPanelsSceneOpened Source code

function OnPanelsSceneOpened ( UIScene OpenedScene, bool bInitialActivation) )
Callback for when the settings scene has opened after its intro animation.

OnSaveProfileCompleted Source code

function OnSaveProfileCompleted ( ) )
Callback for when the profile save has completed.

OnSelectItem Source code

function OnSelectItem ( int PlayerIndex=0) )
Executes a action based on the currently selected menu item.

OnSettingValueChanged Source code

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

SceneActivated Source code

event SceneActivated ( bool bInitialActivation) )


Defaultproperties

defaultproperties
{
   CreditsScene="UI_Scenes_FrontEnd.Scenes.Credits"
   SettingsPanelsScene="UI_Scenes_ChrisBLayout.Scenes.SettingsPanels"
   bSaveSceneValuesOnClose=False
   Begin Object Class=UIComp_Event Name=SceneEventComponent ObjName=SceneEventComponent Archetype=UIComp_Event'UTGame.Default__UTUIFrontEnd_BasicMenu:SceneEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTUIFrontEnd_BasicMenu:SceneEventComponent'
   End Object
   EventProvider=SceneEventComponent
   Name="Default__UTUIFrontEnd_Settings"
   ObjectArchetype=UTUIFrontEnd_BasicMenu'UTGame.Default__UTUIFrontEnd_BasicMenu'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:58.954 - Created with UnCodeX