cocos2d-x  3.0-beta2
 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 Object Clonable

Public Member Functions

void setForcedTarget (Node *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
virtual TargetedActionclone () const override
 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. It will also set the target. More...
 
virtual void stop (void) override
 called after the action has finished. More...
 
virtual void update (float time) override
 called once per frame. More...
 
- Public Member Functions inherited from ActionInterval
float getElapsed (void)
 how many seconds had elapsed since the actions started to run. More...
 
void setAmplitudeRate (float amp)
float getAmplitudeRate (void)
virtual bool isDone (void) const override
 return true if the action has finished More...
 
var isDone ()
 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...
 
- 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
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...
 

Static Public Member Functions

static TargetedActioncreate (Node *target, FiniteTimeAction *action)
 Create an action with the specified action and forced target. More...
 

Protected Member Functions

 TargetedAction ()
virtual ~TargetedAction ()
bool initWithTarget (Node *target, FiniteTimeAction *action)
 Init an action with the specified action and forced target. More...
 
- Protected Member Functions inherited from ActionInterval
bool initWithDuration (float d)
 initializes the action More...
 
var initWithDuration ( var d)
 initializes the action More...
 
local initWithDuration ( local d)
 initializes the action More...
 
- Protected Member Functions inherited from FiniteTimeAction
 FiniteTimeAction ()
 FiniteTimeAction ()
 FiniteTimeAction ()
virtual ~FiniteTimeAction ()
var ~FiniteTimeAction ()
local ~FiniteTimeAction ()
- Protected Member Functions inherited from Action
 Action ()
 Action ()
 Action ()
virtual ~Action ()
var ~Action ()
local ~Action ()

Protected Attributes

FiniteTimeAction_action
Node_forcedTarget
- Protected Attributes inherited from ActionInterval
float _elapsed
bool _firstTick
- Protected Attributes inherited from FiniteTimeAction
float _duration
 duration in seconds More...
 
- Protected Attributes inherited from Action
Node_originalTarget
local _originalTarget
Node_target
 The "target". More...
 
int _tag
 The action tag. More...
 
- Protected Attributes inherited from Object
unsigned int _referenceCount
 count of references 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...
 

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

TargetedAction ( )
protected
virtual ~TargetedAction ( )
protectedvirtual

Member Function Documentation

virtual TargetedAction* clone ( ) const
overridevirtual

returns a clone of action

Implements ActionInterval.

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

Create an action with the specified action and forced target.

Node* getForcedTarget ( )
inline

returns the target that the action is forced to run with

const Node* getForcedTarget ( ) const
inline
bool initWithTarget ( Node target,
FiniteTimeAction action 
)
protected

Init an action with the specified action and forced target.

virtual TargetedAction* reverse ( ) const
overridevirtual

returns a new action that performs the exactly the reverse action

Implements ActionInterval.

void setForcedTarget ( Node forcedTarget)

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

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.

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.

Member Data Documentation

FiniteTimeAction* _action
protected
Node* _forcedTarget
protected

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