Calcatz.Sequine.Tween Class Reference

Runs and manages a single Tween. More...

Inheritance diagram for Calcatz.Sequine.Tween:

Public Member Functions
delegate void	TweenUpdateCallback (float t)
delegate void	FloatTweenUpdateCallback (float value)
	Tween ()
	Tween (float _duration=1f, bool _timescaleIndependent=false, EasingFunction.Ease _easing=EasingFunction.Ease.EaseInOutQuad, float _delay=0f)
TweenInstance	RunTween (TweenUpdateCallback _onUpdate, Action _onComplete=null, float _overrideDuration=-1)
	Runs a tween. More...
TweenInstance	RunTween (UnityEngine.Object _cancelTracker, TweenUpdateCallback _onUpdate, Action _onComplete=null, float _overrideDuration=-1)
	Runs a tween. More...
TweenInstance	RunFloatTween (float _valueFrom, float _valueTo, FloatTweenUpdateCallback _onUpdate, Action _onComplete=null, float _overrideDuration=-1)
	Runs a float tween from a From to a To value. More...
TweenInstance	RunFloatTween (UnityEngine.Object _cancelTracker, float _valueFrom, float _valueTo, FloatTweenUpdateCallback _onUpdate, Action _onComplete=null, float _overrideDuration=-1)
void	Kill ()

Public Attributes
float	duration = 1f
bool	timescaleIndependent
EasingFunction.Ease	easing = EasingFunction.Ease.EaseInOutQuad
float	delay = 0f

Detailed Description

Runs and manages a single Tween.

Constructor & Destructor Documentation

Tween() [1/2]

Calcatz.Sequine.Tween.Tween

(

)

Tween() [2/2]

Calcatz.Sequine.Tween.Tween	(	float	_duration = 1f,
		bool	_timescaleIndependent = false,
		EasingFunction.Ease	_easing = EasingFunction.Ease.EaseInOutQuad,
		float	_delay = 0f
	)

Member Function Documentation

FloatTweenUpdateCallback()

delegate void Calcatz.Sequine.Tween.FloatTweenUpdateCallback

(

float

value

)

Kill()

void Calcatz.Sequine.Tween.Kill

(

)

RunFloatTween() [1/2]

TweenInstance Calcatz.Sequine.Tween.RunFloatTween	(	float	_valueFrom,
		float	_valueTo,
		FloatTweenUpdateCallback	_onUpdate,
		Action	_onComplete = null,
		float	_overrideDuration = -1
	)

Runs a float tween from a From to a To value.

Parameters

_valueFrom
_valueTo
_onUpdate
_onComplete
_overrideDuration

Returns

RunFloatTween() [2/2]

TweenInstance Calcatz.Sequine.Tween.RunFloatTween	(	UnityEngine.Object	_cancelTracker,
		float	_valueFrom,
		float	_valueTo,
		FloatTweenUpdateCallback	_onUpdate,
		Action	_onComplete = null,
		float	_overrideDuration = -1
	)

RunTween() [1/2]

TweenInstance Calcatz.Sequine.Tween.RunTween	(	TweenUpdateCallback	_onUpdate,
		Action	_onComplete = null,
		float	_overrideDuration = -1
	)

Runs a tween.

Parameters

_onUpdate	t is the interpolation value from 0 to 1.
_onComplete
_overrideDuration

RunTween() [2/2]

TweenInstance Calcatz.Sequine.Tween.RunTween	(	UnityEngine.Object	_cancelTracker,
		TweenUpdateCallback	_onUpdate,
		Action	_onComplete = null,
		float	_overrideDuration = -1
	)

Runs a tween.

Parameters

_cancelTracker	Any unity object. This object will be used as the unique identifier to stop the tween when the object is destroyed.
_onUpdate	t is the interpolation value from 0 to 1.
_onComplete
_overrideDuration

Returns

TweenUpdateCallback()

delegate void Calcatz.Sequine.Tween.TweenUpdateCallback

(

float

t

)

Member Data Documentation

delay

float Calcatz.Sequine.Tween.delay = 0f

duration

float Calcatz.Sequine.Tween.duration = 1f

easing

EasingFunction.Ease Calcatz.Sequine.Tween.easing = EasingFunction.Ease.EaseInOutQuad

timescaleIndependent

bool Calcatz.Sequine.Tween.timescaleIndependent