StopGrid Class Reference

StopGrid action. More...

#include <CCActionGrid.h>

Inheritance diagram for StopGrid:

Public Member Functions
virtual void	startWithTarget (Node *target) override
	called before the action start. It will also set the target. More...
virtual StopGrid *	clone () const override
	returns a clone of action More...
virtual StopGrid *	reverse () const override
	returns a new action that performs the exactly the reverse action More...
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
	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	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...
Node *	getTarget () 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...
Node *	getOriginalTarget () 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)
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 ()
Public Member Functions inherited from Clonable
virtual	~Clonable ()
Ref *	copy () 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...

Static Public Member Functions
static StopGrid *	create ()
	Allocates and initializes the action. More...

Protected Member Functions
	StopGrid ()
virtual	~StopGrid ()
void	cacheTargetAsGridNode ()
Protected Member Functions inherited from FiniteTimeAction
	FiniteTimeAction ()
virtual	~FiniteTimeAction ()
Protected Member Functions inherited from Action
	Action ()
	Action ()
	Action ()
virtual	~Action ()
local	~Action ()
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...

Protected Attributes
NodeGrid *	_gridNodeTarget
Protected Attributes inherited from FiniteTimeAction
float	_duration
	duration in seconds More...
Protected Attributes inherited from Action
Node *	_originalTarget
var	_originalTarget
Node *	_target
	The "target". More...
int	_tag
	The action tag. More...
var	_tag
	The action tag. More...
Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...

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

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);

Constructor & Destructor Documentation

StopGrid ( )

inlineprotected

virtual ~StopGrid ( )

inlineprotectedvirtual

Member Function Documentation

void cacheTargetAsGridNode ( )

protected

virtual StopGrid* clone ( ) const

overridevirtual

returns a clone of action

Implements ActionInstant.

static StopGrid* create ( )

static

Allocates and initializes the action.

virtual StopGrid* reverse ( ) const

overridevirtual

returns a new action that performs the exactly the reverse action

Implements ActionInstant.

virtual void startWithTarget ( Node *  target )

overridevirtual

called before the action start. It will also set the target.

Reimplemented from Action.

Member Data Documentation

NodeGrid* _gridNodeTarget

protected

---

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

• /Users/guanghui/cocos2d-x-v3/cocos/2d/CCActionGrid.h