cc Module
The main namespace of Cocos2d-JS, all engine core classes, functions, properties and constants are defined in this namespace.
Classes
Enums
Index
Properties
ENGINE_VERSION String The current version of Cocos2d being used.
Please DO NOT remove this String, it is an important flag for bug tracking.
If you post a bug to forum, please attach this flag._renderContext CanvasRenderingContext2D|WebGLRenderingContext main Canvas 2D/3D Context of game engine_canvas HTMLCanvasElement Main canvas of game enginecontainer HTMLDivElement The element contains the game canvasview View cc.view is the shared view object.director Director DirectorwinSize Size cc.winSize is the alias object for the size of the current game window.game Game systemEvent SystemEvent The System event singleton for global usageInteger string Specify that the input value must be integer in Inspector.
Also used to indicates that the elements in array should be type integer.Float string Indicates that the elements in array should be type double.Boolean string Indicates that the elements in array should be type boolean.String string Indicates that the elements in array should be type string.
Methods
_initDebugSetting Init Debug setting.error Outputs an error message to the Cocos Creator Console (editor) or Web Console (runtime).
- In Cocos Creator, error is red.
- In Chrome, error have a red icon along with red message text.
warn Outputs a warning message to the Cocos Creator Console (editor) or Web Console (runtime).
- In Cocos Creator, warning is yellow.
- In Chrome, warning have a yellow warning icon with the message text.
log Outputs a message to the Cocos Creator Console (editor) or Web Console (runtime).info Outputs an informational message to the Cocos Creator Console (editor) or Web Console (runtime).
- In Cocos Creator, info is blue.
- In Firefox and Chrome, a small "i" icon is displayed next to these items in the Web Console's log.
speed Creates the speed action which changes the speed of an action, making it take longer (speed > 1)
or less (speed < 1) time.
Useful to simulate 'slow motion' or 'fast forward' effect.follow Create a follow action which makes its target follows another node.setPoints Points settercardinalSplineTo Creates an action with a Cardinal Spline array of points and tension.updatePosition update position of targetcardinalSplineBy Creates an action with a Cardinal Spline array of points and tension.catmullRomTo Creates an action with a Cardinal Spline array of points and tension.catmullRomBy Creates an action with a Cardinal Spline array of points and tension.easeIn Creates the action easing object with the rate parameter.
From slow to fast.easeOut Creates the action easing object with the rate parameter.
From fast to slow.easeInOut Creates the action easing object with the rate parameter.
Slow to fast then to slow.easeExponentialIn Creates the action easing object with the rate parameter.
Reference easeInExpo:
http://www.zhihu.com/question/21981571/answer/19925418easeExponentialOut Creates the action easing object.
Reference easeOutExpo:
http://www.zhihu.com/question/21981571/answer/19925418easeExponentialInOut Creates an EaseExponentialInOut action easing object.
Reference easeInOutExpo:
http://www.zhihu.com/question/21981571/answer/19925418easeSineIn Creates an EaseSineIn action.
Reference easeInSine:
http://www.zhihu.com/question/21981571/answer/19925418easeSineOut Creates an EaseSineOut action easing object.
Reference easeOutSine:
http://www.zhihu.com/question/21981571/answer/19925418easeSineInOut Creates the action easing object.
Reference easeInOutSine:
http://www.zhihu.com/question/21981571/answer/19925418easeElasticIn Creates the action easing obejct with the period in radians (default is 0.3).
Reference easeInElastic:
http://www.zhihu.com/question/21981571/answer/19925418easeElasticOut Creates the action easing object with the period in radians (default is 0.3).
Reference easeOutElastic:
http://www.zhihu.com/question/21981571/answer/19925418easeElasticInOut Creates the action easing object with the period in radians (default is 0.3).
Reference easeInOutElastic:
http://www.zhihu.com/question/21981571/answer/19925418easeBounceIn Creates the action easing object.
Eased bounce effect at the beginning.easeBounceOut Creates the action easing object.
Eased bounce effect at the ending.easeBounceInOut Creates the action easing object.
Eased bounce effect at the begining and ending.easeBackIn Creates the action easing object.
In the opposite direction to move slowly, and then accelerated to the right direction.easeBackOut Creates the action easing object.
Fast moving more than the finish, and then slowly back to the finish.easeBackInOut Creates the action easing object.
Begining of cc.EaseBackIn. Ending of cc.EaseBackOut.easeBezierAction Creates the action easing object.
Into the 4 reference point.
To calculate the motion curve.easeQuadraticActionIn Creates the action easing object.
Reference easeInQuad:
http://www.zhihu.com/question/21981571/answer/19925418easeQuadraticActionOut Creates the action easing object.
Reference easeOutQuad:
http://www.zhihu.com/question/21981571/answer/19925418easeQuadraticActionInOut Creates the action easing object.
Reference easeInOutQuad:
http://www.zhihu.com/question/21981571/answer/19925418easeQuarticActionIn Creates the action easing object.
Reference easeIntQuart:
http://www.zhihu.com/question/21981571/answer/19925418easeQuarticActionOut Creates the action easing object.
Reference easeOutQuart:
http://www.zhihu.com/question/21981571/answer/19925418easeQuarticActionInOut Creates the action easing object.
Reference easeInOutQuart:
http://www.zhihu.com/question/21981571/answer/19925418easeQuinticActionIn Creates the action easing object.
Reference easeInQuint:
http://www.zhihu.com/question/21981571/answer/19925418easeQuinticActionOut Creates the action easing object.
Reference easeOutQuint:
http://www.zhihu.com/question/21981571/answer/19925418easeQuinticActionInOut Creates the action easing object.
Reference easeInOutQuint:
http://www.zhihu.com/question/21981571/answer/19925418easeCircleActionIn Creates the action easing object.
Reference easeInCirc:
http://www.zhihu.com/question/21981571/answer/19925418easeCircleActionOut Creates the action easing object.
Reference easeOutCirc:
http://www.zhihu.com/question/21981571/answer/19925418easeCircleActionInOut Creates the action easing object.
Reference easeInOutCirc:
http://www.zhihu.com/question/21981571/answer/19925418easeCubicActionIn Creates the action easing object.
Reference easeInCubic:
http://www.zhihu.com/question/21981571/answer/19925418easeCubicActionOut Creates the action easing object.
Reference easeOutCubic:
http://www.zhihu.com/question/21981571/answer/19925418easeCubicActionInOut Creates the action easing object.
Reference easeInOutCubic:
http://www.zhihu.com/question/21981571/answer/19925418show Show the Node.hide Hide the node.toggleVisibility Toggles the visibility of a node.removeSelf Create a RemoveSelf object with a flag indicate whether the target should be cleaned up while removing.flipX Create a FlipX action to flip or unflip the target.flipY Create a FlipY action to flip or unflip the target.place Creates a Place action with a position.callFunc Creates the action with the callback.sequence Helper constructor to create an array of sequenceable actions
The created action will run actions sequentially, one after another.repeat Creates a Repeat action. Times is an unsigned integer between 1 and pow(2,30)repeatForever Create a acton which repeat forever, as it runs forever, it can't be added into cc.sequence and cc.spawn.spawn Create a spawn action which runs several actions in parallel.rotateTo Rotates a Node object to a certain angle by modifying its rotation property.
The direction will be decided by the shortest angle.rotateBy Rotates a Node object clockwise a number of degrees by modifying its rotation property.
Relative to its properties to modify.moveBy Moves a Node object x,y pixels by modifying its position property.
x and y are relative to the position of the object.
Several MoveBy actions can be concurrently called, and the resulting
movement will be the sum of individual movements.moveTo Moves a Node object to the position x,y. x and y are absolute coordinates by modifying its position property.
Several MoveTo actions can be concurrently called, and the resulting
movement will be the sum of individual movements.skewTo Create a action which skews a Node object to given angles by modifying its skewX and skewY properties.
Changes to the specified value.skewBy Skews a Node object by skewX and skewY degrees.
Relative to its property modification.jumpBy Moves a Node object simulating a parabolic jump movement by modifying it's position property.
Relative to its movement.jumpTo Moves a Node object to a parabolic position simulating a jump movement by modifying its position property.
Jump to the specified location.bezierBy An action that moves the target with a cubic Bezier curve by a certain distance.
Relative to its movement.bezierTo An action that moves the target with a cubic Bezier curve to a destination point.scaleTo Scales a Node object to a zoom factor by modifying it's scale property.scaleBy Scales a Node object a zoom factor by modifying it's scale property.
Relative to its changes.blink Blinks a Node object by modifying it's visible property.fadeTo Fades an object that implements the cc.RGBAProtocol protocol.
It modifies the opacity from the current value to a custom one.fadeIn Fades In an object that implements the cc.RGBAProtocol protocol. It modifies the opacity from 0 to 255.fadeOut Fades Out an object that implements the cc.RGBAProtocol protocol. It modifies the opacity from 255 to 0.tintTo Tints a Node that implements the cc.NodeRGB protocol from current tint to a custom one.tintBy Tints a Node that implements the cc.NodeRGB protocol from current tint to a custom one.
Relative to their own color change.delayTime Delays the action a certain amount of seconds.
延迟指定的时间量。reverseTime Executes an action in reverse order, from time=duration to time=0.targetedAction Create an action with the specified action and forced target.handleTouchesBegin handleTouchesMove handleTouchesEnd handleTouchesCancel getSetOfTouchesEndOrCancel getHTMLElementPosition getPreTouch setPreTouch getTouchByXY getPointByEvent getTouchesByEvent registerSystemEvent Class Defines a CCClass using the given specification, please see Class for details._isCCClass Checks whether the constructor is created by cc.ClassisChildClassOf Checks whether subclass is child of superclass or equals to superclassgetInheritanceChain Return all super classesEnum Define an enum type.
If a enum item has a value of -1, it will be given an Integer number according to it's order in the list.
Otherwise it will use the value specified by user who writes the enum definition.getList setAccelerometerEnabled whether enable accelerometer eventsetAccelerometerInterval set accelerometer interval valuehandleTouchesBegin handleTouchesMove handleTouchesEnd handleTouchesCancel getSetOfTouchesEndOrCancel getHTMLElementPosition getPreTouch setPreTouch getTouchByXY getTouchByXY getPointByEvent getTouchesByEvent registerSystemEvent update lerp
Linear interpolation between 2 numbers, the ratio sets how much it is biased to each end
rand get a random number from 0 to 0xffffffrandomMinus1To1 returns a random float between -1 and 1random0To1 returns a random float between 0 and 1, use Math.random directlydegreesToRadians converts degrees to radiansradiansToDegrees converts radians to degreesnodeDrawSetup Helpful macro that setups the GL server state, the correct GL program and sets the Model View Projection matrixincrementGLDraws
Increments the GL Draws counts by one.
The number of calls per frame are displayed on the screen when the CCDirector's stats are enabled.
checkGLErrorDebug Check webgl error.Error will be shown in console if exists.isValid Checks whether the object is non-nil and not yet destroyed.deserialize Deserialize json to cc.Assetinstantiate Clones the object original and returns the clone, or instantiate a node from the Prefab.find Finds a node by hierarchy path, the path is case-sensitive.
It will traverse the hierarchy by splitting the path using '/' character.
This function will still returns the node even if it is inactive.
It is recommended to not use this function every frame instead cache the result at startup.color The convenience method to create a new Color/Color:method
Alpha channel is optional. Default value is 255.colorEqual returns true if both ccColor3B are equal. Otherwise it returns false.hexToColor convert a string of color for style to Color.
e.g. "#ff06ff" to : cc.color(255,6,255)。colorToHex convert Color to a string of color for style.
e.g. cc.color(255,6,255) to : "#ff06ff"pNeg Returns opposite of Vec2.pAdd Calculates sum of two points.pSub Calculates difference of two points.pMult Returns point multiplied by given factor.pMidpoint Calculates midpoint between two points.pDot Calculates dot product of two points.pCross Calculates cross product of two points.pPerp Calculates perpendicular of v, rotated 90 degrees counter-clockwise -- cross(v, perp(v)) greater than 0.pRPerp Calculates perpendicular of v, rotated 90 degrees clockwise -- cross(v, rperp(v)) smaller than 0.pProject Calculates the projection of v1 over v2.pLengthSQ Calculates the square length of a cc.Vec2 (not calling sqrt() ).pDistanceSQ Calculates the square distance between two points (not calling sqrt() ).pLength Calculates distance between point an origin.pDistance Calculates the distance between two points.pNormalize Returns this vector with a magnitude of 1.pForAngle Converts radians to a normalized vector.pToAngle Converts a vector to radians.clampf Clamp a value between from and to.clamp01 Clamp a value between 0 and 1.pClamp Clamp a point between from and to.pFromSize Quickly convert cc.Size to a cc.Vec2.pCompOp Run a math operation function on each point component
Math.abs, Math.fllor, Math.ceil, Math.round.pLerp Linear Interpolation between two points a and b.
alpha == 0 ? a
alpha == 1 ? b
otherwise a value between a..b.pFuzzyEqual TODOpCompMult Multiplies a nd b components, a.xb.x, a.yb.y.pAngleSigned TODOpAngle TODOpRotateByAngle Rotates a point counter clockwise by the angle around a pivot.pLineIntersect A general line-line intersection test
indicating successful intersection of a line
note that to truly test intersection for segments we have to make
sure that s & t lie within [0..1] and for rays, make sure s & t > 0
the hit point is p3 + t (p4 - p3);
the hit point also is p1 + s (p2 - p1);pSegmentIntersect ccpSegmentIntersect return YES if Segment A-B intersects with segment C-D.pIntersectPoint ccpIntersectPoint return the intersection point of line A-B, C-D.pSameAs check to see if both points are equal.pZeroIn sets the position of the point to 0.pIn copies the position of one point to another.pMultIn multiplies the point with the given factor (inplace).pSubIn subtracts one point from another (inplace).pAddIn adds one point to another (inplace).pNormalizeIn normalizes the point (inplace).rect The convenience method to create a new Rect.
see Rect/Rect:methodrectEqualToRect Check whether a rect's value equals to another.rectContainsRect Check whether the rect1 contains rect2.rectGetMaxX Returns the rightmost x-value of a rect.rectGetMidX Return the midpoint x-value of a rect.rectGetMinX Returns the leftmost x-value of a rect.rectGetMaxY Return the topmost y-value of a rect.rectGetMidY Return the midpoint y-value of `rect'.rectGetMinY Return the bottommost y-value of a rect.rectContainsPoint Check whether a rect contains a point.rectIntersectsRect Check whether a rect intersect with another.rectOverlapsRect Check whether a rect overlaps another.rectUnion Returns the smallest rectangle that contains the two source rectangles.rectIntersection Returns the overlapping portion of 2 rectangles.size Helper function that creates a cc.Size.
Please use cc.p or cc.v2 instead, it will soon replace cc.Size.sizeEqualToSize Check whether a point's value equals to another.V3F_C4B_T2F_QuadZero V3F_C4B_T2F_QuadCopy V3F_C4B_T2F_QuadsCopy v2 The convenience method to create a new cc.Vec2.p The convenience method to creates a new cc.Vec2.pointEqualToPoint Check whether a point's value equals to another.
Details
Properties
ENGINE_VERSION
The current version of Cocos2d being used.
Please DO NOT remove this String, it is an important flag for bug tracking.
If you post a bug to forum, please attach this flag.
_renderContext
main Canvas 2D/3D Context of game engine
_canvas
Main canvas of game engine
container
The element contains the game canvas
view
cc.view is the shared view object.
director
Director
winSize
cc.winSize is the alias object for the size of the current game window.
game
systemEvent
The System event singleton for global usage
Integer
Specify that the input value must be integer in Inspector.
Also used to indicates that the elements in array should be type integer.
Examples
member: {
default: [],
type: cc.Integer
}
Float
Indicates that the elements in array should be type double.
Examples
member: {
default: [],
type: cc.Float
}
Boolean
Indicates that the elements in array should be type boolean.
Examples
member: {
default: [],
type: cc.Boolean
}
String
Indicates that the elements in array should be type string.
Examples
member: {
default: [],
type: cc.String
}
Methods
_initDebugSetting
Init Debug setting.
Parameters
error
Outputs an error message to the Cocos Creator Console (editor) or Web Console (runtime).
- In Cocos Creator, error is red.
- In Chrome, error have a red icon along with red message text.
Parameters
msg Any A JavaScript string containing zero or more substitution strings.subst Any JavaScript objects with which to replace substitution strings within msg. This gives you additional control over the format of the output.
warn
Outputs a warning message to the Cocos Creator Console (editor) or Web Console (runtime).
- In Cocos Creator, warning is yellow.
- In Chrome, warning have a yellow warning icon with the message text.
Parameters
msg Any A JavaScript string containing zero or more substitution strings.subst Any JavaScript objects with which to replace substitution strings within msg. This gives you additional control over the format of the output.
log
Outputs a message to the Cocos Creator Console (editor) or Web Console (runtime).
Parameters
msg String | Any A JavaScript string containing zero or more substitution strings.subst Any JavaScript objects with which to replace substitution strings within msg. This gives you additional control over the format of the output.
info
Outputs an informational message to the Cocos Creator Console (editor) or Web Console (runtime).
- In Cocos Creator, info is blue.
- In Firefox and Chrome, a small "i" icon is displayed next to these items in the Web Console's log.
Parameters
msg Any A JavaScript string containing zero or more substitution strings.subst Any JavaScript objects with which to replace substitution strings within msg. This gives you additional control over the format of the output.
speed
Creates the speed action which changes the speed of an action, making it take longer (speed > 1)
or less (speed < 1) time.
Useful to simulate 'slow motion' or 'fast forward' effect.
Parameters
Examples
var action = cc.scaleTo(0.2, 1, 0.6);
var newAction = cc.speed(action, 0.5);
follow
Create a follow action which makes its target follows another node.
Parameters
Examples
var followAction = cc.follow(targetNode, cc.rect(0, 0, screenWidth * 2 - 100, screenHeight));
node.runAction(followAction);
var followAction = cc.follow(targetNode);
node.runAction(followAction);
setPoints
Points setter
Parameters
cardinalSplineTo
Creates an action with a Cardinal Spline array of points and tension.
Parameters
Examples
var action1 = cc.cardinalSplineTo(3, array, 0);
updatePosition
update position of target
Parameters
cardinalSplineBy
Creates an action with a Cardinal Spline array of points and tension.
Parameters
catmullRomTo
Creates an action with a Cardinal Spline array of points and tension.
Parameters
Examples
var action1 = cc.catmullRomTo(3, array);
catmullRomBy
Creates an action with a Cardinal Spline array of points and tension.
Parameters
Examples
var action1 = cc.catmullRomBy(3, array);
easeIn
Creates the action easing object with the rate parameter.
From slow to fast.
Parameters
Examples
action.easing(cc.easeIn(3.0));
easeOut
Creates the action easing object with the rate parameter.
From fast to slow.
Parameters
Examples
action.easing(cc.easeOut(3.0));
easeInOut
Creates the action easing object with the rate parameter.
Slow to fast then to slow.
Parameters
Examples
action.easing(cc.easeInOut(3.0));
easeExponentialIn
Creates the action easing object with the rate parameter.
Reference easeInExpo:
http://www.zhihu.com/question/21981571/answer/19925418
Examples
action.easing(cc.easeExponentialIn());
easeExponentialOut
Creates the action easing object.
Reference easeOutExpo:
http://www.zhihu.com/question/21981571/answer/19925418
Examples
action.easing(cc.easeExponentialOut());
easeExponentialInOut
Creates an EaseExponentialInOut action easing object.
Reference easeInOutExpo:
http://www.zhihu.com/question/21981571/answer/19925418
Examples
action.easing(cc.easeExponentialInOut());
easeSineIn
Creates an EaseSineIn action.
Reference easeInSine:
http://www.zhihu.com/question/21981571/answer/19925418
Examples
action.easing(cc.easeSineIn());
easeSineOut
Creates an EaseSineOut action easing object.
Reference easeOutSine:
http://www.zhihu.com/question/21981571/answer/19925418
Examples
action.easing(cc.easeSineOut());
easeSineInOut
Creates the action easing object.
Reference easeInOutSine:
http://www.zhihu.com/question/21981571/answer/19925418
Examples
action.easing(cc.easeSineInOut());
easeElasticIn
Creates the action easing obejct with the period in radians (default is 0.3).
Reference easeInElastic:
http://www.zhihu.com/question/21981571/answer/19925418
Parameters
Examples
action.easing(cc.easeElasticIn(3.0));
easeElasticOut
Creates the action easing object with the period in radians (default is 0.3).
Reference easeOutElastic:
http://www.zhihu.com/question/21981571/answer/19925418
Parameters
Examples
action.easing(cc.easeElasticOut(3.0));
easeElasticInOut
Creates the action easing object with the period in radians (default is 0.3).
Reference easeInOutElastic:
http://www.zhihu.com/question/21981571/answer/19925418
Parameters
Examples
action.easing(cc.easeElasticInOut(3.0));
easeBounceIn
Creates the action easing object.
Eased bounce effect at the beginning.
Examples
action.easing(cc.easeBounceIn());
easeBounceOut
Creates the action easing object.
Eased bounce effect at the ending.
Examples
action.easing(cc.easeBounceOut());
easeBounceInOut
Creates the action easing object.
Eased bounce effect at the begining and ending.
Examples
action.easing(cc.easeBounceInOut());
easeBackIn
Creates the action easing object.
In the opposite direction to move slowly, and then accelerated to the right direction.
Examples
action.easing(cc.easeBackIn());
easeBackOut
Creates the action easing object.
Fast moving more than the finish, and then slowly back to the finish.
Examples
action.easing(cc.easeBackOut());
easeBackInOut
Creates the action easing object.
Begining of cc.EaseBackIn. Ending of cc.EaseBackOut.
Examples
action.easing(cc.easeBackInOut());
easeBezierAction
Creates the action easing object.
Into the 4 reference point.
To calculate the motion curve.
Parameters
p0 Number The first bezier parameterp1 Number The second bezier parameterp2 Number The third bezier parameterp3 Number The fourth bezier parameter
Examples
action.easing(cc.easeBezierAction(0.5, 0.5, 1.0, 1.0));
easeQuadraticActionIn
Creates the action easing object.
Reference easeInQuad:
http://www.zhihu.com/question/21981571/answer/19925418
Examples
action.easing(cc.easeQuadraticActionIn());
easeQuadraticActionOut
Creates the action easing object.
Reference easeOutQuad:
http://www.zhihu.com/question/21981571/answer/19925418
Examples
action.easing(cc.easeQuadraticActionOut());
easeQuadraticActionInOut
Creates the action easing object.
Reference easeInOutQuad:
http://www.zhihu.com/question/21981571/answer/19925418
Examples
action.easing(cc.easeQuadraticActionInOut());
easeQuarticActionIn
Creates the action easing object.
Reference easeIntQuart:
http://www.zhihu.com/question/21981571/answer/19925418
Examples
action.easing(cc.easeQuarticActionIn());
easeQuarticActionOut
Creates the action easing object.
Reference easeOutQuart:
http://www.zhihu.com/question/21981571/answer/19925418
Examples
action.easing(cc.QuarticActionOut());
easeQuarticActionInOut
Creates the action easing object.
Reference easeInOutQuart:
http://www.zhihu.com/question/21981571/answer/19925418
easeQuinticActionIn
Creates the action easing object.
Reference easeInQuint:
http://www.zhihu.com/question/21981571/answer/19925418
Examples
action.easing(cc.easeQuinticActionIn());
easeQuinticActionOut
Creates the action easing object.
Reference easeOutQuint:
http://www.zhihu.com/question/21981571/answer/19925418
Examples
action.easing(cc.easeQuadraticActionOut());
easeQuinticActionInOut
Creates the action easing object.
Reference easeInOutQuint:
http://www.zhihu.com/question/21981571/answer/19925418
Examples
action.easing(cc.easeQuinticActionInOut());
easeCircleActionIn
Creates the action easing object.
Reference easeInCirc:
http://www.zhihu.com/question/21981571/answer/19925418
Examples
action.easing(cc.easeCircleActionIn());
easeCircleActionOut
Creates the action easing object.
Reference easeOutCirc:
http://www.zhihu.com/question/21981571/answer/19925418
easeCircleActionInOut
Creates the action easing object.
Reference easeInOutCirc:
http://www.zhihu.com/question/21981571/answer/19925418
Examples
action.easing(cc.easeCircleActionInOut());
easeCubicActionIn
Creates the action easing object.
Reference easeInCubic:
http://www.zhihu.com/question/21981571/answer/19925418
Examples
action.easing(cc.easeCubicActionIn());
easeCubicActionOut
Creates the action easing object.
Reference easeOutCubic:
http://www.zhihu.com/question/21981571/answer/19925418
Examples
action.easing(cc.easeCubicActionOut());
easeCubicActionInOut
Creates the action easing object.
Reference easeInOutCubic:
http://www.zhihu.com/question/21981571/answer/19925418
show
Show the Node.
Examples
var showAction = cc.show();
hide
Hide the node.
Examples
var hideAction = cc.hide();
toggleVisibility
Toggles the visibility of a node.
Examples
var toggleVisibilityAction = cc.toggleVisibility();
removeSelf
Create a RemoveSelf object with a flag indicate whether the target should be cleaned up while removing.
Parameters
Examples
var removeSelfAction = cc.removeSelf();
flipX
Create a FlipX action to flip or unflip the target.
Parameters
flip Boolean Indicate whether the target should be flipped or not
Examples
var flipXAction = cc.flipX(true);
flipY
Create a FlipY action to flip or unflip the target.
Parameters
Examples
var flipYAction = cc.flipY(true);
place
Creates a Place action with a position.
Parameters
Examples
var placeAction = cc.place(cc.p(200, 200));
var placeAction = cc.place(200, 200);
callFunc
Creates the action with the callback.
Parameters
selector function selectorTarget object data Any data for function, it accepts all data types.
Examples
var finish = cc.callFunc(this.removeSprite, this);
var finish = cc.callFunc(this.removeFromParentAndCleanup, this._grossini, true);
sequence
Helper constructor to create an array of sequenceable actions
The created action will run actions sequentially, one after another.
Parameters
Examples
var seq = cc.sequence(act1, act2);
var seq = cc.sequence(actArray);
repeat
Creates a Repeat action. Times is an unsigned integer between 1 and pow(2,30)
Parameters
Examples
var rep = cc.repeat(cc.sequence(jump2, jump1), 5);
repeatForever
Create a acton which repeat forever, as it runs forever, it can't be added into cc.sequence and cc.spawn.
Parameters
Examples
var repeat = cc.repeatForever(cc.rotateBy(1.0, 360));
spawn
Create a spawn action which runs several actions in parallel.
Parameters
Examples
var action = cc.spawn(cc.jumpBy(2, cc.p(300, 0), 50, 4), cc.rotateBy(2, 720));
todo:It should be the direct use new
rotateTo
Rotates a Node object to a certain angle by modifying its rotation property.
The direction will be decided by the shortest angle.
Parameters
duration Number duration in secondsdeltaAngleX Number deltaAngleX in degrees.deltaAngleY Number deltaAngleY in degrees.
Examples
var rotateTo = cc.rotateTo(2, 61.0);
rotateBy
Rotates a Node object clockwise a number of degrees by modifying its rotation property.
Relative to its properties to modify.
Parameters
duration Number duration in secondsdeltaAngleX Number deltaAngleX in degreesdeltaAngleY Number deltaAngleY in degrees
Examples
var actionBy = cc.rotateBy(2, 360);
moveBy
Moves a Node object x,y pixels by modifying its position property.
x and y are relative to the position of the object.
Several MoveBy actions can be concurrently called, and the resulting
movement will be the sum of individual movements.
Parameters
Examples
var actionTo = cc.moveBy(2, cc.p(windowSize.width - 40, windowSize.height - 40));
moveTo
Moves a Node object to the position x,y. x and y are absolute coordinates by modifying its position property.
Several MoveTo actions can be concurrently called, and the resulting
movement will be the sum of individual movements.
Parameters
Examples
var actionBy = cc.moveTo(2, cc.p(80, 80));
skewTo
Create a action which skews a Node object to given angles by modifying its skewX and skewY properties.
Changes to the specified value.
Parameters
Examples
var actionTo = cc.skewTo(2, 37.2, -37.2);
skewBy
Skews a Node object by skewX and skewY degrees.
Relative to its property modification.
Parameters
t Number time in secondssx Number sx skew in degrees for X axissy Number sy skew in degrees for Y axis
Examples
var actionBy = cc.skewBy(2, 0, -90);
jumpBy
Moves a Node object simulating a parabolic jump movement by modifying it's position property.
Relative to its movement.
Parameters
Examples
var actionBy = cc.jumpBy(2, cc.p(300, 0), 50, 4);
var actionBy = cc.jumpBy(2, 300, 0, 50, 4);
jumpTo
Moves a Node object to a parabolic position simulating a jump movement by modifying its position property.
Jump to the specified location.
Parameters
Examples
var actionTo = cc.jumpTo(2, cc.p(300, 300), 50, 4);
var actionTo = cc.jumpTo(2, 300, 300, 50, 4);
bezierBy
An action that moves the target with a cubic Bezier curve by a certain distance.
Relative to its movement.
Parameters
Examples
var bezier = [cc.p(0, windowSize.height / 2), cc.p(300, -windowSize.height / 2), cc.p(300, 100)];
var bezierForward = cc.bezierBy(3, bezier);
bezierTo
An action that moves the target with a cubic Bezier curve to a destination point.
Parameters
Examples
var bezier = [cc.p(0, windowSize.height / 2), cc.p(300, -windowSize.height / 2), cc.p(300, 100)];
var bezierTo = cc.bezierTo(2, bezier);
scaleTo
Scales a Node object to a zoom factor by modifying it's scale property.
Parameters
duration Number sx Number scale parameter in Xsy Number scale parameter in Y, if Null equal to sx
Examples
var actionTo = cc.scaleTo(2, 0.5);
var actionTo = cc.scaleTo(2, 0.5, 2);
scaleBy
Scales a Node object a zoom factor by modifying it's scale property.
Relative to its changes.
Parameters
duration Number duration in secondssx Number sx scale parameter in Xsy Number | Null sy scale parameter in Y, if Null equal to sx
Examples
var actionBy = cc.scaleBy(2, 2);
var actionBy2 = cc.scaleBy(2, 0.25, 4.5);
blink
Blinks a Node object by modifying it's visible property.
Parameters
duration Number duration in secondsblinks Number blinks in times
Examples
var action = cc.blink(2, 10);
fadeTo
Fades an object that implements the cc.RGBAProtocol protocol.
It modifies the opacity from the current value to a custom one.
Parameters
Examples
var action = cc.fadeTo(1.0, 0);
fadeIn
Fades In an object that implements the cc.RGBAProtocol protocol. It modifies the opacity from 0 to 255.
Parameters
duration Number duration in seconds
Examples
var action = cc.fadeIn(1.0);
fadeOut
Fades Out an object that implements the cc.RGBAProtocol protocol. It modifies the opacity from 255 to 0.
Parameters
Examples
var action = cc.fadeOut(1.0);
tintTo
Tints a Node that implements the cc.NodeRGB protocol from current tint to a custom one.
Parameters
Examples
var action = cc.tintTo(2, 255, 0, 255);
tintBy
Tints a Node that implements the cc.NodeRGB protocol from current tint to a custom one.
Relative to their own color change.
Parameters
Examples
var action = cc.tintBy(2, -127, -255, -127);
delayTime
Delays the action a certain amount of seconds.
延迟指定的时间量。
Parameters
Examples
var delay = cc.delayTime(1);
reverseTime
Executes an action in reverse order, from time=duration to time=0.
Parameters
Examples
var reverse = cc.reverseTime(this);
targetedAction
Create an action with the specified action and forced target.
Parameters
handleTouchesBegin
Parameters
handleTouchesMove
Parameters
handleTouchesEnd
Parameters
handleTouchesCancel
Parameters
getSetOfTouchesEndOrCancel
Parameters
getHTMLElementPosition
Parameters
getPreTouch
Parameters
setPreTouch
Parameters
getTouchByXY
Parameters
getPointByEvent
Parameters
getTouchesByEvent
Parameters
registerSystemEvent
Parameters
Class
Defines a CCClass using the given specification, please see Class for details.
Parameters
options Object
name String The class name used for serialization.extends Function The base class.ctor Function The constructor.__ctor__ Function The same as ctor, but less encapsulated.properties Object The property definitions.statics Object The static members.mixins Function[] editor Object attributes for Component listed below.
executeInEditMode Boolean Allows the current component to run in edit mode. By default, all components are executed only at runtime, meaning that they will not have their callback functions executed while the Editor is in edit mode.requireComponent Function Automatically add required component as a dependency.menu String The menu path to register a component to the editors "Component" menu. Eg. "Rendering/Camera".executionOrder Number The execution order of lifecycle methods for Component. Those less than 0 will execute before while those greater than 0 will execute after. The order will only affect onLoad, onEnable, start, update and lateUpdate while onDisable and onDestroy will not be affected.disallowMultiple Boolean If specified to a type, prevents Component of the same type (or subtype) to be added more than once to a Node.playOnFocus Boolean This property is only available when executeInEditMode is set. If specified, the editor's scene view will keep updating this node in 60 fps when it is selected, otherwise, it will update only if necessary.inspector String Customize the page url used by the current component to render in the Properties.icon String Customize the icon that the current component displays in the editor.help String The custom documentation URL
update Function lifecycle method for Component, see updatelateUpdate Function lifecycle method for Component, see lateUpdateonLoad Function lifecycle method for Component, see onLoadstart Function lifecycle method for Component, see startonEnable Function lifecycle method for Component, see onEnableonDisable Function lifecycle method for Component, see onDisableonDestroy Function lifecycle method for Component, see onDestroyonFocusInEditor Function lifecycle method for Component, see onFocusInEditoronLostFocusInEditor Function lifecycle method for Component, see onLostFocusInEditorresetInEditor Function lifecycle method for Component, see resetInEditoronRestore Function for Component only, see onRestore_getLocalBounds Function for Component only, see _getLocalBounds
Examples
var Node = cc.Class();
var Sprite = cc.Class({
name: 'Sprite',
extends: Node,
ctor: function () {
this.url = "";
this.id = 0;
},
statics: {
count: 0,
getBounds: function (spriteList) {
}
},
properties {
width: {
default: 128,
type: 'Integer',
tooltip: 'The width of sprite'
},
height: 128,
size: {
get: function () {
return cc.v2(this.width, this.height);
}
}
},
load: function () {
};
});
var obj = new Sprite();
obj.url = 'sprite.png';
obj.load();
_isCCClass
Checks whether the constructor is created by cc.Class
Parameters
isChildClassOf
Checks whether subclass is child of superclass or equals to superclass
Parameters
getInheritanceChain
Return all super classes
Parameters
Enum
Define an enum type.
If a enum item has a value of -1, it will be given an Integer number according to it's order in the list.
Otherwise it will use the value specified by user who writes the enum definition.
Parameters
obj object a JavaScript literal object containing enum names and values, or a TypeScript enum type
Examples
var WrapMode = cc.Enum({
Repeat: -1,
Clamp: -1
});
var FlagType = cc.Enum({
Flag1: 1,
Flag2: 2,
Flag3: 4,
Flag4: 8,
});
var AtlasSizeList = cc.Enum({
128: 128,
256: 256,
512: 512,
1024: 1024,
});
enum Direction {
Up,
Down,
Left,
Right
}
const {ccclass, property} = cc._decorator;
@ccclass
class NewScript extends cc.Component {
@property({
default: Direction.Up,
type: cc.Enum(Direction)
})
direction: Direction = Direction.Up;
}
getList
Parameters
enumDef Object the enum type defined from cc.Enum
setAccelerometerEnabled
whether enable accelerometer event
Parameters
setAccelerometerInterval
set accelerometer interval value
Parameters
handleTouchesBegin
Parameters
handleTouchesMove
Parameters
handleTouchesEnd
Parameters
handleTouchesCancel
Parameters
getSetOfTouchesEndOrCancel
Parameters
getHTMLElementPosition
Parameters
getPreTouch
Parameters
setPreTouch
Parameters
getTouchByXY
Parameters
getTouchByXY
Parameters
getPointByEvent
Parameters
getTouchesByEvent
Parameters
registerSystemEvent
Parameters
update
Parameters
lerp
Linear interpolation between 2 numbers, the ratio sets how much it is biased to each end
Parameters
Examples
----
lerp
cc.lerp(2,10,0.5)
cc.lerp(2,10,0.2)
rand
get a random number from 0 to 0xffffff
randomMinus1To1
returns a random float between -1 and 1
random0To1
returns a random float between 0 and 1, use Math.random directly
degreesToRadians
converts degrees to radians
Parameters
radiansToDegrees
converts radians to degrees
Parameters
nodeDrawSetup
Helpful macro that setups the GL server state, the correct GL program and sets the Model View Projection matrix
Parameters
incrementGLDraws
Increments the GL Draws counts by one.
The number of calls per frame are displayed on the screen when the CCDirector's stats are enabled.
Parameters
checkGLErrorDebug
Check webgl error.Error will be shown in console if exists.
isValid
Checks whether the object is non-nil and not yet destroyed.
Parameters
Examples
cc.log(cc.isValid(target));
deserialize
Deserialize json to cc.Asset
Parameters
data String | Object the serialized cc.Asset json string or json object.details Details additional loading resultoptions Object
instantiate
Clones the object original and returns the clone, or instantiate a node from the Prefab.
Parameters
original Prefab | Node | Object An existing object that you want to make a copy of.
Examples
var scene = cc.director.getScene();
var node = cc.instantiate(prefabAsset);
node.parent = scene;
var scene = cc.director.getScene();
var node = cc.instantiate(targetNode);
node.parent = scene;
find
Finds a node by hierarchy path, the path is case-sensitive.
It will traverse the hierarchy by splitting the path using '/' character.
This function will still returns the node even if it is inactive.
It is recommended to not use this function every frame instead cache the result at startup.
Parameters
color
The convenience method to create a new Color/Color:method
Alpha channel is optional. Default value is 255.
Parameters
Examples
-----------------------
var color1 = new cc.Color(255, 255, 255, 255);
var color2 = new cc.Color("#000000");
var color3 = new cc.Color({r: 255, g: 255, b: 255, a: 255});
colorEqual
returns true if both ccColor3B are equal. Otherwise it returns false.
Parameters
Examples
cc.log(cc.colorEqual(cc.Color.RED, new cc.Color(255, 0, 0)));
hexToColor
convert a string of color for style to Color.
e.g. "#ff06ff" to : cc.color(255,6,255)。
Parameters
Examples
cc.hexToColor("#FFFF33");
colorToHex
convert Color to a string of color for style.
e.g. cc.color(255,6,255) to : "#ff06ff"
Parameters
Examples
var color = new cc.Color(255, 6, 255)
cc.colorToHex(color);
pNeg
Returns opposite of Vec2.
Parameters
Examples
cc.pNeg(cc.v2(10, 10));
pAdd
Calculates sum of two points.
Parameters
Examples
cc.pAdd(cc.v2(1, 1), cc.v2(2, 2));
pSub
Calculates difference of two points.
Parameters
Examples
cc.pSub(cc.v2(20, 20), cc.v2(5, 5));
pMult
Returns point multiplied by given factor.
Parameters
Examples
cc.pMult(cc.v2(5, 5), 4);
pMidpoint
Calculates midpoint between two points.
Parameters
Examples
cc.pMidpoint(cc.v2(10, 10), cc.v2(5, 5));
pDot
Calculates dot product of two points.
Parameters
Examples
cc.pDot(cc.v2(20, 20), cc.v2(5, 5));
pCross
Calculates cross product of two points.
Parameters
Examples
cc.pCross(cc.v2(20, 20), cc.v2(5, 5));
pPerp
Calculates perpendicular of v, rotated 90 degrees counter-clockwise -- cross(v, perp(v)) greater than 0.
Parameters
Examples
cc.pPerp(cc.v2(20, 20));
pRPerp
Calculates perpendicular of v, rotated 90 degrees clockwise -- cross(v, rperp(v)) smaller than 0.
Parameters
Examples
cc.pRPerp(cc.v2(20, 20));
pProject
Calculates the projection of v1 over v2.
Parameters
Examples
var v1 = cc.v2(20, 20);
var v2 = cc.v2(5, 5);
cc.pProject(v1, v2);
pLengthSQ
Calculates the square length of a cc.Vec2 (not calling sqrt() ).
Parameters
Examples
cc.pLengthSQ(cc.v2(20, 20));
pDistanceSQ
Calculates the square distance between two points (not calling sqrt() ).
Parameters
Examples
var point1 = cc.v2(20, 20);
var point2 = cc.v2(5, 5);
cc.pDistanceSQ(point1, point2);
pLength
Calculates distance between point an origin.
Parameters
Examples
cc.pLength(cc.v2(20, 20));
pDistance
Calculates the distance between two points.
Parameters
Examples
var v1 = cc.v2(20, 20);
var v2 = cc.v2(5, 5);
cc.pDistance(v1, v2);
pNormalize
Returns this vector with a magnitude of 1.
Parameters
Examples
cc.pNormalize(cc.v2(20, 20));
pForAngle
Converts radians to a normalized vector.
Parameters
Examples
cc.pForAngle(20);
pToAngle
Converts a vector to radians.
Parameters
Examples
cc.pToAngle(cc.v2(20, 20));
clampf
Clamp a value between from and to.
Parameters
Examples
var v1 = cc.clampf(20, 0, 20);
var v2 = cc.clampf(-1, 0, 20);
var v3 = cc.clampf(10, 0, 20);
clamp01
Clamp a value between 0 and 1.
Parameters
Examples
var v1 = cc.clampf(20);
var v2 = cc.clampf(-1);
var v3 = cc.clampf(0.5);
pClamp
Clamp a point between from and to.
Parameters
Examples
var min_inclusive = cc.v2(0, 0);
var max_inclusive = cc.v2(20, 20);
var v1 = cc.pClamp(cc.v2(20, 20), min_inclusive, max_inclusive);
var v2 = cc.pClamp(cc.v2(0, 0), min_inclusive, max_inclusive);
var v3 = cc.pClamp(cc.v2(10, 10), min_inclusive, max_inclusive);
pFromSize
Quickly convert cc.Size to a cc.Vec2.
Parameters
Examples
cc.pFromSize(new cc.size(20, 20));
pCompOp
Run a math operation function on each point component
Math.abs, Math.fllor, Math.ceil, Math.round.
Parameters
Examples
cc.pCompOp(cc.p(-10, -10), Math.abs);
pLerp
Linear Interpolation between two points a and b.
alpha == 0 ? a
alpha == 1 ? b
otherwise a value between a..b.
Parameters
Examples
cc.pLerp(cc.v2(20, 20), cc.v2(5, 5), 0.5);
pFuzzyEqual
TODO
Parameters
Examples
var a = cc.v2(20, 20);
var b = cc.v2(5, 5);
var b1 = cc.pFuzzyEqual(a, b, 10);
var b2 = cc.pFuzzyEqual(a, b, 18);
pCompMult
Multiplies a nd b components, a.xb.x, a.yb.y.
Parameters
Examples
cc.pCompMult(acc.v2(20, 20), cc.v2(5, 5));
pAngleSigned
TODO
Parameters
pAngle
TODO
Parameters
pRotateByAngle
Rotates a point counter clockwise by the angle around a pivot.
Parameters
v Vec2 v is the point to rotatepivot Vec2 pivot is the pivot, naturallyangle Number angle is the angle of rotation cw in radians
pLineIntersect
A general line-line intersection test
indicating successful intersection of a line
note that to truly test intersection for segments we have to make
sure that s & t lie within [0..1] and for rays, make sure s & t > 0
the hit point is p3 + t (p4 - p3);
the hit point also is p1 + s (p2 - p1);
Parameters
A Vec2 A is the startpoint for the first line P1 = (p1 - p2).B Vec2 B is the endpoint for the first line P1 = (p1 - p2).C Vec2 C is the startpoint for the second line P2 = (p3 - p4).D Vec2 D is the endpoint for the second line P2 = (p3 - p4).retP Vec2 retP.x is the range for a hitpoint in P1 (pa = p1 + s(p2 - p1)),
retP.y is the range for a hitpoint in P3 (pa = p2 + t(p4 - p3)).
pSegmentIntersect
ccpSegmentIntersect return YES if Segment A-B intersects with segment C-D.
Parameters
pIntersectPoint
ccpIntersectPoint return the intersection point of line A-B, C-D.
Parameters
pSameAs
check to see if both points are equal.
Parameters
A Vec2 A ccp aB Vec2 B ccp b to be compared
pZeroIn
sets the position of the point to 0.
Parameters
pIn
copies the position of one point to another.
Parameters
pMultIn
multiplies the point with the given factor (inplace).
Parameters
pSubIn
subtracts one point from another (inplace).
Parameters
pAddIn
adds one point to another (inplace).
Parameters
pNormalizeIn
normalizes the point (inplace).
Parameters
rect
The convenience method to create a new Rect.
see Rect/Rect:method
Parameters
Examples
var a = new cc.Rect(0 , 0, 10, 0);
rectEqualToRect
Check whether a rect's value equals to another.
Parameters
Examples
var a = new cc.Rect(0, 0, 10, 10);
var b = new cc.Rect(0, 0, 5, 5);
cc.rectEqualToRect(a, b);
var c = new cc.Rect(0, 0, 5, 5);
cc.rectEqualToRect(b, c);
rectContainsRect
Check whether the rect1 contains rect2.
Parameters
Examples
var a = new cc.Rect(0, 0, 20, 20);
var b = new cc.Rect(10, 10, 20, 20);
cc.rectContainsRect(a, b);
rectGetMaxX
Returns the rightmost x-value of a rect.
Parameters
Examples
var a = new cc.Rect(10, 0, 20, 20);
cc.rectGetMaxX(a);
rectGetMidX
Return the midpoint x-value of a rect.
Parameters
Examples
var a = new cc.Rect(10, 0, 20, 20);
cc.rectGetMidX(a);
rectGetMinX
Returns the leftmost x-value of a rect.
Parameters
Examples
var a = new cc.Rect(10, 0, 20, 20);
cc.rectGetMinX(a);
rectGetMaxY
Return the topmost y-value of a rect.
Parameters
Examples
var a = new cc.Rect(0, 10, 20, 20);
cc.rectGetMaxY(a);
rectGetMidY
Return the midpoint y-value of `rect'.
Parameters
Examples
var a = new cc.Rect(0, 10, 20, 20);
cc.rectGetMidY(a);
rectGetMinY
Return the bottommost y-value of a rect.
Parameters
Examples
var a = new cc.Rect(0, 10, 20, 20);
cc.rectGetMinY(a);
rectContainsPoint
Check whether a rect contains a point.
Parameters
Examples
var a = new cc.Rect(0, 10, 20, 20);
var b = new cc.Vec2(0, 10, 10, 10);
cc.rectContainsPoint(a, b);
rectIntersectsRect
Check whether a rect intersect with another.
Parameters
Examples
var a = new cc.Rect(0, 10, 20, 20);
var b = new cc.Rect(0, 10, 10, 10);
cc.rectIntersectsRect(a, b);
rectOverlapsRect
Check whether a rect overlaps another.
Parameters
Examples
var a = new cc.Rect(0, 10, 20, 20);
var b = new cc.Rect(0, 10, 10, 10);
cc.rectOverlapsRect(a, b);
rectUnion
Returns the smallest rectangle that contains the two source rectangles.
Parameters
Examples
var a = new cc.Rect(0, 10, 20, 20);
var b = new cc.Rect(0, 10, 10, 10);
cc.rectUnion(a, b);
rectIntersection
Returns the overlapping portion of 2 rectangles.
Parameters
Examples
var a = new cc.Rect(0, 10, 20, 20);
var b = new cc.Rect(0, 10, 10, 10);
cc.rectIntersection(a, b);
size
Helper function that creates a cc.Size.
Please use cc.p or cc.v2 instead, it will soon replace cc.Size.
Parameters
Examples
var size1 = cc.size();
var size2 = cc.size(100,100);
var size3 = cc.size(size2);
var size4 = cc.size({width: 100, height: 100});
sizeEqualToSize
Check whether a point's value equals to another.
Parameters
Examples
var a = new cc.size(10, 10);
var b = new cc.size(10, 10);
cc.sizeEqualToSize(a, b);
var b = new cc.size(5, 10);
cc.sizeEqualToSize(a, b);
V3F_C4B_T2F_QuadZero
V3F_C4B_T2F_QuadCopy
Parameters
V3F_C4B_T2F_QuadsCopy
Parameters
v2
The convenience method to create a new cc.Vec2.
Parameters
Examples
var v1 = cc.v2();
var v2 = cc.v2(0, 0);
var v3 = cc.v2(v2);
var v4 = cc.v2({x: 100, y: 100});
p
The convenience method to creates a new cc.Vec2.
Parameters
Examples
var point1 = cc.p();
var point2 = cc.p(100, 100);
var point3 = cc.p(point2);
var point4 = cc.p({x: 100, y: 100});
pointEqualToPoint
Check whether a point's value equals to another.
Parameters
