Cogito, ergo sum

UE3:UTGameUISceneClient (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> UIRoot >> UISceneClient >> GameUISceneClient >> UTGameUISceneClient
Package: 
UTGame
Within class: 
UIInteraction
This class in other games:
UT3


Properties

Property group 'Debug'

bShowRenderTimes

Type: bool

Debug values

Internal variables

AnimTime

Type: float


AvgRenderTime

Type: float


AvgTime

Type: float


bDimScreen

Type: bool

Modifiers: transient

Whether or not to dim the entire screen, used for the network dialog on ps3.

FrameCount

Type: float


PreRenderTime

Type: float


RenderTime

Type: float


SaveProfileTemplate

Type: UTUIScene_SaveProfile


Default value: UTUIScene_SaveProfile'UI_Scenes_Common.SaveProfile'

ScreenWarningMessage

Type: string

Modifiers: transient

Screen warning message text. Will be implicitly visible when string isn't empty.

StringRenderTime

Type: float


TickTime

Type: float


ToastFont

Type: Font

Modifiers: transient


Functions

Static native functions

GetWorldInfo

native static function WorldInfo GetWorldInfo ()

Returns the WorldInfo

Native functions

IsInSeamlessTravel

native function bool IsInSeamlessTravel ()


IsUIAcceptingInput

native function bool IsUIAcceptingInput ()

Returns:

TRUE if there are any scenes currently accepting input, FALSE otherwise.

Other instance functions

ClearScreenWarningMessage

function ClearScreenWarningMessage ()

Clears the screen warning message if one was set. It will no longer be rendered.

ShowSaveProfileScene

function UTUIScene_SaveProfile ShowSaveProfileScene (UTPlayerController PlayerOwner)

Displays the Saving Profile scene

Parameters:

  • PlayerOwner - Player to save profile info for.

Returns:

Returns a ref to the scene if one was shown, otherwise, returns None.

ShowScreenWarningMessage

function ShowScreenWarningMessage (string Message)

Displays a screen warning message. This message will be displayed prominently centered in the viewport and will persist until you call ClearScreenWarningMessage(). It's useful for important modal warnings, such as when the controller is disconnected on a console platform.

Parameters:

  • Message - Message to display