Class TextEffectCompletedEvent

Event published when a text effect finishes, whether it ran to completion or was stopped early. Check WasCompleted to tell the two apart.

Inheritance

object

ScyllaEvent

TextEffectCompletedEvent

Inherited Members

ScyllaEvent.IsCancelled

ScyllaEvent.StopPropagation()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Scylla.TextMode

Assembly: ScyllaTextMode.dll

Syntax

public sealed class TextEffectCompletedEvent : ScyllaEvent

Constructors

TextEffectCompletedEvent(ITextEffect, bool)

Creates a new effect-completed event.

Declaration

public TextEffectCompletedEvent(ITextEffect effect, bool wasCompleted)

Parameters

Type	Name	Description
ITextEffect	effect	The effect that finished.
bool	wasCompleted	True if the effect reached full progress.

Properties

Effect

The effect that finished.

Declaration

public ITextEffect Effect { get; }

Property Value

Type	Description
ITextEffect

WasCompleted

True when the effect reached full progress, false when it was stopped before finishing.

Declaration

public bool WasCompleted { get; }

Property Value

Type	Description
bool