UTGame.UTGameUISceneClient

Extends: GameUISceneClient
Modifiers: dependson ( UTSeqObj_SPMission ) dependson ( UTUIScene_SaveProfile ) dependson ( UTUIScene_TutorialMessage ) dependson ( UTUIScene_TimedTutorialMessage ) native ( UI )

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UISceneClient
      |   
      +-- Engine.GameUISceneClient
         |   
         +-- UTGame.UTGameUISceneClient

Variables Summary
float	AnimTime
float	AvgRenderTime
float	AvgTime
bool	bDimScreen
bool	bFirstFrame
bool	bHidingToast
bool	bPerformedMinSpecCheck
bool	bToastVisible
EMissionData	CurrentMissionData
int	CurrentPriority
float	FrameCount
float	HideStartTime
name	LastModifierCardUsed
string	MissionText
float	PreRenderTime
float	RenderTime
UTUIScene_SaveProfile	SaveProfileTemplate
float	ShowStartTime
float	StringRenderTime
float	TickTime
UTUIScene_TimedTutorialMessage	TimedTutorialTemplate
LinearColor	ToastColor
float	ToastDuration
Font	ToastFont
Texture2D	ToastImage
float	ToastImageU
float	ToastImageUL
float	ToastImageV
float	ToastImageVL
string	ToastMessage
float	ToastScale
LinearColor	ToastTextColor
float	ToastTransitionTime
UTUIScene_TutorialMessage	TutorialTemplate
Debug
bool	bShowRenderTimes

Inherited Variables from Engine.GameUISceneClient
ActiveScenes, AnimSequencePool, AnimSubscribers, bDisplayFullPaths, bEnableDebugInput, bInteractiveMode, bKillRestoreMenuProgression, bRenderActiveControlInfo, bRenderCursor, bRenderDebugInfo, bRenderDebugInfoAtTop, bRenderFocusedControlInfo, bRenderTargetControlInfo, bRestrictActiveControlToFocusedScene, bSelectVisibleTargetsOnly, bShowCurrentState, bShowMousePos, bShowRenderBounds, bShowWidgetPath, bUpdateCursorRenderStatus, bUpdateInputProcessingStatus, CurrentMouseCursor, DebugTarget, DefaultUITexture[EUIDefaultPenColor], DoubleClickStartPosition, DoubleClickStartTime, InitialPressedKeys, LatestDeltaTime, OverlaySceneAlphaModulation

Inherited Variables from Engine.GameUISceneClient

ActiveScenes, AnimSequencePool, AnimSubscribers, bDisplayFullPaths, bEnableDebugInput, bInteractiveMode, bKillRestoreMenuProgression, bRenderActiveControlInfo, bRenderCursor, bRenderDebugInfo, bRenderDebugInfoAtTop, bRenderFocusedControlInfo, bRenderTargetControlInfo, bRestrictActiveControlToFocusedScene, bSelectVisibleTargetsOnly, bShowCurrentState, bShowMousePos, bShowRenderBounds, bShowWidgetPath, bUpdateCursorRenderStatus, bUpdateInputProcessingStatus, CurrentMouseCursor, DebugTarget, DefaultUITexture[EUIDefaultPenColor], DoubleClickStartPosition, DoubleClickStartTime, InitialPressedKeys, LatestDeltaTime, OverlaySceneAlphaModulation

Inherited Variables from Engine.UISceneClient
ActiveControl, ActiveSkin, bEnablePostProcess, CanvasToScreen, DataStoreManager, InvCanvasToScreen, MousePosition, OpacityParameter, OpacityParameterName, RenderViewport, UIScenePostProcess

Functions Summary
		FinishToast ()))
	WorldInfo	GetWorldInfo ()
	bool	IsInSeamlessTravel ()
	bool	IsUIAcceptingInput ()
		NotifyGameSessionEnded ()))
		SetCurrentMission (EMissionData NewMissionData))
		SetToastMessage (string Message, optional float ToastTime=6.0f, optional int Priority=0))
	UTUIScene_SaveProfile	ShowSaveProfileScene (UTPlayerController PlayerOwner))

Inherited Functions from Engine.GameUISceneClient
AnimLookupSequence, AnimSubscribe, AnimUnSubscribe, CanShowToolTips, CanUnpauseInternalUI, ClearMenuProgression, CloseMenu, ConditionalPause, CreateMenu, CreateScene, CreateTransientWidget, FindSceneByTag, GetActiveScene, GetCurrentNetMode, GetTransientScene, NotifyGameSessionEnded, NotifyLinkStatusChanged, NotifyOnlineServiceStatusChanged, NotifyPlayerAdded, NotifyPlayerRemoved, OpenMenu, RefreshFormatting, RequestCursorRenderUpdate, RequestInputProcessingUpdate, RestoreMenuProgression, SaveMenuProgression, SetActiveControl, ShowDataStoreField, ShowDataStores, ShowDockingStacks, ShowMenuProgression, ShowMenuStates, ShowRenderBounds, ToggleDebugInput

Inherited Functions from Engine.GameUISceneClient

AnimLookupSequence, AnimSubscribe, AnimUnSubscribe, CanShowToolTips, CanUnpauseInternalUI, ClearMenuProgression, CloseMenu, ConditionalPause, CreateMenu, CreateScene, CreateTransientWidget, FindSceneByTag, GetActiveScene, GetCurrentNetMode, GetTransientScene, NotifyGameSessionEnded, NotifyLinkStatusChanged, NotifyOnlineServiceStatusChanged, NotifyPlayerAdded, NotifyPlayerRemoved, OpenMenu, RefreshFormatting, RequestCursorRenderUpdate, RequestInputProcessingUpdate, RestoreMenuProgression, SaveMenuProgression, SetActiveControl, ShowDataStoreField, ShowDataStores, ShowDockingStacks, ShowMenuProgression, ShowMenuStates, ShowRenderBounds, ToggleDebugInput

Inherited Functions from Engine.UISceneClient
ChangeActiveSkin, ChangeMouseCursor, CloseScene, GetActiveScene, GetCanvasToScreen, GetInverseCanvasToScreen, InitializeScene, IsSceneInitialized, IsUIActive, OpenScene, SetMousePosition, UpdateCanvasToScreen

Variables Detail

AnimTime Source code

var float AnimTime;

AvgRenderTime Source code

var float AvgRenderTime;

AvgTime Source code

var float AvgTime;

bDimScreen Source code

var transient bool bDimScreen;

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

bFirstFrame Source code

var transient bool bFirstFrame;

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 Source code

var transient bool bHidingToast;

Whether or not we are hiding the toast.

bPerformedMinSpecCheck Source code

var globalconfig bool bPerformedMinSpecCheck;

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

bToastVisible Source code

var transient bool bToastVisible;

Whether or not the toast is visible.

CurrentMissionData Source code

var transient EMissionData CurrentMissionData;

Holds a copy of the current mission info

CurrentPriority Source code

var transient int CurrentPriority;

The priority of the currently displaying toast message

FrameCount Source code

var float FrameCount;

HideStartTime Source code

var transient float HideStartTime;

The time the toast message started hiding itself.

LastModifierCardUsed Source code

var transient name LastModifierCardUsed;

MissionText Source code

var transient string MissionText;

Holds the mission briefing

PreRenderTime Source code

var float PreRenderTime;

RenderTime Source code

var float RenderTime;

SaveProfileTemplate Source code

var UTUIScene_SaveProfile SaveProfileTemplate;

ShowStartTime Source code

var transient float ShowStartTime;

The time the toast message was displayed at.

StringRenderTime Source code

var float StringRenderTime;

TickTime Source code

var float TickTime;

TimedTutorialTemplate Source code

var UTUIScene_TimedTutorialMessage TimedTutorialTemplate;

ToastColor Source code

var transient LinearColor ToastColor;

Toast colors

ToastDuration Source code

var transient float ToastDuration;

Amount of time to display the toast for.

ToastFont Source code

var transient Font ToastFont;

Toast image information.

ToastImage Source code

var transient Texture2D ToastImage;

ToastImageU Source code

var transient float ToastImageU;

ToastImageUL Source code

var transient float ToastImageUL;

ToastImageV Source code

var transient float ToastImageV;

ToastImageVL Source code

var transient float ToastImageVL;

ToastMessage Source code

var transient string ToastMessage;

Toast message to display.

ToastScale Source code

var transient float ToastScale;

Scale of toast message background image and text

ToastTextColor Source code

var transient LinearColor ToastTextColor;

ToastTransitionTime Source code

var transient float ToastTransitionTime;

Amount of time toast takes to transition.

TutorialTemplate Source code

var UTUIScene_TutorialMessage TutorialTemplate;

Debug

bShowRenderTimes Source code

var(Debug) bool bShowRenderTimes;

Debug values

Functions Detail

FinishToast Source code

event FinishToast ( ) )

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

GetWorldInfo Source code

native static function WorldInfo GetWorldInfo ( )

Returns the WorldInfo

IsInSeamlessTravel Source code

native function bool IsInSeamlessTravel ( )

IsUIAcceptingInput Source code

native function bool IsUIAcceptingInput ( )

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

NotifyGameSessionEnded Source code

function NotifyGameSessionEnded ( ) )

SetCurrentMission Source code

function SetCurrentMission ( EMissionData NewMissionData) )

Sets the current mission data

SetToastMessage Source code

function SetToastMessage ( string Message, optional float ToastTime=6.0f, optional int Priority=0) )

Sets the current message for this scene.
@param Message Message to display
@param 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 Source code

function UTUIScene_SaveProfile ShowSaveProfileScene ( UTPlayerController PlayerOwner) )

Displays the Saving Profile scene
@param PlayerOwner Player to save profile info for.
@return Returns a ref to the scene if one was shown, otherwise, returns None.

Defaultproperties

defaultproperties
{
   bPerformedMinSpecCheck=True
   SaveProfileTemplate=UTUIScene_SaveProfile'UI_Scenes_Common.SaveProfile'
   TutorialTemplate=UTUIScene_TutorialMessage'UI_InGameHud.Menus.TutorialMessage'
   TimedTutorialTemplate=UTUIScene_TimedTutorialMessage'UI_InGameHud.Menus.TimedTutorialMessage'
   Name="Default__UTGameUISceneClient"
   ObjectArchetype=GameUISceneClient'Engine.Default__GameUISceneClient'
}

Creation time: sk 18-3-2018 10:00:52.321 - Created with UnCodeX