The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

From Unreal Wiki, The Unreal Engine Documentation Site

v • d • e

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

Package: 

UTGame

Known direct subclasses:

UTUIFrontEnd, UTUIFrontEnd_MapSelection, UTUIFrontEnd_TitleScreen, UTUIScene_AnimTest, UTUIScene_Campaign, UTUIScene_DemoSell, UTUIScene_Hud, UTUIScene_MessageBox, UTUIScene_OnlineToast, UTUIScene_SaveProfile, UTUIScene_TimedTutorialMessage, 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

[edit] Constants

See UTUIScene constants.

[edit] Properties

[edit] Property group 'Editor'

[edit] bEditorRealTimePreview

Type: bool

Modifiers: transient

[edit] Property group 'Flags'

[edit] bIgnoreAxisInput

Type: bool

[edit] Internal variables

[edit] bHidingScene

Type: bool

Modifiers: transient

[edit] bShowingScene

Type: bool

Modifiers: transient

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

[edit] bSkipPendingCloseSceneNotify

Type: bool

Modifiers: transient

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

[edit] InputBoxScene

Type: UIScene

Modifiers: transient

[edit] MessageBoxScene

Type: UIScene

Modifiers: transient

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

[edit] OnlineToastScene

Type: UIScene

Modifiers: transient

[edit] PendingCloseScene

Type: UIScene

Modifiers: transient

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

[edit] PendingOpenScene

Type: UIScene

Modifiers: transient

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

[edit] PlayerCardScene

Type: UIScene

Modifiers: transient

[edit] Default values

[edit] Subobjects

[edit] SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UIScene.SceneEventComponent

No new values.

[edit] Enums

[edit] EUTBotTeam

Possible factions for the bots.

UTBotTeam_Random 

UTBotTeam_Ironguard 

UTBotTeam_TwinSouls 

UTBotTeam_Krall 

UTBotTeam_Liandri 

UTBotTeam_Necris 

[edit] EUTRecordDemo

Demo recording.

UTRecordDemo_No 

UTRecordDemo_Yes 

[edit] Delegates

[edit] OnHideAnimationEnded

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

[edit] OnSceneOpened

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

[edit] OnShowAnimationEnded

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

[edit] Functions

[edit] Static native functions

[edit] CheckForAutoLogin

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

[edit] OpenCmdLineURL

Launch the URL specified on the command line

[edit] SetLanPlay

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

[edit] Other static functions

[edit] FindDataStore

Returns:

Returns a datastore given its tag and player owner.

[edit] GetAccountInterface

Returns:

Returns a reference to the online subsystem player interface.

[edit] GetGameInterface

Returns:

Returns a reference to the online subsystem game interface.

[edit] GetPlayerInterface

Returns:

Returns a reference to the online subsystem player interface.

[edit] GetPlayerInterfaceEx

Returns:

Returns a reference to the online subsystem player interface ex.

[edit] HideOnlineToast

Hides the toast message.

[edit] ShowOnlineToast

Shows a toast message.

[edit] StaticOpenScene

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

[edit] TrimWhitespace

Trims whitespace from the beginning and end of a string.

[edit] Native functions

[edit] ActivateLevelEvent

Activates a level remote event in kismet.

[edit] DeleteDemo

[edit] GetCurrentAudioDevice

Returns:

Returns the currently selected audio device.

[edit] GetPawnOwner

Returns the Pawn associated with this Hud

[edit] GetPossibleAudioDevices

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

[edit] GetPossibleScreenResolutions

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

[edit] GetPRIOwner

Returns the PRI associated with this hud

[edit] GetUTPlayerOwner

Get the UTPlayerController that is associated with this Hud

[edit] GetWorldInfo

Overrides: UIScene.GetWorldInfo

Returns the WorldInfo

[edit] IsBelowMinSpecs

Returns:

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

[edit] IsGame

Returns:

the contents of GIsGame

[edit] SetAudioDeviceToUse

Sets the audio device to use for playback.

Parameters:

• InAudioDevice - Audio device to use.

[edit] SetScreenResolution

Sets the screen resolution.

Parameters:

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

[edit] StartDedicatedServer

Starts a dedicated server and kills the current process.

[edit] TryCharacterUnlock

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.

[edit] UpdateSplitscreenPlayers

Creates/Removes local players for splitscreen.

Parameters:

• bCreatePlayers - Whether we are creating or removing players.

[edit] ViewportDeProject

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

[edit] ViewportProject

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

[edit] Events

[edit] IsControllerInput

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.

[edit] OnAnimationFinished

[edit] Other instance functions

See UTUIScene instance functions.