Spawn Class Reference

Spawn a new action immediately. More...

Inherits ActionInterval.

Public Member Functions
virtual Spawn *	clone () const override
	Returns a clone of action. More...
virtual Spawn *	reverse () const override
	Returns a new action that performs the exact reverse of the action. More...
virtual void	startWithTarget (Node *target) override
	Called before the action start. More...
virtual void	stop () override
	Called after the action has finished. More...
virtual void	update (float time) override
Public Member Functions inherited from ActionInterval
float	getElapsed ()
	How many seconds had elapsed since the actions started to run. More...
void	setAmplitudeRate (float amp)
	Sets the amplitude rate, extension in GridAction. More...
float	getAmplitudeRate ()
	Gets the amplitude rate, extension in GridAction. More...
virtual bool	isDone () const override
	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...
void	setDuration (float duration)
	Set duration in seconds of the action. More...
Public Member Functions inherited from Action
virtual std::string	description () const
	@js NA @lua NA
Node *	getTarget () const
	Return certain target. More...
void	setTarget (Node *target)
	The action will modify the target properties. More...
Node *	getOriginalTarget () const
	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...
void	setTag (int tag)
	Changes the tag that is used to identify the action easily. More...
unsigned int	getFlags () const
	Returns a flag field that is used to group the actions easily. More...
void	setFlags (unsigned int flags)
	Changes the flag field that is used to group the actions easily. More...
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 ()
	Destructor. More...
Public Member Functions inherited from Clonable
virtual	~Clonable ()
	@js NA @lua NA

Static Public Member Functions
static Spawn *	create (FiniteTimeAction *action1,...) CC_REQUIRES_NULL_TERMINATION
	Helper constructor to create an array of spawned actions. More...
static Spawn *	createWithVariableList (FiniteTimeAction *action1, va_list args)
	Helper constructor to create an array of spawned actions. More...
static Spawn *	create (const Vector< FiniteTimeAction * > &arrayOfActions)
	Helper constructor to create an array of spawned actions given an array. More...
static Spawn *	createWithTwoActions (FiniteTimeAction *action1, FiniteTimeAction *action2)
	Creates the Spawn action. More...

Protected Member Functions
bool	initWithTwoActions (FiniteTimeAction *action1, FiniteTimeAction *action2)
	initializes the Spawn action with the 2 actions to spawn
Protected Member Functions inherited from ActionInterval
bool	initWithDuration (float d)
	initializes the action

Additional Inherited Members
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.
void *	_scriptObject
	scriptObject, support for swift
bool	_rooted
	When true, it means that the object was already rooted.
Static Public Attributes inherited from Action
static const int	INVALID_TAG = -1
	Default tag used for all the actions.

Detailed Description

Spawn a new action immediately.

Member Function Documentation

create() [1/2]

static Spawn* create ( FiniteTimeAction *  action1,   ...  )

static

Helper constructor to create an array of spawned actions.

When this function bound to the js or lua, the input params changed.
in js  :var   create(var   object1,var   object2, ...)
in lua :local create(local object1,local object2, ...)

Returns

An autoreleased Spawn object.

createWithVariableList()

static Spawn* createWithVariableList ( FiniteTimeAction *  action1, va_list  args  )

static

Helper constructor to create an array of spawned actions.

Parameters

action1	The first sequenceable action.
args	The va_list variable.

Returns

An autoreleased Spawn object. @js NA

create() [2/2]

static Spawn* create ( const Vector< FiniteTimeAction * > &  arrayOfActions )

static

Helper constructor to create an array of spawned actions given an array.

Parameters

arrayOfActions

An array of spawned actions.

Returns

An autoreleased Spawn object.

createWithTwoActions()

static Spawn* createWithTwoActions ( FiniteTimeAction *  action1, FiniteTimeAction *  action2  )

static

Creates the Spawn action.

Parameters

action1	The first spawned action.
action2	The second spawned action.

Returns

An autoreleased Spawn object. @js NA

clone()

virtual Spawn* clone ( ) const

overridevirtual

Returns a clone of action.

Returns

A clone action.

Reimplemented from ActionInterval.

reverse()

virtual Spawn* reverse ( ) const

overridevirtual

Returns a new action that performs the exact reverse of the action.

Returns

A new action that performs the exact reverse of the action. @js NA

Reimplemented from ActionInterval.

startWithTarget()

virtual void startWithTarget ( Node *  target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target

A certain target.

Reimplemented from ActionInterval.

stop()

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

update()

virtual void update ( float  time )

overridevirtual

Parameters

time	In seconds.

Reimplemented from Action.

---

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

• CCActionInterval.h