cocos2d-x  3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ActionInstant Class Reference

Instant actions are immediate actions. More...

#include <CCActionInstant.h>

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

Public Member Functions

virtual ActionInstantclone () const override
 returns a clone of action More...
 
var clone ()
 returns a clone of action More...
 
local clone ()
 returns a clone of action More...
 
virtual ActionInstantreverse () const override
 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...
 
local isDone ()
 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...
 
var update ( var time)
 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...
 
void setDuration (float 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...
 
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
var getOriginalTarget ()
local getOriginalTarget ()
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
var getTag ()
local getTag ()
void setTag (int tag)
var setTag ( var tag)
local setTag ( local tag)
virtual ~Action ()
var ~Action ()
local ~Action ()
- 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 ()
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
Refcopy () const
 returns a copy of the Ref. More...
 
var copy ()
 returns a copy of the Ref. More...
 
local copy ()
 returns a copy of the Ref. More...
 

Additional Inherited Members

- Public Attributes inherited from FiniteTimeAction
CC_CONSTRUCTOR_ACCESS __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
- Public Attributes inherited from Action
CC_CONSTRUCTOR_ACCESS __pad0__: Action()
- 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 Ref
 Ref ()
 Constructor. More...
 
- Protected Attributes inherited from Action
Node_originalTarget
Node_target
 The "target". More...
 
int _tag
 The action tag. More...
 
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references 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
inlineoverridevirtual
var clone ( )
inlineoverridevirtual
local clone ( )
inlineoverridevirtual
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 ( void  ) const
inlineoverridevirtual

returns a new action that performs the exactly the reverse action

Reimplemented from FiniteTimeAction.

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

var reverse (   )
inlineoverridevirtual

returns a new action that performs the exactly the reverse action

Reimplemented from FiniteTimeAction.

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

local reverse (   )
inlineoverridevirtual

returns a new action that performs the exactly the reverse action

Reimplemented from FiniteTimeAction.

Reimplemented in ReuseGrid, CallFunc, StopGrid, Place, FlipY, CCBSoundEffect, FlipX, CCBSetSpriteFrame, 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, FlipX, CCBSetSpriteFrame, 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, FlipX, CCBSetSpriteFrame, 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, FlipX, CCBSetSpriteFrame, RemoveSelf, ToggleVisibility, Hide, and Show.


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