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

Inherits Action.

Inherited by ActionInstant, and ActionInterval.

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

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

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

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

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

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

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.

Static Public Attributes inherited from Action
static const int	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

◆ getDuration()

float getDuration ( ) const

inline

Get duration in seconds of the action.

Returns: The duration in seconds of the action.

◆ setDuration()

void setDuration ( float duration )

inline

Set duration in seconds of the action.

Parameters

duration In seconds of the action.

◆ reverse()

virtual FiniteTimeAction* reverse ( ) const

inlineoverridevirtual

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 from Action.

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, StopGrid, EaseCubicActionOut, EaseCubicActionIn, CallFunc, EaseCircleActionInOut, EaseCircleActionOut, EaseCircleActionIn, EaseQuinticActionInOut, DeccelAmplitude, EaseQuinticActionOut, CatmullRomBy, EaseQuinticActionIn, RepeatForever, EaseQuarticActionInOut, Place, EaseQuarticActionOut, EaseQuarticActionIn, EaseQuadraticActionInOut, CatmullRomTo, EaseQuadraticActionOut, AccelAmplitude, EaseQuadraticActionIn, FlipY, EaseBackInOut, EaseBackOut, CardinalSplineBy, EaseBackIn, Repeat, EaseBounceInOut, FlipX, EaseBounceOut, AccelDeccelAmplitude, EaseBounceIn, CardinalSplineTo, EaseSineInOut, RemoveSelf, EaseSineOut, EaseSineIn, Sequence, EaseExponentialInOut, ToggleVisibility, EaseExponentialOut, EaseExponentialIn, Hide, ProgressFromTo, ActionInterval, ActionTween, Show, Animate3D, ActionCamera, GridAction, ProgressTo, and ActionInstant.

◆ clone()

virtual FiniteTimeAction* clone ( ) const

inlineoverridevirtual

Returns a clone of action.

Returns: A clone action.