Cogito, ergo sum

UE3:UTUIScene (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
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[edit]

See UTUIScene constants.

Properties[edit]

Property group 'Editor'[edit]

bEditorRealTimePreview[edit]

Type: bool

Modifiers: transient


Property group 'Flags'[edit]

bIgnoreAxisInput[edit]

Type: bool


Internal variables[edit]

bHidingScene[edit]

Type: bool

Modifiers: transient


bShowingScene[edit]

Type: bool

Modifiers: transient

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

bSkipPendingCloseSceneNotify[edit]

Type: bool

Modifiers: transient

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

InputBoxScene[edit]

Type: UIScene

Modifiers: transient


MessageBoxScene[edit]

Type: UIScene

Modifiers: transient

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

OnlineToastScene[edit]

Type: UIScene

Modifiers: transient


PendingCloseScene[edit]

Type: UIScene

Modifiers: transient

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

PendingOpenScene[edit]

Type: UIScene

Modifiers: transient

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

PlayerCardScene[edit]

Type: UIScene

Modifiers: transient


Default values[edit]

Property Value
DefaultContextMenuClass Class'UTGame.UTUI_ContextMenu'

Subobjects[edit]

SceneEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UIScene.SceneEventComponent

No new values.

Enums[edit]

EUTBotTeam[edit]

Possible factions for the bots.

UTBotTeam_Random 
UTBotTeam_Ironguard 
UTBotTeam_TwinSouls 
UTBotTeam_Krall 
UTBotTeam_Liandri 
UTBotTeam_Necris 

EUTRecordDemo[edit]

Demo recording.

UTRecordDemo_No 
UTRecordDemo_Yes 

Delegates[edit]

OnHideAnimationEnded[edit]

delegate OnHideAnimationEnded ()

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

OnSceneOpened[edit]

delegate OnSceneOpened (UIScene OpenedScene, bool bInitialActivation)

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

OnShowAnimationEnded[edit]

delegate OnShowAnimationEnded ()

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

Functions[edit]

Static native functions[edit]

CheckForAutoLogin[edit]

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[edit]

native static function bool OpenCmdLineURL ()

Launch the URL specified on the command line

SetLanPlay[edit]

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[edit]

FindDataStore[edit]

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

Returns:

Returns a datastore given its tag and player owner.

GetAccountInterface[edit]

static function OnlineAccountInterface GetAccountInterface ()

Returns:

Returns a reference to the online subsystem player interface.

GetGameInterface[edit]

static function OnlineGameInterface GetGameInterface ()

Returns:

Returns a reference to the online subsystem game interface.

GetPlayerInterface[edit]

static function OnlinePlayerInterface GetPlayerInterface ()

Returns:

Returns a reference to the online subsystem player interface.

GetPlayerInterfaceEx[edit]

static function OnlinePlayerInterfaceEx GetPlayerInterfaceEx ()

Returns:

Returns a reference to the online subsystem player interface ex.

HideOnlineToast[edit]

static function HideOnlineToast ()

Hides the toast message.

ShowOnlineToast[edit]

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

Shows a toast message.

StaticOpenScene[edit]

static function UIScene StaticOpenScene (UIScene SceneToOpen)

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

TrimWhitespace[edit]

static function string TrimWhitespace (string InString)

Trims whitespace from the beginning and end of a string.

Native functions[edit]

ActivateLevelEvent[edit]

native function ActivateLevelEvent (name EventName)

Activates a level remote event in kismet.

DeleteDemo[edit]

native function DeleteDemo (string DemoName)


GetCurrentAudioDevice[edit]

native function string GetCurrentAudioDevice ()

Returns:

Returns the currently selected audio device.

GetPawnOwner[edit]

native function Pawn GetPawnOwner ()

Returns the Pawn associated with this Hud

GetPossibleAudioDevices[edit]

native function GetPossibleAudioDevices (out array<stringOutResults)

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

GetPossibleScreenResolutions[edit]

native function GetPossibleScreenResolutions (out array<stringOutResults)

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

GetPRIOwner[edit]

native function UTPlayerReplicationInfo GetPRIOwner ()

Returns the PRI associated with this hud

GetUTPlayerOwner[edit]

native function UTPlayerController GetUTPlayerOwner (optional int PlayerIndex)

Get the UTPlayerController that is associated with this Hud

GetWorldInfo[edit]

native function WorldInfo GetWorldInfo ()

Overrides: UIScene.GetWorldInfo

Returns the WorldInfo

IsBelowMinSpecs[edit]

native final function bool IsBelowMinSpecs () const

Returns:

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

IsGame[edit]

native function bool IsGame ()

Returns:

the contents of GIsGame

SetAudioDeviceToUse[edit]

native function SetAudioDeviceToUse (string InAudioDevice)

Sets the audio device to use for playback.

Parameters:

  • InAudioDevice - Audio device to use.

SetScreenResolution[edit]

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[edit]

native function StartDedicatedServer (string TravelURL)

Starts a dedicated server and kills the current process.

TryCharacterUnlock[edit]

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[edit]

native function UpdateSplitscreenPlayers (bool bCreatePlayers)

Creates/Removes local players for splitscreen.

Parameters:

  • bCreatePlayers - Whether we are creating or removing players.

ViewportDeProject[edit]

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[edit]

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[edit]

IsControllerInput[edit]

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[edit]

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


Other instance functions[edit]

See UTUIScene instance functions.