Spawn Class Reference

Spawn a new action immediately. More...

Inherits ActionInterval.

Public Types
typedef FiniteTimeAction *	M
	Helper constructor to create an array of spawned actions. More...

Public Member Functions
virtual Spawn *	clone () 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 Spawn *	reverse () const override
	Returns a new action that performs the exact reverse of the action. More...
var	reverse ()
	Returns a new action that performs the exact reverse of the action. More...
local	reverse ()
	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...
var	startWithTarget ( var target)
	Called before the action start. More...
local	startWithTarget ( local target)
	Called before the action start. More...
virtual void	stop () override
	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...
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...
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 amplitude rate, extension in GridAction. More...
float	getAmplitudeRate ()
	Gets the amplitude rate, extension in GridAction. More...
var	getAmplitudeRate ()
	Gets the amplitude rate, extension in GridAction. More...
local	getAmplitudeRate ()
	Gets the amplitude rate, extension in GridAction. More...
virtual bool	isDone () const override
	Return true if the action has finished. More...
var	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...
local	setDuration ( local duration)
	Set duration in seconds of the action. More...
Public Member Functions inherited from Action
Node *	getTarget () const
	Return certain target. More...
var	getTarget ()
	Return certain target. More...
local	getTarget ()
	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...
Node *	getOriginalTarget () 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...
local	setOriginalTarget ( local 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...
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...
unsigned int	getFlags () const
	Returns a flag field that is used to group the actions easily. More...
var	getFlags ()
	Returns a flag field that is used to group the actions easily. More...
local	getFlags ()
	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...
local	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...
local	getReferenceCount ()
	Returns the Ref's current reference count. More...
virtual	~Ref ()
	Destructor. More...
Public Member Functions inherited from Clonable
Ref *	copy () const
	Returns a copy of the Ref. More...

Static Public Member Functions
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
var	initWithTwoActions ( var action1, var action2)
	initializes the Spawn action with the 2 actions to spawn
local	initWithTwoActions ( local action1, local action2)
	initializes the Spawn action with the 2 actions to spawn
Protected Member Functions inherited from ActionInterval
bool	initWithDuration (float d)
	initializes the action
var	initWithDuration ( var d)
	initializes the action
local	initWithDuration ( local d)
	initializes the action

Additional Inherited Members
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID
local	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.
local	_luaID
	Lua reference id.
void *	_scriptObject
	scriptObject, support for swift
local	_scriptObject
	scriptObject, support for swift
bool	_rooted
	When true, it means that the object was already rooted.
local	_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. 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

Spawn a new action immediately.

Member Typedef Documentation

typedef FiniteTimeAction* M

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.

var M

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.

local M

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.

Member Function Documentation

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.

local createWithVariableList ( local  action1, local  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.

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.

var create ( var  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.

local create ( local  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.

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.

local createWithTwoActions ( local  action1, local  action2  )

static

Creates the Spawn action.

Parameters

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

Returns

An autoreleased Spawn object.

virtual Spawn* 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.

virtual Spawn* reverse ( void  ) 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.

Reimplemented from ActionInterval.

var reverse (   )

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.

Reimplemented from ActionInterval.

local reverse (   )

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.

Reimplemented from ActionInterval.

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.

var startWithTarget ( var  target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target

A certain target.

Reimplemented from ActionInterval.

local startWithTarget ( local  target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target

A certain target.

Reimplemented from ActionInterval.

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.

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

time	In seconds.

Reimplemented from Action.

var update ( var  time )

overridevirtual

Parameters

time	In seconds.

Reimplemented from Action.

local update ( local  time )

overridevirtual

Parameters

time	In seconds.

Reimplemented from Action.

---

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

• CCActionInterval.h