PlatformerPro.Tween.LocalPositionTweener Class Reference

A tweener that tweens position. More...

Inheritance diagram for PlatformerPro.Tween.LocalPositionTweener:

Public Member Functions
override void	TweenWithTime (TweenMode tweenMode, Transform target, Vector3 destination, float time, Action< Transform, Vector3 > callback)
	Tweens target transform to destination position over time. More...
override void	TweenWithRate (TweenMode tweenMode, Transform target, Vector3 destination, float speed, Action< Transform, Vector3 > callback)
	Tweens target transform to destination position with given rate (speed). More...
Public Member Functions inherited from PlatformerPro.Tween.PositionTweener
void	Stop ()
	Stops the active tween. More...
Public Member Functions inherited from PlatformerPro.Tween.ITweener< Transform, Vector3 >
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...

Protected Member Functions
override IEnumerator	DoEasedTween ()
	Does the tween using an easing function. More...
Protected Member Functions inherited from PlatformerPro.Tween.PositionTweener
float	BezierBlend (float t)
float	Linear (float t)

Additional Inherited Members
Protected Attributes inherited from PlatformerPro.Tween.PositionTweener
Vector3	destination
float	speed
float	time
Transform	target
Vector3	direction
Action< Transform, Vector3 >	callback
Func< float, float >	easingFunction
Properties inherited from PlatformerPro.Tween.PositionTweener
bool	Active [get, protected set]
	Is tweener currently tweening. More...
bool	UseGameTime [get, set]
	If true use TimeManager.FrameTime false use Unitys Time.deltaTime More...
Properties inherited from PlatformerPro.Tween.ITweener< Transform, Vector3 >
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

A tweener that tweens position.

Member Function Documentation

DoEasedTween()

override IEnumerator PlatformerPro.Tween.LocalPositionTweener.DoEasedTween ( )

protectedvirtual

Does the tween using an easing function.

Returns

The eased tween.

Reimplemented from PlatformerPro.Tween.PositionTweener.

TweenWithRate()

override void PlatformerPro.Tween.LocalPositionTweener.TweenWithRate ( TweenMode  tweenMode, Transform  target, Vector3  destination, float  speed, Action< Transform, Vector3 >  callback  )

virtual

Tweens target transform to destination position with given rate (speed).

Parameters

mode	How to tween.
target	Target object.
finalPosition	Final position.
speed	How fast to move.
callback	Callback.

Returns

The isntance doing the tween.

Not actually tweening

Reimplemented from PlatformerPro.Tween.PositionTweener.

TweenWithTime()

override void PlatformerPro.Tween.LocalPositionTweener.TweenWithTime ( TweenMode  tweenMode, Transform  target, Vector3  destination, float  time, Action< Transform, Vector3 >  callback  )

virtual

Tweens target transform to destination position over time.

Parameters

mode	how to tween.
target	Target object.
destination	Final position.
time	Time to take to do the tween.
callback	Called when tween completes.

Returns

The isntance doing the tween.

Not actually tweening

Reimplemented from PlatformerPro.Tween.PositionTweener.

---

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

• D:/Projects/platformer-pro-2019.3/Assets/PlatformerPro/Scripts/Effects/Tween/LocalPositionTweener.cs