Platformer Pro  2.3.2
A platform game kit for Unity.
PlatformerPro.Tween.ITweener< T, P > Interface Template Reference

Interface for things that can tween. More...

Public Member Functions

void TweenWithTime (TweenMode mode, T target, P destination, float time, Action< T, P > callback)
 Tweens target to destination over time. More...
 
void TweenWithRate (TweenMode mode, T target, P destination, float rate, Action< T, P > callback)
 Tweens target to destination at rate. More...
 
void Stop ()
 Stops the active tween. More...
 

Properties

bool Active [get]
 Is tweener currently tweening. More...
 
bool UseGameTime [get, set]
 If true use TimeManager.FrameTime false use Unitys Time.deltaTime More...
 

Detailed Description

Interface for things that can tween.

Member Function Documentation

◆ Stop()

void PlatformerPro.Tween.ITweener< T, P >.Stop ( )

Stops the active tween.

◆ TweenWithRate()

void PlatformerPro.Tween.ITweener< T, P >.TweenWithRate ( TweenMode  mode,
target,
destination,
float  rate,
Action< T, P >  callback 
)

Tweens target to destination at rate.

Parameters
modehow to tween.
targetTarget object.
destinationDestination position, final value, etc.
rateHow fast to do the tween.
callbackCalled when tween completes.

◆ TweenWithTime()

void PlatformerPro.Tween.ITweener< T, P >.TweenWithTime ( TweenMode  mode,
target,
destination,
float  time,
Action< T, P >  callback 
)

Tweens target to destination over time.

Parameters
modehow to tween.
targetTarget object.
destinationDestination position, final value, etc.
timeTime to take to do the tween.
callbackCalled when tween completes.

Property Documentation

◆ Active

bool PlatformerPro.Tween.ITweener< T, P >.Active
get

Is tweener currently tweening.

◆ UseGameTime

bool PlatformerPro.Tween.ITweener< T, P >.UseGameTime
getset

If true use TimeManager.FrameTime false use Unitys Time.deltaTime

true if use game time; otherwise, false.


The documentation for this interface was generated from the following file: