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

Overrides the target of an action so that it always runs on the target specified at action creation rather than the one specified by runAction. More...

#include <CCActionInterval.h>

Inheritance diagram for TargetedAction:
ActionInterval FiniteTimeAction Action Ref Clonable

Public Member Functions

void setForcedTarget (Node *forcedTarget)
 Sets the target that the action will be forced to run with. More...
 
var setForcedTarget ( var forcedTarget)
 Sets the target that the action will be forced to run with. More...
 
local setForcedTarget ( local forcedTarget)
 Sets the target that the action will be forced to run with. More...
 
NodegetForcedTarget ()
 returns the target that the action is forced to run with. More...
 
const NodegetForcedTarget () const
local getForcedTarget ()
virtual TargetedActionclone () 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 TargetedActionreverse () const override
 Returns a new action that performs the exactly the reverse action. More...
 
virtual void startWithTarget (Node *target) override
 Called before the action start. More...
 
local startWithTarget ( local target)
 Called before the action start. More...
 
virtual void stop (void) override
 Called after the action has finished. More...
 
local stop ()
 Called after the action has finished. More...
 
virtual void update (float time) override
virtual ~TargetedAction ()
bool initWithTarget (Node *target, FiniteTimeAction *action)
 Init an action with the specified action and forced target. More...
 
var initWithTarget ( var target, var action)
 Init an action with the specified action and forced target. More...
 
local initWithTarget ( local target, local action)
 Init an action with the specified action and forced target. More...
 
- Public Member Functions inherited from ActionInterval
float getElapsed (void)
 How many seconds had elapsed since the actions started to run. More...
 
var getElapsed ()
 How many seconds had elapsed since the actions started to run. More...
 
local getElapsed ()
 How many seconds had elapsed since the actions started to run. More...
 
void setAmplitudeRate (float amp)
 Sets the ampliture rate, extension in GridAction. More...
 
local setAmplitudeRate ( local amp)
 Sets the ampliture rate, extension in GridAction. More...
 
float getAmplitudeRate (void)
 Gets the ampliture rate, extension in GridAction. More...
 
local getAmplitudeRate ()
 Gets the ampliture rate, extension in GridAction. More...
 
virtual bool isDone (void) 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
- 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
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 TargetedActioncreate (Node *target, FiniteTimeAction *action)
 Create an action with the specified action and forced target. More...
 
var create ( var target, var action)
 Create an action with the specified action and forced target. More...
 
local create ( local target, local action)
 Create an action with the specified action and forced target. More...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: TargetedAction()
- Public Attributes inherited from ActionInterval
CC_CONSTRUCTOR_ACCESS __pad0__: bool initWithDuration(float d)
- 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()

Protected Attributes

FiniteTimeAction_action
local _action
Node_forcedTarget
var _forcedTarget
local _forcedTarget
- Protected Attributes inherited from ActionInterval
float _elapsed
var _elapsed
local _elapsed
bool _firstTick
var _firstTick
local _firstTick
- 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...
 

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

Detailed Description

Overrides the target of an action so that it always runs on the target specified at action creation rather than the one specified by runAction.

Constructor & Destructor Documentation

virtual ~TargetedAction ( )
virtual
var ~TargetedAction ( )
virtual
local ~TargetedAction ( )
virtual

Member Function Documentation

virtual TargetedAction* clone ( ) const
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInterval.

var clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInterval.

local clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInterval.

static TargetedAction* create ( Node target,
FiniteTimeAction action 
)
static

Create an action with the specified action and forced target.

Parameters
targetThe target needs to override.
actionThe action needs to override.
Returns
An autoreleased TargetedAction object.
var create ( var  target,
var  action 
)
static

Create an action with the specified action and forced target.

Parameters
targetThe target needs to override.
actionThe action needs to override.
Returns
An autoreleased TargetedAction object.
local create ( local  target,
local  action 
)
static

Create an action with the specified action and forced target.

Parameters
targetThe target needs to override.
actionThe action needs to override.
Returns
An autoreleased TargetedAction object.
Node* getForcedTarget ( )
inline

returns the target that the action is forced to run with.

Returns
The target that the action is forced to run with.
var getForcedTarget ( )
inline

returns the target that the action is forced to run with.

Returns
The target that the action is forced to run with.
local getForcedTarget ( )
inline

returns the target that the action is forced to run with.

Returns
The target that the action is forced to run with.
const Node* getForcedTarget ( ) const
inline
var getForcedTarget ( )
inline
local getForcedTarget ( )
inline
bool initWithTarget ( Node target,
FiniteTimeAction action 
)

Init an action with the specified action and forced target.

var initWithTarget ( var  target,
var  action 
)

Init an action with the specified action and forced target.

local initWithTarget ( local  target,
local  action 
)

Init an action with the specified action and forced target.

virtual TargetedAction* 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 ActionInterval.

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

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

void setForcedTarget ( Node forcedTarget)

Sets the target that the action will be forced to run with.

Parameters
forcedTargetThe target that the action will be forced to run with.
var setForcedTarget ( var  forcedTarget)

Sets the target that the action will be forced to run with.

Parameters
forcedTargetThe target that the action will be forced to run with.
local setForcedTarget ( local  forcedTarget)

Sets the target that the action will be forced to run with.

Parameters
forcedTargetThe target that the action will be forced to run with.
virtual void startWithTarget ( Node target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionInterval.

var startWithTarget ( var  target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionInterval.

local startWithTarget ( local  target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionInterval.

virtual void stop ( void  )
overridevirtual

Called after the action has finished.

It will set the 'target' to nil. IMPORTANT: You should never call "Action::stop()" manually. Instead, use: "target->stopAction(action);".

Reimplemented from Action.

var stop (   )
overridevirtual

Called after the action has finished.

It will set the 'target' to nil. IMPORTANT: You should never call "Action::stop()" manually. Instead, use: "target->stopAction(action);".

Reimplemented from Action.

local stop (   )
overridevirtual

Called after the action has finished.

It will set the 'target' to nil. IMPORTANT: You should never call "Action::stop()" manually. Instead, use: "target->stopAction(action);".

Reimplemented from Action.

virtual void update ( float  time)
overridevirtual
Parameters
timeIn seconds.

Reimplemented from Action.

var update ( var  time)
overridevirtual
Parameters
timeIn seconds.

Reimplemented from Action.

local update ( local  time)
overridevirtual
Parameters
timeIn seconds.

Reimplemented from Action.

Member Data Documentation

var __pad0__
local __pad0__
FiniteTimeAction* _action
protected
var _action
protected
local _action
protected
Node* _forcedTarget
protected
var _forcedTarget
protected
local _forcedTarget
protected

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