Base class for Action objects. More...

Inherited by FiniteTimeAction, Follow, and Speed.

Public Member Functions
virtual std::string	description () const
	@js NA @lua NA

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

virtual Action *	reverse () const
	Returns a new action that performs the exact reverse of the action. More...

virtual bool	isDone () const
	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 has finished. More...

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

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

Node *	getTarget () const
	Return certain target. More...

void	setTarget (Node *target)
	The action will modify the target properties. More...

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

void	setOriginalTarget (Node *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...

void	setTag (int 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)
	Changes the flag field that is used to group the actions easily. More...

Public Member Functions inherited from Ref
void	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...

virtual	~Ref ()
	Destructor. More...

Public Member Functions inherited from Clonable
virtual	~Clonable ()
	@js NA @lua NA

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

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

int	_luaID
	Lua reference id.

void *	_scriptObject
	scriptObject, support for swift

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

Detailed Description

Base class for Action objects.

Member Function Documentation

◆ clone()

virtual Action* clone ( ) const

inlinevirtual

Returns a clone of action.

Returns: A clone action.

Implements Clonable.

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

◆ reverse()

virtual Action* reverse ( ) const

inlinevirtual

Returns a new action that performs the exact reverse of the action.

Returns: A new action that performs the exact reverse of the action. @js NA

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

◆ isDone()

virtual bool isDone ( ) const

virtual

Return true if the action has finished.

Returns: Is true if the action has finished.

Reimplemented in Follow, RepeatForever, Speed, Repeat, Sequence, ActionInterval, and ActionInstant.

◆ startWithTarget()

virtual void startWithTarget ( Node * target )

virtual

Called before the action start.

It will also set the target.

Parameters

target A certain target.

Reimplemented in ActionFloat, TargetedAction, Animate, ReverseTime, TintBy, TintTo, FadeOut, FadeIn, FadeTo, Blink, ScaleBy, ScaleTo, BezierTo, BezierBy, JumpTo, JumpBy, ResizeBy, SkewBy, SkewTo, MoveTo, SplitCols, MoveBy, SplitRows, RotateBy, RotateTo, ReuseGrid, Spawn, TurnOffTiles, StopGrid, DeccelAmplitude, RepeatForever, Speed, AccelAmplitude, CardinalSplineBy, Repeat, AccelDeccelAmplitude, CardinalSplineTo, Sequence, ShuffleTiles, OrbitCamera, ProgressFromTo, ActionInterval, ActionTween, Animate3D, GridAction, ActionCamera, ActionInstant, ProgressTo, ActionEase, and ResizeTo.

◆ stop()

virtual void stop ( )

virtual

Called after the action has finished.

It will set the 'target' to nil. IMPORTANT: You should never call "Action::stop()" manually. Instead, use: "target->stopAction(action);".

Reimplemented in TargetedAction, Animate, ReverseTime, Blink, Spawn, Follow, Speed, Repeat, Sequence, Animate3D, and ActionEase.

◆ step()

virtual void step ( float dt )

virtual

Called every frame with it's delta time, dt in seconds.

DON'T override unless you know what you are doing.

Parameters

dt	In seconds.

Reimplemented in Follow, RepeatForever, Speed, ActionInterval, Animate3D, and ActionInstant.

◆ update()

virtual void update ( float time )

virtual

Called once per frame.

time a value between 0 and 1.

For example:

0 Means that the action just started.
0.5 Means that the action is in the middle.
1 Means that the action is over.

Parameters

time	A value between 0 and 1.

Reimplemented in TargetedAction, ReverseTime, DelayTime, TintBy, TintTo, FadeTo, Blink, ScaleTo, BezierBy, JumpBy, ResizeBy, ResizeTo, SkewTo, Twirl, MoveBy, SplitCols, SplitRows, EaseBezierAction, RotateBy, EaseElasticInOut, EaseElasticOut, Waves, JumpTiles3D, EaseElasticIn, RotateTo, Liquid, WavesTiles3D, EaseInOut, EaseOut, EaseIn, Spawn, EaseCubicActionInOut, Shaky3D, TurnOffTiles, EaseCubicActionOut, EaseCubicActionIn, CallFunc, EaseCircleActionInOut, EaseCircleActionOut, EaseCircleActionIn, EaseQuinticActionInOut, EaseQuinticActionOut, DeccelAmplitude, Ripple3D, EaseQuinticActionIn, EaseQuarticActionInOut, Place, EaseQuarticActionOut, EaseQuarticActionIn, EaseQuadraticActionInOut, EaseQuadraticActionOut, AccelAmplitude, EaseQuadraticActionIn, FlipY, EaseBackInOut, EaseBackOut, EaseBackIn, EaseBounceInOut, FlipX, Lens3D, FadeOutTRTiles, EaseBounceOut, AccelDeccelAmplitude, EaseBounceIn, CardinalSplineTo, EaseSineInOut, RemoveSelf, EaseSineOut, EaseSineIn, EaseExponentialInOut, FlipY3D, ToggleVisibility, EaseExponentialOut, ShuffleTiles, OrbitCamera, EaseExponentialIn, Hide, FlipX3D, ProgressFromTo, ShatteredTiles3D, Show, Waves3D, ActionInstant, PageTurn3D, ActionEase, ProgressTo, ShakyTiles3D, Animate, Sequence, Animate3D, Repeat, ActionTween, and ActionFloat.

◆ getTarget()

Node* getTarget ( ) const

inline

Return certain target.

Returns: A certain target.

◆ setTarget()

void setTarget ( Node * target )

inline

The action will modify the target properties.

Parameters

target A certain target.

◆ getOriginalTarget()

Node* getOriginalTarget ( ) const

inline

Return a original Target.

Returns: A original Target.

◆ setOriginalTarget()

void setOriginalTarget ( Node * originalTarget )

inline

Set the original target, since target can be nil.

Is the target that were used to run the action. Unless you are doing something complex, like ActionManager, you should NOT call this method. The target is 'assigned', it is not 'retained'.

Since: v0.8.2

Parameters

originalTarget Is 'assigned', it is not 'retained'.

◆ getTag()

int getTag ( ) const

inline

Returns a tag that is used to identify the action easily.

Returns: A tag.

◆ setTag()

void setTag ( int tag )

inline

Changes the tag that is used to identify the action easily.

Parameters

tag	Used to identify the action easily.

◆ getFlags()

unsigned int getFlags ( ) const

inline

Returns a flag field that is used to group the actions easily.

Returns: A tag.

◆ setFlags()

void setFlags ( unsigned int flags )

inline

Changes the flag field that is used to group the actions easily.

Parameters

flags Used to group the actions easily.

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

CCAction.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clone()

◆ reverse()

◆ isDone()

◆ startWithTarget()

◆ stop()

◆ step()

◆ update()

◆ getTarget()

◆ setTarget()

◆ getOriginalTarget()

◆ setOriginalTarget()

◆ getTag()

◆ setTag()

◆ getFlags()

◆ setFlags()