UE3:UTUIScene_OnlineToast (UDK)

Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIScene_OnlineToast

Package: 

UTGame

This class in other games:

UT3

Online toast message scene.

Properties

Property group 'UTUIScene_OnlineToast'

ToastDuration

Type: float

Amount of time to display the toast for.

Default value: 5.0

Internal variables

bFullyVisible

Type: bool

Modifiers: transient

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

MessageLabel

Type: UILabel

Modifiers: transient

Reference to the message label for the toast.

ShowStartTime

Type: float

Modifiers: transient

The time the toast message was displayed at.

Default values

Property	Value
bAlwaysRenderScene	True
bFlushPlayerInput	False
bIgnoreAxisInput	True
bPauseGameWhileActive	False
bRenderParentScenes	True
bShouldPerformScriptTick	True
SceneInputMode	INPUTMODE_None

Subobjects

SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIScene.SceneEventComponent

No new values.

Functions

Events

PostInitialize

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Called after this screen object's children have been initialized. While the Initialized event is only called when a widget is initialized for the first time, PostInitialize() will be called every time this widget receives a call to Initialize(), even if the widget was already initialized. Examples would be reparenting a widget.

TickScene

event TickScene (float DeltaTime)

Overrides: UTUIScene.TickScene

(Description copied from UTUIScene.TickScene)
Called every frame if bShouldPerformScriptTick is true

Parameters:

• DeltaTime - is the time in seconds for this frame

Other instance functions

BeginHideAnimation

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

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.

FinishToast

function FinishToast ()

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

OnAnimToastHideEnded

function OnAnimToastHideEnded (UIScreenObject AnimTarget, name AnimName, int TrackTypeMask)

Callback for when the hide animation has ended.

SetMessage

function SetMessage (string Message)

Sets the current message for this scene.