Gah - a solution with more questions. – EntropicLqd

UE3:UTGameUISceneClient (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 05:52, 17 January 2010 by Wormbo (Talk | contribs) (1 revision: class descriptions for UDK January update (part 7))

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
UDK Object >> UIRoot >> UISceneClient >> GameUISceneClient >> UTGameUISceneClient
Package: 
UTGame
Within class: 
UIInteraction
This class in other games:
UT3


Properties[edit]

Property group 'Debug'[edit]

bShowRenderTimes[edit]

Type: bool

Debug values

Internal variables[edit]

AnimTime[edit]

Type: float


AvgRenderTime[edit]

Type: float


AvgTime[edit]

Type: float


bDimScreen[edit]

Type: bool

Modifiers: transient

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

FrameCount[edit]

Type: float


PreRenderTime[edit]

Type: float


RenderTime[edit]

Type: float


SaveProfileTemplate[edit]

Type: UTUIScene_SaveProfile


Default value: UTUIScene_SaveProfile'UI_Scenes_Common.SaveProfile'

ScreenWarningMessage[edit]

Type: string

Modifiers: transient

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

StringRenderTime[edit]

Type: float


TickTime[edit]

Type: float


ToastFont[edit]

Type: Font

Modifiers: transient


Functions[edit]

Static native functions[edit]

GetWorldInfo[edit]

native static function WorldInfo GetWorldInfo ()

Returns the WorldInfo

Native functions[edit]

IsInSeamlessTravel[edit]

native function bool IsInSeamlessTravel ()


IsUIAcceptingInput[edit]

native function bool IsUIAcceptingInput ()

Returns:

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

Other instance functions[edit]

ClearScreenWarningMessage[edit]

function ClearScreenWarningMessage ()

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

ShowSaveProfileScene[edit]

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

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