I love the smell of UnrealEd crashing in the morning. – tarquin

Difference between revisions of "UE3:UTUIScene OnlineToast (UT3)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Auto-generated page)
 
m (updated defaults)
 
Line 8: Line 8:
 
}}
 
}}
 
{{autogenerated}}
 
{{autogenerated}}
Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.
+
Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.
  
 
Online toast message scene.
 
Online toast message scene.
Line 62: Line 62:
 
| {{tl|bRenderParentScenes||UIScene}}
 
| {{tl|bRenderParentScenes||UIScene}}
 
| True
 
| True
 +
|-
 +
| {{tl|DefaultContextMenuClass||UIScene}}
 +
| [[Types#Class|Class]]'{{cl|UIContextMenu|Engine}}'
 
|-
 
|-
 
| {{tl|SceneInputMode||UIScene}}
 
| {{tl|SceneInputMode||UIScene}}

Latest revision as of 06:36, 16 August 2009

UT3 Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIScene_OnlineToast
Package: 
UTGame
This class in other games:
UDK

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

Online toast message scene.

Properties[edit]

Property group 'UTUIScene_OnlineToast'[edit]

ToastDuration[edit]

Type: float

Amount of time to display the toast for.

Default value: 5.0

Internal variables[edit]

bFullyVisible[edit]

Type: bool

Modifiers: transient

Whether or not this toast is in the showing or hiding state.

MessageLabel[edit]

Type: UILabel

Modifiers: transient

Reference to the message label for the toast.

ShowStartTime[edit]

Type: float

Modifiers: transient

The time the toast message was displayed at.

Default values[edit]

Property Value
bAlwaysRenderScene True
bFlushPlayerInput False
bIgnoreAxisInput True
bPauseGameWhileActive False
bRenderParentScenes True
DefaultContextMenuClass Class'Engine.UIContextMenu'
SceneInputMode INPUTMODE_None

Subobjects[edit]

SceneEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTUIScene.SceneEventComponent

No new values.

Functions[edit]

Events[edit]

FinishToast[edit]

event FinishToast ()

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

PostInitialize[edit]

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Called after this screen object's children have been initialized

Other instance functions[edit]

BeginHideAnimation[edit]

function bool BeginHideAnimation (bool bClosingScene)

Overrides: UTUIScene.BeginHideAnimation

Starts the exit animation for the scene.

Returns:

TRUE if there's animation for this scene, FALSE otherwise.

BeginShowAnimation[edit]

function bool BeginShowAnimation (bool bInitialActivation, bool bBypassAnimation)

Overrides: UTUIScene.BeginShowAnimation

Starts the show animation for the scene.

Parameters:

  • bInitialActivation - TRUE if the scene is being opened; FALSE if the another scene was closed causing this one to become the topmost scene.
  • bBypassAnimation - TRUE to force all animations to their last frame, effectively bypassing animations. This can be necessary for e.g. scenes which start out off-screen or something.

Returns:

TRUE if there's animation for this scene, FALSE otherwise.

OnAnimToastHideEnded[edit]

function OnAnimToastHideEnded (UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq)

Callback for when the hide animation has ended.

SetMessage[edit]

function SetMessage (string Message)

Sets the current message for this scene.