UE3:UTGameUISceneClient (UT3)

Object >> UIRoot >> UISceneClient >> GameUISceneClient >> UTGameUISceneClient

Package:

UTGame

Within class:

UIInteraction

This class in other games:

UDK

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

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.

bFirstFrame

Type: bool

Modifiers: transient

This is true if the first frame of the toast message has been drawn. We need to know this because sometimes toast messages are shown durring movies (meaning they aren't displayed) and on the first frame we need to reset ShowStartTime so that the toast message is actually displayed.

bHidingToast

Type: bool

Modifiers: transient

Whether or not we are hiding the toast.

bPerformedMinSpecCheck

Type: bool

Modifiers: globalconfig

Indicates whether we've checked that the user's machine meets the min specs.

bToastVisible

Type: bool

Modifiers: transient

Whether or not the toast is visible.

CurrentMissionData

Type: UTSeqObj_SPMission.EMissionData

Modifiers: transient

Holds a copy of the current mission info

CurrentPriority

Type: int

Modifiers: transient

The priority of the currently displaying toast message

FrameCount

Type: float

HideStartTime

Type: float

Modifiers: transient

The time the toast message started hiding itself.

LastModifierCardUsed

Type: name

Modifiers: transient

MissionText

Type: string

Modifiers: transient

Holds the mission briefing

PreRenderTime

Type: float

RenderTime

Type: float

SaveProfileTemplate

Type: UTUIScene_SaveProfile

Default value: UTUIScene_SaveProfile'UI_Scenes_Common.SaveProfile'

ShowStartTime

Type: float

Modifiers: transient

The time the toast message was displayed at.

StringRenderTime

Type: float

TickTime

Type: float

TimedTutorialTemplate

Type: UTUIScene_TimedTutorialMessage

Default value: UTUIScene_TimedTutorialMessage'UI_InGameHud.Menus.TimedTutorialMessage'

ToastColor

Type: Object.LinearColor

Modifiers: transient

Toast colors

ToastDuration

Type: float

Modifiers: transient

Amount of time to display the toast for.

ToastFont

Type: Font

Modifiers: transient

Toast image information.

ToastImage

Type: Texture2D

Modifiers: transient

ToastImageU

Type: float

Modifiers: transient

ToastImageUL

Type: float

Modifiers: transient

ToastImageV

Type: float

Modifiers: transient

ToastImageVL

Type: float

Modifiers: transient

ToastMessage

Type: string

Modifiers: transient

Toast message to display.

ToastScale

Type: float

Modifiers: transient

Scale of toast message background image and text

ToastTextColor

Type: Object.LinearColor

Modifiers: transient

ToastTransitionTime

Type: float

Modifiers: transient

Amount of time toast takes to transition.

TutorialTemplate

Type: UTUIScene_TutorialMessage

Default value: UTUIScene_TutorialMessage'UI_InGameHud.Menus.TutorialMessage'

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.

Events

FinishToast

event FinishToast ()

Called when the toast is complete and ready to be hidden.

Other instance functions

NotifyGameSessionEnded

function NotifyGameSessionEnded ()

Overrides: GameUISceneClient.NotifyGameSessionEnded

Called when the current map is being unloaded. Cleans up any references which would prevent garbage collection.

SetCurrentMission

function SetCurrentMission (UTSeqObj_SPMission.EMissionData NewMissionData)

Sets the current mission data

SetToastMessage

function SetToastMessage (string Message, optional float ToastTime, optional int Priority)

Sets the current message for this scene.

Parameters:

• Message - Message to display
• ToastTime - How long to display the message for. A value of < 0 will make the message stay up forever until hidden manually, and any subsequent calls wont override the existing message.

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.