cocos2d-x  3.0-beta2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ActionInstant Class Referenceabstract

Instant actions are immediate actions. More...

#include <CCActionInstant.h>

Inheritance diagram for ActionInstant:
FiniteTimeAction Action Object Clonable CallFunc FlipX FlipY Hide Place RemoveSelf ReuseGrid Show StopGrid ToggleVisibility CCBSetSpriteFrame CCBSoundEffect

Public Member Functions

virtual ActionInstantclone () const override=0
 returns a clone of action More...
 
local clone ()
 returns a clone of action More...
 
virtual ActionInstantreverse () const override=0
 returns a new action that performs the exactly the reverse action More...
 
virtual bool isDone () const override
 return true if the action has finished More...
 
virtual void step (float dt) override
 called every frame with it's delta time. DON'T override unless you know what you are doing. More...
 
local step ( local dt)
 called every frame with it's delta time. DON'T override unless you know what you are doing. More...
 
virtual void update (float time) override
 called once per frame. More...
 
local update ( local time)
 called once per frame. More...
 
- Public Member Functions inherited from FiniteTimeAction
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...
 
- Public Member Functions inherited from Action
virtual std::string description () const
virtual void startWithTarget (Node *target)
 called before the action start. It will also set the target. More...
 
local startWithTarget ( local target)
 called before the action start. It will also set the target. More...
 
virtual void stop ()
 called after the action has finished. More...
 
var stop ()
 called after the action has finished. More...
 
local stop ()
 called after the action has finished. More...
 
NodegetTarget () const
var getTarget ()
local getTarget ()
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
void setOriginalTarget (Node *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
var getTag ()
local getTag ()
void setTag (int tag)
var setTag ( var tag)
local setTag ( local tag)
- Public Member Functions inherited from Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
void release ()
 Release the ownership immediately. More...
 
void retain ()
 Retains the ownership. More...
 
Objectautorelease ()
 Release the ownership sometime soon automatically. More...
 
bool isSingleReference () const
 Returns a boolean value that indicates whether there is only one reference to the object. More...
 
unsigned int retainCount () const
 Returns the object's current reference count. More...
 
unsigned int getReferenceCount () const
virtual bool isEqual (const Object *object)
 Returns a boolean value that indicates whether this object and a given object are equal. More...
 
virtual void acceptVisitor (DataVisitor &visitor)
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
Objectcopy () const
 returns a copy of the object. More...
 
var copy ()
 returns a copy of the object. More...
 
local copy ()
 returns a copy of the object. More...
 

Additional Inherited Members

- Public Attributes inherited from Object
unsigned int _ID
 object id, ScriptSupport need public _ID More...
 
int _luaID
 Lua reference id. More...
 
- 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...
 
- Protected Member Functions inherited from FiniteTimeAction
 FiniteTimeAction ()
 FiniteTimeAction ()
 FiniteTimeAction ()
virtual ~FiniteTimeAction ()
var ~FiniteTimeAction ()
local ~FiniteTimeAction ()
- Protected Attributes inherited from FiniteTimeAction
float _duration
 duration in seconds More...
 

Detailed Description

Instant actions are immediate actions.

They don't have a duration like the IntervalAction actions.

Member Function Documentation

virtual ActionInstant* clone ( ) const
overridepure virtual
var clone ( )
overridepure virtual
local clone ( )
overridepure virtual
virtual bool isDone ( ) const
overridevirtual

return true if the action has finished

Reimplemented from Action.

var isDone ( )
overridevirtual

return true if the action has finished

Reimplemented from Action.

local isDone ( )
overridevirtual

return true if the action has finished

Reimplemented from Action.

virtual ActionInstant* reverse ( ) const
overridepure virtual

returns a new action that performs the exactly the reverse action

Implements FiniteTimeAction.

Implemented in ReuseGrid, CallFunc, StopGrid, Place, FlipY, CCBSoundEffect, CCBSetSpriteFrame, FlipX, RemoveSelf, ToggleVisibility, Hide, and Show.

var reverse ( )
overridepure virtual

returns a new action that performs the exactly the reverse action

Implements FiniteTimeAction.

Implemented in ReuseGrid, CallFunc, StopGrid, Place, FlipY, CCBSoundEffect, CCBSetSpriteFrame, FlipX, RemoveSelf, ToggleVisibility, Hide, and Show.

local reverse ( )
overridepure virtual

returns a new action that performs the exactly the reverse action

Implements FiniteTimeAction.

Implemented in ReuseGrid, CallFunc, StopGrid, Place, FlipY, CCBSoundEffect, CCBSetSpriteFrame, FlipX, RemoveSelf, ToggleVisibility, Hide, and Show.

virtual void step ( float  dt)
overridevirtual

called every frame with it's delta time. DON'T override unless you know what you are doing.

Reimplemented from Action.

var step ( var  dt)
overridevirtual

called every frame with it's delta time. DON'T override unless you know what you are doing.

Reimplemented from Action.

local step ( local  dt)
overridevirtual

called every frame with it's delta time. DON'T override unless you know what you are doing.

Reimplemented from Action.

virtual void update ( float  time)
overridevirtual

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

Reimplemented from Action.

Reimplemented in CallFunc, Place, FlipY, CCBSoundEffect, CCBSetSpriteFrame, FlipX, RemoveSelf, ToggleVisibility, Hide, and Show.

var update ( var  time)
overridevirtual

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

Reimplemented from Action.

Reimplemented in CallFunc, Place, FlipY, CCBSoundEffect, CCBSetSpriteFrame, FlipX, RemoveSelf, ToggleVisibility, Hide, and Show.

local update ( local  time)
overridevirtual

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

Reimplemented from Action.

Reimplemented in CallFunc, Place, FlipY, CCBSoundEffect, CCBSetSpriteFrame, FlipX, RemoveSelf, ToggleVisibility, Hide, and Show.


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