Enumerator
kCCDirectorProjection2D	sets a 2D projection (orthogonal projection)
kCCDirectorProjection3D	sets a 3D projection with a fovy=60, znear=0.5f and zfar=1500.
kCCDirectorProjectionCustom	it calls "updateProjection" on the projection delegate.
kCCDirectorProjectionDefault	Default projection is 3D projection.

var ccDirectorProjection

Possible OpenGL projections used by director.

Enumerator
kCCDirectorProjection2D	sets a 2D projection (orthogonal projection)
kCCDirectorProjection3D	sets a 3D projection with a fovy=60, znear=0.5f and zfar=1500.
kCCDirectorProjectionCustom	it calls "updateProjection" on the projection delegate.
kCCDirectorProjectionDefault	Default projection is 3D projection.

local ccDirectorProjection

Possible OpenGL projections used by director.

Enumerator
kCCDirectorProjection2D	sets a 2D projection (orthogonal projection)
kCCDirectorProjection3D	sets a 3D projection with a fovy=60, znear=0.5f and zfar=1500.
kCCDirectorProjectionCustom	it calls "updateProjection" on the projection delegate.
kCCDirectorProjectionDefault	Default projection is 3D projection.

Function Documentation

CCNode ( void )

Default constructor.

var ctor ( )

Default constructor.

local CCNode ( )

Default constructor.

CCNodeRGBA ( )

var ctor ( )

local CCNodeRGBA ( )

virtual ~CCNode ( void )

virtual

Default destructor.

virtual ~CCNodeRGBA ( )

virtual

virtual void _setZOrder ( int z)

virtual

Sets the z order which stands for the drawing order.

This is an internal method. Don't call it outside the framework. The difference between setZOrder(int) and _setOrder(int) is:

_setZOrder(int) is a pure setter for m_nZOrder memeber variable
setZOrder(int) firstly changes m_nZOrder, then recorder this node in its parent's chilren array.

var _setZOrder ( var z)

virtual

Sets the z order which stands for the drawing order.

This is an internal method. Don't call it outside the framework. The difference between setZOrder(int) and _setOrder(int) is:

_setZOrder(int) is a pure setter for m_nZOrder memeber variable
setZOrder(int) firstly changes m_nZOrder, then recorder this node in its parent's chilren array.

local _setZOrder ( local z)

virtual

Sets the z order which stands for the drawing order.

This is an internal method. Don't call it outside the framework. The difference between setZOrder(int) and _setOrder(int) is:

_setZOrder(int) is a pure setter for m_nZOrder memeber variable
setZOrder(int) firstly changes m_nZOrder, then recorder this node in its parent's chilren array.

virtual void addChild ( CCNode * child)

virtual

Adds a child to the container with z-order as 0.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters: child A child node

Reimplemented in CCSprite, CCScrollView, CCMenu, CCSpriteBatchNode, CCParticleBatchNode, and CCBatchNode.

var addChild ( var child)

virtual

Adds a child to the container with z-order as 0.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters: child A child node

Reimplemented in CCSprite, CCScrollView, CCMenu, CCSpriteBatchNode, CCParticleBatchNode, and CCBatchNode.

local addChild ( local child)

virtual

Adds a child to the container with z-order as 0.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters: child A child node

Reimplemented in CCSprite, CCScrollView, CCMenu, CCSpriteBatchNode, CCParticleBatchNode, and CCBatchNode.

virtual void addChild ( CCNode * child,

int zOrder

)

virtual

Adds a child to the container with a z-order.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters: child A child node

zOrder Z order for drawing priority. Please refer to setZOrder(int)

Reimplemented in CCSprite, CCScrollView, CCMenu, CCSpriteBatchNode, CCParticleBatchNode, and CCBatchNode.

var addChild ( var child,

var zOrder

)

virtual

Adds a child to the container with a z-order.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters: child A child node

zOrder Z order for drawing priority. Please refer to setZOrder(int)

Reimplemented in CCSprite, CCScrollView, CCMenu, CCSpriteBatchNode, CCParticleBatchNode, and CCBatchNode.

local addChild ( local child,

local zOrder

)

virtual

Adds a child to the container with a z-order.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters: child A child node

zOrder Z order for drawing priority. Please refer to setZOrder(int)

Reimplemented in CCSprite, CCScrollView, CCMenu, CCSpriteBatchNode, CCParticleBatchNode, and CCBatchNode.

virtual void addChild ( CCNode * child,

int zOrder,

int tag

)

virtual

Adds a child to the container with z order and tag.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters: child A child node

zOrder Z order for drawing priority. Please refer to setZOrder(int)

tag A interger to identify the node easily. Please refer to setTag(int)

Reimplemented in CCSprite, CCScrollView, CCTMXLayer, CCMenu, CCSpriteBatchNode, CCParticleBatchNode, and CCBatchNode.

var addChild ( var child,

var zOrder,

var tag

)

virtual

Adds a child to the container with z order and tag.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters: child A child node

zOrder Z order for drawing priority. Please refer to setZOrder(int)

tag A interger to identify the node easily. Please refer to setTag(int)

Reimplemented in CCSprite, CCScrollView, CCTMXLayer, CCMenu, CCSpriteBatchNode, CCParticleBatchNode, and CCBatchNode.

local addChild ( local child,

local zOrder,

local tag

)

virtual

Adds a child to the container with z order and tag.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters: child A child node

zOrder Z order for drawing priority. Please refer to setZOrder(int)

tag A interger to identify the node easily. Please refer to setTag(int)

Reimplemented in CCSprite, CCScrollView, CCTMXLayer, CCMenu, CCSpriteBatchNode, CCParticleBatchNode, and CCBatchNode.

virtual bool addComponent ( CCComponent * pComponent)

virtual

adds a component

var addComponent ( var pComponent)

virtual

adds a component

local addComponent ( local pComponent)

virtual

adds a component

CCRect boundingBox ( void )

Returns a "local" axis aligned bounding box of the node.

The returned box is relative only to its parent.

Note: This method returns a temporaty variable, so it can't returns const CCRect&

Todo:: Rename to getBoundingBox() in the future versions.

Returns: A "local" axis aligned boudning box of the node.

var getBoundingBox ( )

Returns a "local" axis aligned bounding box of the node.

The returned box is relative only to its parent.

Note: This method returns a temporaty variable, so it can't returns const CCRect&

Todo:: Rename to getBoundingBox() in the future versions.

Returns: A "local" axis aligned boudning box of the node.

local boundingBox ( )

Returns a "local" axis aligned bounding box of the node.

The returned box is relative only to its parent.

Note: This method returns a temporaty variable, so it can't returns const CCRect&

Todo:: Rename to getBoundingBox() in the future versions.

Returns: A "local" axis aligned boudning box of the node.

virtual void cleanup ( void )

virtual

Stops all running actions and schedulers.

Reimplemented in CCTransitionScene.

var cleanup ( )

virtual

Stops all running actions and schedulers.

Reimplemented in CCTransitionScene.

local cleanup ( )

virtual

Stops all running actions and schedulers.

Reimplemented in CCTransitionScene.

CCPoint convertToNodeSpace ( const CCPoint & worldPoint)

Converts a Point to node (local) space coordinates.

The result is in Points.

var convertToNodeSpace ( var worldPoint)

Converts a Point to node (local) space coordinates.

The result is in Points.

local convertToNodeSpace ( local worldPoint)

Converts a Point to node (local) space coordinates.

The result is in Points.

CCPoint convertToNodeSpaceAR ( const CCPoint & worldPoint)

Converts a Point to node (local) space coordinates.

The result is in Points. treating the returned/received node point as anchor relative.

var convertToNodeSpaceAR ( var worldPoint)

Converts a Point to node (local) space coordinates.

The result is in Points. treating the returned/received node point as anchor relative.

local convertToNodeSpaceAR ( local worldPoint)

Converts a Point to node (local) space coordinates.

The result is in Points. treating the returned/received node point as anchor relative.

CCPoint convertTouchToNodeSpace ( CCTouch * touch)

convenience methods which take a CCTouch instead of CCPoint

var convertTouchToNodeSpace ( var touch)

convenience methods which take a CCTouch instead of CCPoint

local convertTouchToNodeSpace ( local touch)

convenience methods which take a CCTouch instead of CCPoint

CCPoint convertTouchToNodeSpaceAR ( CCTouch * touch)

converts a CCTouch (world coordinates) into a local coordinate.

This method is AR (Anchor Relative).

var convertTouchToNodeSpaceAR ( var touch)

converts a CCTouch (world coordinates) into a local coordinate.

This method is AR (Anchor Relative).

local convertTouchToNodeSpaceAR ( local touch)

converts a CCTouch (world coordinates) into a local coordinate.

This method is AR (Anchor Relative).

CCPoint convertToWorldSpace ( const CCPoint & nodePoint)

Converts a Point to world space coordinates.

The result is in Points.

var convertToWorldSpace ( var nodePoint)

Converts a Point to world space coordinates.

The result is in Points.

local convertToWorldSpace ( local nodePoint)

Converts a Point to world space coordinates.

The result is in Points.

CCPoint convertToWorldSpaceAR ( const CCPoint & nodePoint)

Converts a local Point to world space coordinates.The result is in Points.

treating the returned/received node point as anchor relative.

var convertToWorldSpaceAR ( var nodePoint)

Converts a local Point to world space coordinates.The result is in Points.

treating the returned/received node point as anchor relative.

local convertToWorldSpaceAR ( local nodePoint)

Converts a local Point to world space coordinates.The result is in Points.

treating the returned/received node point as anchor relative.

static CCNode* create ( void )

static

Allocates and initializes a node.

Returns: A initialized node which is marked as "autorelease".

var create ( )

static

Allocates and initializes a node.

Returns: A initialized node which is marked as "autorelease".

local create ( )

static

Allocates and initializes a node.

Returns: A initialized node which is marked as "autorelease".

static CCNodeRGBA* create ( void )

static

Allocates and initializes a nodergba.

Returns: A initialized node which is marked as "autorelease".

var create ( )

static

Allocates and initializes a nodergba.

Returns: A initialized node which is marked as "autorelease".

local create ( )

static

Allocates and initializes a nodergba.

Returns: A initialized node which is marked as "autorelease".

const char* description ( void )

Gets the description string.

It makes debugging easier.

Returns: A string terminated with '0円'

local description ( )

Gets the description string.

It makes debugging easier.

Returns: A string terminated with '0円'

virtual void draw ( void )

virtual

Override this method to draw your own node.

The following GL states will be enabled by default:

glEnableClientState(GL_VERTEX_ARRAY);
glEnableClientState(GL_COLOR_ARRAY);
glEnableClientState(GL_TEXTURE_COORD_ARRAY);
glEnable(GL_TEXTURE_2D); AND YOU SHOULD NOT DISABLE THEM AFTER DRAWING YOUR NODE But if you enable any other GL state, you should disable it after drawing your node.

Reimplemented in CCTransitionCrossFade, CCSprite, CCLayerColor, CCTextFieldTTF, CCSpriteBatchNode, CCArmature, CCParticleSystemQuad, CCAtlasNode, CCParticleBatchNode, CCTransitionScene, CCProgressTimer, CCMotionStreak, CCRenderTexture, CCDrawNode, CCBatchNode, CCSkeleton, and UICCLabelAtlas.

var draw ( )

virtual

Override this method to draw your own node.

The following GL states will be enabled by default:

glEnableClientState(GL_VERTEX_ARRAY);
glEnableClientState(GL_COLOR_ARRAY);
glEnableClientState(GL_TEXTURE_COORD_ARRAY);
glEnable(GL_TEXTURE_2D); AND YOU SHOULD NOT DISABLE THEM AFTER DRAWING YOUR NODE But if you enable any other GL state, you should disable it after drawing your node.

Reimplemented in CCTransitionCrossFade, CCSprite, CCLayerColor, CCTextFieldTTF, CCSpriteBatchNode, CCArmature, CCParticleSystemQuad, CCAtlasNode, CCParticleBatchNode, CCTransitionScene, CCProgressTimer, CCMotionStreak, CCRenderTexture, CCDrawNode, CCBatchNode, CCSkeleton, and UICCLabelAtlas.

local draw ( )

virtual

Override this method to draw your own node.

The following GL states will be enabled by default:

glEnableClientState(GL_VERTEX_ARRAY);
glEnableClientState(GL_COLOR_ARRAY);
glEnableClientState(GL_TEXTURE_COORD_ARRAY);
glEnable(GL_TEXTURE_2D); AND YOU SHOULD NOT DISABLE THEM AFTER DRAWING YOUR NODE But if you enable any other GL state, you should disable it after drawing your node.

Reimplemented in CCTransitionCrossFade, CCSprite, CCLayerColor, CCTextFieldTTF, CCSpriteBatchNode, CCArmature, CCParticleSystemQuad, CCAtlasNode, CCParticleBatchNode, CCTransitionScene, CCProgressTimer, CCMotionStreak, CCRenderTexture, CCDrawNode, CCBatchNode, CCSkeleton, and UICCLabelAtlas.

CCAction* getActionByTag ( int tag)

Gets an action from the running action list by its tag.

See Also: setTag(int), getTag().

Returns: The action object with the given tag.

var getActionByTag ( var tag)

Gets an action from the running action list by its tag.

See Also: setTag(int), getTag().

Returns: The action object with the given tag.

local getActionByTag ( local tag)

Gets an action from the running action list by its tag.

See Also: setTag(int), getTag().

Returns: The action object with the given tag.

virtual CCActionManager*
getActionManager ( )

virtual

Gets the CCActionManager object that is used by all actions.

See Also: setActionManager(CCActionManager*)

Returns: A CCActionManager object.

var getActionManager ( )

virtual

Gets the CCActionManager object that is used by all actions.

See Also: setActionManager(CCActionManager*)

Returns: A CCActionManager object.

local getActionManager ( )

virtual

Gets the CCActionManager object that is used by all actions.

See Also: setActionManager(CCActionManager*)

Returns: A CCActionManager object.

virtual const CCPoint&
getAnchorPoint ( )

virtual

Returns the anchor point in percent.

See Also: setAnchorPoint(const CCPoint&)

Returns: The anchor point of node.

var getAnchorPoint ( )

virtual

Returns the anchor point in percent.

See Also: setAnchorPoint(const CCPoint&)

Returns: The anchor point of node.

local getAnchorPoint ( )

virtual

Returns the anchor point in percent.

See Also: setAnchorPoint(const CCPoint&)

Returns: The anchor point of node.

virtual const CCPoint&
getAnchorPointInPoints ( )

virtual

Returns the anchorPoint in absolute pixels.

Warning: You can only read it. If you wish to modify it, use anchorPoint instead.

See Also: getAnchorPoint()

Returns: The anchor point in absolute pixels.

var getAnchorPointInPoints ( )

virtual

Returns the anchorPoint in absolute pixels.

Warning: You can only read it. If you wish to modify it, use anchorPoint instead.

See Also: getAnchorPoint()

Returns: The anchor point in absolute pixels.

local getAnchorPointInPoints ( )

virtual

Returns the anchorPoint in absolute pixels.

Warning: You can only read it. If you wish to modify it, use anchorPoint instead.

See Also: getAnchorPoint()

Returns: The anchor point in absolute pixels.

virtual CCCamera* getCamera ( )

virtual

Returns a camera object that lets you move the node using a gluLookAt.

CCCamera* camera = node->getCamera();

camera->setEyeXYZ(0, 0, 415/2);

camera->setCenterXYZ(0, 0, 0);

Returns: A CCCamera object that lets you move the node using a gluLookAt

var getCamera ( )

virtual

Returns a camera object that lets you move the node using a gluLookAt.

CCCamera* camera = node->getCamera();

camera->setEyeXYZ(0, 0, 415/2);

camera->setCenterXYZ(0, 0, 0);

Returns: A CCCamera object that lets you move the node using a gluLookAt

local getCamera ( )

virtual

Returns a camera object that lets you move the node using a gluLookAt.

CCCamera* camera = node->getCamera();

camera->setEyeXYZ(0, 0, 415/2);

camera->setCenterXYZ(0, 0, 0);

Returns: A CCCamera object that lets you move the node using a gluLookAt

CCNode* getChildByTag ( int tag)

Gets a child from the container with its tag.

Parameters: tag An identifier to find the child node.

Returns: a CCNode object whose tag equals to the input parameter

var getChildByTag ( var tag)

Gets a child from the container with its tag.

Parameters: tag An identifier to find the child node.

Returns: a CCNode object whose tag equals to the input parameter

local getChildByTag ( local tag)

Gets a child from the container with its tag.

Parameters: tag An identifier to find the child node.

Returns: a CCNode object whose tag equals to the input parameter

virtual CCArray* getChildren ( )

virtual

Return an array of children.

Composing a "tree" structure is a very important feature of CCNode Here's a sample code of traversing children array:

CCNode* node = NULL;

CCARRAY_FOREACH(parent->getChildren(), node)

{

node->setPosition(0,0);

}

This sample code traverses all children nodes, and set theie position to (0,0)

Returns: An array of children

var getChildren ( )

virtual

Return an array of children.

Composing a "tree" structure is a very important feature of CCNode Here's a sample code of traversing children array:

CCNode* node = NULL;

CCARRAY_FOREACH(parent->getChildren(), node)

{

node->setPosition(0,0);

}

This sample code traverses all children nodes, and set theie position to (0,0)

Returns: An array of children

local getChildren ( )

virtual

Return an array of children.

Composing a "tree" structure is a very important feature of CCNode Here's a sample code of traversing children array:

CCNode* node = NULL;

CCARRAY_FOREACH(parent->getChildren(), node)

{

node->setPosition(0,0);

}

This sample code traverses all children nodes, and set theie position to (0,0)

Returns: An array of children

unsigned int getChildrenCount ( void ) const

Get the amount of children.

Returns: The amount of children.

var getChildrenCount ( )

Get the amount of children.

Returns: The amount of children.

local getChildrenCount ( )

Get the amount of children.

Returns: The amount of children.

virtual const ccColor3B& getColor ( void )

virtual

Returns color that is currently used.

Returns: The ccColor3B contains R,G,B bytes.

Implements CCRGBAProtocol.

Reimplemented in CCScale9Sprite, CCAtlasNode, and CCProgressTimer.

var getColor ( )

virtual

Returns color that is currently used.

Returns: The ccColor3B contains R,G,B bytes.

Implements CCRGBAProtocol.

Reimplemented in CCScale9Sprite, CCAtlasNode, and CCProgressTimer.

local getColor ( )

virtual

Returns color that is currently used.

Returns: The ccColor3B contains R,G,B bytes.

Implements CCRGBAProtocol.

Reimplemented in CCScale9Sprite, CCAtlasNode, and CCProgressTimer.

CCComponent* getComponent ( const char * pName) const

gets a component by its name

var getComponent ( var pName)

gets a component by its name

local getComponent ( local pName)

gets a component by its name

virtual const CCSize&
getContentSize ( ) const

virtual

Returns the untransformed size of the node.

See Also: setContentSize(const CCSize&)

Returns: The untransformed size of the node.

Reimplemented in CCScrollView.

var getContentSize ( )

virtual

Returns the untransformed size of the node.

See Also: setContentSize(const CCSize&)

Returns: The untransformed size of the node.

Reimplemented in CCScrollView.

local getContentSize ( )

virtual

Returns the untransformed size of the node.

See Also: setContentSize(const CCSize&)

Returns: The untransformed size of the node.

Reimplemented in CCScrollView.

virtual const ccColor3B&
getDisplayedColor ( )

virtual

Returns the displayed color.

Returns: The ccColor3B contains R,G,B bytes.

Implements CCRGBAProtocol.

var getDisplayedColor ( )

virtual

Returns the displayed color.

Returns: The ccColor3B contains R,G,B bytes.

Implements CCRGBAProtocol.

local getDisplayedColor ( )

virtual

Returns the displayed color.

Returns: The ccColor3B contains R,G,B bytes.

Implements CCRGBAProtocol.

virtual GLubyte getDisplayedOpacity ( )

virtual

Returns the displayed opacity.

Returns: The opacity of sprite, from 0 ~ 255

Implements CCRGBAProtocol.

var getDisplayedOpacity ( )

virtual

Returns the displayed opacity.

Returns: The opacity of sprite, from 0 ~ 255

Implements CCRGBAProtocol.

local getDisplayedOpacity ( )

virtual

Returns the displayed opacity.

Returns: The opacity of sprite, from 0 ~ 255

Implements CCRGBAProtocol.

virtual ccGLServerState
getGLServerState ( )

virtual

Returns the state of OpenGL server side.

Returns: The state of OpenGL server side.

local getGLServerState ( )

virtual

Returns the state of OpenGL server side.

Returns: The state of OpenGL server side.

virtual CCGridBase* getGrid ( )

virtual

Returns a grid object that is used when applying effects.

Returns: A CCGrid object that is used when applying effects

local getGrid ( )

virtual

Returns a grid object that is used when applying effects.

Returns: A CCGrid object that is used when applying effects

virtual GLubyte getOpacity ( )

virtual

Returns the opacity.

The opacity which indicates how transparent or opaque this node is. 0 indicates fully transparent and 255 is fully opaque.

Returns: The opacity of sprite, from 0 ~ 255

Implements CCRGBAProtocol.

Reimplemented in CCScale9Sprite, CCProgressTimer, and CCMotionStreak.

var getOpacity ( )

virtual

Returns the opacity.

The opacity which indicates how transparent or opaque this node is. 0 indicates fully transparent and 255 is fully opaque.

Returns: The opacity of sprite, from 0 ~ 255

Implements CCRGBAProtocol.

Reimplemented in CCScale9Sprite, CCProgressTimer, and CCMotionStreak.

local getOpacity ( )

virtual

Returns the opacity.

The opacity which indicates how transparent or opaque this node is. 0 indicates fully transparent and 255 is fully opaque.

Returns: The opacity of sprite, from 0 ~ 255

Implements CCRGBAProtocol.

Reimplemented in CCScale9Sprite, CCProgressTimer, and CCMotionStreak.

virtual unsigned int
getOrderOfArrival ( )

virtual

Returns the arrival order, indecates which children is added previously.

See Also: setOrderOfArrival(unsigned int)

Returns: The arrival order.

var getOrderOfArrival ( )

virtual

Returns the arrival order, indecates which children is added previously.

See Also: setOrderOfArrival(unsigned int)

Returns: The arrival order.

local getOrderOfArrival ( )

virtual

Returns the arrival order, indecates which children is added previously.

See Also: setOrderOfArrival(unsigned int)

Returns: The arrival order.

virtual CCNode* getParent ( )

virtual

Returns a pointer to the parent node.

See Also: setParent(CCNode*)

Returns: A pointer to the parnet node

var getParent ( )

virtual

Returns a pointer to the parent node.

See Also: setParent(CCNode*)

Returns: A pointer to the parnet node

local getParent ( )

virtual

Returns a pointer to the parent node.

See Also: setParent(CCNode*)

Returns: A pointer to the parnet node

virtual const CCPoint& getPosition ( )

virtual

Gets the position (x,y) of the node in OpenGL coordinates.

See Also: setPosition(const CCPoint&)

Returns: The position (x,y) of the node in OpenGL coordinates

Reimplemented in CCPhysicsSprite.

var getPosition ( )

virtual

Gets the position (x,y) of the node in OpenGL coordinates.

See Also: setPosition(const CCPoint&)

Returns: The position (x,y) of the node in OpenGL coordinates

Reimplemented in CCPhysicsSprite.

local getPosition ( )

virtual

Gets the position (x,y) of the node in OpenGL coordinates.

See Also: setPosition(const CCPoint&)

Returns: The position (x,y) of the node in OpenGL coordinates

Reimplemented in CCPhysicsSprite.

virtual void getPosition ( float * x,

float * y

)

virtual

Gets position in a more efficient way, returns two number instead of a CCPoint object.

See Also: setPosition(float, float)

Reimplemented in CCPhysicsSprite.

var getPosition ( var x,

var y

)

virtual

Gets position in a more efficient way, returns two number instead of a CCPoint object.

See Also: setPosition(float, float)

Reimplemented in CCPhysicsSprite.

local getPosition ( local x,

local y

)

virtual

Gets position in a more efficient way, returns two number instead of a CCPoint object.

See Also: setPosition(float, float)

Reimplemented in CCPhysicsSprite.

virtual float getPositionX ( void )

virtual

Reimplemented in CCPhysicsSprite.

var getPositionX ( )

virtual

Reimplemented in CCPhysicsSprite.

local getPositionX ( )

virtual

Reimplemented in CCPhysicsSprite.

virtual float getPositionY ( void )

virtual

Reimplemented in CCPhysicsSprite.

var getPositionY ( )

virtual

Reimplemented in CCPhysicsSprite.

local getPositionY ( )

virtual

Reimplemented in CCPhysicsSprite.

virtual float getRotation ( )

virtual

Returns the rotation of the node in degrees.

See Also: setRotation(float)

Returns: The rotation of the node in degrees.

Reimplemented in CCPhysicsSprite.

var getRotation ( )

virtual

Returns the rotation of the node in degrees.

See Also: setRotation(float)

Returns: The rotation of the node in degrees.

Reimplemented in CCPhysicsSprite.

local getRotation ( )

virtual

Returns the rotation of the node in degrees.

See Also: setRotation(float)

Returns: The rotation of the node in degrees.

Reimplemented in CCPhysicsSprite.

virtual float getRotationX ( )

virtual

Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew.

See Also: setRotationX(float)

Returns: The X rotation in degrees.

var getRotationX ( )

virtual

Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew.

See Also: setRotationX(float)

Returns: The X rotation in degrees.

local getRotationX ( )

virtual

Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew.

See Also: setRotationX(float)

Returns: The X rotation in degrees.

virtual float getRotationY ( )

virtual

Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew.

See Also: setRotationY(float)

Returns: The Y rotation in degrees.

var getRotationY ( )

virtual

Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew.

See Also: setRotationY(float)

Returns: The Y rotation in degrees.

local getRotationY ( )

virtual

Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew.

See Also: setRotationY(float)

Returns: The Y rotation in degrees.

virtual float getScale ( )

virtual

Gets the scale factor of the node, when X and Y have the same scale factor.

Warning: Assert when m_fScaleX != m_fScaleY.

See Also: setScale(float)

Returns: The scale factor of the node.

var getScale ( )

virtual

Gets the scale factor of the node, when X and Y have the same scale factor.

Warning: Assert when m_fScaleX != m_fScaleY.

See Also: setScale(float)

Returns: The scale factor of the node.

local getScale ( )

virtual

Gets the scale factor of the node, when X and Y have the same scale factor.

Warning: Assert when m_fScaleX != m_fScaleY.

See Also: setScale(float)

Returns: The scale factor of the node.

virtual float getScaleX ( )

virtual

Returns the scale factor on X axis of this node.

See Also: setScaleX(float)

Returns: The scale factor on X axis.

var getScaleX ( )

virtual

Returns the scale factor on X axis of this node.

See Also: setScaleX(float)

Returns: The scale factor on X axis.

local getScaleX ( )

virtual

Returns the scale factor on X axis of this node.

See Also: setScaleX(float)

Returns: The scale factor on X axis.

virtual float getScaleY ( )

virtual

Returns the scale factor on Y axis of this node.

See Also: setScaleY(float)

Returns: The scale factor on Y axis.

var getScaleY ( )

virtual

Returns the scale factor on Y axis of this node.

See Also: setScaleY(float)

Returns: The scale factor on Y axis.

local getScaleY ( )

virtual

Returns the scale factor on Y axis of this node.

See Also: setScaleY(float)

Returns: The scale factor on Y axis.

virtual CCScheduler* getScheduler ( )

virtual

Gets a CCSheduler object.

See Also: setScheduler(CCScheduler*)

Returns: A CCScheduler object.

local getScheduler ( )

virtual

Gets a CCSheduler object.

See Also: setScheduler(CCScheduler*)

Returns: A CCScheduler object.

int getScriptHandler ( )

inline

Gets script handler for onEnter/onExit event.

This is an internal method. g

See Also: registerScriptHandler(int)

Returns: A number that indicates a lua function.

var getScriptHandler ( )

inline

Gets script handler for onEnter/onExit event.

This is an internal method. g

See Also: registerScriptHandler(int)

Returns: A number that indicates a lua function.

local getScriptHandler ( )

inline

Gets script handler for onEnter/onExit event.

This is an internal method. g

See Also: registerScriptHandler(int)

Returns: A number that indicates a lua function.

virtual CCGLProgram*
getShaderProgram ( )

virtual

Return the shader program currently used for this node.

Returns: The shader program currelty used for this node

var getShaderProgram ( )

virtual

Return the shader program currently used for this node.

Returns: The shader program currelty used for this node

local getShaderProgram ( )

virtual

Return the shader program currently used for this node.

Returns: The shader program currelty used for this node

virtual float getSkewX ( )

virtual

Returns the X skew angle of the node in degrees.

See Also: setSkewX(float)

Returns: The X skew angle of the node in degrees.

var getSkewX ( )

virtual

Returns the X skew angle of the node in degrees.

See Also: setSkewX(float)

Returns: The X skew angle of the node in degrees.

local getSkewX ( )

virtual

Returns the X skew angle of the node in degrees.

See Also: setSkewX(float)

Returns: The X skew angle of the node in degrees.

virtual float getSkewY ( )

virtual

Returns the Y skew angle of the node in degrees.

See Also: setSkewY(float)

Returns: The Y skew angle of the node in degrees.

var getSkewY ( )

virtual

Returns the Y skew angle of the node in degrees.

See Also: setSkewY(float)

Returns: The Y skew angle of the node in degrees.

local getSkewY ( )

virtual

Returns the Y skew angle of the node in degrees.

See Also: setSkewY(float)

Returns: The Y skew angle of the node in degrees.

virtual int getTag ( ) const

virtual

Returns a tag that is used to identify the node easily.

You can set tags to node then identify them easily.

#define TAG_PLAYER 1

#define TAG_MONSTER 2

#define TAG_BOSS 3

// set tags

node1->setTag(TAG_PLAYER);

node2->setTag(TAG_MONSTER);

node3->setTag(TAG_BOSS);

parent->addChild(node1);

parent->addChild(node2);

parent->addChild(node3);

// identify by tags

CCNode* node = NULL;

CCARRAY_FOREACH(parent->getChildren(), node)

{

switch(node->getTag())

{

case TAG_PLAYER:

break;

case TAG_MONSTER:

break;

case TAG_BOSS:

break;

}

Returns: A interger that identifies the node.

var getTag ( )

virtual

Returns a tag that is used to identify the node easily.

You can set tags to node then identify them easily.

#define TAG_PLAYER 1

#define TAG_MONSTER 2

#define TAG_BOSS 3

// set tags

node1->setTag(TAG_PLAYER);

node2->setTag(TAG_MONSTER);

node3->setTag(TAG_BOSS);

parent->addChild(node1);

parent->addChild(node2);

parent->addChild(node3);

// identify by tags

CCNode* node = NULL;

CCARRAY_FOREACH(parent->getChildren(), node)

{

switch(node->getTag())

{

case TAG_PLAYER:

break;

case TAG_MONSTER:

break;

case TAG_BOSS:

break;

}

Returns: A interger that identifies the node.

local getTag ( )

virtual

Returns a tag that is used to identify the node easily.

You can set tags to node then identify them easily.

#define TAG_PLAYER 1

#define TAG_MONSTER 2

#define TAG_BOSS 3

// set tags

node1->setTag(TAG_PLAYER);

node2->setTag(TAG_MONSTER);

node3->setTag(TAG_BOSS);

parent->addChild(node1);

parent->addChild(node2);

parent->addChild(node3);

// identify by tags

CCNode* node = NULL;

CCARRAY_FOREACH(parent->getChildren(), node)

{

switch(node->getTag())

{

case TAG_PLAYER:

break;

case TAG_MONSTER:

break;

case TAG_BOSS:

break;

}

Returns: A interger that identifies the node.

virtual void* getUserData ( )

virtual

Returns a custom user data pointer.

You can set everything in UserData pointer, a data block, a structure or an object.

Returns: A custom user data pointer

local getUserData ( )

virtual

Returns a custom user data pointer.

You can set everything in UserData pointer, a data block, a structure or an object.

Returns: A custom user data pointer

virtual CCObject* getUserObject ( )

virtual

Returns a user assigned CCObject.

Similar to userData, but instead of holding a void* it holds an object

Returns: A user assigned CCObject

local getUserObject ( )

virtual

Returns a user assigned CCObject.

Similar to userData, but instead of holding a void* it holds an object

Returns: A user assigned CCObject

virtual float getVertexZ ( )

virtual

Gets OpenGL Z vertex of this node.

See Also: setVertexZ(float)

Returns: OpenGL Z vertex of this node

var getVertexZ ( )

virtual

Gets OpenGL Z vertex of this node.

See Also: setVertexZ(float)

Returns: OpenGL Z vertex of this node

local getVertexZ ( )

virtual

Gets OpenGL Z vertex of this node.

See Also: setVertexZ(float)

Returns: OpenGL Z vertex of this node

virtual int getZOrder ( )

virtual

Gets the Z order of this node.

See Also: setZOrder(int)

Returns: The Z order.

var getZOrder ( )

virtual

Gets the Z order of this node.

See Also: setZOrder(int)

Returns: The Z order.

local getZOrder ( )

virtual

Gets the Z order of this node.

See Also: setZOrder(int)

Returns: The Z order.

virtual void
ignoreAnchorPointForPosition ( bool ignore)

virtual

Sets whether the anchor point will be (0,0) when you position this node.

This is an internal method, only used by CCLayer and CCScene. Don't call it outside framework. The default value is false, while in CCLayer and CCScene are true

Parameters: ignore true if anchor point will be (0,0) when you position this node

Todo:: This method shoud be renamed as setIgnoreAnchorPointForPosition(bool) or something with "set"

Reimplemented in CCSprite.

var ignoreAnchorPointForPosition ( var ignore)

virtual

Sets whether the anchor point will be (0,0) when you position this node.

This is an internal method, only used by CCLayer and CCScene. Don't call it outside framework. The default value is false, while in CCLayer and CCScene are true

Parameters: ignore true if anchor point will be (0,0) when you position this node

Todo:: This method shoud be renamed as setIgnoreAnchorPointForPosition(bool) or something with "set"

Reimplemented in CCSprite.

local ignoreAnchorPointForPosition ( local ignore)

virtual

Sets whether the anchor point will be (0,0) when you position this node.

This is an internal method, only used by CCLayer and CCScene. Don't call it outside framework. The default value is false, while in CCLayer and CCScene are true

Parameters: ignore true if anchor point will be (0,0) when you position this node

Todo:: This method shoud be renamed as setIgnoreAnchorPointForPosition(bool) or something with "set"

Reimplemented in CCSprite.

virtual bool init ( )

virtual

Initializes the instance of CCNode.

Returns: Whether the initialization was successful.

Reimplemented in CCNodeRGBA, CCParticleSystem, CCMenuItemImage, CCLayerGradient, CCLayerColor, UIRectClippingNode, CCParticleRain, CCParticleSnow, CCLabelBMFont, CCLayerRGBA, CCParticleSmoke, CCParticleExplosion, CCSprite, CCParticleSpiral, CCParticleMeteor, CCLabelTTF, CCControl, CCParticleFlower, CCControlButton, CCSpriteBatchNode, CCScale9Sprite, CCParticleGalaxy, CCMenu, CCParticleSun, CCScrollView, CCLayer, CCArmature, CCParticleFireworks, CCBone, CCControlColourPicker, CCClippingNode, CCDrawNode, CCScene, UILayer, CCParticleFire, CCBatchNode, and ModalLayer.

var init ( )

virtual

Initializes the instance of CCNode.

Returns: Whether the initialization was successful.

Reimplemented in CCNodeRGBA, CCParticleSystem, CCMenuItemImage, CCLayerGradient, CCLayerColor, UIRectClippingNode, CCParticleRain, CCParticleSnow, CCLabelBMFont, CCLayerRGBA, CCParticleSmoke, CCParticleExplosion, CCSprite, CCParticleSpiral, CCParticleMeteor, CCLabelTTF, CCControl, CCParticleFlower, CCControlButton, CCSpriteBatchNode, CCScale9Sprite, CCParticleGalaxy, CCMenu, CCParticleSun, CCScrollView, CCLayer, CCArmature, CCParticleFireworks, CCBone, CCControlColourPicker, CCClippingNode, CCDrawNode, CCScene, UILayer, CCParticleFire, CCBatchNode, and ModalLayer.

local init ( )

virtual

Initializes the instance of CCNode.

Returns: Whether the initialization was successful.

Reimplemented in CCNodeRGBA, CCParticleSystem, CCMenuItemImage, CCLayerGradient, CCLayerColor, UIRectClippingNode, CCParticleRain, CCParticleSnow, CCLabelBMFont, CCLayerRGBA, CCParticleSmoke, CCParticleExplosion, CCSprite, CCParticleSpiral, CCParticleMeteor, CCLabelTTF, CCControl, CCParticleFlower, CCControlButton, CCSpriteBatchNode, CCScale9Sprite, CCParticleGalaxy, CCMenu, CCParticleSun, CCScrollView, CCLayer, CCArmature, CCParticleFireworks, CCBone, CCControlColourPicker, CCClippingNode, CCDrawNode, CCScene, UILayer, CCParticleFire, CCBatchNode, and ModalLayer.

virtual bool init ( )

virtual

Initializes the instance of CCNode.

Returns: Whether the initialization was successful.

Reimplemented from CCNode.

Reimplemented in CCMenuItemImage, CCSprite, CCLabelTTF, CCScale9Sprite, CCArmature, and CCBone.

var init ( )

virtual

Initializes the instance of CCNode.

Returns: Whether the initialization was successful.

Reimplemented from CCNode.

Reimplemented in CCMenuItemImage, CCSprite, CCLabelTTF, CCScale9Sprite, CCArmature, and CCBone.

local init ( )

virtual

Initializes the instance of CCNode.

Returns: Whether the initialization was successful.

Reimplemented from CCNode.

Reimplemented in CCMenuItemImage, CCSprite, CCLabelTTF, CCScale9Sprite, CCArmature, and CCBone.

virtual bool isCascadeColorEnabled ( )

virtual

whether or not color should be propagated to its children.

Implements CCRGBAProtocol.

var isCascadeColorEnabled ( )

virtual

whether or not color should be propagated to its children.

Implements CCRGBAProtocol.

local isCascadeColorEnabled ( )

virtual

whether or not color should be propagated to its children.

Implements CCRGBAProtocol.

virtual bool
isCascadeOpacityEnabled ( )

virtual

whether or not opacity should be propagated to its children.

Implements CCRGBAProtocol.

var isCascadeOpacityEnabled ( )

virtual

whether or not opacity should be propagated to its children.

Implements CCRGBAProtocol.

local isCascadeOpacityEnabled ( )

virtual

whether or not opacity should be propagated to its children.

Implements CCRGBAProtocol.

virtual bool
isIgnoreAnchorPointForPosition ( )

virtual

Gets whether the anchor point will be (0,0) when you position this node.

See Also: ignoreAnchorPointForPosition(bool)

Returns: true if the anchor point will be (0,0) when you position this node.

var isIgnoreAnchorPointForPosition ( )

virtual

Gets whether the anchor point will be (0,0) when you position this node.

See Also: ignoreAnchorPointForPosition(bool)

Returns: true if the anchor point will be (0,0) when you position this node.

local
isIgnoreAnchorPointForPosition ( )

virtual

Gets whether the anchor point will be (0,0) when you position this node.

See Also: ignoreAnchorPointForPosition(bool)

Returns: true if the anchor point will be (0,0) when you position this node.

virtual bool isOpacityModifyRGB ( )

inlinevirtual

Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity)

Returns: Returns opacity modify flag.

Implements CCRGBAProtocol.

Reimplemented in CCSprite, CCScale9Sprite, CCAtlasNode, CCMotionStreak, and CCSkeleton.

var isOpacityModifyRGB ( )

inlinevirtual

Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity)

Returns: Returns opacity modify flag.

Implements CCRGBAProtocol.

Reimplemented in CCSprite, CCScale9Sprite, CCAtlasNode, CCMotionStreak, and CCSkeleton.

local isOpacityModifyRGB ( )

inlinevirtual

Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity)

Returns: Returns opacity modify flag.

Implements CCRGBAProtocol.

Reimplemented in CCSprite, CCScale9Sprite, CCAtlasNode, CCMotionStreak, and CCSkeleton.

virtual bool isRunning ( )

virtual

Returns whether or not the node accepts event callbacks.

Running means the node accept event callbacks like onEnter(), onExit(), update()

Returns: Whether or not the node is running.

var isRunning ( )

virtual

Returns whether or not the node accepts event callbacks.

Running means the node accept event callbacks like onEnter(), onExit(), update()

Returns: Whether or not the node is running.

local isRunning ( )

virtual

Returns whether or not the node accepts event callbacks.

Running means the node accept event callbacks like onEnter(), onExit(), update()

Returns: Whether or not the node is running.

bool isScheduled ( SEL_SCHEDULE selector)

Checks whether a selector is scheduled.

Parameters: selector A function selector

Returns: Whether the funcion selector is scheduled.

virtual bool isVisible ( )

virtual

Determines if the node is visible.

See Also: setVisible(bool)

Returns: true if the node is visible, false if the node is hidden.

var isVisible ( )

virtual

Determines if the node is visible.

See Also: setVisible(bool)

Returns: true if the node is visible, false if the node is hidden.

local isVisible ( )

virtual

Determines if the node is visible.

See Also: setVisible(bool)

Returns: true if the node is visible, false if the node is hidden.

virtual CCAffineTransform
nodeToParentTransform ( void )

virtual

Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates.

The matrix is in Pixels.

Reimplemented in CCArmature, and CCPhysicsSprite.

var nodeToParentTransform ( )

virtual

Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates.

The matrix is in Pixels.

Reimplemented in CCArmature, and CCPhysicsSprite.

local nodeToParentTransform ( )

virtual

Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates.

The matrix is in Pixels.

Reimplemented in CCArmature, and CCPhysicsSprite.

virtual CCAffineTransform
nodeToWorldTransform ( void )

virtual

Returns the world affine transform matrix.

The matrix is in Pixels.

Reimplemented in CCBone, and CCSkin.

var nodeToWorldTransform ( )

virtual

Returns the world affine transform matrix.

The matrix is in Pixels.

Reimplemented in CCBone, and CCSkin.

local nodeToWorldTransform ( )

virtual

Returns the world affine transform matrix.

The matrix is in Pixels.

Reimplemented in CCBone, and CCSkin.

unsigned int numberOfRunningActions ( void )

Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays).

Composable actions are counted as 1 action. Example: If you are running 1 Sequence of 7 actions, it will return 1. If you are running 7 Sequences of 2 actions, it will return 7.

Todo:: Rename to getNumberOfRunningActions()

Returns: The number of actions that are running plus the ones that are schedule to run

var numberOfRunningActions ( )

Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays).

Composable actions are counted as 1 action. Example: If you are running 1 Sequence of 7 actions, it will return 1. If you are running 7 Sequences of 2 actions, it will return 7.

Todo:: Rename to getNumberOfRunningActions()

Returns: The number of actions that are running plus the ones that are schedule to run

local numberOfRunningActions ( )

Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays).

Composable actions are counted as 1 action. Example: If you are running 1 Sequence of 7 actions, it will return 1. If you are running 7 Sequences of 2 actions, it will return 7.

Todo:: Rename to getNumberOfRunningActions()

Returns: The number of actions that are running plus the ones that are schedule to run

virtual void onEnter ( )

virtual

Event callback that is invoked every time when CCNode enters the 'stage'.

If the CCNode enters the 'stage' with a transition, this event is called when the transition starts. During onEnter you can't access a "sister/brother" node. If you override onEnter, you shall call its parent's one, e.g., CCNode::onEnter().

Reimplemented in CCTransitionFadeTR, CCTransitionSplitCols, CCTransitionTurnOffTiles, CCTransitionCrossFade, CCTransitionFade, CCTransitionZoomFlipAngular, CCTransitionZoomFlipY, CCTransitionZoomFlipX, CCTransitionFlipAngular, CCTransitionFlipY, CCTransitionFlipX, CCTransitionShrinkGrow, CCEditBox, CCTransitionSlideInL, CCTransitionMoveInL, CCTransitionJumpZoom, CCTransitionRotoZoom, CCControl, CCTransitionScene, CCTransitionPageTurn, CCLayer, CCClippingNode, UILayer, CCTransitionProgress, and UICCTextField.

virtual void
onEnterTransitionDidFinish ( )

virtual

Event callback that is invoked when the CCNode enters in the 'stage'.

If the CCNode enters the 'stage' with a transition, this event is called when the transition finishes. If you override onEnterTransitionDidFinish, you shall call its parent's one, e.g. CCNode::onEnterTransitionDidFinish()

Reimplemented in CCLayer, CCClippingNode, and UILayer.

virtual void onExit ( )

virtual

Event callback that is invoked every time the CCNode leaves the 'stage'.

If the CCNode leaves the 'stage' with a transition, this event is called when the transition finishes. During onExit you can't access a sibling node. If you override onExit, you shall call its parent's one, e.g., CCNode::onExit().

Reimplemented in CCTransitionCrossFade, CCTransitionFade, CCEditBox, CCMenu, CCControl, CCTransitionScene, CCClippingNode, CCLayer, UILayer, and CCTransitionProgress.

virtual void
onExitTransitionDidStart ( )

virtual

Event callback that is called every time the CCNode leaves the 'stage'.

If the CCNode leaves the 'stage' with a transition, this callback is called when the transition starts.

Reimplemented in CCClippingNode.

virtual CCAffineTransform
parentToNodeTransform ( void )

virtual

Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates.

The matrix is in Pixels.

var parentToNodeTransform ( )

virtual

Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates.

The matrix is in Pixels.

local parentToNodeTransform ( )

virtual

Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates.

The matrix is in Pixels.

void pauseSchedulerAndActions ( void )

Pauses all scheduled selectors and actions.

This method is called internally by onExit

virtual void registerScriptHandler ( int handler)

virtual

Registers a script function that will be called in onEnter() & onExit() seires functions.

This handler will be removed automatically after onExit() called.

-- lua sample

local function sceneEventHandler(eventType)

if eventType == kCCNodeOnEnter then

-- do something

elseif evetType == kCCNodeOnExit then

-- do something

end

scene::registerScriptHandler(sceneEventHandler)

Warning: This method is for internal usage, don't call it manually.

Todo:: Perhaps we should rename it to get/set/removeScriptHandler acoording to the function name style.

Parameters: handler A number that indicates a lua function.

var registerScriptHandler ( var handler)

virtual

Registers a script function that will be called in onEnter() & onExit() seires functions.

This handler will be removed automatically after onExit() called.

-- lua sample

local function sceneEventHandler(eventType)

if eventType == kCCNodeOnEnter then

-- do something

elseif evetType == kCCNodeOnExit then

-- do something

end

scene::registerScriptHandler(sceneEventHandler)

Warning: This method is for internal usage, don't call it manually.

Todo:: Perhaps we should rename it to get/set/removeScriptHandler acoording to the function name style.

Parameters: handler A number that indicates a lua function.

local registerScriptHandler ( local handler)

virtual

Registers a script function that will be called in onEnter() & onExit() seires functions.

This handler will be removed automatically after onExit() called.

-- lua sample

local function sceneEventHandler(eventType)

if eventType == kCCNodeOnEnter then

-- do something

elseif evetType == kCCNodeOnExit then

-- do something

end

scene::registerScriptHandler(sceneEventHandler)

Warning: This method is for internal usage, don't call it manually.

Todo:: Perhaps we should rename it to get/set/removeScriptHandler acoording to the function name style.

Parameters: handler A number that indicates a lua function.

virtual void removeAllChildren ( )

virtual

Removes all children from the container with a cleanup.

See Also: removeAllChildrenWithCleanup(bool)

var removeAllChildren ( )

virtual

Removes all children from the container with a cleanup.

See Also: removeAllChildrenWithCleanup(bool)

local removeAllChildren ( )

virtual

Removes all children from the container with a cleanup.

See Also: removeAllChildrenWithCleanup(bool)

virtual void
removeAllChildrenWithCleanup ( bool cleanup)

virtual

Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.

Parameters: cleanup true if all running actions on all children nodes should be cleanup, false oterwise.

Reimplemented in CCSprite, CCSpriteBatchNode, CCParticleBatchNode, and CCParallaxNode.

var removeAllChildren ( var cleanup)

virtual

Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.

Parameters: cleanup true if all running actions on all children nodes should be cleanup, false oterwise.

Reimplemented in CCSprite, CCSpriteBatchNode, CCParticleBatchNode, and CCParallaxNode.

local removeAllChildrenWithCleanup ( local cleanup)

virtual

Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.

Parameters: cleanup true if all running actions on all children nodes should be cleanup, false oterwise.

Reimplemented in CCSprite, CCSpriteBatchNode, CCParticleBatchNode, and CCParallaxNode.

virtual void removeAllComponents ( )

virtual

removes all components

var removeAllComponents ( )

virtual

removes all components

local removeAllComponents ( )

virtual

removes all components

virtual void removeChild ( CCNode * child)

virtual

Removes a child from the container with a cleanup.

See Also: removeChild(CCNode, bool)

Parameters: child The child node which will be removed.

var removeChild ( var child)

virtual

Removes a child from the container with a cleanup.

See Also: removeChild(CCNode, bool)

Parameters: child The child node which will be removed.

local removeChild ( local child)

virtual

Removes a child from the container with a cleanup.

See Also: removeChild(CCNode, bool)

Parameters: child The child node which will be removed.

virtual void removeChild ( CCNode * child,

bool cleanup

)

virtual

Removes a child from the container.

It will also cleanup all running actions depending on the cleanup parameter.

Parameters: child The child node which will be removed.

cleanup true if all running actions and callbacks on the child node will be cleanup, false otherwise.

Reimplemented in CCSprite, CCTMXLayer, CCMenu, CCSpriteBatchNode, CCParticleBatchNode, CCParallaxNode, and CCBatchNode.

var removeChild ( var child,

var cleanup

)

virtual

Removes a child from the container.

It will also cleanup all running actions depending on the cleanup parameter.

Parameters: child The child node which will be removed.

cleanup true if all running actions and callbacks on the child node will be cleanup, false otherwise.

Reimplemented in CCSprite, CCTMXLayer, CCMenu, CCSpriteBatchNode, CCParticleBatchNode, CCParallaxNode, and CCBatchNode.

local removeChild ( local child,

local cleanup

)

virtual

Removes a child from the container.

It will also cleanup all running actions depending on the cleanup parameter.

Parameters: child The child node which will be removed.

cleanup true if all running actions and callbacks on the child node will be cleanup, false otherwise.

Reimplemented in CCSprite, CCTMXLayer, CCMenu, CCSpriteBatchNode, CCParticleBatchNode, CCParallaxNode, and CCBatchNode.

virtual void removeChildByTag ( int tag)

virtual

Removes a child from the container by tag value with a cleanup.

See Also: removeChildByTag(int, bool)

Parameters: tag An interger number that identifies a child node

var removeChildByTag ( var tag)

virtual

Removes a child from the container by tag value with a cleanup.

See Also: removeChildByTag(int, bool)

Parameters: tag An interger number that identifies a child node

local removeChildByTag ( local tag)

virtual

Removes a child from the container by tag value with a cleanup.

See Also: removeChildByTag(int, bool)

Parameters: tag An interger number that identifies a child node

virtual void removeChildByTag ( int tag,

bool cleanup

)

virtual

Removes a child from the container by tag value.

It will also cleanup all running actions depending on the cleanup parameter

Parameters: tag An interger number that identifies a child node

cleanup true if all running actions and callbacks on the child node will be cleanup, false otherwise.

var removeChildByTag ( var tag,

var cleanup

)

virtual

Removes a child from the container by tag value.

It will also cleanup all running actions depending on the cleanup parameter

Parameters: tag An interger number that identifies a child node

cleanup true if all running actions and callbacks on the child node will be cleanup, false otherwise.

local removeChildByTag ( local tag,

local cleanup

)

virtual

Removes a child from the container by tag value.

It will also cleanup all running actions depending on the cleanup parameter

Parameters: tag An interger number that identifies a child node

cleanup true if all running actions and callbacks on the child node will be cleanup, false otherwise.

virtual bool removeComponent ( const char * pName)

virtual

removes a component by its name

var removeComponent ( var pName)

virtual

removes a component by its name

local removeComponent ( local pName)

virtual

removes a component by its name

virtual void removeFromParent ( )

virtual

Removes this node itself from its parent node with a cleanup.

If the node orphan, then nothing happens.

See Also: removeFromParentAndCleanup(bool)

var removeFromParent ( )

virtual

Removes this node itself from its parent node with a cleanup.

If the node orphan, then nothing happens.

See Also: removeFromParentAndCleanup(bool)

local removeFromParent ( )

virtual

Removes this node itself from its parent node with a cleanup.

If the node orphan, then nothing happens.

See Also: removeFromParentAndCleanup(bool)

virtual void
removeFromParentAndCleanup ( bool cleanup)

virtual

Removes this node itself from its parent node.

If the node orphan, then nothing happens.

Parameters: cleanup true if all actions and callbacks on this node should be removed, false otherwise.

var removeFromParent ( var cleanup)

virtual

Removes this node itself from its parent node.

If the node orphan, then nothing happens.

Parameters: cleanup true if all actions and callbacks on this node should be removed, false otherwise.

local removeFromParentAndCleanup ( local cleanup)

virtual

Removes this node itself from its parent node.

If the node orphan, then nothing happens.

Parameters: cleanup true if all actions and callbacks on this node should be removed, false otherwise.

virtual void reorderChild ( CCNode * child,

int zOrder

)

virtual

Reorders a child according to a new z value.

Parameters: child An already added child node. It MUST be already added.

zOrder Z order for drawing priority. Please refer to setZOrder(int)

Reimplemented in CCSprite, CCSpriteBatchNode, and CCParticleBatchNode.

var reorderChild ( var child,

var zOrder

)

virtual

Reorders a child according to a new z value.

Parameters: child An already added child node. It MUST be already added.

zOrder Z order for drawing priority. Please refer to setZOrder(int)

Reimplemented in CCSprite, CCSpriteBatchNode, and CCParticleBatchNode.

local reorderChild ( local child,

local zOrder

)

virtual

Reorders a child according to a new z value.

Parameters: child An already added child node. It MUST be already added.

zOrder Z order for drawing priority. Please refer to setZOrder(int)

Reimplemented in CCSprite, CCSpriteBatchNode, and CCParticleBatchNode.

void resumeSchedulerAndActions ( void )

Resumes all scheduled selectors and actions.

This method is called internally by onEnter

CCAction* runAction ( CCAction * action)

Executes an action, and returns the action that is executed.

This node becomes the action's target. Refer to CCAction::getTarget()

Warning: Actions don't retain their target.

Returns: An Action pointer

var runAction ( var action)

Executes an action, and returns the action that is executed.

This node becomes the action's target. Refer to CCAction::getTarget()

Warning: Actions don't retain their target.

Returns: An Action pointer

local runAction ( local action)

Executes an action, and returns the action that is executed.

This node becomes the action's target. Refer to CCAction::getTarget()

Warning: Actions don't retain their target.

Returns: An Action pointer

void schedule ( SEL_SCHEDULE selector,

float interval,

unsigned int repeat,

float delay

)

Schedules a custom selector.

If the selector is already scheduled, then the interval parameter will be updated without scheduling it again.

// firstly, implement a schedule function

void MyNode::TickMe(float dt);

// wrap this function into a selector via schedule_selector marco.

this->schedule(schedule_selector(MyNode::TickMe), 0, 0, 0);

Parameters: interval Tick interval in seconds. 0 means tick every frame. If interval = 0, it's recommended to use scheduleUpdate() instead.

repeat The selector will be excuted (repeat + 1) times, you can use kCCRepeatForever for tick infinitely.

delay The amount of time that the first tick will wait before execution.

var schedule ( var selector,

var interval,

var repeat,

var delay

)

Schedules a custom selector.

If the selector is already scheduled, then the interval parameter will be updated without scheduling it again.

// firstly, implement a schedule function

void MyNode::TickMe(float dt);

// wrap this function into a selector via schedule_selector marco.

this->schedule(schedule_selector(MyNode::TickMe), 0, 0, 0);

Parameters: interval Tick interval in seconds. 0 means tick every frame. If interval = 0, it's recommended to use scheduleUpdate() instead.

repeat The selector will be excuted (repeat + 1) times, you can use kCCRepeatForever for tick infinitely.

delay The amount of time that the first tick will wait before execution.

void schedule ( SEL_SCHEDULE selector,

float interval

)

Schedules a custom selector with an interval time in seconds.

See Also: schedule(SEL_SCHEDULE, float, unsigned int, float)

Parameters: selector A function wrapped as a selector

interval Callback interval time in seconds. 0 means tick every frame,

var schedule ( var selector,

var interval

)

Schedules a custom selector with an interval time in seconds.

See Also: schedule(SEL_SCHEDULE, float, unsigned int, float)

Parameters: selector A function wrapped as a selector

interval Callback interval time in seconds. 0 means tick every frame,

void schedule ( SEL_SCHEDULE selector)

Schedules a custom selector, the scheduled selector will be ticked every frame.

See Also: schedule(SEL_SCHEDULE, float, unsigned int, float)

Parameters: selector A function wrapped as a selector

var schedule ( var selector)

Schedules a custom selector, the scheduled selector will be ticked every frame.

See Also: schedule(SEL_SCHEDULE, float, unsigned int, float)

Parameters: selector A function wrapped as a selector

void scheduleOnce ( SEL_SCHEDULE selector,

float delay

)

Schedules a selector that runs only once, with a delay of 0 or larger.

See Also: schedule(SEL_SCHEDULE, float, unsigned int, float)

Parameters: selector A function wrapped as a selector

delay The amount of time that the first tick will wait before execution.

var scheduleOnce ( var selector,

var delay

)

Schedules a selector that runs only once, with a delay of 0 or larger.

See Also: schedule(SEL_SCHEDULE, float, unsigned int, float)

Parameters: selector A function wrapped as a selector

delay The amount of time that the first tick will wait before execution.

void scheduleUpdate ( void )

Schedules the "update" method.

It will use the order number 0. This method will be called every frame. Scheduled methods with a lower order value will be called before the ones that have a higher order value. Only one "update" method could be scheduled per node.

var scheduleUpdate ( )

Schedules the "update" method.

It will use the order number 0. This method will be called every frame. Scheduled methods with a lower order value will be called before the ones that have a higher order value. Only one "update" method could be scheduled per node.

void scheduleUpdateWithPriority ( int priority)

Schedules the "update" method with a custom priority.

This selector will be called every frame. Scheduled methods with a lower priority will be called before the ones that have a higher value. Only one "update" selector could be scheduled per node (You can't have 2 'update' selectors).

var scheduleUpdateWithPriority ( var priority)

Schedules the "update" method with a custom priority.

This selector will be called every frame. Scheduled methods with a lower priority will be called before the ones that have a higher value. Only one "update" selector could be scheduled per node (You can't have 2 'update' selectors).

void scheduleUpdateWithPriorityLua ( int nHandler,

int priority

)

Schedules for lua script.

local scheduleUpdateWithPriorityLua ( local nHandler,

local priority

)

Schedules for lua script.

virtual void setActionManager ( CCActionManager * actionManager)

virtual

Sets the CCActionManager object that is used by all actions.

Warning: If you set a new CCActionManager, then previously created actions will be removed.

Parameters: actionManager A CCActionManager object that is used by all actions.

var setActionManager ( var actionManager)

virtual

Sets the CCActionManager object that is used by all actions.

Warning: If you set a new CCActionManager, then previously created actions will be removed.

Parameters: actionManager A CCActionManager object that is used by all actions.

local setActionManager ( local actionManager)

virtual

Sets the CCActionManager object that is used by all actions.

Warning: If you set a new CCActionManager, then previously created actions will be removed.

Parameters: actionManager A CCActionManager object that is used by all actions.

void setAdditionalTransform ( const CCAffineTransform & additionalTransform)

Sets the additional transform.

Note: The additional transform will be concatenated at the end of nodeToParentTransform. It could be used to simulate parent-child relationship between two nodes (e.g. one is in BatchNode, another isn't).
// create a batchNode

CCSpriteBatchNode* batch= CCSpriteBatchNode::create("Icon-114.png");

this->addChild(batch);

// create two sprites, spriteA will be added to batchNode, they are using different textures.

CCSprite* spriteA = CCSprite::createWithTexture(batch->getTexture());

CCSprite* spriteB = CCSprite::create("Icon-72.png");

batch->addChild(spriteA);

// We can't make spriteB as spriteA's child since they use different textures. So just add it to layer.

// But we want to simulate `parent-child` relationship for these two node.

this->addChild(spriteB);

//position

spriteA->setPosition(ccp(200, 200));

// Gets the spriteA's transform.

CCAffineTransform t = spriteA->nodeToParentTransform();

// Sets the additional transform to spriteB, spriteB's postion will based on its pseudo parent i.e. spriteA.

spriteB->setAdditionalTransform(t);

//scale

spriteA->setScale(2);

// Gets the spriteA's transform.

t = spriteA->nodeToParentTransform();

// Sets the additional transform to spriteB, spriteB's scale will based on its pseudo parent i.e. spriteA.

spriteB->setAdditionalTransform(t);

//rotation

spriteA->setRotation(20);

// Gets the spriteA's transform.

t = spriteA->nodeToParentTransform();

// Sets the additional transform to spriteB, spriteB's rotation will based on its pseudo parent i.e. spriteA.

spriteB->setAdditionalTransform(t);

var setAdditionalTransform ( var additionalTransform)

Sets the additional transform.

Note: The additional transform will be concatenated at the end of nodeToParentTransform. It could be used to simulate parent-child relationship between two nodes (e.g. one is in BatchNode, another isn't).
// create a batchNode

CCSpriteBatchNode* batch= CCSpriteBatchNode::create("Icon-114.png");

this->addChild(batch);

// create two sprites, spriteA will be added to batchNode, they are using different textures.

CCSprite* spriteA = CCSprite::createWithTexture(batch->getTexture());

CCSprite* spriteB = CCSprite::create("Icon-72.png");

batch->addChild(spriteA);

// We can't make spriteB as spriteA's child since they use different textures. So just add it to layer.

// But we want to simulate `parent-child` relationship for these two node.

this->addChild(spriteB);

//position

spriteA->setPosition(ccp(200, 200));

// Gets the spriteA's transform.

CCAffineTransform t = spriteA->nodeToParentTransform();

// Sets the additional transform to spriteB, spriteB's postion will based on its pseudo parent i.e. spriteA.

spriteB->setAdditionalTransform(t);

//scale

spriteA->setScale(2);

// Gets the spriteA's transform.

t = spriteA->nodeToParentTransform();

// Sets the additional transform to spriteB, spriteB's scale will based on its pseudo parent i.e. spriteA.

spriteB->setAdditionalTransform(t);

//rotation

spriteA->setRotation(20);

// Gets the spriteA's transform.

t = spriteA->nodeToParentTransform();

// Sets the additional transform to spriteB, spriteB's rotation will based on its pseudo parent i.e. spriteA.

spriteB->setAdditionalTransform(t);

local setAdditionalTransform ( local additionalTransform)

Sets the additional transform.

Note: The additional transform will be concatenated at the end of nodeToParentTransform. It could be used to simulate parent-child relationship between two nodes (e.g. one is in BatchNode, another isn't).
// create a batchNode

CCSpriteBatchNode* batch= CCSpriteBatchNode::create("Icon-114.png");

this->addChild(batch);

// create two sprites, spriteA will be added to batchNode, they are using different textures.

CCSprite* spriteA = CCSprite::createWithTexture(batch->getTexture());

CCSprite* spriteB = CCSprite::create("Icon-72.png");

batch->addChild(spriteA);

// We can't make spriteB as spriteA's child since they use different textures. So just add it to layer.

// But we want to simulate `parent-child` relationship for these two node.

this->addChild(spriteB);

//position

spriteA->setPosition(ccp(200, 200));

// Gets the spriteA's transform.

CCAffineTransform t = spriteA->nodeToParentTransform();

// Sets the additional transform to spriteB, spriteB's postion will based on its pseudo parent i.e. spriteA.

spriteB->setAdditionalTransform(t);

//scale

spriteA->setScale(2);

// Gets the spriteA's transform.

t = spriteA->nodeToParentTransform();

// Sets the additional transform to spriteB, spriteB's scale will based on its pseudo parent i.e. spriteA.

spriteB->setAdditionalTransform(t);

//rotation

spriteA->setRotation(20);

// Gets the spriteA's transform.

t = spriteA->nodeToParentTransform();

// Sets the additional transform to spriteB, spriteB's rotation will based on its pseudo parent i.e. spriteA.

spriteB->setAdditionalTransform(t);

virtual void setAnchorPoint ( const CCPoint & anchorPoint)

virtual

Sets the anchor point in percent.

anchorPoint is the point around which all transformations and positioning manipulations take place. It's like a pin in the node where it is "attached" to its parent. The anchorPoint is normalized, like a percentage. (0,0) means the bottom-left corner and (1,1) means the top-right corner. But you can use values higher than (1,1) and lower than (0,0) too. The default anchorPoint is (0.5,0.5), so it starts in the center of the node.

Parameters: anchorPoint The anchor point of node.

Reimplemented in CCEditBox, CCSprite, and CCLabelBMFont.

var setAnchorPoint ( var anchorPoint)

virtual

Sets the anchor point in percent.

anchorPoint is the point around which all transformations and positioning manipulations take place. It's like a pin in the node where it is "attached" to its parent. The anchorPoint is normalized, like a percentage. (0,0) means the bottom-left corner and (1,1) means the top-right corner. But you can use values higher than (1,1) and lower than (0,0) too. The default anchorPoint is (0.5,0.5), so it starts in the center of the node.

Parameters: anchorPoint The anchor point of node.

Reimplemented in CCEditBox, CCSprite, and CCLabelBMFont.

local setAnchorPoint ( local anchorPoint)

virtual

Sets the anchor point in percent.

anchorPoint is the point around which all transformations and positioning manipulations take place. It's like a pin in the node where it is "attached" to its parent. The anchorPoint is normalized, like a percentage. (0,0) means the bottom-left corner and (1,1) means the top-right corner. But you can use values higher than (1,1) and lower than (0,0) too. The default anchorPoint is (0.5,0.5), so it starts in the center of the node.

Parameters: anchorPoint The anchor point of node.

Reimplemented in CCEditBox, CCSprite, and CCLabelBMFont.

virtual void setCascadeColorEnabled ( bool cascadeColorEnabled)

virtual

Implements CCRGBAProtocol.

var setCascadeColorEnabled ( var cascadeColorEnabled)

virtual

Implements CCRGBAProtocol.

local setCascadeColorEnabled ( local cascadeColorEnabled)

virtual

Implements CCRGBAProtocol.

virtual void
setCascadeOpacityEnabled ( bool cascadeOpacityEnabled)

virtual

Implements CCRGBAProtocol.

var setCascadeOpacityEnabled ( var cascadeOpacityEnabled)

virtual

Implements CCRGBAProtocol.

local setCascadeOpacityEnabled ( local cascadeOpacityEnabled)

virtual

Implements CCRGBAProtocol.

virtual void setColor ( const ccColor3B & color)

virtual

@

Implements CCRGBAProtocol.

Reimplemented in CCScale9Sprite, CCSprite, CCBone, CCAtlasNode, and CCProgressTimer.

var setColor ( var color)

virtual

@

Implements CCRGBAProtocol.

Reimplemented in CCScale9Sprite, CCSprite, CCBone, CCAtlasNode, and CCProgressTimer.

local setColor ( local color)

virtual

@

Implements CCRGBAProtocol.

Reimplemented in CCScale9Sprite, CCSprite, CCBone, CCAtlasNode, and CCProgressTimer.

virtual void setContentSize ( const CCSize & contentSize)

virtual

Sets the untransformed size of the node.

The contentSize remains the same no matter the node is scaled or rotated. All nodes has a size. Layer and Scene has the same size of the screen.

Parameters: contentSize The untransformed size of the node.

Reimplemented in CCEditBox, CCLayerColor, CCScrollView, and CCScale9Sprite.

var setContentSize ( var contentSize)

virtual

Sets the untransformed size of the node.

The contentSize remains the same no matter the node is scaled or rotated. All nodes has a size. Layer and Scene has the same size of the screen.

Parameters: contentSize The untransformed size of the node.

Reimplemented in CCEditBox, CCLayerColor, CCScrollView, and CCScale9Sprite.

local setContentSize ( local contentSize)

virtual

Sets the untransformed size of the node.

The contentSize remains the same no matter the node is scaled or rotated. All nodes has a size. Layer and Scene has the same size of the screen.

Parameters: contentSize The untransformed size of the node.

Reimplemented in CCEditBox, CCLayerColor, CCScrollView, and CCScale9Sprite.

virtual void setGLServerState ( ccGLServerState glServerState)

virtual

Sets the state of OpenGL server side.

Parameters: glServerState The state of OpenGL server side.

local setGLServerState ( local glServerState)

virtual

Sets the state of OpenGL server side.

Parameters: glServerState The state of OpenGL server side.

virtual void setGrid ( CCGridBase * pGrid)

virtual

Changes a grid object that is used when applying effects.

Parameters: A CCGrid object that is used when applying effects

var setGrid ( var pGrid)

virtual

Changes a grid object that is used when applying effects.

Parameters: A CCGrid object that is used when applying effects

local setGrid ( local pGrid)

virtual

Changes a grid object that is used when applying effects.

Parameters: A CCGrid object that is used when applying effects

virtual void setOpacity ( GLubyte opacity)

virtual

Changes the opacity.

Parameters: value Goes from 0 to 255, where 255 means fully opaque and 0 means fully transparent.

Implements CCRGBAProtocol.

Reimplemented in CCScale9Sprite, CCSprite, CCBone, CCAtlasNode, CCProgressTimer, and CCMotionStreak.

var setOpacity ( var opacity)

virtual

Changes the opacity.

Parameters: value Goes from 0 to 255, where 255 means fully opaque and 0 means fully transparent.

Implements CCRGBAProtocol.

Reimplemented in CCScale9Sprite, CCSprite, CCBone, CCAtlasNode, CCProgressTimer, and CCMotionStreak.

local setOpacity ( local opacity)

virtual

Changes the opacity.

Parameters: value Goes from 0 to 255, where 255 means fully opaque and 0 means fully transparent.

Implements CCRGBAProtocol.

Reimplemented in CCScale9Sprite, CCSprite, CCBone, CCAtlasNode, CCProgressTimer, and CCMotionStreak.

virtual void setOpacityModifyRGB ( bool bValue)

inlinevirtual

Changes the OpacityModifyRGB property.

If thie property is set to true, then the rendered color will be affected by opacity. Normally, r = r * opacity/255, g = g * opacity/255, b = b * opacity/255.

Parameters: bValue true then the opacity will be applied as: glColor(R,G,B,opacity); false then the opacity will be applied as: glColor(opacity, opacity, opacity, opacity);

Implements CCRGBAProtocol.

Reimplemented in CCSprite, CCScale9Sprite, CCAtlasNode, CCMotionStreak, and CCSkeleton.

var setOpacityModifyRGB ( var bValue)

inlinevirtual

Changes the OpacityModifyRGB property.

If thie property is set to true, then the rendered color will be affected by opacity. Normally, r = r * opacity/255, g = g * opacity/255, b = b * opacity/255.

Parameters: bValue true then the opacity will be applied as: glColor(R,G,B,opacity); false then the opacity will be applied as: glColor(opacity, opacity, opacity, opacity);

Implements CCRGBAProtocol.

Reimplemented in CCSprite, CCScale9Sprite, CCAtlasNode, CCMotionStreak, and CCSkeleton.

local setOpacityModifyRGB ( local bValue)

inlinevirtual

Changes the OpacityModifyRGB property.

If thie property is set to true, then the rendered color will be affected by opacity. Normally, r = r * opacity/255, g = g * opacity/255, b = b * opacity/255.

Parameters: bValue true then the opacity will be applied as: glColor(R,G,B,opacity); false then the opacity will be applied as: glColor(opacity, opacity, opacity, opacity);

Implements CCRGBAProtocol.

Reimplemented in CCSprite, CCScale9Sprite, CCAtlasNode, CCMotionStreak, and CCSkeleton.

virtual void setOrderOfArrival ( unsigned int uOrderOfArrival)

virtual

Sets the arrival order when this node has a same ZOrder with other children.

A node which called addChild subsequently will take a larger arrival order, If two children have the same Z order, the child with larger arrival order will be drawn later.

Warning: This method is used internally for zOrder sorting, don't change this manually

Parameters: uOrderOfArrival The arrival order.

var setOrderOfArrival ( var uOrderOfArrival)

virtual

Sets the arrival order when this node has a same ZOrder with other children.

A node which called addChild subsequently will take a larger arrival order, If two children have the same Z order, the child with larger arrival order will be drawn later.

Warning: This method is used internally for zOrder sorting, don't change this manually

Parameters: uOrderOfArrival The arrival order.

local setOrderOfArrival ( local uOrderOfArrival)

virtual

Sets the arrival order when this node has a same ZOrder with other children.

A node which called addChild subsequently will take a larger arrival order, If two children have the same Z order, the child with larger arrival order will be drawn later.

Warning: This method is used internally for zOrder sorting, don't change this manually

Parameters: uOrderOfArrival The arrival order.

virtual void setParent ( CCNode * parent)

virtual

Sets the parent node.

Parameters: parent A pointer to the parnet node

var setParent ( var parent)

virtual

Sets the parent node.

Parameters: parent A pointer to the parnet node

local setParent ( local parent)

virtual

Sets the parent node.

Parameters: parent A pointer to the parnet node

virtual void setPosition ( const CCPoint & position)

virtual

Changes the position (x,y) of the node in OpenGL coordinates.

Usually we use ccp(x,y) to compose CCPoint object. The original point (0,0) is at the left-bottom corner of screen. For example, this codesnip sets the node in the center of screen.

CCSize size = CCDirector::sharedDirector()->getWinSize();

node->setPosition( ccp(size.width/2, size.height/2) )

Parameters: position The position (x,y) of the node in OpenGL coordinates

Reimplemented in CCEditBox, CCSprite, CCPhysicsSprite, and CCMotionStreak.

local setPosition ( local position)

virtual

Changes the position (x,y) of the node in OpenGL coordinates.

Usually we use ccp(x,y) to compose CCPoint object. The original point (0,0) is at the left-bottom corner of screen. For example, this codesnip sets the node in the center of screen.

CCSize size = CCDirector::sharedDirector()->getWinSize();

node->setPosition( ccp(size.width/2, size.height/2) )

Parameters: position The position (x,y) of the node in OpenGL coordinates

Reimplemented in CCEditBox, CCSprite, CCPhysicsSprite, and CCMotionStreak.

virtual void setPosition ( float x,

float y

)

virtual

Sets position in a more efficient way.

Passing two numbers (x,y) is much efficient than passing CCPoint object. This method is binded to lua and javascript. Passing a number is 10 times faster than passing a object from lua to c++

// sample code in lua

local pos = node::getPosition() -- returns CCPoint object from C++

node:setPosition(x, y) -- pass x, y coordinate to C++

Parameters: x X coordinate for position

y Y coordinate for position

local setPosition ( local x,

local y

)

virtual

Sets position in a more efficient way.

Passing two numbers (x,y) is much efficient than passing CCPoint object. This method is binded to lua and javascript. Passing a number is 10 times faster than passing a object from lua to c++

// sample code in lua

local pos = node::getPosition() -- returns CCPoint object from C++

node:setPosition(x, y) -- pass x, y coordinate to C++

Parameters: x X coordinate for position

y Y coordinate for position

virtual void setPositionX ( float x)

virtual

Gets/Sets x or y coordinate individually for position.

These methods are used in Lua and Javascript Bindings

var setPositionX ( var x)

virtual

Gets/Sets x or y coordinate individually for position.

These methods are used in Lua and Javascript Bindings

local setPositionX ( local x)

virtual

Gets/Sets x or y coordinate individually for position.

These methods are used in Lua and Javascript Bindings

virtual void setPositionY ( float y)

virtual

var setPositionY ( var y)

virtual

local setPositionY ( local y)

virtual

virtual void setRotation ( float fRotation)

virtual

Sets the rotation (angle) of the node in degrees.

0 is the default rotation angle. Positive values rotate node clockwise, and negative values for anti-clockwise.

Parameters: fRotation The roration of the node in degrees.

Reimplemented in CCParticleSystem, CCSprite, and CCPhysicsSprite.

var setRotation ( var fRotation)

virtual

Sets the rotation (angle) of the node in degrees.

0 is the default rotation angle. Positive values rotate node clockwise, and negative values for anti-clockwise.

Parameters: fRotation The roration of the node in degrees.

Reimplemented in CCParticleSystem, CCSprite, and CCPhysicsSprite.

local setRotation ( local fRotation)

virtual

Sets the rotation (angle) of the node in degrees.

0 is the default rotation angle. Positive values rotate node clockwise, and negative values for anti-clockwise.

Parameters: fRotation The roration of the node in degrees.

Reimplemented in CCParticleSystem, CCSprite, and CCPhysicsSprite.

virtual void setRotationX ( float fRotaionX)

virtual

Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew.

0 is the default rotation angle. Positive values rotate node clockwise, and negative values for anti-clockwise.

Parameters: fRotationX The X rotation in degrees which performs a horizontal rotational skew.

Reimplemented in CCSprite.

var setRotationX ( var fRotaionX)

virtual

Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew.

0 is the default rotation angle. Positive values rotate node clockwise, and negative values for anti-clockwise.

Parameters: fRotationX The X rotation in degrees which performs a horizontal rotational skew.

Reimplemented in CCSprite.

local setRotationX ( local fRotaionX)

virtual

Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew.

0 is the default rotation angle. Positive values rotate node clockwise, and negative values for anti-clockwise.

Parameters: fRotationX The X rotation in degrees which performs a horizontal rotational skew.

Reimplemented in CCSprite.

virtual void setRotationY ( float fRotationY)

virtual

Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew.

0 is the default rotation angle. Positive values rotate node clockwise, and negative values for anti-clockwise.

Parameters: fRotationY The Y rotation in degrees.

Reimplemented in CCSprite.

var setRotationY ( var fRotationY)

virtual

Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew.

0 is the default rotation angle. Positive values rotate node clockwise, and negative values for anti-clockwise.

Parameters: fRotationY The Y rotation in degrees.

Reimplemented in CCSprite.

local setRotationY ( local fRotationY)

virtual

Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew.

0 is the default rotation angle. Positive values rotate node clockwise, and negative values for anti-clockwise.

Parameters: fRotationY The Y rotation in degrees.

Reimplemented in CCSprite.

virtual void setScale ( float scale)

virtual

Changes both X and Y scale factor of the node.

1.0 is the default scale factor. It modifies the X and Y scale at the same time.

Parameters: scale The scale factor for both X and Y axis.

Reimplemented in CCParticleSystem, CCSprite, and CCLabelBMFont.

var setScale ( var scale)

virtual

Changes both X and Y scale factor of the node.

1.0 is the default scale factor. It modifies the X and Y scale at the same time.

Parameters: scale The scale factor for both X and Y axis.

Reimplemented in CCParticleSystem, CCSprite, and CCLabelBMFont.

local setScale ( local scale)

virtual

Changes both X and Y scale factor of the node.

1.0 is the default scale factor. It modifies the X and Y scale at the same time.

Parameters: scale The scale factor for both X and Y axis.

Reimplemented in CCParticleSystem, CCSprite, and CCLabelBMFont.

virtual void setScale ( float fScaleX,

float fScaleY

)

virtual

Changes both X and Y scale factor of the node.

1.0 is the default scale factor. It modifies the X and Y scale at the same time.

Parameters: fScaleX The scale factor on X axis.

fScaleY The scale factor on Y axis.

var setScale ( var fScaleX,

var fScaleY

)

virtual

Changes both X and Y scale factor of the node.

1.0 is the default scale factor. It modifies the X and Y scale at the same time.

Parameters: fScaleX The scale factor on X axis.

fScaleY The scale factor on Y axis.

local setScale ( local fScaleX,

local fScaleY

)

virtual

Changes both X and Y scale factor of the node.

1.0 is the default scale factor. It modifies the X and Y scale at the same time.

Parameters: fScaleX The scale factor on X axis.

fScaleY The scale factor on Y axis.

virtual void setScaleX ( float fScaleX)

virtual

Changes the scale factor on X axis of this node.

The deafult value is 1.0 if you haven't changed it before

Parameters: fScaleX The scale factor on X axis.

Reimplemented in CCParticleSystem, CCSprite, and CCLabelBMFont.

var setScaleX ( var fScaleX)

virtual

Changes the scale factor on X axis of this node.

The deafult value is 1.0 if you haven't changed it before

Parameters: fScaleX The scale factor on X axis.

Reimplemented in CCParticleSystem, CCSprite, and CCLabelBMFont.

local setScaleX ( local fScaleX)

virtual

Changes the scale factor on X axis of this node.

The deafult value is 1.0 if you haven't changed it before

Parameters: fScaleX The scale factor on X axis.

Reimplemented in CCParticleSystem, CCSprite, and CCLabelBMFont.

virtual void setScaleY ( float fScaleY)

virtual

Changes the scale factor on Y axis of this node.

The Default value is 1.0 if you haven't changed it before.

Parameters: fScaleY The scale factor on Y axis.

Reimplemented in CCParticleSystem, CCSprite, and CCLabelBMFont.

var setScaleY ( var fScaleY)

virtual

Changes the scale factor on Y axis of this node.

The Default value is 1.0 if you haven't changed it before.

Parameters: fScaleY The scale factor on Y axis.

Reimplemented in CCParticleSystem, CCSprite, and CCLabelBMFont.

local setScaleY ( local fScaleY)

virtual

Changes the scale factor on Y axis of this node.

The Default value is 1.0 if you haven't changed it before.

Parameters: fScaleY The scale factor on Y axis.

Reimplemented in CCParticleSystem, CCSprite, and CCLabelBMFont.

virtual void setScheduler ( CCScheduler * scheduler)

virtual

Sets a CCScheduler object that is used to schedule all "updates" and timers.

Warning: If you set a new CCScheduler, then previously created timers/update are going to be removed.

Parameters: scheduler A CCShdeduler object that is used to schedule all "update" and timers.

local setScheduler ( local scheduler)

virtual

Sets a CCScheduler object that is used to schedule all "updates" and timers.

Warning: If you set a new CCScheduler, then previously created timers/update are going to be removed.

Parameters: scheduler A CCShdeduler object that is used to schedule all "update" and timers.

virtual void setShaderProgram ( CCGLProgram * pShaderProgram)

virtual

Sets the shader program for this node.

Since v2.0, each rendering node must set its shader program. It should be set in initialize phase.

node->setShaderProgram(CCShaderCache::sharedShaderCache()->programForKey(kCCShader_PositionTextureColor));

Parameters: The shader program which fetchs from CCShaderCache.

var setShaderProgram ( var pShaderProgram)

virtual

Sets the shader program for this node.

Since v2.0, each rendering node must set its shader program. It should be set in initialize phase.

node->setShaderProgram(CCShaderCache::sharedShaderCache()->programForKey(kCCShader_PositionTextureColor));

Parameters: The shader program which fetchs from CCShaderCache.

local setShaderProgram ( local pShaderProgram)

virtual

Sets the shader program for this node.

Since v2.0, each rendering node must set its shader program. It should be set in initialize phase.

node->setShaderProgram(CCShaderCache::sharedShaderCache()->programForKey(kCCShader_PositionTextureColor));

Parameters: The shader program which fetchs from CCShaderCache.

virtual void setSkewX ( float fSkewX)

virtual

Changes the X skew angle of the node in degrees.

This angle describes the shear distortion in the X direction. Thus, it is the angle between the Y axis and the left edge of the shape The default skewX angle is 0. Positive values distort the node in a CW direction.

Parameters: fSkewX The X skew angle of the node in degrees.

Reimplemented in CCSprite.

var setSkewX ( var fSkewX)

virtual

Changes the X skew angle of the node in degrees.

This angle describes the shear distortion in the X direction. Thus, it is the angle between the Y axis and the left edge of the shape The default skewX angle is 0. Positive values distort the node in a CW direction.

Parameters: fSkewX The X skew angle of the node in degrees.

Reimplemented in CCSprite.

local setSkewX ( local fSkewX)

virtual

Changes the X skew angle of the node in degrees.

This angle describes the shear distortion in the X direction. Thus, it is the angle between the Y axis and the left edge of the shape The default skewX angle is 0. Positive values distort the node in a CW direction.

Parameters: fSkewX The X skew angle of the node in degrees.

Reimplemented in CCSprite.

virtual void setSkewY ( float fSkewY)

virtual

Changes the Y skew angle of the node in degrees.

This angle describes the shear distortion in the Y direction. Thus, it is the angle between the X axis and the bottom edge of the shape The default skewY angle is 0. Positive values distort the node in a CCW direction.

Parameters: fSkewY The Y skew angle of the node in degrees.

Reimplemented in CCSprite.

var setSkewY ( var fSkewY)

virtual

Changes the Y skew angle of the node in degrees.

This angle describes the shear distortion in the Y direction. Thus, it is the angle between the X axis and the bottom edge of the shape The default skewY angle is 0. Positive values distort the node in a CCW direction.

Parameters: fSkewY The Y skew angle of the node in degrees.

Reimplemented in CCSprite.

local setSkewY ( local fSkewY)

virtual

Changes the Y skew angle of the node in degrees.

This angle describes the shear distortion in the Y direction. Thus, it is the angle between the X axis and the bottom edge of the shape The default skewY angle is 0. Positive values distort the node in a CCW direction.

Parameters: fSkewY The Y skew angle of the node in degrees.

Reimplemented in CCSprite.

virtual void setTag ( int nTag)

virtual

Changes the tag that is used to identify the node easily.

Please refer to getTag for the sample code.

Parameters: A interger that indentifies the node.

var setTag ( var nTag)

virtual

Changes the tag that is used to identify the node easily.

Please refer to getTag for the sample code.

Parameters: A interger that indentifies the node.

local setTag ( local nTag)

virtual

Changes the tag that is used to identify the node easily.

Please refer to getTag for the sample code.

Parameters: A interger that indentifies the node.

virtual void setUserData ( void * pUserData)

virtual

Sets a custom user data pointer.

You can set everything in UserData pointer, a data block, a structure or an object, etc.

Warning: Don't forget to release the memroy manually, especially before you change this data pointer, and before this node is autoreleased.

Returns: A custom user data pointer

local setUserData ( local pUserData)

virtual

Sets a custom user data pointer.

You can set everything in UserData pointer, a data block, a structure or an object, etc.

Warning: Don't forget to release the memroy manually, especially before you change this data pointer, and before this node is autoreleased.

Returns: A custom user data pointer

virtual void setUserObject ( CCObject * pUserObject)

virtual

Returns a user assigned CCObject.

Similar to UserData, but instead of holding a void* it holds an object. The UserObject will be retained once in this method, and the previous UserObject (if existed) will be relese. The UserObject will be released in CCNode's destructure.

Parameters: A user assigned CCObject

var setUserObject ( var pUserObject)

virtual

Returns a user assigned CCObject.

Similar to UserData, but instead of holding a void* it holds an object. The UserObject will be retained once in this method, and the previous UserObject (if existed) will be relese. The UserObject will be released in CCNode's destructure.

Parameters: A user assigned CCObject

local setUserObject ( local pUserObject)

virtual

Returns a user assigned CCObject.

Similar to UserData, but instead of holding a void* it holds an object. The UserObject will be retained once in this method, and the previous UserObject (if existed) will be relese. The UserObject will be released in CCNode's destructure.

Parameters: A user assigned CCObject

virtual void setVertexZ ( float vertexZ)

virtual

Sets the real OpenGL Z vertex.

Differences between openGL Z vertex and cocos2d Z order:

OpenGL Z modifies the Z vertex, and not the Z order in the relation between parent-children
OpenGL Z might require to set 2D projection
cocos2d Z order works OK if all the nodes uses the same openGL Z vertex. eg: vertexZ = 0

Warning: Use it at your own risk since it might break the cocos2d parent-children z order

Parameters: fVertexZ OpenGL Z vertex of this node.

Reimplemented in CCSprite.

var setVertexZ ( var vertexZ)

virtual

Sets the real OpenGL Z vertex.

Differences between openGL Z vertex and cocos2d Z order:

OpenGL Z modifies the Z vertex, and not the Z order in the relation between parent-children
OpenGL Z might require to set 2D projection
cocos2d Z order works OK if all the nodes uses the same openGL Z vertex. eg: vertexZ = 0

Warning: Use it at your own risk since it might break the cocos2d parent-children z order

Parameters: fVertexZ OpenGL Z vertex of this node.

Reimplemented in CCSprite.

local setVertexZ ( local vertexZ)

virtual

Sets the real OpenGL Z vertex.

Differences between openGL Z vertex and cocos2d Z order:

OpenGL Z modifies the Z vertex, and not the Z order in the relation between parent-children
OpenGL Z might require to set 2D projection
cocos2d Z order works OK if all the nodes uses the same openGL Z vertex. eg: vertexZ = 0

Warning: Use it at your own risk since it might break the cocos2d parent-children z order

Parameters: fVertexZ OpenGL Z vertex of this node.

Reimplemented in CCSprite.

virtual void setVisible ( bool visible)

virtual

Sets whether the node is visible.

The default value is true, a node is default to visible

Parameters: visible true if the node is visible, false if the node is hidden.

Reimplemented in CCEditBox, CCSprite, and UILayer.

var setVisible ( var visible)

virtual

Sets whether the node is visible.

The default value is true, a node is default to visible

Parameters: visible true if the node is visible, false if the node is hidden.

Reimplemented in CCEditBox, CCSprite, and UILayer.

local setVisible ( local visible)

virtual

Sets whether the node is visible.

The default value is true, a node is default to visible

Parameters: visible true if the node is visible, false if the node is hidden.

Reimplemented in CCEditBox, CCSprite, and UILayer.

virtual void setZOrder ( int zOrder)

virtual

Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array.

The Z order of node is relative to its "brothers": children of the same parent. It's nothing to do with OpenGL's z vertex. This one only affects the draw order of nodes in cocos2d. The larger number it is, the later this node will be drawn in each message loop. Please refer to setVertexZ(float) for the difference.

Parameters: nZOrder Z order of this node.

Reimplemented in CCBone.

var setZOrder ( var zOrder)

virtual

Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array.

The Z order of node is relative to its "brothers": children of the same parent. It's nothing to do with OpenGL's z vertex. This one only affects the draw order of nodes in cocos2d. The larger number it is, the later this node will be drawn in each message loop. Please refer to setVertexZ(float) for the difference.

Parameters: nZOrder Z order of this node.

Reimplemented in CCBone.

local setZOrder ( local zOrder)

virtual

Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array.

The Z order of node is relative to its "brothers": children of the same parent. It's nothing to do with OpenGL's z vertex. This one only affects the draw order of nodes in cocos2d. The larger number it is, the later this node will be drawn in each message loop. Please refer to setVertexZ(float) for the difference.

Parameters: nZOrder Z order of this node.

Reimplemented in CCBone.

virtual void sortAllChildren ( )

virtual

Sorts the children array once before drawing, instead of every time when a child is added or reordered.

This appraoch can improves the performance massively.

Note: Don't call this manually unless a child added needs to be removed in the same frame

Reimplemented in CCSprite, and CCSpriteBatchNode.

var sortAllChildren ( )

virtual

Sorts the children array once before drawing, instead of every time when a child is added or reordered.

This appraoch can improves the performance massively.

Note: Don't call this manually unless a child added needs to be removed in the same frame

Reimplemented in CCSprite, and CCSpriteBatchNode.

local sortAllChildren ( )

virtual

Sorts the children array once before drawing, instead of every time when a child is added or reordered.

This appraoch can improves the performance massively.

Note: Don't call this manually unless a child added needs to be removed in the same frame

Reimplemented in CCSprite, and CCSpriteBatchNode.

void stopAction ( CCAction * action)

Stops and removes an action from the running action list.

Parameters: An action object to be removed.

var stopAction ( var action)

Stops and removes an action from the running action list.

Parameters: An action object to be removed.

local stopAction ( local action)

Stops and removes an action from the running action list.

Parameters: An action object to be removed.

void stopActionByTag ( int tag)

Removes an action from the running action list by its tag.

Parameters: A tag that indicates the action to be removed.

var stopActionByTag ( var tag)

Removes an action from the running action list by its tag.

Parameters: A tag that indicates the action to be removed.

local stopActionByTag ( local tag)

Removes an action from the running action list by its tag.

Parameters: A tag that indicates the action to be removed.

void stopAllActions ( void )

Stops and removes all actions from the running action list .

var stopAllActions ( )

Stops and removes all actions from the running action list .

local stopAllActions ( )

Stops and removes all actions from the running action list .

void transform ( void )

Performs OpenGL view-matrix transformation based on position, scale, rotation and other attributes.

var transform ( )

Performs OpenGL view-matrix transformation based on position, scale, rotation and other attributes.

local transform ( )

Performs OpenGL view-matrix transformation based on position, scale, rotation and other attributes.

void transformAncestors ( void )

Performs OpenGL view-matrix transformation of it's ancestors.

Generally the ancestors are already transformed, but in certain cases (eg: attaching a FBO) It's necessary to transform the ancestors again.

var transformAncestors ( )

Performs OpenGL view-matrix transformation of it's ancestors.

Generally the ancestors are already transformed, but in certain cases (eg: attaching a FBO) It's necessary to transform the ancestors again.

local transformAncestors ( )

Performs OpenGL view-matrix transformation of it's ancestors.

Generally the ancestors are already transformed, but in certain cases (eg: attaching a FBO) It's necessary to transform the ancestors again.

virtual void
unregisterScriptHandler ( void )

virtual

Unregisters a script function that will be called in onEnter() & onExit() series functions.

See Also: registerScriptHandler(int)

var unregisterScriptHandler ( )

virtual

Unregisters a script function that will be called in onEnter() & onExit() series functions.

See Also: registerScriptHandler(int)

local unregisterScriptHandler ( )

virtual

Unregisters a script function that will be called in onEnter() & onExit() series functions.

See Also: registerScriptHandler(int)

void unschedule ( SEL_SCHEDULE selector)

Unschedules a custom selector.

See Also: schedule(SEL_SCHEDULE, float, unsigned int, float)

Parameters: selector A function wrapped as a selector

var unschedule ( var selector)

Unschedules a custom selector.

See Also: schedule(SEL_SCHEDULE, float, unsigned int, float)

Parameters: selector A function wrapped as a selector

void unscheduleAllSelectors ( void )

Unschedule all scheduled selectors: custom selectors, and the 'update' selector.

Actions are not affected by this method.

var unscheduleAllSelectors ( )

Unschedule all scheduled selectors: custom selectors, and the 'update' selector.

Actions are not affected by this method.

local unscheduleAllSelectors ( )

Unschedule all scheduled selectors: custom selectors, and the 'update' selector.

Actions are not affected by this method.

void unscheduleUpdate ( void )

var unscheduleUpdate ( )

local unscheduleUpdate ( )

virtual void update ( float delta)

virtual

Reimplemented from CCObject.

Reimplemented in CCParticleSystem, CCBone, CCArmature, CCMotionStreak, CCControlStepper, CCSkeleton, and CCSkeletonAnimation.

var update ( var delta)

virtual

Reimplemented from CCObject.

Reimplemented in CCParticleSystem, CCBone, CCArmature, CCMotionStreak, CCControlStepper, CCSkeleton, and CCSkeletonAnimation.

local update ( local delta)

virtual

Reimplemented from CCObject.

Reimplemented in CCParticleSystem, CCBone, CCArmature, CCMotionStreak, CCControlStepper, CCSkeleton, and CCSkeletonAnimation.

virtual void updateDisplayedColor ( const ccColor3B & color)

virtual

recursive method that updates display color

Implements CCRGBAProtocol.

Reimplemented in CCSprite, and CCBone.

var updateDisplayedColor ( var color)

virtual

recursive method that updates display color

Implements CCRGBAProtocol.

Reimplemented in CCSprite, and CCBone.

local updateDisplayedColor ( local color)

virtual

recursive method that updates display color

Implements CCRGBAProtocol.

Reimplemented in CCSprite, and CCBone.

virtual void updateDisplayedOpacity ( GLubyte opacity)

virtual

recursive method that updates the displayed opacity.

Implements CCRGBAProtocol.

Reimplemented in CCScale9Sprite, CCSprite, CCBone, and UICCLabelAtlas.

var updateDisplayedOpacity ( var opacity)

virtual

recursive method that updates the displayed opacity.

Implements CCRGBAProtocol.

Reimplemented in CCScale9Sprite, CCSprite, CCBone, and UICCLabelAtlas.

local updateDisplayedOpacity ( local opacity)

virtual

recursive method that updates the displayed opacity.

Implements CCRGBAProtocol.

Reimplemented in CCScale9Sprite, CCSprite, CCBone, and UICCLabelAtlas.

virtual void updateTransform ( void )

virtual

Calls children's updateTransform() method recursively.

This method is moved from CCSprite, so it's no longer specific to CCSprite. As the result, you apply CCSpriteBatchNode's optimization on your customed CCNode. e.g., batchNode->addChild(myCustomNode), while you can only addChild(sprite) before.

Reimplemented in CCSprite, and CCSkin.

var updateTransform ( )

virtual

Calls children's updateTransform() method recursively.

This method is moved from CCSprite, so it's no longer specific to CCSprite. As the result, you apply CCSpriteBatchNode's optimization on your customed CCNode. e.g., batchNode->addChild(myCustomNode), while you can only addChild(sprite) before.

Reimplemented in CCSprite, and CCSkin.

local updateTransform ( )

virtual

Calls children's updateTransform() method recursively.

This method is moved from CCSprite, so it's no longer specific to CCSprite. As the result, you apply CCSpriteBatchNode's optimization on your customed CCNode. e.g., batchNode->addChild(myCustomNode), while you can only addChild(sprite) before.

Reimplemented in CCSprite, and CCSkin.

virtual void visit ( void )

virtual

Visits this node's children and draw them recursively.

Reimplemented in GUIRenderer, CCEditBox, UIRectClippingNode, CCScrollView, CCSpriteBatchNode, CCArmature, CCParticleBatchNode, CCScale9Sprite, CCClippingNode, CCRenderTexture, CCParallaxNode, and CCBatchNode.

var visit ( )

virtual

Visits this node's children and draw them recursively.

Reimplemented in GUIRenderer, CCEditBox, UIRectClippingNode, CCScrollView, CCSpriteBatchNode, CCArmature, CCParticleBatchNode, CCScale9Sprite, CCClippingNode, CCRenderTexture, CCParallaxNode, and CCBatchNode.

local visit ( )

virtual

Visits this node's children and draw them recursively.

Reimplemented in GUIRenderer, CCEditBox, UIRectClippingNode, CCScrollView, CCSpriteBatchNode, CCArmature, CCParticleBatchNode, CCScale9Sprite, CCClippingNode, CCRenderTexture, CCParallaxNode, and CCBatchNode.

virtual CCAffineTransform
worldToNodeTransform ( void )

virtual

Returns the inverse world affine transform matrix.

The matrix is in Pixels.

var worldToNodeTransform ( )

virtual

Returns the inverse world affine transform matrix.

The matrix is in Pixels.

local worldToNodeTransform ( )

virtual

Returns the inverse world affine transform matrix.

The matrix is in Pixels.

Variable Documentation

bool _cascadeColorEnabled

protected

var _cascadeColorEnabled

protected

local _cascadeColorEnabled

protected

bool _cascadeOpacityEnabled

protected

var _cascadeOpacityEnabled

protected

local _cascadeOpacityEnabled

protected

ccColor3B _displayedColor

protected

var _displayedColor

protected

local _displayedColor

protected

GLubyte _displayedOpacity

protected

var _displayedOpacity

protected

local _displayedOpacity

protected

ccColor3B _realColor

protected

var _realColor

protected

local _realColor

protected

GLubyte _realOpacity

protected

var _realOpacity

protected

local _realOpacity

protected

bool m_bAdditionalTransformDirty

protected

The flag to check whether the additional transform is dirty.

var m_bAdditionalTransformDirty

protected

The flag to check whether the additional transform is dirty.

local m_bAdditionalTransformDirty

protected

The flag to check whether the additional transform is dirty.

bool
m_bIgnoreAnchorPointForPosition

protected

true if the Anchor Point will be (0,0) when you position the CCNode, false otherwise.

Used by CCLayer and CCScene.

var m_bIgnoreAnchorPointForPosition

protected

true if the Anchor Point will be (0,0) when you position the CCNode, false otherwise.

Used by CCLayer and CCScene.

local
m_bIgnoreAnchorPointForPosition

protected

true if the Anchor Point will be (0,0) when you position the CCNode, false otherwise.

Used by CCLayer and CCScene.

bool m_bInverseDirty

protected

transform dirty flag

var m_bInverseDirty

protected

transform dirty flag

local m_bInverseDirty

protected

transform dirty flag

bool m_bReorderChildDirty

protected

children order dirty flag

var m_bReorderChildDirty

protected

children order dirty flag

local m_bReorderChildDirty

protected

children order dirty flag

bool m_bRunning

protected

is running

var m_bRunning

protected

is running

local m_bRunning

protected

is running

bool m_bTransformDirty

protected

transform dirty flag

var m_bTransformDirty

protected

transform dirty flag

local m_bTransformDirty

protected

transform dirty flag

bool m_bVisible

protected

is this node visible

var m_bVisible

protected

is this node visible

local m_bVisible

protected

is this node visible

ccGLServerState m_eGLServerState

protected

OpenGL servier side state.

var m_eGLServerState

protected

OpenGL servier side state.

local m_eGLServerState

protected

OpenGL servier side state.

ccScriptType m_eScriptType

protected

type of script binding, lua or javascript

var m_eScriptType

protected

type of script binding, lua or javascript

local m_eScriptType

protected

type of script binding, lua or javascript

float m_fRotationX

protected

rotation angle on x-axis

float m_fRotationY

protected

rotation angle on y-axis

var m_fRotationY

protected

rotation angle on y-axis

local m_fRotationY

protected

rotation angle on y-axis

float m_fScaleX

protected

scaling factor on x-axis

var m_fScaleX

protected

scaling factor on x-axis

local m_fScaleX

protected

scaling factor on x-axis

float m_fScaleY

protected

scaling factor on y-axis

var m_fScaleY

protected

scaling factor on y-axis

local m_fScaleY

protected

scaling factor on y-axis

float m_fSkewX

protected

skew angle on x-axis

var m_fSkewX

protected

skew angle on x-axis

local m_fSkewX

protected

skew angle on x-axis

float m_fSkewY

protected

skew angle on y-axis

var m_fSkewY

protected

skew angle on y-axis

local m_fSkewY

protected

skew angle on y-axis

float m_fVertexZ

protected

OpenGL real Z vertex.

var m_fVertexZ

protected

OpenGL real Z vertex.

local m_fVertexZ

protected

OpenGL real Z vertex.

int m_nScriptHandler

protected

script handler for onEnter() & onExit(), used in Javascript binding and Lua binding.

var m_nScriptHandler

protected

script handler for onEnter() & onExit(), used in Javascript binding and Lua binding.

local m_nScriptHandler

protected

script handler for onEnter() & onExit(), used in Javascript binding and Lua binding.

int m_nTag

protected

a tag. Can be any number you assigned just to identify this node

var m_nTag

protected

a tag. Can be any number you assigned just to identify this node

local m_nTag

protected

a tag. Can be any number you assigned just to identify this node

int m_nUpdateScriptHandler

protected

script handler for update() callback per frame, which is invoked from lua & javascript.

var m_nUpdateScriptHandler

protected

script handler for update() callback per frame, which is invoked from lua & javascript.

local m_nUpdateScriptHandler

protected

script handler for update() callback per frame, which is invoked from lua & javascript.

int m_nZOrder

protected

z-order value that affects the draw order

var m_nZOrder

protected

z-order value that affects the draw order

local m_nZOrder

z-order value that affects the draw order

anchor point normalized (NOT in points)