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

StopGrid action. More...

#include <CCActionGrid.h>

Inheritance diagram for StopGrid:
ActionInstant FiniteTimeAction Action Ref Clonable

Public Member Functions

virtual void startWithTarget (Node *target) override
 Called before the action start. More...
 
var startWithTarget ( var target)
 Called before the action start. More...
 
virtual StopGridclone () const override
 Returns a clone of action. More...
 
local clone ()
 Returns a clone of action. More...
 
virtual StopGridreverse () const override
 Returns a new action that performs the exactly the reverse action. More...
 
void cacheTargetAsGridNode ()
var cacheTargetAsGridNode ()
local cacheTargetAsGridNode ()
- Public Member Functions inherited from ActionInstant
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
var step ( var dt)
local step ( local dt)
virtual void update (float time) override
local update ( local time)
- 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 stop ()
 Called after the action has finished. 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...
 
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 ()
 Destructor. More...
 
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
Refcopy () const
 Returns a copy of the Ref. More...
 

Static Public Member Functions

static StopGridcreate ()
 Create a StopGrid Action. More...
 
local create ()
 Create a StopGrid Action. More...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: StopGrid() {} virtual ~StopGrid() {} protected: NodeGrid* _gridNodeTarget
- Public Attributes inherited from FiniteTimeAction
CC_CONSTRUCTOR_ACCESS __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
var __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
local __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
- Public Attributes inherited from Action
CC_CONSTRUCTOR_ACCESS __pad0__: Action()

Additional Inherited Members

- 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...
 
 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...
 
local _referenceCount
 count of references More...
 

Detailed Description

StopGrid action.

Warning
Don't call this action if another grid action is active. Call if you want to remove the the grid effect. Example: Sequence::actions(Lens::action(...), StopGrid::action(...), nullptr);

Member Function Documentation

void cacheTargetAsGridNode ( )
var cacheTargetAsGridNode ( )
local cacheTargetAsGridNode ( )
virtual StopGrid* clone ( ) const
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInstant.

var clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInstant.

local clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInstant.

static StopGrid* create ( )
static

Create a StopGrid Action.

Returns
Return a pointer of StopGrid. When the creation failed, return nil.
var create ( )
static

Create a StopGrid Action.

Returns
Return a pointer of StopGrid. When the creation failed, return nil.
local create ( )
static

Create a StopGrid Action.

Returns
Return a pointer of StopGrid. When the creation failed, return nil.
virtual StopGrid* reverse ( void  ) const
overridevirtual

Returns a new action that performs the exactly the reverse action.

Returns
A new action that performs the exactly the reverse action.

Reimplemented from ActionInstant.

var reverse (   )
overridevirtual

Returns a new action that performs the exactly the reverse action.

Returns
A new action that performs the exactly the reverse action.

Reimplemented from ActionInstant.

local reverse (   )
overridevirtual

Returns a new action that performs the exactly the reverse action.

Returns
A new action that performs the exactly the reverse action.

Reimplemented from ActionInstant.

virtual void startWithTarget ( Node target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from Action.

var startWithTarget ( var  target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from Action.

local startWithTarget ( local  target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from Action.

Member Data Documentation

var __pad0__
local __pad0__

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