I don't need to test my programs. I have an error-correcting modem.

UE3:UTUIScene_OnlineToast (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT3 Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIScene_OnlineToast

Contents

Package: 
UTGame
This class in other games:
UDK

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

Online toast message scene.

[edit] Properties

[edit] Property group 'UTUIScene_OnlineToast'

[edit] ToastDuration

Type: float

Amount of time to display the toast for.

Default value: 5.0

[edit] Internal variables

[edit] bFullyVisible

Type: bool

Modifiers: transient

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

[edit] MessageLabel

Type: UILabel

Modifiers: transient

Reference to the message label for the toast.

[edit] ShowStartTime

Type: float

Modifiers: transient

The time the toast message was displayed at.

[edit] Default values

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

[edit] Subobjects

[edit] SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIScene.SceneEventComponent

No new values.

[edit] Functions

[edit] Events

[edit] FinishToast

event FinishToast ()

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

[edit] PostInitialize

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Called after this screen object's children have been initialized

[edit] Other instance functions

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

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

[edit] OnAnimToastHideEnded

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

Callback for when the hide animation has ended.

[edit] SetMessage

function SetMessage (string Message)

Sets the current message for this scene.