UE3:UTUIScene (UT3)

Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene

Package: 

UTGame

Direct subclasses:

UTUIFrontEnd_TitleScreen, UTUIScene_TimedTutorialMessage, UTUIFrontEnd, UTUIFrontEnd_MapSelection, UTUIScene_AnimTest, UTUIScene_Campaign, UTUIScene_DemoSell, UTUIScene_Hud, UTUIScene_MessageBox, UTUIScene_OnlineToast, UTUIScene_SaveProfile, UTUIScene_TutorialMessage

This class in other games:

UDK

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

Our UIScenes provide PreRender and tick passes to our Widgets

Constants

See UTUIScene constants.

Properties

Property group 'Editor'

bEditorRealTimePreview

Type: bool

Modifiers: transient

Property group 'Flags'

bIgnoreAxisInput

Type: bool

Internal variables

bHidingScene

Type: bool

Modifiers: transient

bShowingScene

Type: bool

Modifiers: transient

Animation flags, used by the tick function to determine which update func to call.

bSkipPendingCloseSceneNotify

Type: bool

Modifiers: transient

Whether or not to skip the kismet notify for the close scene that is pending.

InputBoxScene

Type: UIScene

Modifiers: transient

MessageBoxScene

Type: UIScene

Modifiers: transient

Global scene references, only scenes that are used in-game and in-menus should be referenced here.

OnlineToastScene

Type: UIScene

Modifiers: transient

PendingCloseScene

Type: UIScene

Modifiers: transient

Pending scene to close since we are waiting for the current scene's exit animation to end.

PendingOpenScene

Type: UIScene

Modifiers: transient

Pending scene to open since we are waiting for the current scene's exit animation to end.

PlayerCardScene

Type: UIScene

Modifiers: transient

Default values

Property	Value
DefaultContextMenuClass	Class'UTGame.UTUI_ContextMenu'

Subobjects

SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UIScene.SceneEventComponent

No new values.

Enums

EUTBotTeam

Possible factions for the bots.

UTBotTeam_Random 

UTBotTeam_Ironguard 

UTBotTeam_TwinSouls 

UTBotTeam_Krall 

UTBotTeam_Liandri 

UTBotTeam_Necris 

EUTRecordDemo

Demo recording.

UTRecordDemo_No 

UTRecordDemo_Yes 

Delegates

OnHideAnimationEnded

delegate OnHideAnimationEnded ()

Callback for when the scene's hide animation has ended.

OnSceneOpened

delegate OnSceneOpened (UIScene OpenedScene, bool bInitialActivation)

Callback for when a scene has opened after hiding the topmost scene.

OnShowAnimationEnded

delegate OnShowAnimationEnded ()

Callback for when the scene's show animation has ended.

Functions

Static native functions

CheckForAutoLogin

native static function bool CheckForAutoLogin (out string Username, out string Password)

returns true if a username/password was specified on the command line and an auto login is in progress

OpenCmdLineURL

native static function bool OpenCmdLineURL ()

Launch the URL specified on the command line

SetLanPlay

native static final function SetLanPlay (bool bValue)

Sets the value of GIsLanPlay, which controls LAN server bandwidth optimizations; True means faster downloads, but higher bandwidth usage

Other static functions

FindDataStore

static function UIDataStore FindDataStore (name DataStoreTag, optional LocalPlayer InPlayerOwner)

Returns:

Returns a datastore given its tag and player owner.

GetAccountInterface

static function OnlineAccountInterface GetAccountInterface ()

Returns:

Returns a reference to the online subsystem player interface.

GetGameInterface

static function OnlineGameInterface GetGameInterface ()

Returns:

Returns a reference to the online subsystem game interface.

GetPlayerInterface

static function OnlinePlayerInterface GetPlayerInterface ()

Returns:

Returns a reference to the online subsystem player interface.

GetPlayerInterfaceEx

static function OnlinePlayerInterfaceEx GetPlayerInterfaceEx ()

Returns:

Returns a reference to the online subsystem player interface ex.

HideOnlineToast

static function HideOnlineToast ()

Hides the toast message.

ShowOnlineToast

static function ShowOnlineToast (string InMessage, optional float ToastTime, optional int Priority)

Shows a toast message.

StaticOpenScene

static function UIScene StaticOpenScene (UIScene SceneToOpen)

Opens a scene without any special hiding animation for previous scenes.

TrimWhitespace

static function string TrimWhitespace (string InString)

Trims whitespace from the beginning and end of a string.

Native functions

ActivateLevelEvent

native function ActivateLevelEvent (name EventName)

Activates a level remote event in kismet.

DeleteDemo

native function DeleteDemo (string DemoName)

GetCurrentAudioDevice

native function string GetCurrentAudioDevice ()

Returns:

Returns the currently selected audio device.

GetPawnOwner

native function Pawn GetPawnOwner ()

Returns the Pawn associated with this Hud

GetPossibleAudioDevices

native function GetPossibleAudioDevices (out array<string> OutResults)

Retrieves all of the possible audio devices from the audio driver.

GetPossibleScreenResolutions

native function GetPossibleScreenResolutions (out array<string> OutResults)

Retrieves all of the possible screen resolutions from the display driver.

GetPRIOwner

native function UTPlayerReplicationInfo GetPRIOwner ()

Returns the PRI associated with this hud

GetUTPlayerOwner

native function UTPlayerController GetUTPlayerOwner (optional int PlayerIndex)

Get the UTPlayerController that is associated with this Hud

GetWorldInfo

native function WorldInfo GetWorldInfo ()

Overrides: UIScene.GetWorldInfo

Returns the WorldInfo

IsBelowMinSpecs

native final function bool IsBelowMinSpecs () const

Returns:

TRUE if the user's machine is below the minimum required specs to play the game.

IsGame

native function bool IsGame ()

Returns:

the contents of GIsGame

SetAudioDeviceToUse

native function SetAudioDeviceToUse (string InAudioDevice)

Sets the audio device to use for playback.

Parameters:

• InAudioDevice - Audio device to use.

SetScreenResolution

native function SetScreenResolution (int ResX, int ResY, bool bFullscreen)

Sets the screen resolution.

Parameters:

• ResX - Width of the screen
• ResY - Height of the screen
• bFullscreen - Whether or not we are fullscreen.

StartDedicatedServer

native function StartDedicatedServer (string TravelURL)

Starts a dedicated server and kills the current process.

TryCharacterUnlock

native function bool TryCharacterUnlock (string UnlockCode)

Tries to unlock a character using a code.

Parameters:

• UnlockCode - Code to use to unlock the character.

Returns:

TRUE if the unlock succeeded, FALSE otherwise.

UpdateSplitscreenPlayers

native function UpdateSplitscreenPlayers (bool bCreatePlayers)

Creates/Removes local players for splitscreen.

Parameters:

• bCreatePlayers - Whether we are creating or removing players.

ViewportDeProject

native function ViewportDeProject (LocalPlayer LocalPlayerOwner, Object.Vector ScreenLocation, out Object.Vector OutLocation, out Object.Vector OutDirection)

Converts a 2D Screen coordiate in to 3D space

Parameters:

• LocalPlayerOwner - The LocalPlayer that owns the viewport where the projection occurs
• ScreenLocation - Where on the screen are we converting from
• OutLocation - Returns the Location in world space
• OutDirection - Returns the view direction

ViewportProject

native function ViewportProject (LocalPlayer LocalPlayerOwner, Object.Vector WorldLocation, out Object.Vector OutScreenLocation)

Converts a 2D Screen coordiate in to 3D space

Parameters:

• LocalPlayerOwner - The LocalPlayer that owns the viewport where the projection occurs
• WorldLocation - The world location to project to
• OutScreenLocation - Returns the location in 2D space

Events

IsControllerInput

event bool IsControllerInput (name KeyName)

Returns whether or not the input passed in is a gamepad input event.

Parameters:

• KeyName - Key name to check

Returns:

Returns TRUE if the input key is from a gamepad, FALSE otherwise.

OnAnimationFinished

event OnAnimationFinished (UIObject AnimTarget, name AnimName, name SeqName)

Other instance functions

See UTUIScene instance functions.