METHODS

y(endValue, duration (opt), tweenType (opt), completionCallbackOwner (opt), completionCallbackName (opt), completionCallbackArgs (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Swooper}

IncisorAPI.js, line 17068

Swoops (interpolates) given component from its current value to the given end value over the duration.

Parameters:

Name	Type	Attributes	Default	Description
endValue	number			The ending value for the numeric property being swooped.
duration	number	<optional>		The duration for the interpolation. [DEFAULT: 0]
tweenType	TweenType	<optional>		The TweenType, determining the method of interpolation. [DEFAULT: nc.tweenTypes.Linear]
completionCallbackOwner	object	<optional>		The object owning the callback function that is called when the Swooper completes.
completionCallbackName	string	<optional>		The name of the function that is called when the Swooper completes.
completionCallbackArgs	Array | any	<optional>		Arguments for the function that is called when the Swooper completes.
pauseImmunity	PauseEvent | Array.<PauseEvent>	<optional>		The PauseEvent or Array of PauseEvents that this Swooper will be immune to. Set this parameter to [] to create callbacks with no immunity. If this parameter is left undefined, the current value of 'nc.defaultPauseImmunity' will be used. The value for 'nc.defaultPauseImmunity' defaults to [], but can be changed at any time. [DEFAULT: nc.defaultPauseImmunity]
speedControl	SpeedControl | Array.<SpeedControl>	<optional>		The SpeedControl or Array of SpeedControls that this Swooper is affected by. [DEFAULT: nc.defaultSpeedControl]
eventCallbackOwner	object	<optional>		The object owning the callback function that is called with each fixedUpdate during the swooping process.
eventCallbackName	string	<optional>		The name of the function that is called with each fixedUpdate during the swooping process.

Returns:

Swooper

Methods below are inherited from the parent class.

all(endValue, duration (opt), tweenType (opt), completionCallbackOwner (opt), completionCallbackName (opt), completionCallbackArgs (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Swooper}

IncisorAPI.js, line 17028

Swoops (interpolates) all of the Vector components from their current values to the given end value over the duration.

Parameters:

Name	Type	Attributes	Default	Description
endValue	number			The ending value for the numeric properties being swooped.
duration	number	<optional>		The duration for the interpolation. [DEFAULT: 0]
tweenType	TweenType	<optional>		The TweenType, determining the method of interpolation. [DEFAULT: nc.tweenTypes.Linear]
completionCallbackOwner	object	<optional>		The object owning the callback function that is called when the Swooper completes.
completionCallbackName	string	<optional>		The name of the function that is called when the Swooper completes.
completionCallbackArgs	Array | any	<optional>		Arguments for the function that is called when the Swooper completes.
pauseImmunity	PauseEvent | Array.<PauseEvent>	<optional>		The PauseEvent or Array of PauseEvents that this Swooper will be immune to. Set this parameter to [] to create callbacks with no immunity. If this parameter is left undefined, the current value of 'nc.defaultPauseImmunity' will be used. The value for 'nc.defaultPauseImmunity' defaults to [], but can be changed at any time. [DEFAULT: nc.defaultPauseImmunity]
speedControl	SpeedControl | Array.<SpeedControl>	<optional>		The SpeedControl or Array of SpeedControls that this Swooper is affected by. [DEFAULT: nc.defaultSpeedControl]
eventCallbackOwner	object	<optional>		The object owning the callback function that is called with each fixedUpdate during the swooping process.
eventCallbackName	string	<optional>		The name of the function that is called with each fixedUpdate during the swooping process.

Returns:

Swooper

Inherited From:

• Vector1Swoop#all

each(endValues, duration (opt), tweenType (opt), completionCallbackOwner (opt), completionCallbackName (opt), completionCallbackArgs (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Swooper}

IncisorAPI.js, line 17012

Swoops (interpolates) each of the Vector components from their current values to the given end values over the duration.

Parameters:

Name	Type	Attributes	Default	Description
endValues	Array.<number>			The ending values for the numeric properties being swooped.
duration	number	<optional>		The duration for the interpolation. [DEFAULT: 0]
tweenType	TweenType	<optional>		The TweenType, determining the method of interpolation. [DEFAULT: nc.tweenTypes.Linear]
completionCallbackOwner	object	<optional>		The object owning the callback function that is called when the Swooper completes.
completionCallbackName	string	<optional>		The name of the function that is called when the Swooper completes.
completionCallbackArgs	Array | any	<optional>		Arguments for the function that is called when the Swooper completes.
pauseImmunity	PauseEvent | Array.<PauseEvent>	<optional>		The PauseEvent or Array of PauseEvents that this Swooper will be immune to. Set this parameter to [] to create callbacks with no immunity. If this parameter is left undefined, the current value of 'nc.defaultPauseImmunity' will be used. The value for 'nc.defaultPauseImmunity' defaults to [], but can be changed at any time. [DEFAULT: nc.defaultPauseImmunity]
speedControl	SpeedControl | Array.<SpeedControl>	<optional>		The SpeedControl or Array of SpeedControls that this Swooper is affected by. [DEFAULT: nc.defaultSpeedControl]
eventCallbackOwner	object	<optional>		The object owning the callback function that is called with each fixedUpdate during the swooping process.
eventCallbackName	string	<optional>		The name of the function that is called with each fixedUpdate during the swooping process.

Returns:

Swooper

Inherited From:

• Vector1Swoop#each

x(endValue, duration (opt), tweenType (opt), completionCallbackOwner (opt), completionCallbackName (opt), completionCallbackArgs (opt), pauseImmunity (opt), speedControl (opt), eventCallbackOwner (opt), eventCallbackName (opt)) returns {Swooper}

IncisorAPI.js, line 17044

Swoops (interpolates) given component from its current value to the given end value over the duration.

Parameters:

Name	Type	Attributes	Default	Description
endValue	number			The ending value for the numeric property being swooped.
duration	number	<optional>		The duration for the interpolation. [DEFAULT: 0]
tweenType	TweenType	<optional>		The TweenType, determining the method of interpolation. [DEFAULT: nc.tweenTypes.Linear]
completionCallbackOwner	object	<optional>		The object owning the callback function that is called when the Swooper completes.
completionCallbackName	string	<optional>		The name of the function that is called when the Swooper completes.
completionCallbackArgs	Array | any	<optional>		Arguments for the function that is called when the Swooper completes.
pauseImmunity	PauseEvent | Array.<PauseEvent>	<optional>		The PauseEvent or Array of PauseEvents that this Swooper will be immune to. Set this parameter to [] to create callbacks with no immunity. If this parameter is left undefined, the current value of 'nc.defaultPauseImmunity' will be used. The value for 'nc.defaultPauseImmunity' defaults to [], but can be changed at any time. [DEFAULT: nc.defaultPauseImmunity]
speedControl	SpeedControl | Array.<SpeedControl>	<optional>		The SpeedControl or Array of SpeedControls that this Swooper is affected by. [DEFAULT: nc.defaultSpeedControl]
eventCallbackOwner	object	<optional>		The object owning the callback function that is called with each fixedUpdate during the swooping process.
eventCallbackName	string	<optional>		The name of the function that is called with each fixedUpdate during the swooping process.

Returns:

Swooper

Inherited From:

• Vector1Swoop#x