Cogito, ergo sum
Difference between revisions of "UE3:UTUIFrontEnd TitleScreen (UDK)"
(Talk) |
m (1 revision: class descriptions for UDK January update (part 8)) |
(No difference)
| |
Latest revision as of 07:02, 17 January 2010
 |
Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIFrontEnd_TitleScreen |
| 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. |
Title screen scene for UT3, handles attract mode launching.
Properties[edit]
Property group 'UTUIFrontEnd_TitleScreen'[edit]
MovieName[edit]
Type: string
Name of the attract mode movie.
TimeTillAttractMovie[edit]
Type: float
Amount of time until the attract movie starts.
Default value: 90.0
Internal variables[edit]
bInMovie[edit]
Type: bool
Whether or not we are in the attract mode movie.
bUpdatePlayersOnNextTick[edit]
Type: bool
Modifiers: transient
Flag to update the LP array on the next tick.
MainMenuScene[edit]
Type: string
Reference to the main menu scene.
Default value: "UI_Scenes_ChrisBLayout.Scenes.MainMenu"
TimeElapsed[edit]
Type: float
Amount of time elapsed since last user input.
Default values[edit]
| Property | Value |
|---|---|
| OnInterceptRawInputKey | HandleInputKey |
Subobjects[edit]
SceneEventComponent[edit]
Class: Engine.UIComp_Event
Inherits from: UTUIScene.SceneEventComponent
No new values.
Functions[edit]
Native functions[edit]
StartMovie[edit]
Starts the attract mode movie.
StopMovie[edit]
Stops the currently playing movie.
UpdateGamePlayersArray[edit]
Creates a local player for every signed in controller.
UpdateMovieStatus[edit]
Checks to see if a movie is done playing.
Events[edit]
GetNumLoggedInPlayers[edit]
Returns:
- Returns the number of currently logged in controllers.
PostInitialize[edit]
Overrides: UIScreenObject.PostInitialize
Post initialize event - Sets delegates for the scene.
SceneActivated[edit]
Overrides: UIScene.SceneActivated
(Description copied from UIScene.SceneActivated)
Called just after the scene is added to the ActiveScenes array, or when this scene has become the active scene as a result of closing another scene.
Parameters:
- bInitialActivation - TRUE if this is the first time this scene is being activated; FALSE if this scene has become active as a result of closing another scene or manually moving this scene in the stack.
SceneDeactivated[edit]
Overrides: UIScene.SceneDeactivated
Called just after this scene is removed from the active scenes array
UpdateProfileLabels[edit]
Updates the profile labels.
Other instance functions[edit]
CheckTitleSkip[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.
CleanupOnlineDelegates[edit]
Cleans up any registered online delegates.
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.
OnLoginChange[edit]
Called any time any player changes their current login status.
OnProfileReadComplete[edit]
Called when the profile read has completed for any player.
RegisterOnlineDelegates[edit]
Registers online delegates to catch global events such as login changes.
SetMainControllerId[edit]
Sets PlayerIndex 0's controller id to be the specified controller id, this makes it so that the specified controller can control all of the menus.
