TweenParms Class Reference

Method chaining parameters for a Tweener. More...

Inheritance diagram for TweenParms:

List of all members.

Classes
class	HOTPropData
Public Member Functions
TweenParms	PixelPerfect ()
	Sets this tween so that it works with pixel perfect values. Only works with Vector3, Vector2, Single, PlugVector3X, PlugVector3Y, PlugVector3Z plugins.
TweenParms	SpeedBased ()
	Sets this tween to work by speed instead than time. When a tween is based on speed instead than time, duration is considered as the amount that the property will change every second, and ease is automatically set to Linear. In case of Vectors, the amount represents the vector length x second; in case of Quaternions, the amount represents the full rotation (360°) speed x second; in case of strings, the amount represents the amount of changed letters x second.
TweenParms	SpeedBased (bool p_speedBased)
	Sets whether to tween by speed or not. When a tween is based on speed instead than time, duration is considered as the amount that the property will change every second, and ease is automatically set to Linear. In case of Vectors, the amount represents the vector length x second; in case of strings, the amount represents the amount of changed letters x second.
TweenParms	Ease (EaseType p_easeType)
	Sets the ease type to use (default = EaseType.easeOutQuad). If you set this tween to use speed instead than time, this parameter becomes useless, because it will be managed internally.
TweenParms	Ease (EaseType p_easeType, float p_overshoot)
	Sets the ease type to use (default = EaseType.easeOutQuad). If you set this tween to use speed instead than time, this parameter becomes useless, because it will be managed internally.
TweenParms	Ease (EaseType p_easeType, float p_amplitude, float p_period)
	Sets the ease type to use (default = EaseType.easeOutQuad). If you set this tween to use speed instead than time, this parameter becomes useless, because it will be managed internally.
TweenParms	Ease (AnimationCurve p_easeAnimationCurve)
	Sets the ease to use the given AnimationCurve. If you set this tween to use speed instead than time, this parameter becomes useless, because it will be managed internally.
TweenParms	Delay (float p_delay)
	Sets the seconds of delay before the tween should start (default = 0).
TweenParms	Pause ()
	Sets the Tweener in a paused state.
TweenParms	Pause (bool p_pause)
	Choose whether to set the Tweener in a paused state.
TweenParms	NewProp (string p_propName, ABSTweenPlugin p_plugin)
	Sets a property or field to tween, directly assigning the given TweenPlugin to it. Behaves as Prop(), but removes any other property tween previously set in this TweenParms (useful if you want to reuse the same parameters with a new set of property tweens).
TweenParms	NewProp (string p_propName, object p_endVal)
	Sets a property or field to tween. Behaves as Prop(), but removes any other property tween previously set in this TweenParms (useful if you want to reuse the same parameters with a new set of property tweens).
TweenParms	NewProp (string p_propName, object p_endVal, bool p_isRelative)
	Sets a property or field to tween. Behaves as Prop(), but removes any other property tween previously set in this TweenParms (useful if you want to reuse the same parameters with a new set of property tweens).
TweenParms	Prop (string p_propName, ABSTweenPlugin p_plugin)
	Sets a property or field to tween, directly assigning the given TweenPlugin to it. Behaves as NewProp(), but without removing the other property tweens that were set in this TweenParms.
TweenParms	Prop (string p_propName, object p_endVal)
	Sets a property or field to tween. Behaves as NewProp(), but without removing the other property tweens that were set in this TweenParms.
TweenParms	Prop (string p_propName, object p_endVal, bool p_isRelative)
	Sets a property or field to tween. Behaves as NewProp(), but without removing the other property tweens that were set in this TweenParms.
TweenParms	Id (string p_id)
	Sets the ID of this Tweener (default = ""). The same ID can be applied to multiple Tweeners, thus allowing for group operations. You can also use IntId instead of Id for faster operations.
TweenParms	IntId (int p_intId)
	Sets the int ID of this Tweener (default = 0). The same intId can be applied to multiple Tweeners, thus allowing for group operations. The main difference from Id is that while Id is more legible, IntId allows for faster operations.
TweenParms	AutoKill (bool p_active)
	Sets auto-kill behaviour for when the Tweener reaches its end (default = false).
TweenParms	UpdateType (UpdateType p_updateType)
	Sets the type of update to use for this Tweener (default = UpdateType.Update).
TweenParms	TimeScale (float p_timeScale)
	Sets the time scale that will be used by this Tweener.
TweenParms	Loops (int p_loops)
	Sets the number of times the Tweener will run (default = 1, meaning only one go and no other loops).
TweenParms	Loops (int p_loops, LoopType p_loopType)
	Sets the number of times the Tweener will run, and the type of loop behaviour to apply (default = 1, LoopType.Restart).
TweenParms	OnStart (TweenDelegate.TweenCallback p_function)
	Function to call when the Tweener is started for the very first time.
TweenParms	OnStart (TweenDelegate.TweenCallbackWParms p_function, params object[] p_funcParms)
	Function to call when the Tweener is started for the very first time.
TweenParms	OnUpdate (TweenDelegate.TweenCallback p_function)
	Function to call each time the Tweener is updated.
TweenParms	OnUpdate (TweenDelegate.TweenCallbackWParms p_function, params object[] p_funcParms)
	Function to call each time the Tweener is updated.
TweenParms	OnPluginUpdated (TweenDelegate.TweenCallbackWParms p_function, params object[] p_funcParms)
	Function to call each time a plugin is updated.
TweenParms	OnPause (TweenDelegate.TweenCallback p_function)
	Function to call when the Tweener switches from a playing state to a paused state.
TweenParms	OnPause (TweenDelegate.TweenCallbackWParms p_function, params object[] p_funcParms)
	Function to call when the Tweener switches from a playing state to a paused state.
TweenParms	OnPlay (TweenDelegate.TweenCallback p_function)
	Function to call when the Tweener switches from a paused state to a playing state.
TweenParms	OnPlay (TweenDelegate.TweenCallbackWParms p_function, params object[] p_funcParms)
	Function to call when the Tweener switches from a paused state to a playing state.
TweenParms	OnRewinded (TweenDelegate.TweenCallback p_function)
	Function to call each time the Tweener is rewinded from a non-rewinded state (either because of a direct call to Rewind, or because the tween's virtual playehead reached the start due to a playing backwards behaviour).
TweenParms	OnRewinded (TweenDelegate.TweenCallbackWParms p_function, params object[] p_funcParms)
	Function to call each time the Tweener is rewinded from a non-rewinded state (either because of a direct call to Rewind, or because the tween's virtual playehead reached the start due to a playing backwards behaviour).
TweenParms	OnStepComplete (TweenDelegate.TweenCallback p_function)
	Function to call each time a single loop of the Tweener is completed.
TweenParms	OnStepComplete (TweenDelegate.TweenCallbackWParms p_function, params object[] p_funcParms)
	Function to call each time a single loop of the Tweener is completed.
TweenParms	OnStepComplete (GameObject p_sendMessageTarget, string p_methodName, object p_value=null, SendMessageOptions p_options=SendMessageOptions.RequireReceiver)
	Uses sendMessage to call the method named p_methodName on every MonoBehaviour in the p_sendMessageTarget GameObject.
TweenParms	OnComplete (TweenDelegate.TweenCallback p_function)
	Function to call when the full Tweener, loops included, is completed.
TweenParms	OnComplete (TweenDelegate.TweenCallbackWParms p_function, params object[] p_funcParms)
	Function to call when the full Tweener, loops included, is completed.
TweenParms	OnComplete (GameObject p_sendMessageTarget, string p_methodName, object p_value=null, SendMessageOptions p_options=SendMessageOptions.RequireReceiver)
	Uses sendMessage to call the method named p_methodName on every MonoBehaviour in the p_sendMessageTarget GameObject.
TweenParms	OnPluginOverwritten (TweenDelegate.TweenCallback p_function)
	Function to call when one of the plugins used in the tween gets overwritten (available only if OverwriteManager is active).
TweenParms	OnPluginOverwritten (TweenDelegate.TweenCallbackWParms p_function, params object[] p_funcParms)
	Function to call when one of the plugins used in the tween gets overwritten (available only if OverwriteManager is active).
TweenParms	KeepEnabled (Behaviour p_target)
	Keeps the given component enabled while the tween is playing.
TweenParms	KeepEnabled (GameObject p_target)
	Keeps the given gameObject activated while the tween is playing.
TweenParms	KeepEnabled (Behaviour[] p_targets)
	Keeps the given components enabled while the tween is playing.
TweenParms	KeepEnabled (GameObject[] p_targets)
	Keeps the given GameObject activated while the tween is playing.
TweenParms	KeepDisabled (Behaviour p_target)
	Keeps the given component disabled while the tween is playing.
TweenParms	KeepDisabled (GameObject p_target)
	Keeps the given GameObject disabled while the tween is playing.
TweenParms	KeepDisabled (Behaviour[] p_targets)
	Keeps the given components disabled while the tween is playing.
TweenParms	KeepDisabled (GameObject[] p_targets)
	Keeps the given GameObject disabled while the tween is playing.
Properties
bool	hasProps [get]
	Returns true if at least one property tween was added to these parameters, either via Prop() or NewProp().

---

Detailed Description

Method chaining parameters for a Tweener.

---

Member Function Documentation

TweenParms AutoKill

(

bool

p_active

)

Sets auto-kill behaviour for when the Tweener reaches its end (default = false).

Parameters:

p_active

If true the Tweener is killed and removed from HOTween as soon as it's completed. If false doesn't remove this Tweener from HOTween when it is completed, and you will need to call an HOTween.Kill to remove this Tweener.

TweenParms Delay

(

float

p_delay

)

Sets the seconds of delay before the tween should start (default = 0).

Parameters:

p_delay

The seconds of delay.

TweenParms Ease

(

EaseType

p_easeType

)

Sets the ease type to use (default = EaseType.easeOutQuad). If you set this tween to use speed instead than time, this parameter becomes useless, because it will be managed internally.

Parameters:

p_easeType

The EaseType to use.

TweenParms Ease	(	EaseType	p_easeType,
		float	p_overshoot
	)

Sets the ease type to use (default = EaseType.easeOutQuad). If you set this tween to use speed instead than time, this parameter becomes useless, because it will be managed internally.

Parameters:

p_easeType	The EaseType to use.
p_overshoot	Eventual overshoot to use with Back easeType (default is 1.70158).

TweenParms Ease	(	EaseType	p_easeType,
		float	p_amplitude,
		float	p_period
	)

Sets the ease type to use (default = EaseType.easeOutQuad). If you set this tween to use speed instead than time, this parameter becomes useless, because it will be managed internally.

Parameters:

p_easeType	The EaseType to use.
p_amplitude	Eventual amplitude to use with Elastic easeType (default is 0).
p_period	Eventual period to use with Elastic easeType (default is 0).

TweenParms Ease

(

AnimationCurve

p_easeAnimationCurve

)

Sets the ease to use the given AnimationCurve. If you set this tween to use speed instead than time, this parameter becomes useless, because it will be managed internally.

Parameters:

p_easeAnimationCurve

The AnimationCurve to use.

TweenParms Id

(

string

p_id

)

Sets the ID of this Tweener (default = ""). The same ID can be applied to multiple Tweeners, thus allowing for group operations. You can also use IntId instead of Id for faster operations.

Parameters:

p_id	The ID for this Tweener.

TweenParms IntId

(

int

p_intId

)

Sets the int ID of this Tweener (default = 0). The same intId can be applied to multiple Tweeners, thus allowing for group operations. The main difference from Id is that while Id is more legible, IntId allows for faster operations.

Parameters:

p_intId

The int ID for this Tweener.

TweenParms KeepDisabled

(

Behaviour

p_target

)

Keeps the given component disabled while the tween is playing.

TweenParms KeepDisabled

(

GameObject

p_target

)

Keeps the given GameObject disabled while the tween is playing.

TweenParms KeepDisabled

(

Behaviour[]

p_targets

)

Keeps the given components disabled while the tween is playing.

TweenParms KeepDisabled

(

GameObject[]

p_targets

)

Keeps the given GameObject disabled while the tween is playing.

TweenParms KeepEnabled

(

Behaviour

p_target

)

Keeps the given component enabled while the tween is playing.

TweenParms KeepEnabled

(

GameObject

p_target

)

Keeps the given gameObject activated while the tween is playing.

TweenParms KeepEnabled

(

Behaviour[]

p_targets

)

Keeps the given components enabled while the tween is playing.

TweenParms KeepEnabled

(

GameObject[]

p_targets

)

Keeps the given GameObject activated while the tween is playing.

TweenParms Loops

(

int

p_loops

)

Sets the number of times the Tweener will run (default = 1, meaning only one go and no other loops).

Parameters:

p_loops

Number of loops (set it to -1 or float.PositiveInfinity to apply infinite loops).

TweenParms Loops	(	int	p_loops,
		LoopType	p_loopType
	)

Sets the number of times the Tweener will run, and the type of loop behaviour to apply (default = 1, LoopType.Restart).

Parameters:

p_loops	Number of loops (set it to -1 or float.PositiveInfinity to apply infinite loops).
p_loopType	The LoopType behaviour to use.

TweenParms NewProp	(	string	p_propName,
		ABSTweenPlugin	p_plugin
	)

Sets a property or field to tween, directly assigning the given TweenPlugin to it. Behaves as Prop(), but removes any other property tween previously set in this TweenParms (useful if you want to reuse the same parameters with a new set of property tweens).

Parameters:

p_propName	The name of the property.
p_plugin	The ABSTweenPlugin to use.

TweenParms NewProp	(	string	p_propName,
		object	p_endVal
	)

Sets a property or field to tween. Behaves as Prop(), but removes any other property tween previously set in this TweenParms (useful if you want to reuse the same parameters with a new set of property tweens).

Parameters:

p_propName	The name of the property.
p_endVal	The absolute end value the object should reach with the tween.

TweenParms NewProp	(	string	p_propName,
		object	p_endVal,
		bool	p_isRelative
	)

Sets a property or field to tween. Behaves as Prop(), but removes any other property tween previously set in this TweenParms (useful if you want to reuse the same parameters with a new set of property tweens).

Parameters:

p_propName	The name of the property.
p_endVal	The end value the object should reach with the tween.
p_isRelative	If true treats the end value as relative, otherwise as absolute.

TweenParms OnComplete

(

TweenDelegate.TweenCallback

p_function

)

Function to call when the full Tweener, loops included, is completed.

Parameters:

p_function

The function to call, who must return void and accept no parameters.

TweenParms OnComplete	(	TweenDelegate.TweenCallbackWParms	p_function,
		params object[]	p_funcParms
	)

Function to call when the full Tweener, loops included, is completed.

Parameters:

p_function	The function to call. It must return void and has to accept a single parameter of type TweenEvent.
p_funcParms	Additional comma separated parameters to pass to the function.

TweenParms OnComplete	(	GameObject	p_sendMessageTarget,
		string	p_methodName,
		object	p_value = null,
		SendMessageOptions	p_options = SendMessageOptions.RequireReceiver
	)

Uses sendMessage to call the method named p_methodName on every MonoBehaviour in the p_sendMessageTarget GameObject.

Parameters:

p_sendMessageTarget	GameObject to target for sendMessage
p_methodName	Name of the method to call
p_value	Eventual additional parameter
p_options	SendMessageOptions

TweenParms OnPause

(

TweenDelegate.TweenCallback

p_function

)

Function to call when the Tweener switches from a playing state to a paused state.

Parameters:

p_function

The function to call, who must return void and accept no parameters.

TweenParms OnPause	(	TweenDelegate.TweenCallbackWParms	p_function,
		params object[]	p_funcParms
	)

Function to call when the Tweener switches from a playing state to a paused state.

Parameters:

p_function	The function to call. It must return void and has to accept a single parameter of type TweenEvent.
p_funcParms	Additional comma separated parameters to pass to the function.

TweenParms OnPlay

(

TweenDelegate.TweenCallback

p_function

)

Function to call when the Tweener switches from a paused state to a playing state.

Parameters:

p_function

The function to call, who must return void and accept no parameters.

TweenParms OnPlay	(	TweenDelegate.TweenCallbackWParms	p_function,
		params object[]	p_funcParms
	)

Function to call when the Tweener switches from a paused state to a playing state.

Parameters:

p_function	The function to call. It must return void and has to accept a single parameter of type TweenEvent.
p_funcParms	Additional comma separated parameters to pass to the function.

TweenParms OnPluginOverwritten

(

TweenDelegate.TweenCallback

p_function

)

Function to call when one of the plugins used in the tween gets overwritten (available only if OverwriteManager is active).

Parameters:

p_function

The function to call, who must return void and accept no parameters.

TweenParms OnPluginOverwritten	(	TweenDelegate.TweenCallbackWParms	p_function,
		params object[]	p_funcParms
	)

Function to call when one of the plugins used in the tween gets overwritten (available only if OverwriteManager is active).

Parameters:

p_function	The function to call. It must return void and has to accept a single parameter of type TweenEvent.
p_funcParms	Additional comma separated parameters to pass to the function.

TweenParms OnPluginUpdated	(	TweenDelegate.TweenCallbackWParms	p_function,
		params object[]	p_funcParms
	)

Function to call each time a plugin is updated.

Parameters:

p_function	The function to call. It must return void and has to accept a single parameter of type TweenEvent.
p_funcParms	Additional comma separated parameters to pass to the function.

TweenParms OnRewinded

(

TweenDelegate.TweenCallback

p_function

)

Function to call each time the Tweener is rewinded from a non-rewinded state (either because of a direct call to Rewind, or because the tween's virtual playehead reached the start due to a playing backwards behaviour).

Parameters:

p_function

The function to call, who must return void and accept no parameters.

TweenParms OnRewinded	(	TweenDelegate.TweenCallbackWParms	p_function,
		params object[]	p_funcParms
	)

Function to call each time the Tweener is rewinded from a non-rewinded state (either because of a direct call to Rewind, or because the tween's virtual playehead reached the start due to a playing backwards behaviour).

Parameters:

p_function	The function to call. It must return void and has to accept a single parameter of type TweenEvent.
p_funcParms	Additional comma separated parameters to pass to the function.

TweenParms OnStart

(

TweenDelegate.TweenCallback

p_function

)

Function to call when the Tweener is started for the very first time.

Parameters:

p_function

The function to call, who must return void and accept no parameters.

TweenParms OnStart	(	TweenDelegate.TweenCallbackWParms	p_function,
		params object[]	p_funcParms
	)

Function to call when the Tweener is started for the very first time.

Parameters:

p_function	The function to call. It must return void and has to accept a single parameter of type TweenEvent.
p_funcParms	Additional comma separated parameters to pass to the function.

TweenParms OnStepComplete

(

TweenDelegate.TweenCallback

p_function

)

Function to call each time a single loop of the Tweener is completed.

Parameters:

p_function

The function to call, who must return void and accept no parameters.

TweenParms OnStepComplete	(	TweenDelegate.TweenCallbackWParms	p_function,
		params object[]	p_funcParms
	)

Function to call each time a single loop of the Tweener is completed.

Parameters:

p_function	The function to call. It must return void and has to accept a single parameter of type TweenEvent.
p_funcParms	Additional comma separated parameters to pass to the function.

TweenParms OnStepComplete	(	GameObject	p_sendMessageTarget,
		string	p_methodName,
		object	p_value = null,
		SendMessageOptions	p_options = SendMessageOptions.RequireReceiver
	)

Uses sendMessage to call the method named p_methodName on every MonoBehaviour in the p_sendMessageTarget GameObject.

Parameters:

p_sendMessageTarget	GameObject to target for sendMessage
p_methodName	Name of the method to call
p_value	Eventual additional parameter
p_options	SendMessageOptions

TweenParms OnUpdate

(

TweenDelegate.TweenCallback

p_function

)

Function to call each time the Tweener is updated.

Parameters:

p_function

The function to call, who must return void and accept no parameters.

TweenParms OnUpdate	(	TweenDelegate.TweenCallbackWParms	p_function,
		params object[]	p_funcParms
	)

Function to call each time the Tweener is updated.

Parameters:

p_function	The function to call. It must return void and has to accept a single parameter of type TweenEvent.
p_funcParms	Additional comma separated parameters to pass to the function.

TweenParms Pause

(

)

Sets the Tweener in a paused state.

TweenParms Pause

(

bool

p_pause

)

Choose whether to set the Tweener in a paused state.

TweenParms PixelPerfect

(

)

Sets this tween so that it works with pixel perfect values. Only works with Vector3, Vector2, Single, PlugVector3X, PlugVector3Y, PlugVector3Z plugins.

Returns:

TweenParms Prop	(	string	p_propName,
		ABSTweenPlugin	p_plugin
	)

Sets a property or field to tween, directly assigning the given TweenPlugin to it. Behaves as NewProp(), but without removing the other property tweens that were set in this TweenParms.

Parameters:

p_propName	The name of the property.
p_plugin	The ABSTweenPlugin to use.

TweenParms Prop	(	string	p_propName,
		object	p_endVal
	)

Sets a property or field to tween. Behaves as NewProp(), but without removing the other property tweens that were set in this TweenParms.

Parameters:

p_propName	The name of the property.
p_endVal	The absolute end value the object should reach with the tween.

TweenParms Prop	(	string	p_propName,
		object	p_endVal,
		bool	p_isRelative
	)

Sets a property or field to tween. Behaves as NewProp(), but without removing the other property tweens that were set in this TweenParms.

Parameters:

p_propName	The name of the property.
p_endVal	The end value the object should reach with the tween.
p_isRelative	If true treats the end value as relative, otherwise as absolute.

TweenParms SpeedBased

(

)

Sets this tween to work by speed instead than time. When a tween is based on speed instead than time, duration is considered as the amount that the property will change every second, and ease is automatically set to Linear. In case of Vectors, the amount represents the vector length x second; in case of Quaternions, the amount represents the full rotation (360°) speed x second; in case of strings, the amount represents the amount of changed letters x second.

TweenParms SpeedBased

(

bool

p_speedBased

)

Sets whether to tween by speed or not. When a tween is based on speed instead than time, duration is considered as the amount that the property will change every second, and ease is automatically set to Linear. In case of Vectors, the amount represents the vector length x second; in case of strings, the amount represents the amount of changed letters x second.

Parameters:

p_speedBased

If true this tween will work by speed instead than by time.

TweenParms TimeScale

(

float

p_timeScale

)

Sets the time scale that will be used by this Tweener.

Parameters:

p_timeScale

The time scale to use.

TweenParms UpdateType

(

UpdateType

p_updateType

)

Sets the type of update to use for this Tweener (default = UpdateType.Update).

Parameters:

p_updateType

The type of update to use.

---

Property Documentation

bool hasProps [get]

Returns true if at least one property tween was added to these parameters, either via Prop() or NewProp().