Cocos2d-x  v3.15
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
FiniteTimeAction Class Reference

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 FiniteTimeActionreverse () const override
 Returns a new action that performs the exact reverse of the action. More...
 
virtual FiniteTimeActionclone () 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...
 
local isDone ()
 Return true if the action has finished. More...
 
virtual void startWithTarget (Node *target)
 Called before the action start. More...
 
var startWithTarget ( var target)
 Called before the action start. More...
 
local startWithTarget ( local 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...
 
local step ( local dt)
 Called every frame with it's 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...
 
NodegetTarget () const
 Return certain target. More...
 
void setTarget (Node *target)
 The action will modify the target properties. More...
 
var setTarget ( var target)
 The action will modify the target properties. More...
 
local setTarget ( local target)
 The action will modify the target properties. More...
 
NodegetOriginalTarget () const
 Return a original Target. More...
 
var getOriginalTarget ()
 Return a original Target. More...
 
local getOriginalTarget ()
 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...
 
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...
 
var getFlags ()
 Returns a flag field that is used to group the actions easily. More...
 
local getFlags ()
 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...
 
var setFlags ( var flags)
 Changes the flag field that is used to group the actions easily. More...
 
local setFlags ( local 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...
 
Refautorelease ()
 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
Refcopy () const
 Returns a copy of the Ref. More...
 

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.
 
- Static Public Attributes inherited from Action
static const int INVALID_TAG = -1
 Default tag used for all the actions. More...
 
var INVALID_TAG = -1
 Default tag used for all the actions. More...
 
local INVALID_TAG = -1
 Default tag used for all the actions. More...
 

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.

Returns
The duration in seconds of the action.
var getDuration ( )
inline

Get duration in seconds of the action.

Returns
The duration in seconds of the action.
local getDuration ( )
inline

Get duration in seconds of the action.

Returns
The duration in seconds of the action.
void setDuration ( float  duration)
inline

Set duration in seconds of the action.

Parameters
durationIn seconds of the action.
var setDuration ( var  duration)
inline

Set duration in seconds of the action.

Parameters
durationIn seconds of the action.
local setDuration ( local  duration)
inline

Set duration in seconds of the action.

Parameters
durationIn seconds of the action.
virtual FiniteTimeAction* clone ( ) const
inlineoverridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from Action.

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

var clone ( )
inlineoverridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from Action.

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

local clone ( )
inlineoverridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from Action.

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


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