Cogito, ergo sum
Difference between revisions of "UE3:UTUIFrontEnd (UDK)"
(Talk) |
m (1 revision: class descriptions for UDK January update (part 8)) |
(No difference)
| |
Latest revision as of 06:02, 17 January 2010
 |
Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIFrontEnd |
- Package:
- UTGame
- Direct subclasses:
- UTUIFrontEnd_ArenaConfigMenu, UTUIFrontEnd_BasicMenu, UTUIFrontEnd_JoinGame, UTUIFrontEnd_LaunchGame, UTUIFrontEnd_Mutators, UTUIFrontEnd_WeaponReplacementMenu
- This class in other games:
- UT3
| 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. |
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]
ButtonBar[edit]
Type: UTUIButtonBar
Modifiers: transient
Pointer to the button bar for this scene.
CurrentPageIndex[edit]
Type: int
Modifiers: transient
PreviousPageIndex[edit]
Type: int
Modifiers: transient
TabControl[edit]
Type: UTUITabControl
Modifiers: transient
Pointer to the tab control for this scene.
Default values[edit]
| Property | Value |
|---|---|
| OnInterceptRawInputKey | HandleInputKey |
| OnTopSceneChanged | ChildSceneOpened |
| bPauseGameWhileActive | False |
| SceneRenderMode | SPLITRENDER_Fullscreen |
Subobjects[edit]
SceneEventComponent[edit]
Class: Engine.UIComp_Event
Inherits from: UTUIScene.SceneEventComponent
No new values.
Functions[edit]
Events[edit]
PostInitialize[edit]
Overrides: UIScreenObject.PostInitialize
Post initialize callback.
SceneActivated[edit]
Overrides: UIScene.SceneActivated
Scene activated event, sets up the title for the scene.
Other instance functions[edit]
BeginHideAnimation[edit]
Overrides: UTUIScene.BeginHideAnimation
Starts the exit animation for the scene.
Returns:
- TRUE if there's animation for this scene, FALSE otherwise.
BeginShowAnimation[edit]
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]
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]
Called when a new scene is opened over this one. Propagates the values for bRequiresNetwork and bRequiresOnlineService to the new page.
GetTitleLabel[edit]
Returns:
- Returns the title label that is located on the background scene.
HandleInputKey[edit]
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.
OnMainRegion_Show_UIAnimEnd[edit]
Called when a tab page has finished showing.
OnPageActivated[edit]
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.
OnTabPage_Hide_UIAnimEnd[edit]
Called when a tab page has finished hiding.
OnTabPage_Show_UIAnimEnd[edit]
Called when a tab page has finished showing.
SetTitle[edit]
Sets the title for this scene.
SetupButtonBar[edit]
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.
