- Developed by Dented Pixel
API Docs for: LeanTween 2.14

Support LeanTween!
Show:

LeanTween Class

Defined in: LeanTween.cs:1344

LeanTween is an efficient tweening engine for Unity3d

Index of All Methods | Optional Paramaters that can be passed

Optional Parameters are passed at the end of every method

Example:
LeanTween.moveX( gameObject, 1f, 1f).setEase( LeanTweenType.easeInQuad ).setDelay(1f);

You can pass the optional parameters in any order, and chain on as many as you wish.
You can also pass parameters at a later time by saving a reference to what is returned.

Example:
LTDescr d = LeanTween.moveX(gameObject, 1f, 1f);
  ...later set some parameters
d.setOnComplete( onCompleteFunc ).setEase( LeanTweenType.easeInOutBack );

Methods

LeanTween.addListener

(
  • caller:GameObject
  • eventId:int
  • callback:System.Action<LTEvent>
)

Defined in LeanTween.cs:3861

Add a listener method to be called when the appropriate LeanTween.dispatchEvent is called

Parameters:

  • caller:GameObject GameObject

    the gameObject the listener is attached to

  • eventId:int Int

    a unique int that describes the event (best to use an enum)

  • callback:System.Action<LTEvent> System.Action

    the method to call when the event has been dispatched

Example:

LeanTween.addListener(gameObject, (int)MyEvents.JUMP, jumpUp);

void jumpUp( LTEvent e ){ Debug.Log("jump!"); }

LeanTween.alpha

(
  • ltRect:LTRect
  • to:float
  • time:float
)
LTDescr

Defined in LeanTween.cs:2458

Fade a GUI Object

Parameters:

  • ltRect:LTRect LTRect

    LTRect that you wish to fade

  • to:float Float

    the final alpha value (0-1)

  • time:float Float

    The time with which to fade the object

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

Example:

LeanTween.alpha(ltRect, 1f, 1f) .setEase(LeanTweenType.easeInCirc);

LeanTween.alpha

(
  • gameObject:GameObject
  • to:float
  • time:float
)
LTDescr

Defined in LeanTween.cs:2443

Fade a gameobject's material to a certain alpha value. The material's shader needs to support alpha. Owl labs has some excellent efficient shaders.

Parameters:

  • gameObject:GameObject GameObject

    Gameobject that you wish to fade

  • to:float Float

    the final alpha value (0-1)

  • time:float Float

    The time with which to fade the object

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

Example:

LeanTween.alpha(gameObject, 1f, 1f) .setDelay(1f);

LeanTween.alphaVertex

(
  • gameObject:GameObject
  • to:float
  • time:float
)
LTDescr

Defined in LeanTween.cs:2474

This works by tweening the vertex colors directly.

Vertex-based coloring is useful because you avoid making a copy of your object's material for each instance that needs a different color.

A shader that supports vertex colors is required for it to work (for example the shaders in Mobile/Particles/)

Parameters:

  • gameObject:GameObject GameObject

    Gameobject that you wish to alpha

  • to:float Float

    The alpha value you wish to tween to

  • time:float Float

    The time with which to delay before calling the function

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

LeanTween.cancel

(
  • gameObject:GameObject
  • id:int
)

Defined in LeanTween.cs:2202

Cancel a specific tween with the provided id

Parameters:

  • gameObject:GameObject GameObject

    gameObject whose tweens you want to cancel

  • id:int Float

    unique id that represents that tween

LeanTween.cancel

(
  • ltRect:LTRect
  • id:int
)

Defined in LeanTween.cs:2220

Cancel a specific tween with the provided id

Parameters:

  • ltRect:LTRect LTRect

    LTRect object whose tweens you want to cancel

  • id:int Float

    unique id that represents that tween

LeanTween.cancel

(
  • gameObject:GameObject
)

Defined in LeanTween.cs:2185

Cancel all tweens that are currently targeting the gameObject

Parameters:

  • gameObject:GameObject GameObject

    gameObject whose tweens you wish to cancel

Example:

LeanTween.move( gameObject, new Vector3(0f,1f,2f), 1f);
LeanTween.cancel( gameObject );

LeanTween.color

(
  • gameObject:GameObject
  • to:Color
  • time:float
)
LTDescr

Defined in LeanTween.cs:2493

Change a gameobject's material to a certain color value. The material's shader needs to support color tinting. Owl labs has some excellent efficient shaders.

Parameters:

  • gameObject:GameObject GameObject

    Gameobject that you wish to change the color

  • to:Color Color

    the final color value ex: Color.Red, new Color(1.0f,1.0f,0.0f,0.8f)

  • time:float Float

    The time with which to fade the object

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

Example:

LeanTween.color(gameObject, Color.yellow, 1f) .setDelay(1f);

LeanTween.dispatchEvent

(
  • eventId:int
  • data:object
)

Defined in LeanTween.cs:3936

Tell the added listeners that you are dispatching the event

Parameters:

  • eventId:int Int

    a unique int that describes the event (best to use an enum)

  • data:object Object

    Pass data to the listener, access it from the listener with *.data on the LTEvent object

Example:

LeanTween.dispatchEvent( (int)MyEvents.JUMP, transform );

void jumpUp( LTEvent e ){
  Transform tran = (Transform)e.data;
}

LeanTween.dispatchEvent

(
  • eventId:int
)

Defined in LeanTween.cs:3925

Tell the added listeners that you are dispatching the event

Parameters:

  • eventId:int Int

    a unique int that describes the event (best to use an enum)

Example:

LeanTween.dispatchEvent( (int)MyEvents.JUMP );

LeanTween.init

(
  • maxSimultaneousTweens:int
)

Defined in LeanTween.cs:1386

This line is optional. Here you can specify the maximum number of tweens you will use (the default is 400). This must be called before any use of LeanTween is made for it to be effective.

Parameters:

  • maxSimultaneousTweens:int Integer

    The maximum number of tweens you will use, make sure you don't go over this limit, otherwise the code will throw an error

Example:

LeanTween.init( 800 );

LeanTween.isTweening

(
  • ltRect:LTRect
)

Defined in LeanTween.cs:2359

Test whether or not a tween is active on a LTRect

Parameters:

  • ltRect:LTRect LTRect

    LTRect that you want to test if it is tweening

LeanTween.isTweening

(
  • gameObject:GameObject
)

Defined in LeanTween.cs:2324

Test whether or not a tween is active on a GameObject

Parameters:

  • gameObject:GameObject GameObject

    GameObject that you want to test if it is tweening

LeanTween.isTweening

(
  • id:int
)

Defined in LeanTween.cs:2339

Test whether or not a tween is active or not

Parameters:

  • id:int GameObject

    id of the tween that you want to test if it is tweening   Example:
      int id = LeanTween.moveX(gameObject, 1f, 3f).id;
      if(LeanTween.isTweening( id ))
         Debug.Log("I am tweening!");

LeanTween.move

(
  • GameObject
  • vec:Vector3
  • time:float
)
LTDescr

Defined in LeanTween.cs:2532

Move a GameObject to a certain location

Parameters:

  • GameObject GameObject

    gameObject Gameobject that you wish to move

  • vec:Vector3 Vector3

    to The final positin with which to move to

  • time:float Float

    time The time to complete the tween in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

Example:

LeanTween.move(gameObject, new Vector3(0f,-3f,5f), 2.0f) .setEase( LeanTweenType.easeOutQuad );

LeanTween.move

(
  • gameObject:GameObject
  • []
  • time:float
)
LTDescr

Defined in LeanTween.cs:2550

Move a GameObject along a set of bezier curves

Parameters:

  • gameObject:GameObject GameObject

    Gameobject that you wish to move

  • [] Vector3 optional

    A set of points that define the curve(s) ex: Point1,Handle2,Handle1,Point2,...

  • time:float Float

    The time to complete the tween in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

Example:

Javascript:
LeanTween.move(gameObject, [Vector3(0,0,0),Vector3(1,0,0),Vector3(1,0,0),Vector3(1,0,1)], 2.0) .setEase(LeanTweenType.easeOutQuad).setOrientToPath(true);

C#:
LeanTween.move(gameObject, new Vector3[]{new Vector3(0f,0f,0f),new Vector3(1f,0f,0f),new Vector3(1f,0f,0f),new Vector3(1f,0f,1f)}, 1.5f).setEase(LeanTweenType.easeOutQuad).setOrientToPath(true);;

LeanTween.move (GUI)

(
  • ltRect:LTRect
  • vec:Vector2
  • time:float
)
LTDescr

Defined in LeanTween.cs:2616

Move a GUI Element to a certain location

Parameters:

  • ltRect:LTRect LTRect

    ltRect LTRect object that you wish to move

  • vec:Vector2 Vector2

    to The final position with which to move to (pixel coordinates)

  • time:float Float

    time The time to complete the tween in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

LeanTween.moveLocal

(
  • gameObject:GameObject
  • []
  • time:float
)
LTDescr

Defined in LeanTween.cs:2686

Move a GameObject along a set of bezier curves, in local space

Parameters:

  • gameObject:GameObject GameObject

    Gameobject that you wish to move

  • [] Vector3 optional

    A set of points that define the curve(s) ex: Point1,Handle1,Handle2,Point2,...

  • time:float Float

    The time to complete the tween in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

Example:

Javascript:
LeanTween.move(gameObject, [Vector3(0,0,0),Vector3(1,0,0),Vector3(1,0,0),Vector3(1,0,1)], 2.0).setEase(LeanTweenType.easeOutQuad).setOrientToPath(true);

C#:
LeanTween.move(gameObject, new Vector3[]{Vector3(0f,0f,0f),Vector3(1f,0f,0f),Vector3(1f,0f,0f),Vector3(1f,0f,1f)}).setEase(LeanTweenType.easeOutQuad).setOrientToPath(true);

LeanTween.moveLocal

(
  • GameObject
  • Vector3
  • float
  • Hashtable
)
LTDescr

Defined in LeanTween.cs:2672

Move a GameObject to a certain location relative to the parent transform.

Parameters:

  • GameObject GameObject

    gameObject Gameobject that you wish to rotate

  • Vector3 Vector3

    to The final positin with which to move to

  • float Float

    time The time to complete the tween in

  • Hashtable Hashtable

    optional Hashtable where you can pass optional items.

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

LeanTween.moveSpline

(
  • gameObject:GameObject
  • []
  • time:float
)
LTDescr

Defined in LeanTween.cs:2574

Move a GameObject through a set of points

Parameters:

  • gameObject:GameObject GameObject

    Gameobject that you wish to move

  • [] Vector3 optional

    A set of points that define the curve(s) ex: ControlStart,Pt1,Pt2,Pt3,.. ..ControlEnd

  • time:float Float

    The time to complete the tween in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

Example:

Javascript:
LeanTween.moveSpline(gameObject, [Vector3(0,0,0),Vector3(1,0,0),Vector3(1,0,0),Vector3(1,0,1)], 2.0) .setEase(LeanTweenType.easeOutQuad).setOrientToPath(true);

C#:
LeanTween.moveSpline(gameObject, new Vector3[]{new Vector3(0f,0f,0f),new Vector3(1f,0f,0f),new Vector3(1f,0f,0f),new Vector3(1f,0f,1f)}, 1.5f).setEase(LeanTweenType.easeOutQuad).setOrientToPath(true);

LeanTween.moveSplineLocal

(
  • gameObject:GameObject
  • []
  • time:float
)
LTDescr

Defined in LeanTween.cs:2595

Move a GameObject through a set of points, in local space

Parameters:

  • gameObject:GameObject GameObject

    Gameobject that you wish to move

  • [] Vector3 optional

    A set of points that define the curve(s) ex: ControlStart,Pt1,Pt2,Pt3,.. ..ControlEnd

  • time:float Float

    The time to complete the tween in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

Example:

Javascript:
LeanTween.moveSpline(gameObject, [Vector3(0,0,0),Vector3(1,0,0),Vector3(1,0,0),Vector3(1,0,1)], 2.0) .setEase(LeanTweenType.easeOutQuad).setOrientToPath(true);

C#:
LeanTween.moveSpline(gameObject, new Vector3[]{new Vector3(0f,0f,0f),new Vector3(1f,0f,0f),new Vector3(1f,0f,0f),new Vector3(1f,0f,1f)}, 1.5f).setEase(LeanTweenType.easeOutQuad).setOrientToPath(true);

LeanTween.moveX

(
  • gameObject:GameObject
  • to:float
  • time:float
)
LTDescr

Defined in LeanTween.cs:2633

Move a GameObject along the x-axis

Parameters:

  • gameObject:GameObject GameObject

    gameObject Gameobject that you wish to move

  • to:float Float

    to The final position with which to move to

  • time:float Float

    time The time to complete the move in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

LeanTween.moveY

(
  • GameObject
  • float
  • float
)
LTDescr

Defined in LeanTween.cs:2646

Move a GameObject along the y-axis

Parameters:

  • GameObject GameObject

    gameObject Gameobject that you wish to move

  • float Float

    to The final position with which to move to

  • float Float

    time The time to complete the move in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

LeanTween.moveZ

(
  • GameObject
  • float
  • float
)
LTDescr

Defined in LeanTween.cs:2659

Move a GameObject along the z-axis

Parameters:

  • GameObject GameObject

    gameObject Gameobject that you wish to move

  • float Float

    to The final position with which to move to

  • float Float

    time The time to complete the move in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

LeanTween.pause

(
  • gameObject:GameObject
)

Defined in LeanTween.cs:2276

Pause all tweens for a GameObject

Parameters:

  • gameObject:GameObject GameObject

    GameObject whose tweens you want to pause

LeanTween.removeListener

(
  • caller:GameObject
  • eventId:int
  • callback:System.Action<LTEvent>
)

Defined in LeanTween.cs:3902

Remove an event listener you have added

Parameters:

  • caller:GameObject GameObject

    the gameObject the listener is attached to

  • eventId:int Int

    a unique int that describes the event (best to use an enum)

  • callback:System.Action<LTEvent> System.Action

    the method that was specified to call when the event has been dispatched

Example:

LeanTween.removeListener(gameObject, (int)MyEvents.JUMP, jumpUp);

void jumpUp( LTEvent e ){ }

LeanTween.resume

(
  • id:int
)

Defined in LeanTween.cs:2296

Resume a specific tween

Parameters:

  • id:int Int

    Id of the tween you want to resume ex: int id = LeanTween.MoveX(gameObject, 5, 1.0).id;

LeanTween.resume

(
  • gameObject:GameObject
)

Defined in LeanTween.cs:2310

Resume all the tweens on a GameObject

Parameters:

  • gameObject:GameObject GameObject

    GameObject whose tweens you want to resume

LeanTween.rotate

(
  • ltRect:LTRect
  • to:float
  • time:float
  • optional:Array
)
LTDescr

Defined in LeanTween.cs:2737

Rotate a GUI element (using an LTRect object), to a value that is in degrees

Parameters:

  • ltRect:LTRect LTRect

    LTRect that you wish to rotate

  • to:float Float

    The final rotation with which to rotate to

  • time:float Float

    The time to complete the tween in

  • optional:Array Array

    Object Array where you can pass optional items.

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

Example:

if(GUI.Button(buttonRect.rect, "Rotate"))
LeanTween.rotate( buttonRect4, 150.0f, 1.0f).setEase(LeanTweenType.easeOutElastic);
GUI.matrix = Matrix4x4.identity;

LeanTween.rotate

(
  • GameObject
  • Vector3
  • float
)
LTDescr

Defined in LeanTween.cs:2722

Rotate a GameObject, to values are in passed in degrees

Parameters:

  • GameObject GameObject

    gameObject Gameobject that you wish to rotate

  • Vector3 Vector3

    to The final rotation with which to rotate to

  • float Float

    time The time to complete the tween in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

Example:

LeanTween.rotate(cube, new Vector3(180f,30f,0f), 1.5f);

LeanTween.rotateAround

(
  • gameObject:GameObject
  • vec:Vector3
  • degrees:float
  • time:float
)
LTDescr

Defined in LeanTween.cs:2807

Rotate a GameObject around a certain Axis (the best method to use when you want to rotate beyond 180 degrees)

Parameters:

  • gameObject:GameObject GameObject

    Gameobject that you wish to rotate

  • vec:Vector3 Vector3

    axis in which to rotate around ex: Vector3.up

  • degrees:float Float

    the degrees in which to rotate

  • time:float Float

    time The time to complete the rotation in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

Example:

Example:
LeanTween.rotateAround ( gameObject, Vector3.left, 90f, 1f );

LeanTween.rotateAroundLocal

(
  • gameObject:GameObject
  • vec:Vector3
  • degrees:float
  • time:float
)
LTDescr

Defined in LeanTween.cs:2824

Rotate a GameObject around a certain Axis in Local Space (the best method to use when you want to rotate beyond 180 degrees)

Parameters:

  • gameObject:GameObject GameObject

    Gameobject that you wish to rotate

  • vec:Vector3 Vector3

    axis in which to rotate around ex: Vector3.up

  • degrees:float Float

    the degrees in which to rotate

  • time:float Float

    time The time to complete the rotation in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

Example:

Example:
LeanTween.rotateAround ( gameObject, Vector3.left, 90f, 1f );

LeanTween.rotateLocal

(
  • gameObject:GameObject
  • to:Vector3
  • time:float
)
LTDescr

Defined in LeanTween.cs:2755

Rotate a GameObject in the objects local space (on the transforms localEulerAngles object)

Parameters:

  • gameObject:GameObject GameObject

    Gameobject that you wish to rotate

  • to:Vector3 Vector3

    The final rotation with which to rotate to

  • time:float Float

    The time to complete the rotation in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

LeanTween.rotateX

(
  • GameObject
  • to:float
  • time:float
)
LTDescr

Defined in LeanTween.cs:2768

Rotate a GameObject only on the X axis

Parameters:

  • GameObject GameObject

    Gameobject that you wish to rotate

  • to:float Float

    The final x-axis rotation with which to rotate

  • time:float Float

    The time to complete the rotation in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

LeanTween.rotateY

(
  • GameObject
  • to:float
  • time:float
)
LTDescr

Defined in LeanTween.cs:2781

Rotate a GameObject only on the Y axis

Parameters:

  • GameObject GameObject

    Gameobject that you wish to rotate

  • to:float Float

    The final y-axis rotation with which to rotate

  • time:float Float

    The time to complete the rotation in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

LeanTween.rotateZ

(
  • GameObject
  • to:float
  • time:float
)
LTDescr

Defined in LeanTween.cs:2794

Rotate a GameObject only on the Z axis

Parameters:

  • GameObject GameObject

    Gameobject that you wish to rotate

  • to:float Float

    The final z-axis rotation with which to rotate

  • time:float Float

    The time to complete the rotation in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

LeanTween.scale

(
  • gameObject:GameObject
  • vec:Vector3
  • time:float
)
LTDescr

Defined in LeanTween.cs:2841

Scale a GameObject to a certain size

Parameters:

  • gameObject:GameObject GameObject

    gameObject Gameobject that you wish to scale

  • vec:Vector3 Vector3

    to The size with which to tween to

  • time:float Float

    time The time to complete the tween in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

LeanTween.scale (GUI)

(
  • LTRect
  • Vector2
  • float
)
LTDescr

Defined in LeanTween.cs:2854

Scale a GUI Element to a certain width and height

Parameters:

  • LTRect LTRect

    ltRect LTRect object that you wish to move

  • Vector2 Vector2

    to The final width and height to scale to (pixel based)

  • float Float

    time The time to complete the tween in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

Example:

Example Javascript:
var bRect:LTRect = new LTRect( 0, 0, 100, 50 );
LeanTween.scale( bRect, Vector2(bRect.rect.width, bRect.rect.height) * 1.3, 0.25 ).setEase(LeanTweenType.easeOutBounce);
function OnGUI(){
  if(GUI.Button(bRect.rect, "Scale")){ }
}

Example C#:
LTRect bRect = new LTRect( 0f, 0f, 100f, 50f );
LeanTween.scale( bRect, new Vector2(150f,75f), 0.25f ).setEase(LeanTweenType.easeOutBounce);
void OnGUI(){
  if(GUI.Button(bRect.rect, "Scale")){ }
}

LeanTween.scaleX

(
  • gameObject:GameObject
  • scaleTo:float
  • time:float
)
LTDescr

Defined in LeanTween.cs:2881

Scale a GameObject to a certain size along the x-axis only

Parameters:

  • gameObject:GameObject GameObject

    Gameobject that you wish to scale

  • scaleTo:float Float

    the size with which to scale to

  • time:float Float

    the time to complete the tween in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

LeanTween.scaleY

(
  • gameObject:GameObject
  • scaleTo:float
  • time:float
)
LTDescr

Defined in LeanTween.cs:2894

Scale a GameObject to a certain size along the y-axis only

Parameters:

  • gameObject:GameObject GameObject

    Gameobject that you wish to scale

  • scaleTo:float Float

    the size with which to scale to

  • time:float Float

    the time to complete the tween in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

LeanTween.scaleZ

(
  • gameObject:GameObject
  • scaleTo:float
  • time:float
)
LTDescr

Defined in LeanTween.cs:2907

Scale a GameObject to a certain size along the z-axis only

Parameters:

  • gameObject:GameObject GameObject

    Gameobject that you wish to scale

  • scaleTo:float Float

    the size with which to scale to

  • time:float Float

    the time to complete the tween in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

LeanTween.value (Color)

(
  • GameObject
  • callOnUpdate:Action<Color>
  • Color
  • Color
  • Color
)
LTDescr

Defined in LeanTween.cs:2948

Tween from one color to another

Parameters:

  • GameObject GameObject

    gameObject GameObject with which to tie the tweening with. This is only used when you need to cancel this tween, it does not actually perform any operations on this gameObject

  • callOnUpdate:Action<Color> Action

    The function that is called on every Update frame, this function needs to accept a color value ex: function updateValue( Color val ){ }

  • Color Color

    from The original value to start the tween from

  • Color Color

    to The value to end the tween on

  • Color Color

    time The time to complete the tween in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

Example:

Example Javascript:
LeanTween.value( gameObject, updateValueExampleCallback, Color.red, Color.green, 1f).setEase(LeanTweenType.easeOutElastic);
function updateValueExampleCallback( val:Color ){
  Debug.Log("tweened color:"+val+" set this to whatever variable you are tweening...");
}

Example C#:
LeanTween.value( gameObject, updateValueExampleCallback, Color.red, Color.green, 1f).setEase(LeanTweenType.easeOutElastic);
void updateValueExampleCallback( Color val ){
  Debug.Log("tweened color:"+val+" set this to whatever variable you are tweening...");
}

LeanTween.value (float)

(
  • GameObject
  • callOnUpdate:Action<float>
  • float
  • float
  • float
)
LTDescr

Defined in LeanTween.cs:2920

Tween any particular value, it does not need to be tied to any particular type or GameObject

Parameters:

  • GameObject GameObject

    gameObject GameObject with which to tie the tweening with. This is only used when you need to cancel this tween, it does not actually perform any operations on this gameObject

  • callOnUpdate:Action<float> Action

    The function that is called on every Update frame, this function needs to accept a float value ex: function updateValue( float val ){ }

  • float Float

    from The original value to start the tween from

  • float Float

    to The value to end the tween on

  • float Float

    time The time to complete the tween in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

Example:

Example Javascript:
LeanTween.value( gameObject, updateValueExampleCallback, 180f, 270f, 1f).setEase(LeanTweenType.easeOutElastic);
function updateValueExampleCallback( val:float ){
  Debug.Log("tweened value:"+val+" set this to whatever variable you are tweening...");
}

Example C#:
LeanTween.value( gameObject, updateValueExampleCallback, 180f, 270f, 1f).setEase(LeanTweenType.easeOutElastic);
void updateValueExampleCallback( float val ){
  Debug.Log("tweened value:"+val+" set this to whatever variable you are tweening...");
}

LeanTween.value (float,object)

(
  • gameObject:GameObject
  • callOnUpdate:Action<float,object>
  • from:Vector3
  • to:Vector3
  • time:float
)
LTDescr

Defined in LeanTween.cs:2992

Tween any particular value (float)

Parameters:

  • gameObject:GameObject GameObject

    Gameobject that you wish to attach the tween to

  • callOnUpdate:Action<float,object> Action

    The function that is called on every Update frame, this function needs to accept a float value ex: function updateValue( Vector3 val, object obj ){ }

  • from:Vector3 Float

    The original value to start the tween from

  • to:Vector3 Vector3

    The final Vector3 with which to tween to

  • time:float Float

    The time to complete the tween in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween

LeanTween.value (Vector3)

(
  • gameObject:GameObject
  • callOnUpdate:Action<Vector3>
  • from:Vector3
  • to:Vector3
  • time:float
)
LTDescr

Defined in LeanTween.cs:2977

Tween any particular value (Vector3), this could be used to tween an arbitrary value like a material color

Parameters:

  • gameObject:GameObject GameObject

    Gameobject that you wish to attach the tween to

  • callOnUpdate:Action<Vector3> Action

    The function that is called on every Update frame, this function needs to accept a float value ex: function updateValue( Vector3 val ){ }

  • from:Vector3 Float

    The original value to start the tween from

  • to:Vector3 Vector3

    The final Vector3 with which to tween to

  • time:float Float

    The time to complete the tween in

Returns:

LTDescr:

LTDescr an object that distinguishes the tween