DOTween  0.8.530
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Tweener Class Referenceabstract

Animates a single value More...

Inheritance diagram for Tweener:
Tween ABSSequentiable

Public Member Functions

abstract Tweener ChangeStartValue (object newStartValue, float newDuration=-1)
 Changes the start value of a tween and rewinds it (without pausing it). Has no effect with tweens that are inside Sequences More...
 
abstract Tweener ChangeEndValue (object newEndValue, float newDuration=-1, bool snapStartValue=false)
 Changes the end value of a tween and rewinds it (without pausing it). Has no effect with tweens that are inside Sequences More...
 
abstract Tweener ChangeEndValue (object newEndValue, bool snapStartValue)
 Changes the end value of a tween and rewinds it (without pausing it). Has no effect with tweens that are inside Sequences More...
 
abstract Tweener ChangeValues (object newStartValue, object newEndValue, float newDuration=-1)
 Changes the start and end value of a tween and rewinds it (without pausing it). Has no effect with tweens that are inside Sequences More...
 

Public Attributes

float timeScale
 TimeScale for the tween More...
 
bool isBackwards
 If TRUE the tween wil go backwards More...
 
object id
 Id (usable for filtering with DOTween static methods). Can be an int, a string, an object, or anything else More...
 
object target
 Tween target (usable for filtering with DOTween static methods). Automatically set by tween creation shorcuts More...
 
TweenCallback onPlay
 Called when the tween is set in a playing state, after any eventual delay. Also called each time the tween resumes playing from a paused state More...
 
TweenCallback onRewind
 Called when the tween is rewinded, either by calling More...
 
TweenCallback onUpdate
 Called each time the tween updates More...
 
TweenCallback onStepComplete
 Called the moment the tween completes one loop cycle More...
 
TweenCallback onComplete
 Called the moment the tween reaches completion (loops included) More...
 
TweenCallback onKill
 Called the moment the tween is killed More...
 
float easeOvershootOrAmplitude
 
float easePeriod
 
TweenCallback onStart
 Called the first time the tween is set in a playing state, after any eventual delay More...
 

Detailed Description

Animates a single value

Member Function Documentation

abstract Tweener ChangeEndValue ( object  newEndValue,
float  newDuration = -1,
bool  snapStartValue = false 
)
pure virtual

Changes the end value of a tween and rewinds it (without pausing it). Has no effect with tweens that are inside Sequences

Parameters
newEndValueThe new end value
newDurationIf bigger than 0 applies it as the new tween duration
snapStartValueIf TRUE the start value will become the current target's value, otherwise it will stay the same
abstract Tweener ChangeEndValue ( object  newEndValue,
bool  snapStartValue 
)
pure virtual

Changes the end value of a tween and rewinds it (without pausing it). Has no effect with tweens that are inside Sequences

Parameters
newEndValueThe new end value
snapStartValueIf TRUE the start value will become the current target's value, otherwise it will stay the same
abstract Tweener ChangeStartValue ( object  newStartValue,
float  newDuration = -1 
)
pure virtual

Changes the start value of a tween and rewinds it (without pausing it). Has no effect with tweens that are inside Sequences

Parameters
newStartValueThe new start value
newDurationIf bigger than 0 applies it as the new tween duration
abstract Tweener ChangeValues ( object  newStartValue,
object  newEndValue,
float  newDuration = -1 
)
pure virtual

Changes the start and end value of a tween and rewinds it (without pausing it). Has no effect with tweens that are inside Sequences

Parameters
newStartValueThe new start value
newEndValueThe new end value
newDurationIf bigger than 0 applies it as the new tween duration

Member Data Documentation

float easeOvershootOrAmplitude
inherited
float easePeriod
inherited
object id
inherited

Id (usable for filtering with DOTween static methods). Can be an int, a string, an object, or anything else

bool isBackwards
inherited

If TRUE the tween wil go backwards

TweenCallback onComplete
inherited

Called the moment the tween reaches completion (loops included)

TweenCallback onKill
inherited

Called the moment the tween is killed

TweenCallback onPlay
inherited

Called when the tween is set in a playing state, after any eventual delay. Also called each time the tween resumes playing from a paused state

TweenCallback onRewind
inherited

Called when the tween is rewinded, either by calling

Rewind or by reaching the start position while playing backwards. Rewinding a tween that is already rewinded will not fire this callback

TweenCallback onStart
inherited

Called the first time the tween is set in a playing state, after any eventual delay

TweenCallback onStepComplete
inherited

Called the moment the tween completes one loop cycle

TweenCallback onUpdate
inherited

Called each time the tween updates

object target
inherited

Tween target (usable for filtering with DOTween static methods). Automatically set by tween creation shorcuts

float timeScale
inherited

TimeScale for the tween