Support LeanTween! |
LeanTween Class
LeanTween.cs:1344LeanTween 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 );
Item Index
Methods
- LeanTween.addListener
- LeanTween.alpha
- LeanTween.alpha
- LeanTween.alphaVertex
- LeanTween.cancel
- LeanTween.cancel
- LeanTween.cancel
- LeanTween.color
- LeanTween.dispatchEvent
- LeanTween.dispatchEvent
- LeanTween.init
- LeanTween.isTweening
- LeanTween.isTweening
- LeanTween.isTweening
- LeanTween.move
- LeanTween.move
- LeanTween.move (GUI)
- LeanTween.moveLocal
- LeanTween.moveLocal
- LeanTween.moveSpline
- LeanTween.moveSplineLocal
- LeanTween.moveX
- LeanTween.moveY
- LeanTween.moveZ
- LeanTween.pause
- LeanTween.removeListener
- LeanTween.resume
- LeanTween.resume
- LeanTween.rotate
- LeanTween.rotate
- LeanTween.rotateAround
- LeanTween.rotateAroundLocal
- LeanTween.rotateLocal
- LeanTween.rotateX
- LeanTween.rotateY
- LeanTween.rotateZ
- LeanTween.scale
- LeanTween.scale (GUI)
- LeanTween.scaleX
- LeanTween.scaleY
- LeanTween.scaleZ
- LeanTween.value (Color)
- LeanTween.value (float)
- LeanTween.value (float,object)
- LeanTween.value (Vector3)
Methods
LeanTween.addListener
caller:GameObjecteventId:intcallback:System.Action<LTEvent>
Defined inLeanTween.cs:3861
Add a listener method to be called when the appropriate LeanTween.dispatchEvent is called
Parameters:
caller:GameObjectGameObjectthe gameObject the listener is attached to
eventId:intInta unique int that describes the event (best to use an enum)
callback:System.Action<LTEvent>System.Actionthe 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:LTRectto:floattime:float
Defined inLeanTween.cs:2458
Fade a GUI Object
Parameters:
ltRect:LTRectLTRectLTRect that you wish to fade
to:floatFloatthe final alpha value (0-1)
time:floatFloatThe time with which to fade the object
Returns:
LTDescr an object that distinguishes the tween
Example:
LeanTween.alpha(ltRect, 1f, 1f) .setEase(LeanTweenType.easeInCirc);
LeanTween.alpha
gameObject:GameObjectto:floattime:float
Defined inLeanTween.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:GameObjectGameObjectGameobject that you wish to fade
to:floatFloatthe final alpha value (0-1)
time:floatFloatThe time with which to fade the object
Returns:
LTDescr an object that distinguishes the tween
Example:
LeanTween.alpha(gameObject, 1f, 1f) .setDelay(1f);
LeanTween.alphaVertex
gameObject:GameObjectto:floattime:float
Defined inLeanTween.cs:2474
This works by tweening the vertex colors directly.
Vertex-based coloring is useful because you avoid making a copy of yourobject'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:GameObjectGameObjectGameobject that you wish to alpha
to:floatFloatThe alpha value you wish to tween to
time:floatFloatThe time with which to delay before calling the function
Returns:
LTDescr an object that distinguishes the tween
LeanTween.cancel
gameObject:GameObjectid:int
Defined inLeanTween.cs:2202
Cancel a specific tween with the provided id
Parameters:
gameObject:GameObjectGameObjectgameObject whose tweens you want to cancel
id:intFloatunique id that represents that tween
LeanTween.cancel
ltRect:LTRectid:int
Defined inLeanTween.cs:2220
Cancel a specific tween with the provided id
Parameters:
ltRect:LTRectLTRectLTRect object whose tweens you want to cancel
id:intFloatunique id that represents that tween
LeanTween.cancel
gameObject:GameObject
Defined inLeanTween.cs:2185
Cancel all tweens that are currently targeting the gameObject
Parameters:
gameObject:GameObjectGameObjectgameObject whose tweens you wish to cancel
Example:
LeanTween.move( gameObject, new Vector3(0f,1f,2f), 1f);
LeanTween.cancel( gameObject );
LeanTween.color
gameObject:GameObjectto:Colortime:float
Defined inLeanTween.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:GameObjectGameObjectGameobject that you wish to change the color
to:ColorColorthe final color value ex: Color.Red, new Color(1.0f,1.0f,0.0f,0.8f)
time:floatFloatThe time with which to fade the object
Returns:
LTDescr an object that distinguishes the tween
Example:
LeanTween.color(gameObject, Color.yellow, 1f) .setDelay(1f);
LeanTween.dispatchEvent
eventId:intdata:object
Defined inLeanTween.cs:3936
Tell the added listeners that you are dispatching the event
Parameters:
eventId:intInta unique int that describes the event (best to use an enum)
data:objectObjectPass 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 inLeanTween.cs:3925
Tell the added listeners that you are dispatching the event
Parameters:
eventId:intInta unique int that describes the event (best to use an enum)
Example:
LeanTween.dispatchEvent( (int)MyEvents.JUMP );
LeanTween.init
maxSimultaneousTweens:int
Defined inLeanTween.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:intIntegerThe 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 inLeanTween.cs:2359
Test whether or not a tween is active on a LTRect
Parameters:
ltRect:LTRectLTRectLTRect that you want to test if it is tweening
LeanTween.isTweening
gameObject:GameObject
Defined inLeanTween.cs:2324
Test whether or not a tween is active on a GameObject
Parameters:
gameObject:GameObjectGameObjectGameObject that you want to test if it is tweening
LeanTween.isTweening
id:int
Defined inLeanTween.cs:2339
Test whether or not a tween is active or not
Parameters:
id:intGameObjectid 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
GameObjectvec:Vector3time:float
Defined inLeanTween.cs:2532
Move a GameObject to a certain location
Parameters:
GameObjectGameObjectgameObject Gameobject that you wish to move
vec:Vector3Vector3to The final positin with which to move to
time:floatFloattime The time to complete the tween in
Returns:
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
Defined inLeanTween.cs:2550
Move a GameObject along a set of bezier curves
Parameters:
gameObject:GameObjectGameObjectGameobject that you wish to move
[]Vector3optionalA set of points that define the curve(s) ex: Point1,Handle2,Handle1,Point2,...
time:floatFloatThe time to complete the tween in
Returns:
LTDescr an object that distinguishes the tween
Example:
#"../classes/LTDescr.html">LTDescr Defined in Move a GUI Element to a certain location ltRect LTRect object that you wish to move to The final position with which to move to (pixel coordinates) time The time to complete the tween in LTDescr an object that distinguishes the tweenLeanTween.cs:2616Parameters:
ltRect:LTRectLTRectvec:Vector2Vector2time:floatFloatReturns:
LeanTween.moveLocal
gameObject:GameObject[]time:float
Defined inLeanTween.cs:2686
Move a GameObject along a set of bezier curves, in local space
Parameters:
gameObject:GameObjectGameObjectGameobject that you wish to move
[]Vector3optionalA set of points that define the curve(s) ex: Point1,Handle1,Handle2,Point2,...
time:floatFloatThe time to complete the tween in
Returns:
LTDescr an object that distinguishes the tween
Example:
#"../classes/LTDescr.html">LTDescr Defined in Move a GameObject to a certain location relative to the parent transform. gameObject Gameobject that you wish to rotate to The final positin with which to move to time The time to complete the tween in optional Hashtable where you can passoptional items. LTDescr an object that distinguishes the tweenLeanTween.cs:2672Parameters:
GameObjectGameObjectVector3Vector3floatFloatHashtableHashtableReturns:
LeanTween.moveSpline
gameObject:GameObject[]time:float
Defined inLeanTween.cs:2574
Move a GameObject through a set of points
Parameters:
gameObject:GameObjectGameObjectGameobject that you wish to move
[]Vector3optionalA set of points that define the curve(s) ex: ControlStart,Pt1,Pt2,Pt3,.. ..ControlEnd
time:floatFloatThe time to complete the tween in
Returns:
LTDescr an object that distinguishes the tween
Example:
#"../classes/LTDescr.html">LTDescr Defined in Move a GameObject through a set of points, in local space Gameobject that you wish to move A set of points that define the curve(s) ex: ControlStart,Pt1,Pt2,Pt3,.. ..ControlEnd The time to complete the tween in LTDescr an object that distinguishes the tween #"../classes/LTDescr.html">LTDescr Defined in Move a GameObject along the x-axis gameObject Gameobject that you wish to move to The final position with which to move to time The time to complete the move in LTDescr an object that distinguishes the tween Defined in Move a GameObject along the y-axis gameObject Gameobject that you wish to move to The final position with which to move to time The time to complete the move in LTDescr an object that distinguishes the tween Defined in Move a GameObject along the z-axis gameObject Gameobject that you wish to move to The final position with which to move to time The time to complete the move in LTDescr an object that distinguishes the tween Defined in Pause all tweens for a GameObject GameObject whose tweens you want to pause Defined in Remove an event listener you have added the gameObject the listener is attached to a unique int that describes the event (best to use an enum) the method that was specified to call when the event has been dispatched LeanTween.removeListener(gameObject, (int)MyEvents.JUMP, jumpUp); Defined in Resume a specific tween Id of the tween you want to resume ex: int id = LeanTween.MoveX(gameObject, 5, 1.0).id; Defined in Resume all the tweens on a GameObject GameObject whose tweens you want to resume Defined in Rotate a GUI element (using an LTRect object), to a value that is in degrees LTRect that you wish to rotate The final rotation with which to rotate to The time to complete the tween in Object Array where you can passoptional items. LTDescr an object that distinguishes the tween if(GUI.Button(buttonRect.rect, "Rotate")) Defined in Rotate a GameObject, to values are in passed in degrees gameObject Gameobject that you wish to rotate to The final rotation with which to rotate to time The time to complete the tween in LTDescr an object that distinguishes the tween LeanTween.rotate(cube, new Vector3(180f,30f,0f), 1.5f); Defined in Rotate a GameObject around a certain Axis (the best method to use when you want to rotate beyond 180 degrees) Gameobject that you wish to rotate axis in which to rotate around ex: Vector3.up the degrees in which to rotate time The time to complete the rotation in LTDescr an object that distinguishes the tween Example: Defined in Rotate a GameObject around a certain Axis in Local Space (the best method to use when you want to rotate beyond 180 degrees) Gameobject that you wish to rotate axis in which to rotate around ex: Vector3.up the degrees in which to rotate time The time to complete the rotation in LTDescr an object that distinguishes the tween Example: Defined in Rotate a GameObject in the objects local space (on the transforms localEulerAngles object) Gameobject that you wish to rotate The final rotation with which to rotate to The time to complete the rotation in LTDescr an object that distinguishes the tween Defined in Rotate a GameObject only on the X axis Gameobject that you wish to rotate The final x-axis rotation with which to rotate The time to complete the rotation in LTDescr an object that distinguishes the tween Defined in Rotate a GameObject only on the Y axis Gameobject that you wish to rotate The final y-axis rotation with which to rotate The time to complete the rotation in LTDescr an object that distinguishes the tween Defined in Rotate a GameObject only on the Z axis Gameobject that you wish to rotate The final z-axis rotation with which to rotate The time to complete the rotation in LTDescr an object that distinguishes the tween Defined in Scale a GameObject to a certain size gameObject Gameobject that you wish to scale to The size with which to tween to time The time to complete the tween in LTDescr an object that distinguishes the tween Defined in Scale a GUI Element to a certain width and height ltRect LTRect object that you wish to move to The final width and height to scale to (pixel based) time The time to complete the tween in LTDescr an object that distinguishes the tween Example #"../classes/LTDescr.html">LTDescr Defined in Scale a GameObject to a certain size along the x-axis only Gameobject that you wish to scale the size with which to scale to the time to complete the tween in LTDescr an object that distinguishes the tween Defined in Scale a GameObject to a certain size along the y-axis only Gameobject that you wish to scale the size with which to scale to the time to complete the tween in LTDescr an object that distinguishes the tween Defined in Scale a GameObject to a certain size along the z-axis only Gameobject that you wish to scale the size with which to scale to the time to complete the tween in LTDescr an object that distinguishes the tween Defined in Tween from one color to another 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 The function that is called on every Update frame, this function needs to accept a color value ex: function updateValue( Color val ){ } from The original value to start the tween from to The value to end the tween on time The time to complete the tween in LTDescr an object that distinguishes the tween Example #"../classes/LTDescr.html">LTDescr Defined in Tween any particular value, it does not need to be tied to any particular type or 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 The function that is called on every Update frame, this function needs to accept a float value ex: function updateValue( float val ){ } from The original value to start the tween from to The value to end the tween on time The time to complete the tween in LTDescr an object that distinguishes the tween Example #"../classes/LTDescr.html">LTDescr Defined in Tween any particular value (float) Gameobject that you wish to attach the tween to The function that is called on every Update frame, this function needs to accept a float value ex: function updateValue( Vector3 val, object obj ){ } The original value to start the tween from The final Vector3 with which to tween to The time to complete the tween in LTDescr an object that distinguishes the tween Defined in Tween any particular value (Vector3), this could be used to tween an arbitrary value like a material color Gameobject that you wish to attach the tween to The function that is called on every Update frame, this function needs to accept a float value ex: function updateValue( Vector3 val ){ } The original value to start the tween from The final Vector3 with which to tween to The time to complete the tween in LTDescr an object that distinguishes the tweenLeanTween.cs:2595Parameters:
gameObject:GameObjectGameObject[]Vector3optionaltime:floatFloatReturns:
Example:
LeanTween.cs:2633Parameters:
gameObject:GameObjectGameObjectto:floatFloattime:floatFloatReturns:
LeanTween.moveY
)GameObjectfloatfloatLeanTween.cs:2646Parameters:
GameObjectGameObjectfloatFloatfloatFloatReturns:
LeanTween.moveZ
)GameObjectfloatfloatLeanTween.cs:2659Parameters:
GameObjectGameObjectfloatFloatfloatFloatReturns:
LeanTween.pause
)gameObject:GameObjectLeanTween.cs:2276Parameters:
gameObject:GameObjectGameObjectLeanTween.removeListener
)caller:GameObjecteventId:intcallback:System.Action<LTEvent>LeanTween.cs:3902Parameters:
caller:GameObjectGameObjecteventId:intIntcallback:System.Action<LTEvent>System.ActionExample:
void jumpUp( LTEvent e ){ }LeanTween.resume
)id:intLeanTween.cs:2296Parameters:
id:intIntLeanTween.resume
)gameObject:GameObjectLeanTween.cs:2310Parameters:
gameObject:GameObjectGameObjectLeanTween.rotate
)ltRect:LTRectto:floattime:floatoptional:ArrayLeanTween.cs:2737Parameters:
ltRect:LTRectLTRectto:floatFloattime:floatFloatoptional:ArrayArrayReturns:
Example:
LeanTween.rotate( buttonRect4, 150.0f, 1.0f).setEase(LeanTweenType.easeOutElastic);
GUI.matrix = Matrix4x4.identity;LeanTween.rotate
)GameObjectVector3floatLeanTween.cs:2722Parameters:
GameObjectGameObjectVector3Vector3floatFloatReturns:
Example:
LeanTween.rotateAround
)gameObject:GameObjectvec:Vector3degrees:floattime:floatLeanTween.cs:2807Parameters:
gameObject:GameObjectGameObjectvec:Vector3Vector3degrees:floatFloattime:floatFloatReturns:
Example:
LeanTween.rotateAround ( gameObject, Vector3.left, 90f, 1f );LeanTween.rotateAroundLocal
)gameObject:GameObjectvec:Vector3degrees:floattime:floatLeanTween.cs:2824Parameters:
gameObject:GameObjectGameObjectvec:Vector3Vector3degrees:floatFloattime:floatFloatReturns:
Example:
LeanTween.rotateAround ( gameObject, Vector3.left, 90f, 1f );LeanTween.rotateLocal
)gameObject:GameObjectto:Vector3time:floatLeanTween.cs:2755Parameters:
gameObject:GameObjectGameObjectto:Vector3Vector3time:floatFloatReturns:
LeanTween.rotateX
)GameObjectto:floattime:floatLeanTween.cs:2768Parameters:
GameObjectGameObjectto:floatFloattime:floatFloatReturns:
LeanTween.rotateY
)GameObjectto:floattime:floatLeanTween.cs:2781Parameters:
GameObjectGameObjectto:floatFloattime:floatFloatReturns:
LeanTween.rotateZ
)GameObjectto:floattime:floatLeanTween.cs:2794Parameters:
GameObjectGameObjectto:floatFloattime:floatFloatReturns:
LeanTween.scale
)gameObject:GameObjectvec:Vector3time:floatLeanTween.cs:2841Parameters:
gameObject:GameObjectGameObjectvec:Vector3Vector3time:floatFloatReturns:
LeanTween.scale (GUI)
)LTRectVector2floatLeanTween.cs:2854Parameters:
LTRectLTRectVector2Vector2floatFloatReturns:
Example:
LeanTween.cs:2881Parameters:
gameObject:GameObjectGameObjectscaleTo:floatFloattime:floatFloatReturns:
LeanTween.scaleY
)gameObject:GameObjectscaleTo:floattime:floatLeanTween.cs:2894Parameters:
gameObject:GameObjectGameObjectscaleTo:floatFloattime:floatFloatReturns:
LeanTween.scaleZ
)gameObject:GameObjectscaleTo:floattime:floatLeanTween.cs:2907Parameters:
gameObject:GameObjectGameObjectscaleTo:floatFloattime:floatFloatReturns:
LeanTween.value (Color)
)GameObjectcallOnUpdate:Action<Color>ColorColorColorLeanTween.cs:2948Parameters:
GameObjectGameObjectcallOnUpdate:Action<Color>ActionColorColorColorColorColorColorReturns:
Example:
LeanTween.cs:2920Parameters:
GameObjectGameObjectcallOnUpdate:Action<float>ActionfloatFloatfloatFloatfloatFloatReturns:
Example:
LeanTween.cs:2992Parameters:
gameObject:GameObjectGameObjectcallOnUpdate:Action<float,object>Actionfrom:Vector3Floatto:Vector3Vector3time:floatFloatReturns:
LeanTween.value (Vector3)
)gameObject:GameObjectcallOnUpdate:Action<Vector3>from:Vector3to:Vector3time:floatLeanTween.cs:2977Parameters:
gameObject:GameObjectGameObjectcallOnUpdate:Action<Vector3>Actionfrom:Vector3Floatto:Vector3Vector3time:floatFloatReturns:
[8]ページ先頭