Package Holoville.HOTween

Packages
package	Core
package	Plugins
Classes
class	HOTween
	Main tween manager. Controls all tween types (Tweener and Sequence), and is used to directly create Tweeners (to create Sequences, directly create a new Sequence instead). More...
interface	IHOTweenComponent
	Public interface shared by Tweener and Sequence. More...
class	Sequence
	Sequence component. Manager for sequence of Tweeners or other nested Sequences. More...
class	SequenceParms
	Method chaining parameters for a Sequence. More...
class	Tweener
	Tween component, created by HOTween for each separate tween. More...
class	TweenEvent
	This object is passed as the only parameter of all HOTween's callbacks. More...
class	TweenParms
	Method chaining parameters for a Tweener. More...
class	TweenVar
	A special class used to setup a "virtual" tween, which will not actually be tweened nor updated, but will just set and return a value when you call Update. More...
Enumerations
enum	Axis {   None = 0, X = 2, Y = 4, Z = 8,   W = 16 }
	Enumeration of axis. More...
enum	CallbackType {   OnStart, OnUpdate, OnStepComplete, OnComplete,   OnPause, OnPlay, OnRewinded, OnPluginOverwritten }
	Only used with ABSTweenComponent ApplyCallback method. More...
enum	EaseType {   Linear, EaseInSine, EaseOutSine, EaseInOutSine,   EaseInQuad, EaseOutQuad, EaseInOutQuad, EaseInCubic,   EaseOutCubic, EaseInOutCubic, EaseInQuart, EaseOutQuart,   EaseInOutQuart, EaseInQuint, EaseOutQuint, EaseInOutQuint,   EaseInExpo, EaseOutExpo, EaseInOutExpo, EaseInCirc,   EaseOutCirc, EaseInOutCirc, EaseInElastic, EaseOutElastic,   EaseInOutElastic, EaseInBack, EaseOutBack, EaseInOutBack,   EaseInBounce, EaseOutBounce, EaseInOutBounce, AnimationCurve,   EaseInStrong, EaseOutStrong, EaseInOutStrong }
	Enumeration of ease types. More...
enum	LoopType { Restart, Yoyo, YoyoInverse, Incremental }
	Enumeration of types of loops to apply. More...
enum	PathType { Linear, Curved }
	Type of path (used with PlugVector3Path) More...
enum	TweenType { To, From }
	Tween type. More...
enum	UpdateType { Update, LateUpdate, FixedUpdate, TimeScaleIndependentUpdate }
	Enumeration of types of update that can be applied to a tween. More...
enum	WarningLevel { None, Important, Verbose }
	Enumeration of the levels of warning that should be used to output messages in case of auto-resolved errors. More...

---

Enumeration Type Documentation

enum Axis

Enumeration of axis.

Enumerator:

None	No axis.
X	X axis.
Y	Y axis.
Z	Z axis.
W	W axis.

enum CallbackType

Only used with ABSTweenComponent ApplyCallback method.

Enumerator:

OnStart	Called when the tween is starting.
OnUpdate	Called each time the tween is updated.
OnStepComplete	Called each time a single loop is completed.
OnComplete	Called when the whole tween (loops included) is complete.
OnPause	Called when the tween is paused.
OnPlay	Called when the tween is played.
OnRewinded	Called when the tween is rewinded.
OnPluginOverwritten	Works only with Tweeners, and not with Sequences. Called when a plugin of the Tweens is overwritten by the OverwriteManager.

enum EaseType

Enumeration of ease types.

Enumerator:

Linear	Linear.
EaseInSine	Ease in sine.
EaseOutSine	Ease out sine.
EaseInOutSine	Ease in out sine.
EaseInQuad	Ease in quad.
EaseOutQuad	Ease out quad.
EaseInOutQuad	Ease in out quad.
EaseInCubic	Ease in cubic.
EaseOutCubic	Ease out cubic.
EaseInOutCubic	Ease in out cubic.
EaseInQuart	Ease in quart.
EaseOutQuart	Ease out quart.
EaseInOutQuart	Ease in out quart.
EaseInQuint	Ease in quint.
EaseOutQuint	Ease out quint.
EaseInOutQuint	Ease in out quint.
EaseInExpo	Ease in expo.
EaseOutExpo	Ease out expo.
EaseInOutExpo	Ease in out expo.
EaseInCirc	Ease in circ.
EaseOutCirc	Ease out circ.
EaseInOutCirc	Ease in out circ.
EaseInElastic	Ease in elastic.
EaseOutElastic	Ease out elastic.
EaseInOutElastic	Ease in out elastic.
EaseInBack	Ease in back.
EaseOutBack	Ease out back.
EaseInOutBack	Ease in out back.
EaseInBounce	Ease in bounce.
EaseOutBounce	Ease out bounce.
EaseInOutBounce	Ease in out bounce.
AnimationCurve	Don't assign this! It's assigned internally when setting the ease to an AnimationCurve.
EaseInStrong	Ease in strong. OBSOLETE: use EaseInQuint instead.
EaseOutStrong	OBSOLETE: use EaseOutQuint instead. Ease out strong.
EaseInOutStrong	OBSOLETE: use EaseInOutQuint instead. Ease in out strong.

enum LoopType

Enumeration of types of loops to apply.

Enumerator:

Restart	When a tween completes, rewinds the animation and restarts (X to Y, repeat).
Yoyo	Tweens to the end values then back to the original ones and so on (X to Y, Y to X, repeat).
YoyoInverse	Like LoopType.Yoyo, but also inverts the easing (meaning if it was easeInSomething, it will become easeOutSomething, and viceversa).
Incremental	Continuously increments the tween (X to Y, Y to Y+(Y-X), and so on), thus always moving "onward".

enum PathType

Type of path (used with PlugVector3Path)

Enumerator:

Linear	Straight path.
Curved	Curved (Catmull-Rom) path.

enum TweenType

Tween type.

Enumerator:

To	Tween to value.
From	Tween from value.

enum UpdateType

Enumeration of types of update that can be applied to a tween.

Enumerator:

Update	Normal update.
LateUpdate	Late update.
FixedUpdate	Fixed update (useful for rigidBodies).
TimeScaleIndependentUpdate	Timescale independent update. Contrary to the other types, this one is not subject to changes in Time.timeScale, thus it's the best way for tweens that happen inside GUI methods (so that even if the game is paused, the GUI will still have animated tweens).

enum WarningLevel

Enumeration of the levels of warning that should be used to output messages in case of auto-resolved errors.

Enumerator:

None	No messages will be logged.
Important	Only important messages will be logged (this will exclude warnings when a tween is overwritten).
Verbose	All messages will be logged.