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

UTGame.GFxUDKFrontEnd_MainMenu

Extends
GFxUDKFrontEnd_Screen
Modifiers
config ( UI )

Filename : GFxUDKFrontEnd_MainMenu.uc Content : GFx-UDK Front End Implementaiton Copyright : (c) 2010 Scaleform Corp. All Rights Reserved. Notes : Implementation of a main menu for the GFx-UDK front end. Associated Flash content: udk_main_menu.fla Licensees may use this file in accordance with the valid Scaleform Commercial License Agreement provided with the software. This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR ANY PURPOSE.

Core.Object
|   
+-- GFxUI.GFxObject
   |   
   +-- UTGame.GFxUIView
      |   
      +-- UTGame.GFxUDKFrontEnd_View
         |   
         +-- UTGame.GFxUDKFrontEnd_Screen
            |   
            +-- UTGame.GFxUDKFrontEnd_MainMenu

Constants Summary
Inherited Contants from UTGame.GFxUDKFrontEnd_View
FakePlayerIndex

Variables Summary
byteLastSelectedIndex
GFxObjectListDataProvider
GFxClikWidgetListMC
array<Option>ListOptions
GFxObjectUserLabelTxt
GFxObjectUserNameTxt
Inherited Variables from UTGame.GFxUDKFrontEnd_Screen
AcceptButtonHelpText, AcceptButtonImage, BackBtn, CancelButtonHelpText, CancelButtonImage, FooterMC, HelpTxt, InfoTxt, LogoMC, TitleMC, ViewTitle
Inherited Variables from UTGame.GFxUDKFrontEnd_View
MenuManager, ViewName

Structures Summary
Option
OptionName, OptionLabel, OptionDesc

Functions Summary
function DisableSubComponents (bool bDisableComponents))
function ExitDialog_SelectBack (GFxClikWidget.EventData ev ))
function ExitDialog_SelectOK (GFxClikWidget.EventData ev ))
function OnEscapeKeyPress ()))
function OnListChange (GFxClikWidget.EventData ev))
function OnListItemPress (GFxClikWidget.EventData ev))
function OnTopMostView (optional bool bPlayOpenAnimation = false))
function OnViewLoaded ()))
function Select_ExitGame ()))
function Select_InstantAction ()))
function Select_Multiplayer ()))
function SetList (GFxObject InList))
function UpdateDescription ()))
function UpdateListDataProvider ()))
eventbool WidgetInitialized (name WidgetName, name WidgetPath, GFxObject Widget))
Inherited Functions from UTGame.GFxUDKFrontEnd_Screen
FocusIn_BackButton, UpdateHelpButtonImages, WidgetInitialized
Inherited Functions from UTGame.GFxUDKFrontEnd_View
DisableSubComponents, MoveBackImpl, OnEscapeKeyPress, OnTopMostView, OnViewActivated, OnViewClosed, OnViewLoaded, PlayCloseAnimation, PlayOpenAnimation, Select_Back, WidgetInitialized


Variables Detail

LastSelectedIndex Source code

var byte LastSelectedIndex;

ListDataProvider Source code

var GFxObject ListDataProvider;
Reference to the list's dataProvider array in AS.

ListMC Source code

var GFxClikWidget ListMC;
Reference to the list.

ListOptions Source code

var config array<Option> ListOptions;
Aray of all list options, defined in DefaultUI.ini

UserLabelTxt Source code

var GFxObject UserLabelTxt;
Reference to the "USER" label at the bottom right. Label for username textField.

UserNameTxt Source code

var GFxObject UserNameTxt;
Reference to the User Name textField. This only appears if the user is properly logged in.


Structures Detail

Option Source code

struct Option
{
var string OptionDesc;
var string OptionLabel;
var string OptionName;
};
Structure which defines a unique game mode.


Functions Detail

DisableSubComponents Source code

function DisableSubComponents ( bool bDisableComponents) )
Enable/disable sub-components of the view.

ExitDialog_SelectBack Source code

function ExitDialog_SelectBack ( GFxClikWidget.EventData ev ) )
Listener for ExitDialog's "Cancel" button press. Pops a dialog from the view stack.

ExitDialog_SelectOK Source code

function ExitDialog_SelectOK ( GFxClikWidget.EventData ev ) )
Listener for ExitDialog's "OK" button press. Quits the game.

OnEscapeKeyPress Source code

function OnEscapeKeyPress ( ) )

OnListChange Source code

private final function OnListChange ( GFxClikWidget.EventData ev) )
Listener for the menu's list "CLIK_onChange" event. When the selectedIndex of the list changes, update the title, description, and image information using the data from the list.

OnListItemPress Source code

private final function OnListItemPress ( GFxClikWidget.EventData ev) )
Listener for the menu's list "CLIK_itemPress" event. When an item is pressed, retrieve the data associated with the item and use it to trigger the appropriate function call.

OnTopMostView Source code

function OnTopMostView ( optional bool bPlayOpenAnimation = false) )
Update the view. This method is called whenever the view is pushed or popped from the view stakc.

OnViewLoaded Source code

function OnViewLoaded ( ) )
Configures the view when it is first loaded.

Select_ExitGame Source code

function Select_ExitGame ( ) )
Before exiting the game, spawn a dialog asking the user to confirm his selection.

Select_InstantAction Source code

function Select_InstantAction ( ) )
Pushes the Instant Action view on to the stack. This method is fired by the list's OnListItemPress() listener.

Select_Multiplayer Source code

function Select_Multiplayer ( ) )
Pushes the Multiplayer view on to the stack. This method is fired by the list's OnListItemPress() listener.

SetList Source code

function SetList ( GFxObject InList) )
Passes a reference to the list back to the AS View implementation.

UpdateDescription Source code

function UpdateDescription ( ) )
Update the info text field with a description of the currently selected index.

UpdateListDataProvider Source code

function UpdateListDataProvider ( ) )
Sets up the list's dataProvider using the data pulled from DefaultUI.ini.

WidgetInitialized Source code

event bool WidgetInitialized ( name WidgetName, name WidgetPath, GFxObject Widget) )


Defaultproperties

defaultproperties
{
	AcceptButtonHelpText="SELECT"
	CancelButtonHelpText="EXIT GAME"
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: ti 22-3-2011 19:56:50.511 - Created with UnCodeX