#Upgrade guide from Cocos2d-JS v3.0 beta to Cocos2d-JS v3.1
If you are still using Cocos2d-html5 or Cocos2d-JSB v2.x, you need to read the previous upgrade guide first : Upgrade guide from Cocos2d-html5 v2.2.x to Cocos2d-JS v3.0 beta
In v3.0, you can start to bake a layer to a static cache, so that it can be rendered more efficiently.
var layer = new cc.Layer();
layer.bake();
// To disable bake
layer.unbake();
Detailed informations can be found in layer baking document
An object pool implementation have been proposed: cc.pool, it can helps you to improve your game performance for objects which need frequent release and recreate operations
Some common use case is : - Bullets in game (die very soon, massive creation and recreation, no side effect on other objects) - Blocks in Candy Crash (massive creation and recreation) - etc...
When you no longer need an object and hope that it can be reused, you can add it to the object pool with cc.pool.putInPool(obj).
layer.removeChild(sprite);
cc.pool.putInPool(sprite);
When you want to retrieve an object from object pool, you can use cc.pool.getFromPool().
cc.pool.getFromPool(cc.Sprite, "a.png");
You can check whether there is objects available in the pool for a given class with cc.pool.hasObj(cc.Sprite).
You can also clean the pool and release all objects with cc.pool.drainAllPool().
We added a bunch of new easing functions listing below:
cc.easeBezierAction(p0, p1, p2, p3) // Have issues in JSB
cc.easeQuadraticActionIn()
cc.easeQuadraticActionOut()
cc.easeQuadraticActionInOut()
cc.easeQuarticActionIn()
cc.easeQuarticActionOut()
cc.easeQuarticActionInOut()
cc.easeQuinticActionIn()
cc.easeQuinticActionOut()
cc.easeQuinticActionInOut()
cc.easeCircleActionIn()
cc.easeCircleActionOut()
cc.easeCircleActionInOut()
cc.easeCubicActionIn()
cc.easeCubicActionOut()
cc.easeCubicActionInOut()
Just for a remindment, the new API for using an easing action is action.easing(cc.easeQuadraticActionIn()).
We added jsb namespace to contain all jsb only APIs:
cc.fileUtils --> jsb.fileUtils
cc.Reflection --> jsb.Reflection
cc.AssetsManager --> jsb.AssetsManager
cc.EventAssetsManager --> jsb.EventAssetsManager
cc.EventListenerAssetsManager --> jsb.EventListenerAssetsManager
And some new functions have been bound to jsb.fileUtils:
jsb.fileUtils.getSearchPaths()
jsb.fileUtils.setSearchPaths(paths)
jsb.fileUtils.getSearchResolutionsOrder()
jsb.fileUtils.setSearchResolutionsOrder(orders)
jsb.fileUtils.addSearchResolutionsOrder(order)
getLeftInParent --> getLeftBoundary
getBottomInParent --> getBottomBoundary
getRightInParent --> getRightBoundary
getTopInParent --> getTopBoundary
We also added getContentSize and setContentSize to ccui.Widget, so that it can share the same usage with cc.Node.
// Added
ccui.Widget#getContentSize
ccui.Widget#setContentSize
All addEventListenerXXX in ccui have been renamed to addEventListener to ensure better develop experience.
ccui.CheckBox#addEventListenerCheckBox --> ccui.CheckBox#addEventListener
ccui.Slider#addEventListenerSlider --> ccui.Slider#addEventListener
ccui.TextField#addEventListenerTextField --> ccui.TextField#addEventListener
ccui.PageView#addEventListenerPageView --> ccui.PageView#addEventListener
ccui.ScrollView#addEventListenerScrollView --> ccui.ScrollView#addEventListener
ccui.ListView#addEventListenerListView --> ccui.ListView#addEventListener
A new API downloadFailedAssets allows you to restart failed download, and other great improvement can be found in upgraded Assets manager document
cc.FadeIn.create(duration, toOpacity) --> cc.FadeIn.create(duration)
var str = "The number is";
var number = cc.random0To1() * 10;
cc.log("%s : %d", str, number);
To adapte our naming protocole, we have renamed all affine transform functions, here is the list:
cc.AffineTransformMake -> cc.affineTransformMake
cc.PointApplyAffineTransform -> cc.pointApplyAffineTransform
cc.\_PointApplyAffineTransform -> cc._pointApplyAffineTransform
cc.SizeApplyAffineTransform -> cc.sizeApplyAffineTransform
cc.AffineTransformMakeIdentity -> cc.affineTransformMakeIdentity
cc.AffineTransformIdentity -> cc.affineTransformIdentity
cc.RectApplyAffineTransform -> cc.rectApplyAffineTransform
cc.\_RectApplyAffineTransformIn -> cc._rectApplyAffineTransformIn
cc.AffineTransformTranslate -> cc.affineTransformTranslate
cc.AffineTransformScale -> cc.affineTransformScale
cc.AffineTransformRotate -> cc.affineTransformRotate
cc.AffineTransformConcat -> cc.affineTransformConcat
cc.AffineTransformEqualToTransform -> cc.affineTransformEqualToTransform
cc.AffineTransformInvert -> cc.affineTransformInvert
cc.RenderTexture.beginWithClear(r, g, b, a, depthValue, stencilValue)
cc.RenderTexture's beginWithClear function now start to accept color value from 0-255 for r, g, b, a parameters, please stop to use float value parameters.
Added cc.sys.platform for detecting target platform.
Bound console.log function for JSB.
Added cc.formatStr for string formatting, for example:
cc.formatStr("a: %d, b: %b", a, b);
The following APIs also support formatted string as parameters:
cc.log(message, ...)
cc.assert(condition, message, ...)
cc.warn(message, ...)
cc.error(message, ...)
cc.pool.hasObj -> cc.pool.hasObject
cc.pool.removeObj -> cc.pool.removeObject
cc.textureCache.textureForKey -> cc.textureCache.getTextureForKey
cc.TMXTilemap#propertiesForGID -> cc.TMXTilemap#getPropertiesForGID
// Added
cc.DENSITYDPI_DEVICE = "device-dpi";
cc.DENSITYDPI_HIGH = "high-dpi";
cc.DENSITYDPI_MEDIUM = "medium-dpi";
cc.DENSITYDPI_LOW = "low-dpi";
cc.view.setTargetDensityDPI(targetDensityDPI)
cc.view.getTargetDensityDPI()