iTween.audioFrom(GameObject, Hashtable)
iTween.audioTo(GameObject, Hashtable)
- Base arguments: volume:float=0, pitch:float=1, delay:float=0, time:float=1, transition:string=linear
- Callback arguments: onStart:string, onStartTarget:gameobject, onStartParams:string, onUpdate:string, onUpdateTarget:string, onUpdateTarget:gameobject, onComplete:string, onCompleteParams:object, onCompleteTarget:gameobject
- Fades volume and or pitch of an AudioClip to the supplied target values.
iTween.colorFrom(GameObject, Hashtable)
iTween.colorTo(GameObject, Hashtable)
- Base arguments: time:float=1, delay:float=0, includeChildren:boolean=true, transition:string=linear, loopType:string
- Callback arguments: onStart:string, onStartTarget:gameobject, onStartParams:string, onUpdate:string, onUpdateTarget:string, onUpdateTarget:gameobject, onComplete:string, onCompleteParams:object, onCompleteTarget:gameobject
- Coordinate arguments can be sent as individual properties: "r":float, "g":float, "b":float or as a Color: "color":Color
- Possible loopTypes are "loop" and "pingPong"
- Modifies the color values of the material or guiTexture to the supplies values.
iTween.fadeFrom(GameObject, Hashtable)
iTween.fadeTo(GameObject, Hashtable)
- Base arguments: alpha:float=0, time:float=1, delay:float=0, includeChildren:boolean=true, transition:string=linear, loopType:string
- Callback arguments: onStart:string, onStartTarget:gameobject, onStartParams:string, onUpdate:string, onUpdateTarget:string, onUpdateTarget:gameobject, onComplete:string, onCompleteParams:object, onCompleteTarget:gameobject
- Possible loopTypes are "loop" and "pingPong"
- Fades the GameObject to the supplied alpha
- Only works if the GameObject's material calculates transparency.
iTween.lookFrom(GameObject, Hashtable)
iTween.lookFromWorld(GameObject, Hashtable)
- Helper function for lookFrom that calls a lookFrom with "isLocal" set to false.
iTween.lookTo(GameObject, Hashtable)
- Helper function for rotateTo which simplifies the task of getting an object to animate a lookAt
- Arguments in addition to rotateTo's: target:vector3, transform:Transform, axis:string
- Callback arguments: onStart:string, onStartTarget:gameobject, onStartParams:string, onUpdate:string, onUpdateTarget:string, onUpdateTarget:gameobject, onComplete:string, onCompleteParams:object, onCompleteTarget:gameobject
- The intended look direction can be set as "target":Vector3 or as "transform":Transform
- If "transform" is passed as the look direction the supplied Transform's position will be utilized and is ideal for "live" or updated targets
- Adding a value of "x", "y", or "z" to an "axis" argument will restrict the look operation to that axis
iTween.lookToUpdate(GameObject, Hashtable) - REPEAT CALLABLE
- Base arguments: target:vector3, lookSpeed:float=3, axis:string, isLocal:boolean=true
- Adding a value of "x", "y", or "z" to an "axis" argument will restrict the look operation to that axis
- Intended to be called continuously from Update methods or similar situations
- Will smoothly look towards a target based on lookSpeed (a lower number means slower speed)
- Ideal for smoothed camera target following, enemies that aim at a character, and anywhere you need an object to look at a moving target or point
iTween.lookToUpdateWorld(GameObject, Hashtable) - REPEAT CALLABLE
- Helper function for lookToUpdate that simply calls a lookToUpdate with "isLocal" set to false.
iTween.lookToWorld(GameObject, Hashtable)
- Helper function for lookTo that calls a lookTo with "isLocal" set to false.
iTween.moveAdd(GameObject, Hashtable)
iTween.moveAddWorld(GameObject, Hashtable)
iTween.moveBy(GameObject, Hashtable)
- Base arguments: time:float=1, delay:float=0, transition:String=easeInOutCubic, loopType:string, isLocal:boolean=true
- Callback arguments: onStart:string, onStartTarget:gameobject, onStartParams:string, onUpdate:string, onUpdateTarget:string, onUpdateTarget:gameobject, onComplete:string, onCompleteParams:object, onCompleteTarget:gameobject
- Coordinate arguments can be sent as individual properties: "x":float, "y":float, "z":float or as a Vector3: "amount":vector3
- Automatically sets isKinematic to true if the gameObject contains a rigidbody and it is not true (returns value on completition) to avoid physics oddities
- Possible loopTypes are "loop" and "pingPong"
- Moves the GameObject by the supplied coordinate(s).
iTween.moveByWorld(GameObject, Hashtable)
- Helper function for moveBy that simply calls a moveBy with "isLocal" set to false.
iTween.moveFrom(GameObject, Hashtable)
iTween.moveFromWorld(GameObject, Hashtable)
- Helper function for moveFrom that simply calls a moveFrom with "isLocal" set to false.
iTween.moveTo(GameObject, Hashtable)
- Base arguments: time:float=1, delay:float=0, transition:string=easeInOutCubic, lookAt:vector3, lookAtTransform:Transform, loopType:string, isLocal:boolean=true
- Callback arguments: onStart:string, onStartTarget:gameobject, onStartParams:string, onUpdate:string, onUpdateTarget:string, onUpdateTarget:gameobject, onComplete:string, onCompleteParams:object, onCompleteTarget:gameobject
- Coordinate arguments can be sent as individual properties: "x":float, "y":float, "z":float or as a Vector3: "position":vector3
- Possible loopTypes are "loop" and "pingPong"
- Automatically sets isKinematic to true if the gameObject contains a rigidbody and it is not true (returns value on completition) to avoid physics oddities
- Moves the GameObject to the supplied coordinate(s).
- lookAt allows you to set a Vector3 that the object will look towards as it moves and overrides orientToPath.
- lookAtTransform allows you to set a Transform that the object will look towards as it moves and overrides orientToPath.
iTween.moveToBezier(GameObject, Hashtable)
- Base arguments: axis:string, bezier:array, lookAt:Vector3, lookAtTransform:Transform, orientToPath:boolean=true, lookSpeed:float=8, time:float=1, delay:float=0, transition:String=easeInOutCubic, loopType:string
- Callback arguments: onStart:string, onStartTarget:gameobject, onStartParams:string, onUpdate:string, onUpdateTarget:string, onUpdateTarget:gameobject, onComplete:string, onCompleteParams:object, onCompleteTarget:gameobject
- Possible loopTypes are "loop" and "pingPong"
- Adding an axis argument:string with either "x", "y", or "z" will lock lookTo and orientToPath to that axis
- You can change the dafault lookSpeed to augment how fast the object turns as it moves (for lookAt and orientToPath)
- Automatically sets isKinematic to true if the gameObject contains a rigidbody and it is not true (returns value on completition) to avoid physics oddities
- Identical to other move methods except movement paths can be curved through an array of Vector3s
- "bezier" argument should be structured as an array of Vector3 (i.e. "bezier":[Vector3(),Vector3(),Vector3(),etc...])
- Each new "control point" in the bezier array will set a new point to curve into.
- orientToPath causes the object to look in the direction it's moving.
- lookAt allows you to set a Vector3 that the object will look towards as it moves and overrides orientToPath.
- lookAtTransform allows you to set a Transform that the object will look towards as it moves and overrides orientToPath.
iTween.moveToBezierWorld(GameObject, Hashtable)
- Helper function for moveToBezier that simply calls a moveToBezier with "isLocal" set to false.
iTween.moveToUpdate(GameObject, Hashtable) - REPEAT CALLABLE
- Base arguments: time:float=.05
- Coordinate arguments can be sent as individual properties: "x":float, "y":float, "z":float or as a Vector3: "position":Vector3
- Intended to be called continuously from Update methods or similar situations
- Will smoothly move object to supplied values over the time provided (lower number means faster speed)
- Ideal for eased mouse followers, eased camera following and anywhere you need an object to slowly arrive at a "live" and possibly changing location
iTween.moveToUpdateWorld(GameObject, Hashtable) - REPEAT CALLABLE
- Helper function for moveToUpdate that simply calls a moveToUpdate with "isLocal" set to false.
iTween.moveToWorld(GameObject, Hashtable)
- Helper function for moveTo that simply calls a moveTo with "isLocal" set to false.
iTween.punchPosition(GameObject, Hashtable)
- Base arguments: time:float=1, delay:float=0, isLocal:boolean=true
- Callback arguments: onStart:string, onStartTarget:gameobject, onStartParams:string, onUpdate:string, onUpdateTarget:string, onUpdateTarget:gameobject, onComplete:string, onCompleteParams:object, onCompleteTarget:gameobject
- Coordinate arguments can be sent as individual properties: "x":float, "y":float, "z":float or as a Vector3: "amount":vector3
- Applies a jolt of force on the given axis and springs the GameObject back to its original position like a punching bag.
- Automatically sets isKinematic to true if the gameObject contains a rigidbody and it is not true (returns value on completition) to avoid physics oddities
- Negative/positive values dictate the direction of the initial impact.
- Does not utilize a transition.
iTween.punchPositionWorld(GameObject, Hashtable)
- Helper function for punchPosition that simply calls a punchPosition with "isLocal" set to false.
iTween.punchRotation(GameObject, Hashtable)
- Base arguments: time:float=1, delay:float=0, isLocal:boolean=true
- Callback arguments: onStart:string, onStartTarget:gameobject, onStartParams:string, onUpdate:string, onUpdateTarget:string, onUpdateTarget:gameobject, onComplete:string, onCompleteParams:object, onCompleteTarget:gameobject
- Coordinate arguments can be sent as individual properties: "x":float, "y":float, "z":float or as a Vector3: "amount":vector3
- Applies a jolt of rotation force on the given axis based on a percentage or multiplier of 360 degrees and springs the GameObject back to its original position like a punching bag.
- Negative/positive values dictate the direction of the initial impact.
- Automatically sets isKinematic to true if the gameObject contains a rigidbody and it is not true (returns value on completition) to avoid physics oddities
- Does not work on GUIText, GUITexture and similar display objects that do not support rotation.
- Does not utilize a transition.
iTween.punchRotationWorld(GameObject, Hashtable)
- Helper function for punchRotation that simply calls a punchRotation with "isLocal" set to false.
iTween.punchScale(GameObject, Hashtable)
- Base arguments: time:float=1, delay:float=0
- Callback arguments: onStart:string, onStartTarget:gameobject, onStartParams:string, onUpdate:string, onUpdateTarget:string, onUpdateTarget:gameobject, onComplete:string, onCompleteParams:object, onCompleteTarget:gameobject
- Coordinate arguments can be sent as individual properties: "x":float, "y":float, "z":float or as a Vector3: "amount":vector3
- Applies a jolt of force on the given axis and springs the GameObject back to its original scale like a jello blob.
- Automatically sets isKinematic to true if the gameObject contains a rigidbody and it is not true (returns value on completition) to avoid physics oddities
- Negative/positive values dictate the direction of the initial impact.
- Does not utilize a transition.
iTween.rotateAdd(GameObject, Hashtable)
- Same as rotateAdd but it adds to the current values instead of multiplies.
iTween.rotateBy(GameObject, Hashtable)
- Base arguments: time:float=1, delay:float=0, transition:String=easeInOutCubic, loopType:string, isLocal:boolean=true
- Callback arguments: onStart:string, onStartTarget:gameobject, onStartParams:string, onUpdate:string, onUpdateTarget:string, onUpdateTarget:gameobject, onComplete:string, onCompleteParams:object, onCompleteTarget:gameobject
- Coordinate arguments can be sent as individual properties: "x":float, "y":float, "z":float or as a Vector3: "amount":Vector3
- Possible loopTypes are "loop" and "pingPong"
- Automatically sets isKinematic to true if the gameObject contains a rigidbody and it is not true (returns value on completition) to avoid physics oddities
- Rotates the GameObject 360 degrees times the supplied multiplier(s).
- Negative/positive values dictate direction of rotation.
- Does not work on GUIText, GUITexture and similar display objects that do not support rotation.
iTween.rotateByWorld(GameObject, Hashtable)
- Helper function for rotateBy that simply calls a rotateBy with "isLocal" set to false.
iTween.rotateFrom(GameObject, Hashtable)
iTween.rotateTo(GameObject, Hashtable)
- Base arguments: time:float=1, delay:float=0, transition:String=easeInOutCubic, loopType:string, isLocal:boolean=true
- Callback arguments: onStart:string, onStartTarget:gameobject, onStartParams:string, onUpdate:string, onUpdateTarget:string, onUpdateTarget:gameobject, onComplete:string, onCompleteParams:object, onCompleteTarget:gameobject
- Coordinate arguments can be sent as individual properties: "x":float, "y":float, "z":float or as a Vector3: "rotation":Vector3
- Possible loopTypes are "loop" and "pingPong"
- Automatically sets isKinematic to true if the gameObject contains a rigidbody and it is not true (returns value on completition) to avoid physics oddities
- Rotates the GameObject to the supplied degree(s).
- Rotation direction is automatically decided based on shortest travel time.
- Does not work on GUIText, GUITexture and similar display objects that do not support rotation.
iTween.scaleAdd(GameObject, Hashtable)
- Same as scaleBy but it adds to the current values instead of multiplies.
iTween.scaleBy(GameObject, Hashtable)
- Base arguments: time:float=1, delay:float=0, loopType:string=easeInOutCubic
- Callback arguments: onStart:string, onStartTarget:gameobject, onStartParams:string, onUpdate:string, onUpdateTarget:string, onUpdateTarget:gameobject, onComplete:string, onCompleteParams:object, onCompleteTarget:gameobject
- Coordinate arguments can be sent as individual properties: "x":float, "y":float, "z":float or as a Vector3: "amount":Vector3
- Automatically sets isKinematic to true if the gameObject contains a rigidbody and it is not true (returns value on completition) to avoid physics oddities
- Scales the GameObject by the supplied multiplier(s).
- Possible loopTypes are "loop" and "pingPong"
iTween.scaleFrom(GameObject, Hashtable)
iTween.scaleTo(GameObject, Hashtable)
- Base arguments: time:float=1, delay:float=0, loopType:string=easeInOutCubic
- Callback arguments: onStart:string, onStartTarget:gameobject, onStartParams:string, onUpdate:string, onUpdateTarget:string, onUpdateTarget:gameobject, onComplete:string, onCompleteParams:object, onCompleteTarget:gameobject
- Coordinate arguments can be sent as individual properties: "x":float, "y":float, "z":float or as a Vector3: "scale":Vector3
- Possible loopTypes are "loop" and "pingPong"
- Automatically sets isKinematic to true if the gameObject contains a rigidbody and it is not true (returns value on completition) to avoid physics oddities
- Scales the GameObject to the supplied multiplier(s).
iTween.shake(GameObject, Hashtable)
- Base arguments: time:float=1, delay:float=0, isLocal:boolean=true
- Callback arguments: onStart:string, onStartTarget:gameobject, onStartParams:string, onUpdate:string, onUpdateTarget:string, onUpdateTarget:gameobject, onComplete:string, onCompleteParams:object, onCompleteTarget:gameobject
- Coordinate arguments can be sent as individual properties: "x":float, "y":float, "z":float or as a Vector3: "amount":Vector3
- Automatically sets isKinematic to true if the gameObject contains a rigidbody and it is not true (returns value on completition) to avoid physics oddities
- Randomly shakes the GameObject on each supplied axis by the supplied magnitude.
- Negative/positive values dictate direction of initial impact.
- Application will gradually resolve and return object to its original coordinates.
- Does not utilize a transition.
iTween.shakeWorld(GameObject, Hashtable)
- Helper function for shake that simply calls a shake with "isLocal" set to false.
iTween.stab(GameObject, Hashtable)
- Base arguments: delay:float=0, volume:float=1, pitch:float=1, clip:AudioClip, delay:float
- Callback arguments: onStart:string, onStartTarget:gameobject, onStartParams:string, onComplete:string, onCompleteParams:object, onCompleteTarget:gameobject
- Plays an AudioClip one time based on supplied volume and pitch.
- "onComplete" functionality fires after audio has finished playing.
- If an AudioSource component isn't attached to the GameObject one will be automatically added.
- If no AudioClip is provided the default AudioSource's clip property will be used.
iTween.stop(GameObject)
- Stops all iTweens on the supplied GameObject.
iTween.stopType(GameObject, String)
- Stops all iTweens on the supplied GameObject of a particular method.
- Supplied types are of the root name of the type (i.e. "move", "scale", "fade", etc...) minus the "To" or "From".
iTween.tweenCount()
- Returns an int.
- Returns the total number of iTweens on the supplied GameObject.
