Base class actions that do have a finite time duration. More...

Inherits Action.

Inherited by ActionInstant, and ActionInterval.

Public Member Functions
float	getDuration () const
	Get duration in seconds of the action. More...

var	getDuration ()
	Get duration in seconds of the action. More...

local	getDuration ()
	Get duration in seconds of the action. More...

void	setDuration (float duration)
	Set duration in seconds of the action. More...

var	setDuration ( var duration)
	Set duration in seconds of the action. More...

local	setDuration ( local duration)
	Set duration in seconds of the action. More...

virtual FiniteTimeAction *	reverse () const override
	Returns a new action that performs the exactly the reverse action. More...

local	reverse ()
	Returns a new action that performs the exactly the reverse action. More...

virtual FiniteTimeAction *	clone () const override
	Returns a clone of action. More...

Public Member Functions inherited from Action
virtual bool	isDone () const
	Return true if the action has finished. More...

var	isDone ()
	Return true if the action has finished. More...

local	isDone ()
	Return true if the action has finished. More...

virtual void	startWithTarget (Node *target)
	Called before the action start. More...

virtual void	stop ()
	Called after the action that has finished. More...

virtual void	step (float dt)
	Called every frame with its delta time, dt in seconds. More...

local	step ( local dt)
	Called every frame with its delta time, dt in seconds. More...

virtual void	update (float time)
	Called once per frame. More...

var	update ( var time)
	Called once per frame. More...

local	update ( local time)
	Called once per frame. More...

Node *	getTarget () const
	Return the current target. More...

void	setTarget (Node *target)
	The setter function for the target property. More...

var	setTarget ( var target)
	The setter function for the target property. More...

local	setTarget ( local target)
	The setter function for the target property. More...

Node *	getOriginalTarget () const
	Return the original Target. More...

var	getOriginalTarget ()
	Return the original Target. More...

local	getOriginalTarget ()
	Return the original Target. More...

void	setOriginalTarget (Node *originalTarget)
	Set the original target, since target can be nil. More...

var	setOriginalTarget ( var originalTarget)
	Set the original target, since target can be nil. More...

local	setOriginalTarget ( local originalTarget)
	Set the original target, since target can be nil. More...

int	getTag () const
	Returns a tag that is used to identify the action easily. More...

var	getTag ()
	Returns a tag that is used to identify the action easily. More...

local	getTag ()
	Returns a tag that is used to identify the action easily. More...

void	setTag (int tag)
	Changes the tag that is used to identify the action easily. More...

var	setTag ( var tag)
	Changes the tag that is used to identify the action easily. More...

local	setTag ( local tag)
	Changes the tag that is used to identify the action easily. More...

unsigned int	getFlags () const
	Returns a flag field that is used to group the actions easily. More...

void	setFlags (unsigned int flags)
	Returns a flag field that is used to group the actions easily. More...

var	setFlags ( var flags)
	Returns a flag field that is used to group the actions easily. More...

local	setFlags ( local flags)
	Returns a flag field that is used to group the actions easily. More...

Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...

local	retain ()
	Retains the ownership. More...

void	release ()
	Releases the ownership immediately. More...

Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...

unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...

local	getReferenceCount ()
	Returns the Ref's current reference count. More...

virtual	~Ref ()
	Destructor.

Public Member Functions inherited from Clonable
Ref *	copy () const
	Returns a copy of the Ref.

Additional Inherited Members
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID

local	_ID
	object id, ScriptSupport need public _ID

int	_luaID
	Lua reference id.

local	_luaID
	Lua reference id.

void *	_scriptObject
	scriptObject, support for swift

local	_scriptObject
	scriptObject, support for swift

bool	_rooted
	When true, it means that the object was already rooted.

local	_rooted
	When true, it means that the object was already rooted.

bool	_scriptOwned
	The life of the object is scrolled by the scripting engine. More...

local	_scriptOwned
	The life of the object is scrolled by the scripting engine. More...

Static Public Attributes inherited from Action
static const int	INVALID_TAG = -1
	Default tag used for all the actions.

var	INVALID_TAG = -1
	Default tag used for all the actions.

local	INVALID_TAG = -1
	Default tag used for all the actions.

Detailed Description

Base class actions that do have a finite time duration.

Possible actions:

An action with a duration of 0 seconds.
An action with a duration of 35.5 seconds. Infinite time actions are valid.

Member Function Documentation

float getDuration ( ) const

inline

Get duration in seconds of the action.

The duration in seconds of the action.

var getDuration ( )

inline

Get duration in seconds of the action.

The duration in seconds of the action.

local getDuration ( )

inline

Get duration in seconds of the action.

The duration in seconds of the action.

void setDuration ( float duration )

inline

Set duration in seconds of the action.

In seconds of the action.

var setDuration ( var duration )

inline

Set duration in seconds of the action.

In seconds of the action.

local setDuration ( local duration )

inline

Set duration in seconds of the action.

In seconds of the action.

virtual FiniteTimeAction* reverse ( void ) const

inlineoverridevirtual

Returns a new action that performs the exactly the reverse action.

A new action that performs the exactly the reverse action.

Reimplemented from Action.

Reimplemented in ActionFloat, TargetedAction, Animate, ReverseTime, DelayTime, TintBy, TintTo, FadeOut, FadeIn, FadeTo, EaseCubicActionInOut, EaseCubicActionOut, Blink, EaseCubicActionIn, ScaleBy, EaseCircleActionInOut, EaseCircleActionOut, EaseCircleActionIn, EaseQuinticActionInOut, ScaleTo, EaseQuinticActionOut, EaseQuinticActionIn, EaseQuarticActionInOut, BezierTo, EaseQuarticActionOut, EaseQuarticActionIn, BezierBy, EaseQuadraticActionInOut, EaseQuadraticActionOut, JumpTo, EaseQuadraticActionIn, EaseBezierAction, JumpBy, EaseBackInOut, SkewBy, EaseBackOut, SkewTo, EaseBackIn, MoveTo, EaseBounceInOut, EaseBounceOut, MoveBy, EaseBounceIn, EaseBounce, EaseElasticInOut, RotateBy, EaseElasticOut, EaseElasticIn, RotateTo, EaseElastic, Spawn, EaseSineInOut, ReuseGrid, EaseSineOut, StopGrid, EaseSineIn, CatmullRomBy, DeccelAmplitude, RepeatForever, CallFunc, EaseExponentialInOut, CatmullRomTo, AccelAmplitude, EaseExponentialOut, CardinalSplineBy, EaseExponentialIn, Repeat, Place, AccelDeccelAmplitude, EaseInOut, CardinalSplineTo, FlipY, EaseOut, Sequence, FlipX, EaseIn, RemoveSelf, ToggleVisibility, EaseRateAction, Animate3D, ActionTween, Hide, ActionInterval, ProgressFromTo, Show, ActionEase, GridAction, ProgressTo, ActionCamera, and ActionInstant.

var reverse ( )

inlineoverridevirtual

Returns a new action that performs the exactly the reverse action.

A new action that performs the exactly the reverse action.

Reimplemented from Action.

Reimplemented in ActionFloat, TargetedAction, Animate, ReverseTime, DelayTime, TintBy, TintTo, FadeOut, FadeIn, FadeTo, EaseCubicActionInOut, EaseCubicActionOut, Blink, EaseCubicActionIn, ScaleBy, EaseCircleActionInOut, EaseCircleActionOut, EaseCircleActionIn, EaseQuinticActionInOut, ScaleTo, EaseQuinticActionOut, EaseQuinticActionIn, EaseQuarticActionInOut, BezierTo, EaseQuarticActionOut, EaseQuarticActionIn, BezierBy, EaseQuadraticActionInOut, EaseQuadraticActionOut, JumpTo, EaseQuadraticActionIn, EaseBezierAction, JumpBy, EaseBackInOut, SkewBy, EaseBackOut, SkewTo, EaseBackIn, MoveTo, EaseBounceInOut, EaseBounceOut, MoveBy, EaseBounceIn, EaseBounce, EaseElasticInOut, RotateBy, EaseElasticOut, EaseElasticIn, RotateTo, EaseElastic, Spawn, EaseSineInOut, ReuseGrid, EaseSineOut, StopGrid, EaseSineIn, CatmullRomBy, DeccelAmplitude, RepeatForever, CallFunc, EaseExponentialInOut, CatmullRomTo, AccelAmplitude, EaseExponentialOut, CardinalSplineBy, EaseExponentialIn, Repeat, Place, AccelDeccelAmplitude, EaseInOut, CardinalSplineTo, FlipY, EaseOut, Sequence, FlipX, EaseIn, RemoveSelf, ToggleVisibility, EaseRateAction, Animate3D, ActionTween, Hide, ActionInterval, ProgressFromTo, Show, ActionEase, GridAction, ProgressTo, ActionCamera, and ActionInstant.

local reverse ( )

inlineoverridevirtual

Returns a new action that performs the exactly the reverse action.

A new action that performs the exactly the reverse action.

Reimplemented from Action.

Reimplemented in ActionFloat, TargetedAction, Animate, ReverseTime, DelayTime, TintBy, TintTo, FadeOut, FadeIn, FadeTo, EaseCubicActionInOut, EaseCubicActionOut, Blink, EaseCubicActionIn, ScaleBy, EaseCircleActionInOut, EaseCircleActionOut, EaseCircleActionIn, EaseQuinticActionInOut, ScaleTo, EaseQuinticActionOut, EaseQuinticActionIn, EaseQuarticActionInOut, BezierTo, EaseQuarticActionOut, EaseQuarticActionIn, BezierBy, EaseQuadraticActionInOut, EaseQuadraticActionOut, JumpTo, EaseQuadraticActionIn, EaseBezierAction, JumpBy, EaseBackInOut, SkewBy, EaseBackOut, SkewTo, EaseBackIn, MoveTo, EaseBounceInOut, EaseBounceOut, MoveBy, EaseBounceIn, EaseBounce, EaseElasticInOut, RotateBy, EaseElasticOut, EaseElasticIn, RotateTo, EaseElastic, Spawn, EaseSineInOut, ReuseGrid, EaseSineOut, StopGrid, EaseSineIn, CatmullRomBy, DeccelAmplitude, RepeatForever, CallFunc, EaseExponentialInOut, CatmullRomTo, AccelAmplitude, EaseExponentialOut, CardinalSplineBy, EaseExponentialIn, Repeat, Place, AccelDeccelAmplitude, EaseInOut, CardinalSplineTo, FlipY, EaseOut, Sequence, FlipX, EaseIn, RemoveSelf, ToggleVisibility, EaseRateAction, Animate3D, ActionTween, Hide, ActionInterval, ProgressFromTo, Show, ActionEase, GridAction, ProgressTo, ActionCamera, and ActionInstant.

virtual FiniteTimeAction* clone ( ) const

inlineoverridevirtual

Returns a clone of action.

A clone action.

Reimplemented from Action.

Reimplemented in ActionFloat, TargetedAction, Animate, ReverseTime, DelayTime, TintBy, TintTo, FadeOut, FadeIn, FadeTo, EaseCubicActionInOut, EaseCubicActionOut, Blink, EaseCubicActionIn, ScaleBy, EaseCircleActionInOut, EaseCircleActionOut, EaseCircleActionIn, EaseQuinticActionInOut, ScaleTo, EaseQuinticActionOut, EaseQuinticActionIn, EaseQuarticActionInOut, BezierTo, EaseQuarticActionOut, EaseQuarticActionIn, EaseQuadraticActionInOut, BezierBy, EaseQuadraticActionOut, JumpTo, EaseQuadraticActionIn, EaseBezierAction, JumpBy, EaseBackInOut, SkewBy, EaseBackOut, SkewTo, EaseBackIn, MoveTo, EaseBounceInOut, EaseBounceOut, MoveBy, EaseBounceIn, Twirl, SplitCols, EaseBounce, EaseElasticInOut, RotateBy, SplitRows, EaseElasticOut, Waves, JumpTiles3D, EaseElasticIn, RotateTo, Liquid, WavesTiles3D, EaseElastic, Spawn, EaseSineInOut, ReuseGrid, Shaky3D, CallFuncN, EaseSineOut, TurnOffTiles, StopGrid, EaseSineIn, CatmullRomBy, DeccelAmplitude, Ripple3D, RepeatForever, CallFunc, EaseExponentialInOut, FadeOutDownTiles, CatmullRomTo, AccelAmplitude, FadeOutUpTiles, EaseExponentialOut, CardinalSplineBy, FadeOutBLTiles, EaseExponentialIn, Repeat, Place, AccelDeccelAmplitude, FadeOutTRTiles, Lens3D, EaseInOut, CardinalSplineTo, FlipY, TiledGrid3DAction, EaseOut, Sequence, FlipX, FlipY3D, EaseIn, ShuffleTiles, RemoveSelf, OrbitCamera, Grid3DAction, ToggleVisibility, FlipX3D, EaseRateAction, ActionInterval, ShatteredTiles3D, Animate3D, ActionTween, Hide, LuaCallFunc, ProgressFromTo, Waves3D, Show, PageTurn3D, ShakyTiles3D, ActionCamera, ProgressTo, ActionEase, GridAction, and ActionInstant.

var clone ( )

inlineoverridevirtual

Returns a clone of action.

A clone action.

Reimplemented from Action.

Reimplemented in ActionFloat, TargetedAction, Animate, ReverseTime, DelayTime, TintBy, TintTo, FadeOut, FadeIn, FadeTo, EaseCubicActionInOut, EaseCubicActionOut, Blink, EaseCubicActionIn, ScaleBy, EaseCircleActionInOut, EaseCircleActionOut, EaseCircleActionIn, EaseQuinticActionInOut, ScaleTo, EaseQuinticActionOut, EaseQuinticActionIn, EaseQuarticActionInOut, BezierTo, EaseQuarticActionOut, EaseQuarticActionIn, EaseQuadraticActionInOut, BezierBy, EaseQuadraticActionOut, JumpTo, EaseQuadraticActionIn, EaseBezierAction, JumpBy, EaseBackInOut, SkewBy, EaseBackOut, SkewTo, EaseBackIn, MoveTo, EaseBounceInOut, EaseBounceOut, MoveBy, EaseBounceIn, Twirl, SplitCols, EaseBounce, EaseElasticInOut, RotateBy, SplitRows, EaseElasticOut, Waves, JumpTiles3D, EaseElasticIn, RotateTo, Liquid, WavesTiles3D, EaseElastic, Spawn, EaseSineInOut, ReuseGrid, Shaky3D, CallFuncN, EaseSineOut, TurnOffTiles, StopGrid, EaseSineIn, CatmullRomBy, DeccelAmplitude, Ripple3D, RepeatForever, CallFunc, EaseExponentialInOut, FadeOutDownTiles, CatmullRomTo, AccelAmplitude, FadeOutUpTiles, EaseExponentialOut, CardinalSplineBy, FadeOutBLTiles, EaseExponentialIn, Repeat, Place, AccelDeccelAmplitude, FadeOutTRTiles, Lens3D, EaseInOut, CardinalSplineTo, FlipY, TiledGrid3DAction, EaseOut, Sequence, FlipX, FlipY3D, EaseIn, ShuffleTiles, RemoveSelf, OrbitCamera, Grid3DAction, ToggleVisibility, FlipX3D, EaseRateAction, ActionInterval, ShatteredTiles3D, Animate3D, ActionTween, Hide, LuaCallFunc, ProgressFromTo, Waves3D, Show, PageTurn3D, ShakyTiles3D, ActionCamera, ProgressTo, ActionEase, GridAction, and ActionInstant.

local clone ( )

inlineoverridevirtual

Returns a clone of action.

A clone action.

Reimplemented from Action.

Reimplemented in ActionFloat, TargetedAction, Animate, ReverseTime, DelayTime, TintBy, TintTo, FadeOut, FadeIn, FadeTo, EaseCubicActionInOut, EaseCubicActionOut, Blink, EaseCubicActionIn, ScaleBy, EaseCircleActionInOut, EaseCircleActionOut, EaseCircleActionIn, EaseQuinticActionInOut, ScaleTo, EaseQuinticActionOut, EaseQuinticActionIn, EaseQuarticActionInOut, BezierTo, EaseQuarticActionOut, EaseQuarticActionIn, EaseQuadraticActionInOut, BezierBy, EaseQuadraticActionOut, JumpTo, EaseQuadraticActionIn, EaseBezierAction, JumpBy, EaseBackInOut, SkewBy, EaseBackOut, SkewTo, EaseBackIn, MoveTo, EaseBounceInOut, EaseBounceOut, MoveBy, EaseBounceIn, Twirl, SplitCols, EaseBounce, EaseElasticInOut, RotateBy, SplitRows, EaseElasticOut, Waves, JumpTiles3D, EaseElasticIn, RotateTo, Liquid, WavesTiles3D, EaseElastic, Spawn, EaseSineInOut, ReuseGrid, Shaky3D, CallFuncN, EaseSineOut, TurnOffTiles, StopGrid, EaseSineIn, CatmullRomBy, DeccelAmplitude, Ripple3D, RepeatForever, CallFunc, EaseExponentialInOut, FadeOutDownTiles, CatmullRomTo, AccelAmplitude, FadeOutUpTiles, EaseExponentialOut, CardinalSplineBy, FadeOutBLTiles, EaseExponentialIn, Repeat, Place, AccelDeccelAmplitude, FadeOutTRTiles, Lens3D, EaseInOut, CardinalSplineTo, FlipY, TiledGrid3DAction, EaseOut, Sequence, FlipX, FlipY3D, EaseIn, ShuffleTiles, RemoveSelf, OrbitCamera, Grid3DAction, ToggleVisibility, FlipX3D, EaseRateAction, ActionInterval, ShatteredTiles3D, Animate3D, ActionTween, Hide, LuaCallFunc, ProgressFromTo, Waves3D, Show, PageTurn3D, ShakyTiles3D, ActionCamera, ProgressTo, ActionEase, GridAction, and ActionInstant.

The documentation for this class was generated from the following file:

CCAction.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation