Show / Hide Table of Contents

Enum TweenOverwrite

Tween overwriting automatically stops existing tweens and avoids conflicting tweens to be created.

Namespace: Sttz.Tweener
Assembly: cs.temp.dll.dll
Syntax
[Flags]
public enum TweenOverwrite
Remarks

The TweenOverwrite enumeration holds different flag options that can be combined to define the exact overwrite behavior. E.g. TweenOverwrite.Default is actually (OnStart | Stop | Overlapping).

Some fields in TweenOverwrite are mutually exclusive:

Fields

Name Description
All

Overwrite all tweens with the same target and property.

Cancel

Cancel tweens that are being overwritten, setting them to their initial value.

Default

Default overwrite preset. Overwrite on start, stopping all overlapping tweens.

Finish

Finish tweens that are being overwritten, setting them to their target value.

Immediate

Immediate overwrite preset. Overwrite on initialize, stopping all tweens with the same target and property.

None

Turn off overwriting. You'll have to manually call Stop(Object, String), Finish(Object, String) or Cancel(Object, String) to avoid conflicting tweens.

OnInitialize

Overwrite during initialization. This is usually during the next frame after the tween was created or when Validate(Boolean) is called.

OnStart

Overwrite when starting the tween. The tween is started before it begins animating.

Overlapping

Overwrite tweens with the same target and property that are actually overlapping the current tween. E.g. a tween with a start delay that doesn't interfere with the current tween is not overwritten.

Stop

Stop tweens that are being overwritten, leaving them at their current value.

Undefined

Undefined overwriting. The parent scope's overwrite setting will be used in this case.

Back to top © 2018 Adrian Stutz