Class EchoOptions

Namespace

FriedSynapse.FlowEnt

Provides options for echo.

public class EchoOptions : AbstractAnimationOptions

Inheritance

object

AbstractAnimationOptions

EchoOptions

Inherited Members

AbstractAnimationOptions.DefaultLoopCount

AbstractAnimationOptions.DefaultTimeScale

AbstractAnimationOptions.Name

AbstractAnimationOptions.UpdateType

AbstractAnimationOptions.AutoStart

AbstractAnimationOptions.SkipFrames

AbstractAnimationOptions.Delay

AbstractAnimationOptions.DelayUntil

AbstractAnimationOptions.TimeScale

AbstractAnimationOptions.LoopCount

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

CommonExtensions.Echo<TItem>(TItem, EchoOptions)

CommonExtensions.Echo<TItem>(TItem, float?, bool)

CommonExtensions.Tween<TItem>(TItem, TweenOptions)

CommonExtensions.Tween<TItem>(TItem, float, bool)

Constructors

EchoOptions()

Initialises a new instance of the EchoOptions class.

public EchoOptions()

Fields

DefaultTime

public const float DefaultTime = 1

Field Value

float

Properties

StopCondition

The condition that when true, it will stop the echo.

public Func<float, bool> StopCondition { get; set; }

Property Value

Func<float, bool>

Timeout

The amount of time in seconds that this echo will last.

public float? Timeout { get; set; }

Property Value

float?

Methods

SetAutoStart(bool)

Sets whether this animation should auto-start or not.

public EchoOptions SetAutoStart(bool autoStart)

Parameters

autoStart bool

Returns

EchoOptions

Remarks

Auto-start will be slower than a true-start. See more at https://flowent.friedsynapse.com/tips#h.s5cucrg5qyjc

SetDelay(float)

Sets the amount of time in seconds that you want to delay when this animation is started.

public EchoOptions SetDelay(float time)

Parameters

time float

Returns

EchoOptions

SetDelayUntil(Func<bool>)

Sets the callback that holds the starting of the animation.

public EchoOptions SetDelayUntil(Func<bool> callback)

Parameters

callback Func<bool>

Returns

EchoOptions

SetLoopCount(int?)

Sets the amount of loops you want this animation to have. If you want infinite loops pass a null value.

public EchoOptions SetLoopCount(int? loopCount)

Parameters

loopCount int?

Returns

EchoOptions

Remarks

Flows only have reset loop types.

SetName(string)

Sets the name of the animation.

public EchoOptions SetName(string name)

Parameters

name string

Returns

EchoOptions

SetSkipFrames(int)

Sets the amount of frames you want to skip at when this animation is started.

public EchoOptions SetSkipFrames(int frames)

Parameters

frames int

Returns

EchoOptions

SetStopCondition(Func<float, bool>)

Sets the condition that when true, it will stop the echo.

public EchoOptions SetStopCondition(Func<float, bool> stopCondition)

Parameters

stopCondition Func<float, bool>

Returns

EchoOptions

SetTimeScale(float)

Sets the time scale for the current animation.

public EchoOptions SetTimeScale(float timeScale)

Parameters

timeScale float

Returns

EchoOptions

SetTimeout(float?)

Sets the amount of time in seconds that this echo will last.

public EchoOptions SetTimeout(float? timeout)

Parameters

timeout float?

Returns

EchoOptions

SetUpdateType(UpdateType)

Sets the update type for the animation.

public EchoOptions SetUpdateType(UpdateType updateType)

Parameters

updateType UpdateType

Returns

EchoOptions