Once I get that upgrade to 36-hour days, I will tackle that. – Mychaeel

Difference between revisions of "UE3:UTUIFrontEnd (UT3)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
m (1 revision)
m (added missing members)
 
(2 intermediate revisions by the same user not shown)
Line 57: Line 57:
 
====ImportState====
 
====ImportState====
 
'''Type:''' {{tl|EModImport}}
 
'''Type:''' {{tl|EModImport}}
 +
 +
'''[[Variables#Modifiers|Modifiers]]:''' transient
 +
 +
<!-- enter variable description -->
 +
 +
====LastURL====
 +
'''Type:''' [[string]]
  
 
'''[[Variables#Modifiers|Modifiers]]:''' transient
 
'''[[Variables#Modifiers|Modifiers]]:''' transient
Line 105: Line 112:
 
<!-- enter variable description -->
 
<!-- enter variable description -->
  
−
'''Default value:''' "Version 1.3 Beta 4"
+
'''Default value:''' "Version 2.1"
  
 
===Default values===
 
===Default values===
Line 120: Line 127:
 
| {{tl|bPauseGameWhileActive||UIScene}}
 
| {{tl|bPauseGameWhileActive||UIScene}}
 
| False
 
| False
 +
|-
 +
| {{tl|DefaultContextMenuClass||UIScene}}
 +
| [[Types#Class|Class]]'{{cl|UIContextMenu|Engine}}'
 
|-
 
|-
 
| {{tl|SceneRenderMode||UIScene}}
 
| {{tl|SceneRenderMode||UIScene}}
Line 303: Line 313:
 
* ''NewlyActivePage'' - the page that was just activated
 
* ''NewlyActivePage'' - the page that was just activated
 
* ''PlayerIndex'' - the index [into the Engine.GamePlayers array] for the player that generated this event.
 
* ''PlayerIndex'' - the index [into the Engine.GamePlayers array] for the player that generated this event.
 +
 +
====OnRetryPasswordDialog_Closed====
 +
{{code|final function '''OnRetryPasswordDialog_Closed''' ({{cl|UTUIScene_MessageBox}}&nbsp;'''MessageBox''', [[int]]&nbsp;'''SelectedOption''', [[int]]&nbsp;'''PlayerIndex''')}}
 +
 +
<!-- enter function description -->
  
 
====OnTabPage_Hide_UIAnimEnd====
 
====OnTabPage_Hide_UIAnimEnd====
Line 313: Line 328:
  
 
Called when a tab page has finished showing.
 
Called when a tab page has finished showing.
 +
 +
====PromptForPassword====
 +
{{code|final function '''PromptForPassword''' ()}}
 +
 +
<!-- enter function description -->
  
 
====SetTitle====
 
====SetTitle====

Latest revision as of 06:07, 16 August 2009

UT3 Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIFrontEnd
Package: 
UTGame
Direct subclasses:
UTUIFrontEnd_PlayerStats, UTUIScene_CNewOrContinue, UTUIFrontEnd_WeaponPreference, UTUIFrontEnd_QuickMatch, UTUIFrontEnd_CharacterFaction, UTUIFrontEnd_WeaponReplacementMenu, UTUIFrontEnd_ArenaConfigMenu, UTUIFrontEnd_BasicMenu, UTUIFrontEnd_BindKeys360, UTUIFrontEnd_BindKeysPC, UTUIFrontEnd_BindKeysPS3, UTUIFrontEnd_BotSelection, UTUIFrontEnd_CharacterCustomization, UTUIFrontEnd_CharacterSelection, UTUIFrontEnd_Credits, UTUIFrontEnd_CustomScreen, UTUIFrontEnd_DemoPlayback, UTUIFrontEnd_Friends, UTUIFrontEnd_JoinGame, UTUIFrontEnd_LaunchGame, UTUIFrontEnd_Leaderboards, UTUIFrontEnd_MapCycle, UTUIFrontEnd_Mutators, UTUIFrontEnd_SettingsPanels, UTUIFrontEnd_News, UTUIFrontEnd_SettingsVideoAdvanced, UTUIScene_COptions, UTUIFrontEnd_Achievements, UTUIFrontEnd_BrowserMutatorFilters, UTUIFrontEnd_ModSettings
This class in other games:
UDK
This is an auto-generated page and may need human attention.
Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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

Base class for frontend scenes, looks for buttonbar and tab control references.

Properties[edit]

Property group 'UTUIFrontEnd'[edit]

TitleMarkupString[edit]

Type: string

Markup for the title for this scene.

Internal variables[edit]

bCancellingInstallPS3[edit]

Type: bool

Modifiers: transient

Whether or not we are currently cancelling the ps3 install on the PS3.

bInstallingPS3[edit]

Type: bool

Modifiers: transient

Whether or not we are currently installing on the PS3.

ButtonBar[edit]

Type: UTUIButtonBar

Modifiers: transient

Pointer to the button bar for this scene.

CurrentPageIndex[edit]

Type: int

Modifiers: transient


ImportingMessageBoxReference[edit]

Type: UTUIScene_MessageBox

Modifiers: transient


ImportState[edit]

Type: EModImport

Modifiers: transient


LastURL[edit]

Type: string

Modifiers: transient


PreviousPageIndex[edit]

Type: int

Modifiers: transient


TabControl[edit]

Type: UTUITabControl

Modifiers: transient

Pointer to the tab control for this scene.

VersionFont[edit]

Type: Font


VersionPos[edit]

Type: Object.Vector2D


Default value:

Member Value
X 0.0090
Y 0.057

VersionText[edit]

Type: string

Modifiers: localized


Default value: "Version 2.1"

Default values[edit]

Property Value
OnRawInputKey HandleInputKey
OnTopSceneChanged ChildSceneOpened
bPauseGameWhileActive False
DefaultContextMenuClass Class'Engine.UIContextMenu'
SceneRenderMode SPLITRENDER_Fullscreen

Subobjects[edit]

SceneEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTUIScene.SceneEventComponent

No new values.

Enums[edit]

EModImport[edit]

Current mod import state.

MODIMPORT_Inactive 
MODIMPORT_Started 
MODIMPORT_Unpacking 
MODIMPORT_Finished 

Functions[edit]

Native functions[edit]

BeginImportMod[edit]

native function BeginImportMod ()

Starts the mod importing process.

BeginInstallPS3[edit]

native function BeginInstallPS3 ()

Starts the PS3 install process.

CancelInstallPS3[edit]

native function CancelInstallPS3 ()

Cancels the PS3 install.

SavePassword[edit]

native function SavePassword (string Password)

Encrypts the password and saves the data

Events[edit]

PostInitialize[edit]

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Post initialize callback.

SceneActivated[edit]

event SceneActivated (bool bInitialActivation)

Overrides: UIScene.SceneActivated

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

UpdateModState[edit]

event UpdateModState (EModImport NewState)

Updates the current state of the mod import.

Parameters:

  • NewState - New import state

UpdatePS3InstallState[edit]

event UpdatePS3InstallState (int CurrentFileNum, int TotalFileNum, bool bFinishedCancelling)

Updates the current install state for the PS3 Install.

Parameters:

  • CurrentFileNum - Current file number installing.
  • TotalFileNum - Total number of files to install.

Other instance functions[edit]

BeginHideAnimation[edit]

function bool BeginHideAnimation (bool bClosingScene)

Overrides: UTUIScene.BeginHideAnimation

Starts the exit animation for the scene.

Returns:

TRUE if there's animation for this scene, FALSE otherwise.

BeginShowAnimation[edit]

function bool BeginShowAnimation (bool bInitialActivation, bool bBypassAnimation)

Overrides: UTUIScene.BeginShowAnimation

Starts the show animation for the scene.

Parameters:

  • bInitialActivation - TRUE if the scene is being opened; FALSE if the another scene was closed causing this one to become the topmost scene.
  • bBypassAnimation - TRUE to force all animations to their last frame, effectively bypassing animations. This can be necessary for e.g. scenes which start out off-screen or something.

Returns:

TRUE if there's animation for this scene, FALSE otherwise.

CheckForFrontEndError[edit]

function CheckForFrontEndError ()

Checks to see if a frontend error message was set by the game before returning to the main menu, if so, we skip to the main menu and display the message.

ChildSceneOpened[edit]

function ChildSceneOpened (UIScene NewTopScene)

Called when a new scene is opened over this one. Propagates the values for bRequiresNetwork and bRequiresOnlineService to the new page.

GetTitleLabel[edit]

function UILabel GetTitleLabel ()

Returns:

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

HandleInputKey[edit]

function bool HandleInputKey (const out UIRoot.InputEventParameters EventParms)

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.

ImportMod[edit]

function ImportMod ()

Function to start importing a mod.

InstallPS3[edit]

function InstallPS3 ()

Installs the game on PS3.

OnCancelInstallPS3[edit]

function OnCancelInstallPS3 (UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex)

Confirmation for the cancel dialog.

OnCancelMessageClosed[edit]

function OnCancelMessageClosed ()

Callback for the install PS3 messagebox has closed.

OnImportModFinished[edit]

function OnImportModFinished ()

Callback for when the import has finished for a mod.

OnInstallMessageClosed[edit]

function OnInstallMessageClosed ()

Callback for the install PS3 messagebox has closed.

OnLoginError_Confirm[edit]

function OnLoginError_Confirm (UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex)

Overrides: UTUIScene.OnLoginError_Confirm

Callback for when the login required box has finished displaying.

OnMainRegion_Show_UIAnimEnd[edit]

function OnMainRegion_Show_UIAnimEnd (UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq)

Called when a tab page has finished showing.

OnPageActivated[edit]

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

Called when a new page 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.

OnRetryPasswordDialog_Closed[edit]

final function OnRetryPasswordDialog_Closed (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex)


OnTabPage_Hide_UIAnimEnd[edit]

function OnTabPage_Hide_UIAnimEnd (UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq)

Called when a tab page has finished hiding.

OnTabPage_Show_UIAnimEnd[edit]

function OnTabPage_Show_UIAnimEnd (UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq)

Called when a tab page has finished showing.

PromptForPassword[edit]

final function PromptForPassword ()


SetTitle[edit]

function SetTitle ()

Sets the title for this scene.

SetupButtonBar[edit]

function SetupButtonBar ()

Overrides: UTUIScene.SetupButtonBar

Function that sets up a buttonbar for this scene, automatically routes the call to the currently selected tab of the scene as well.

Retrieved from "https://wiki.beyondunreal.com/UE3:UTUIFrontEnd_(UT3)?oldid=35241"