Class TweenOptionsFluid

Extension methods implementing fluid TweenOptions interface.

Inheritance
System.Object
TweenOptionsFluid
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ToString()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Sttz.Tweener
Assembly: cs.temp.dll.dll
Syntax
public static class TweenOptionsFluid

Methods

Delay<TContainer>(TContainer, Single)

Delay before the tween starts (in seconds).

Declaration
public static TContainer Delay<TContainer>(this TContainer container, float seconds)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
System.Single seconds
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

Ease<TContainer>(TContainer, EasingMethod)

Easing to apply to the tween. See Easing for possible values. Linear disables easing.

Declaration
public static TContainer Ease<TContainer>(this TContainer container, EasingMethod easing)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
EasingMethod easing
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

LogLevel<TContainer>(TContainer, TweenLogLevel)

Log level of the current scope. Only messages with equal or higher level will be logged to the console.

Declaration
public static TContainer LogLevel<TContainer>(this TContainer container, TweenLogLevel level)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
TweenLogLevel level
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

OnComplete<TContainer>(TContainer, Action)

Event triggered when the tween completes (either normally, by being stopped or overwritten, check CompletedBy if you need to know what completed the tween.

Declaration
public static TContainer OnComplete<TContainer>(this TContainer container, Action handler)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
System.Action handler
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

OnComplete<TContainer>(TContainer, Action<TweenEventArgs>)

Event triggered when the tween completes (either normally, by being stopped or overwritten, check CompletedBy if you need to know what completed the tween.

Declaration
public static TContainer OnComplete<TContainer>(this TContainer container, Action<TweenEventArgs> handler)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
System.Action<TweenEventArgs> handler
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

OnComplete<TContainer>(TContainer, EventHandler<TweenEventArgs>)

Event triggered when the tween completes (either normally, by being stopped or overwritten, check CompletedBy if you need to know what completed the tween.

Declaration
public static TContainer OnComplete<TContainer>(this TContainer container, EventHandler<TweenEventArgs> handler)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
System.EventHandler<TweenEventArgs> handler
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

OnError<TContainer>(TContainer, Action)

Triggered when an error occurs. Error or Error contain a description of the error.

Declaration
public static TContainer OnError<TContainer>(this TContainer container, Action handler)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
System.Action handler
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

OnError<TContainer>(TContainer, Action<TweenEventArgs>)

Triggered when an error occurs. Error or Error contain a description of the error.

Declaration
public static TContainer OnError<TContainer>(this TContainer container, Action<TweenEventArgs> handler)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
System.Action<TweenEventArgs> handler
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

OnError<TContainer>(TContainer, EventHandler<TweenEventArgs>)

Triggered when an error occurs. Error or Error contain a description of the error.

Declaration
public static TContainer OnError<TContainer>(this TContainer container, EventHandler<TweenEventArgs> handler)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
System.EventHandler<TweenEventArgs> handler
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

OnInitialize<TContainer>(TContainer, Action)

Event triggered when the tween initializes (usually in the frame after it was created or when calling Validate(Boolean).)

Declaration
public static TContainer OnInitialize<TContainer>(this TContainer container, Action handler)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
System.Action handler
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

OnInitialize<TContainer>(TContainer, Action<TweenEventArgs>)

Event triggered when the tween initializes (usually in the frame after it was created or when calling Validate(Boolean).)

Declaration
public static TContainer OnInitialize<TContainer>(this TContainer container, Action<TweenEventArgs> handler)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
System.Action<TweenEventArgs> handler
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

OnInitialize<TContainer>(TContainer, EventHandler<TweenEventArgs>)

Event triggered when the tween initializes (usually in the frame after it was created or when calling Validate(Boolean).)

Declaration
public static TContainer OnInitialize<TContainer>(this TContainer container, EventHandler<TweenEventArgs> handler)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
System.EventHandler<TweenEventArgs> handler
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

OnStart<TContainer>(TContainer, Action)

Event triggered when the tween starts (after the start delay).

Declaration
public static TContainer OnStart<TContainer>(this TContainer container, Action handler)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
System.Action handler
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

OnStart<TContainer>(TContainer, Action<TweenEventArgs>)

Event triggered when the tween starts (after the start delay).

Declaration
public static TContainer OnStart<TContainer>(this TContainer container, Action<TweenEventArgs> handler)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
System.Action<TweenEventArgs> handler
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

OnStart<TContainer>(TContainer, EventHandler<TweenEventArgs>)

Event triggered when the tween starts (after the start delay).

Declaration
public static TContainer OnStart<TContainer>(this TContainer container, EventHandler<TweenEventArgs> handler)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
System.EventHandler<TweenEventArgs> handler
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

OnUpdate<TContainer>(TContainer, Action)

Event triggered every time the tween has been updated.

Declaration
public static TContainer OnUpdate<TContainer>(this TContainer container, Action handler)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
System.Action handler
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

OnUpdate<TContainer>(TContainer, Action<TweenEventArgs>)

Event triggered every time the tween has been updated.

Declaration
public static TContainer OnUpdate<TContainer>(this TContainer container, Action<TweenEventArgs> handler)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
System.Action<TweenEventArgs> handler
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

OnUpdate<TContainer>(TContainer, EventHandler<TweenEventArgs>)

Event triggered every time the tween has been updated.

Declaration
public static TContainer OnUpdate<TContainer>(this TContainer container, EventHandler<TweenEventArgs> handler)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
System.EventHandler<TweenEventArgs> handler
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

Over<TContainer>(TContainer, Single)

Duration of the tween (in seconds).

Declaration
public static TContainer Over<TContainer>(this TContainer container, float duration)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
System.Single duration
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

Overwrite<TContainer>(TContainer, TweenOverwrite)

How conflicting tweens are resolved. See TweenOverwrite for all available options.

Declaration
public static TContainer Overwrite<TContainer>(this TContainer container, TweenOverwrite settings)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
TweenOverwrite settings
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

Plugin<TContainer>(TContainer, PluginLoader, Boolean)

Enable or disable a plugin for all tweens these options apply to.

Declaration
public static TContainer Plugin<TContainer>(this TContainer container, PluginLoader loader, bool enable = true)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
PluginLoader loader

The loader of the plugin
System.Boolean enable

Wether to enable or disable the plugin
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

Recycle<TContainer>(TContainer, TweenRecycle)

Wether groups and tweens are recycled.

Declaration
public static TContainer Recycle<TContainer>(this TContainer container, TweenRecycle recycle)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
TweenRecycle recycle
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

Release<TContainer>(TContainer)

Decrease the retain count. Only call this method after having called Retain<TContainer>(TContainer) before.

Declaration
public static TContainer Release<TContainer>(this TContainer container)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

Retain<TContainer>(TContainer)

Increase the retain count, preventing the group or tween from being recycled. Pair this call with one to Release<TContainer>(TContainer) allow recycling again.

Declaration
public static TContainer Retain<TContainer>(this TContainer container)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

Timing<TContainer>(TContainer, TweenTiming)

Timing options of the tween. This sets if the tween is updated during Update, FixedUpdate or LateUpdate and which game time it's based on.

Declaration
public static TContainer Timing<TContainer>(this TContainer container, TweenTiming timing)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
TweenTiming timing
Returns
Type Description
TContainer
Type Parameters
Name Description
TContainer
See Also

WaitForTweenDuration<TContainer>(TContainer)

Return a WaitForSeconds instruction that can be used in Unity coroutines to wait for the duration of the tween (delay + duration).

Declaration
public static WaitForSeconds WaitForTweenDuration<TContainer>(this TContainer container)
    where TContainer : TweenOptionsContainer
Parameters
Type Name Description
TContainer container
Returns
Type Description
WaitForSeconds
Type Parameters
Name Description
TContainer
See Also