Cocos Creator API

1.2.0

Cocos Creator is a highly customizable game development tool that utilizes the power of cocos2d-x.

模块 cc

Cocos 引擎的主要命名空间,引擎代码中所有的类,函数,属性和常量都在这个命名空间中定义。

类型

属性(properties)

view View

cc.view 是全局的视图对象。

director Director

导演类。

winSize Size

cc.winSize 为当前的游戏窗口的大小。

game Game

Integer string readOnly

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 readOnly

Indicates that the elements in array should be type double.

Boolean string readOnly

Indicates that the elements in array should be type boolean.

String string readOnly

Indicates that the elements in array should be type string.

方法

_initDebugSetting
(
  • mode
)

设置调试模式。

名称 类型 描述
mode DebugMode

error
(
  • obj
  • subst
)

输出错误消息到 Cocos Creator 编辑器的 Console 或运行时页面端的 Console 中。

  • 在 Cocos Creator 中,错误信息显示是红色的。
  • 在 Chrome 中,错误信息有红色的图标以及红色的消息文本。
名称 类型 描述
obj 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
(
  • obj
  • subst
)

输出警告消息到 Cocos Creator 编辑器的 Console 或运行时 Web 端的 Console 中。

  • 在 Cocos Creator 中,警告信息显示是黄色的。
  • 在 Chrome 中,警告信息有着黄色的图标以及黄色的消息文本。
名称 类型 描述
obj 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
(
  • obj
  • subst
)

输出一条消息到 Cocos Creator 编辑器的 Console 或运行时 Web 端的 Console 中。

名称 类型 描述
obj 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
(
  • obj
  • subst
)

输出一条信息消息到 Cocos Creator 编辑器的 Console 或运行时 Web 端的 Console 中。

  • 在 Cocos Creator 中,Info 信息显示是蓝色的。
  • 在 Firefox 和 Chrome 中,Info 信息有着小 “i” 图标。
名称 类型 描述
obj 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.

HashElement ( )

Constructor

speed
(
  • action
  • speed
)
Action

修改目标动作的速率。

名称 类型 描述
action ActionInterval
speed Number

返回:

类型: Action

示例:

// change the target action speed;
var action = cc.scaleTo(0.2, 1, 0.6);
var newAction = cc.speed(action, 0.5);

follow
(
  • followedNode
  • rect
)
Action | Null

追踪目标节点的位置。

名称 类型 描述
followedNode Node
rect Rect

返回:

类型: Action | Null

returns the cc.Follow object on success

示例:

// example
// creates the action with a set boundary
var followAction = cc.follow(targetNode, cc.rect(0, 0, screenWidth * 2 - 100, screenHeight));
node.runAction(followAction);

// creates the action with no boundary set
var followAction = cc.follow(targetNode);
node.runAction(followAction);

setPoints
(
  • points
)

Points setter

名称 类型 描述
points Array

cardinalSplineTo
(
  • duration
  • points
  • tension
)
ActionInterval

按基数样条曲线轨迹移动到目标位置。

名称 类型 描述
duration Number
points Array

array of control points

tension Number

返回:

类型: ActionInterval

示例:

//create a cc.CardinalSplineTo
var action1 = cc.cardinalSplineTo(3, array, 0);

updatePosition
(
  • newPos
)

update position of target

名称 类型 描述
newPos Vec2

cardinalSplineBy
(
  • duration
  • points
  • tension
)
ActionInterval

按基数样条曲线轨迹移动指定的距离。

名称 类型 描述
duration Number
points Array
tension Number

返回:

类型: ActionInterval

catmullRomTo
(
  • dt
  • points
)
ActionInterval

按 Catmull Rom 样条曲线轨迹移动到目标位置。

名称 类型 描述
dt Number
points Array

返回:

类型: ActionInterval

示例:

var action1 = cc.catmullRomTo(3, array);

catmullRomBy
(
  • dt
  • points
)
ActionInterval

按 Catmull Rom 样条曲线轨迹移动指定的距离。

名称 类型 描述
dt Number
points Array

返回:

类型: ActionInterval

示例:

var action1 = cc.catmullRomBy(3, array);

easeIn
(
  • rate
)
Object

创建 easeIn 缓动对象,由慢到快。

名称 类型 描述
rate Number

返回:

类型: Object

示例:

// example
action.easing(cc.easeIn(3.0));

easeOut
(
  • rate
)
Object

创建 easeOut 缓动对象,由快到慢。

名称 类型 描述
rate Number

返回:

类型: Object

示例:

// example
action.easing(cc.easeOut(3.0));

easeInOut
(
  • rate
)
Object

创建 easeInOut 缓动对象,慢到快,然后慢。

名称 类型 描述
rate Number

返回:

类型: Object

示例:

//The new usage
action.easing(cc.easeInOut(3.0));

easeExponentialIn ( ) Object

创建 easeExponentialIn 缓动对象。
EaseExponentialIn 是按指数函数缓动进入的动作。
参考 easeInExpo:http://www.zhihu.com/question/21981571/answer/19925418

返回:

类型: Object

示例:

// example
action.easing(cc.easeExponentialIn());

easeExponentialOut ( ) Object

创建 easeExponentialOut 缓动对象。
EaseExponentialOut 是按指数函数缓动退出的动作。
参考 easeOutExpo:http://www.zhihu.com/question/21981571/answer/19925418

返回:

类型: Object

示例:

// example
action.easing(cc.easeExponentialOut());

easeExponentialInOut ( ) Object

创建 easeExponentialInOut 缓动对象。
EaseExponentialInOut 是按指数函数缓动进入并退出的动作。
参考 easeInOutExpo:http://www.zhihu.com/question/21981571/answer/19925418

返回:

类型: Object

示例:

// example
action.easing(cc.easeExponentialInOut());

easeSineIn ( ) Object

创建 EaseSineIn 缓动对象。
EaseSineIn 是按正弦函数缓动进入的动作。
参考 easeInSine:http://www.zhihu.com/question/21981571/answer/19925418

返回:

类型: Object

示例:

// example
action.easing(cc.easeSineIn());

easeSineOut ( ) Object

创建 EaseSineOut 缓动对象。
EaseSineIn 是按正弦函数缓动退出的动作。
参考 easeOutSine:http://www.zhihu.com/question/21981571/answer/19925418

返回:

类型: Object

示例:

// example
action.easing(cc.easeSineOut());

easeSineInOut ( ) Object

创建 easeSineInOut 缓动对象。
EaseSineIn 是按正弦函数缓动进入并退出的动作。
参考 easeInOutSine:http://www.zhihu.com/question/21981571/answer/19925418

返回:

类型: Object

示例:

// example
action.easing(cc.easeSineInOut());

easeElasticIn
(
  • period
)
Object

创建 easeElasticIn 缓动对象。
EaseElasticIn 是按弹性曲线缓动进入的动作。
参数 easeInElastic:http://www.zhihu.com/question/21981571/answer/19925418

名称 类型 描述
period Number

返回:

类型: Object

示例:

// example
action.easing(cc.easeElasticIn(3.0));

easeElasticOut
(
  • period
)
Object

创建 easeElasticOut 缓动对象。
EaseElasticOut 是按弹性曲线缓动退出的动作。
参考 easeOutElastic:http://www.zhihu.com/question/21981571/answer/19925418

名称 类型 描述
period Number

返回:

类型: Object

示例:

// example
action.easing(cc.easeElasticOut(3.0));

easeElasticInOut
(
  • period
)
Object

创建 easeElasticInOut 缓动对象。
EaseElasticInOut 是按弹性曲线缓动进入并退出的动作。
参考 easeInOutElastic:http://www.zhihu.com/question/21981571/answer/19925418

名称 类型 描述
period Number

返回:

类型: Object

示例:

// example
action.easing(cc.easeElasticInOut(3.0));

easeBounceIn ( ) Object

创建 easeBounceIn 缓动对象。
EaseBounceIn 是按弹跳动作缓动进入的动作。

返回:

类型: Object

示例:

// example
action.easing(cc.easeBounceIn());

easeBounceOut ( ) Object

创建 easeBounceOut 缓动对象。
EaseBounceOut 是按弹跳动作缓动退出的动作。

返回:

类型: Object

示例:

// example
action.easing(cc.easeBounceOut());

easeBounceInOut ( ) Object

创建 easeBounceInOut 缓动对象。
EaseBounceInOut 是按弹跳动作缓动进入并退出的动作。

返回:

类型: Object

示例:

// example
action.easing(cc.easeBounceInOut());

easeBackIn ( ) Object

创建 easeBackIn 缓动对象。
easeBackIn 是在相反的方向缓慢移动,然后加速到正确的方向。

返回:

类型: Object

示例:

// example
action.easing(cc.easeBackIn());

easeBackOut ( ) Object

创建 easeBackOut 缓动对象。
easeBackOut 快速移动超出目标,然后慢慢回到目标点。

返回:

类型: Object

示例:

// example
action.easing(cc.easeBackOut());

easeBackInOut ( ) Object

创建 easeBackInOut 缓动对象。

返回:

类型: Object

示例:

// example
action.easing(cc.easeBackInOut());

easeBezierAction
(
  • p0
  • p1
  • p2
  • p3
)
Object

创建 easeBezierAction 缓动对象。
EaseBezierAction 是按贝塞尔曲线缓动的动作。

名称 类型 描述
p0 Number

The first bezier parameter

p1 Number

The second bezier parameter

p2 Number

The third bezier parameter

p3 Number

The fourth bezier parameter

返回:

类型: Object

示例:

// example
action.easing(cc.easeBezierAction(0.5, 0.5, 1.0, 1.0));

easeQuadraticActionIn ( ) Object

创建 easeQuadraticActionIn 缓动对象。
EaseQuadraticIn是按二次函数缓动进入的动作。
参考 easeInQuad:http://www.zhihu.com/question/21981571/answer/19925418

返回:

类型: Object

示例:

//example
action.easing(cc.easeQuadraticActionIn());

easeQuadraticActionOut ( ) Object

创建 easeQuadraticActionOut 缓动对象。
EaseQuadraticOut 是按二次函数缓动退出的动作。
参考 easeOutQuad:http://www.zhihu.com/question/21981571/answer/19925418

返回:

类型: Object

示例:

//example
action.easing(cc.easeQuadraticActionOut());

easeQuadraticActionInOut ( ) Object

创建 easeQuadraticActionInOut 缓动对象。
EaseQuadraticInOut 是按二次函数缓动进入并退出的动作。
参考 easeInOutQuad:http://www.zhihu.com/question/21981571/answer/19925418

返回:

类型: Object

示例:

//example
action.easing(cc.easeQuadraticActionInOut());

easeQuarticActionIn ( ) Object

创建 easeQuarticActionIn 缓动对象。
EaseQuarticIn 是按四次函数缓动进入的动作。
参考 easeIntQuart:http://www.zhihu.com/question/21981571/answer/19925418

返回:

类型: Object

示例:

//example
action.easing(cc.easeQuarticActionIn());

easeQuarticActionOut ( ) Object

创建 easeQuarticActionOut 缓动对象。
EaseQuarticOut 是按四次函数缓动退出的动作。
参考 easeOutQuart:http://www.zhihu.com/question/21981571/answer/19925418

返回:

类型: Object

示例:

//example
action.easing(cc.QuarticActionOut());

easeQuarticActionInOut ( ) Object

创建 easeQuarticActionInOut 缓动对象。
EaseQuarticInOut 是按四次函数缓动进入并退出的动作。
参考 easeInOutQuart:http://www.zhihu.com/question/21981571/answer/19925418

返回:

类型: Object

easeQuinticActionIn ( ) Object

创建 easeQuinticActionIn 缓动对象。
EaseQuinticIn 是按五次函数缓动进的动作。
参考 easeInQuint:http://www.zhihu.com/question/21981571/answer/19925418

返回:

类型: Object

示例:

//example
action.easing(cc.easeQuinticActionIn());

easeQuinticActionOut ( ) Object

创建 easeQuinticActionOut 缓动对象。
EaseQuinticOut 是按五次函数缓动退出的动作 参考 easeOutQuint:http://www.zhihu.com/question/21981571/answer/19925418

返回:

类型: Object

示例:

//example
action.easing(cc.easeQuadraticActionOut());

easeQuinticActionInOut ( ) Object

创建 easeQuinticActionInOut 缓动对象。
EaseQuinticInOut是按五次函数缓动进入并退出的动作。
参考 easeInOutQuint:http://www.zhihu.com/question/21981571/answer/19925418

返回:

类型: Object

示例:

//example
action.easing(cc.easeQuinticActionInOut());

easeCircleActionIn ( ) Object

创建 easeCircleActionIn 缓动对象。
EaseCircleIn是按圆形曲线缓动进入的动作。
参考 easeInCirc:http://www.zhihu.com/question/21981571/answer/19925418

返回:

类型: Object

示例:

//example
action.easing(cc.easeCircleActionIn());

easeCircleActionOut ( ) Object

创建 easeCircleActionOut 缓动对象。
EaseCircleOut是按圆形曲线缓动退出的动作。
参考 easeOutCirc:http://www.zhihu.com/question/21981571/answer/19925418

返回:

类型: Object

easeCircleActionInOut ( ) Object

创建 easeCircleActionInOut 缓动对象。
EaseCircleInOut 是按圆形曲线缓动进入并退出的动作。
参考 easeInOutCirc:http://www.zhihu.com/question/21981571/answer/19925418

返回:

类型: Object

示例:

//example
action.easing(cc.easeCircleActionInOut());

easeCubicActionIn ( ) Object

创建 easeCubicActionIn 缓动对象。
EaseCubicIn 是按三次函数缓动进入的动作。
参考 easeInCubic:http://www.zhihu.com/question/21981571/answer/19925418

返回:

类型: Object

示例:

//example
action.easing(cc.easeCubicActionIn());

easeCubicActionOut ( ) Object

创建 easeCubicActionOut 缓动对象。
EaseCubicOut 是按三次函数缓动退出的动作。
参考 easeOutCubic:http://www.zhihu.com/question/21981571/answer/19925418

返回:

类型: Object

示例:

//example
action.easing(cc.easeCubicActionOut());

easeCubicActionInOut ( ) Object

创建 easeCubicActionInOut 缓动对象。
EaseCubicInOut是按三次函数缓动进入并退出的动作。
参考 easeInOutCubic:http://www.zhihu.com/question/21981571/answer/19925418

返回:

类型: Object

show ( ) ActionInstant

立即显示。

返回:

类型: ActionInstant

示例:

// example
var showAction = cc.show();

hide ( ) ActionInstant

立即隐藏。

返回:

类型: ActionInstant

示例:

// example
var hideAction = cc.hide();

toggleVisibility ( ) ActionInstant

显隐状态切换。

返回:

类型: ActionInstant

示例:

// example
var toggleVisibilityAction = cc.toggleVisibility();

removeSelf
(
  • isNeedCleanUp
)
ActionInstant

从父节点移除自身。

名称 类型 描述
isNeedCleanUp Boolean

返回:

类型: ActionInstant

示例:

// example
var removeSelfAction = cc.removeSelf();

flipX
(
  • flip
)
ActionInstant

X轴翻转。

名称 类型 描述
flip Boolean

Indicate whether the target should be flipped or not

返回:

类型: ActionInstant

示例:

var flipXAction = cc.flipX(true);

flipY
(
  • flip
)
ActionInstant

Y轴翻转。

名称 类型 描述
flip Boolean

返回:

类型: ActionInstant

示例:

var flipYAction = cc.flipY(true);

place
(
  • pos
  • [y ]
)
ActionInstant

放置在目标位置。

名称 类型 描述
pos Vec2 | Number
y optional Number

返回:

类型: ActionInstant

示例:

// example
var placeAction = cc.place(cc.p(200, 200));
var placeAction = cc.place(200, 200);

callFunc
(
  • selector
  • [selectorTarget ]
  • [data ]
)
ActionInstant

执行回调函数。

名称 类型 描述
selector function
selectorTarget optional object | Null
data optional | Null

data for function, it accepts all data types.

返回:

类型: ActionInstant

示例:

// example
// CallFunc without data
var finish = cc.callFunc(this.removeSprite, this);

// CallFunc with data
var finish = cc.callFunc(this.removeFromParentAndCleanup, this._grossini,  true);

sequence
(
  • tempArray
)
ActionInterval

顺序执行动作,创建的动作将按顺序依次运行。

名称 类型 描述
tempArray Array | FiniteTimeAction

返回:

类型: ActionInterval

示例:

// example
// create sequence with actions
var seq = cc.sequence(act1, act2);

// create sequence with array
var seq = cc.sequence(actArray);

repeat
(
  • action
  • times
)
ActionInterval

重复动作,可以按一定次数重复一个动,如果想永远重复一个动作请使用 repeatForever 动作来完成。

名称 类型 描述
action FiniteTimeAction
times Number

返回:

类型: ActionInterval

示例:

// example
var rep = cc.repeat(cc.sequence(jump2, jump1), 5);

repeatForever
(
  • action
)
ActionInterval

永远地重复一个动作,有限次数内重复一个动作请使用 repeat 动作。

名称 类型 描述
action FiniteTimeAction

返回:

类型: ActionInterval

示例:

// example
var repeat = cc.repeatForever(cc.rotateBy(1.0, 360));

spawn
(
  • tempArray
)
FiniteTimeAction

同步执行动作,同步执行一组动作。

名称 类型 描述
tempArray Array | FiniteTimeAction

返回:

示例:

// example
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
(
  • duration
  • deltaAngleX
  • [deltaAngleY ]
)
ActionInterval

旋转到目标角度,通过逐帧修改它的 rotation 属性,旋转方向将由最短的角度决定。

名称 类型 描述
duration Number

duration in seconds

deltaAngleX Number

deltaAngleX in degrees.

deltaAngleY optional Number

deltaAngleY in degrees.

返回:

类型: ActionInterval

示例:

// example
var rotateTo = cc.rotateTo(2, 61.0);

rotateBy
(
  • duration
  • deltaAngleX
  • [deltaAngleY ]
)
ActionInterval

旋转指定的角度。

名称 类型 描述
duration Number

duration in seconds

deltaAngleX Number

deltaAngleX in degrees

deltaAngleY optional Number

deltaAngleY in degrees

返回:

类型: ActionInterval

示例:

// example
var actionBy = cc.rotateBy(2, 360);

moveBy
(
  • duration
  • deltaPos
  • deltaY
  • </