Cocos Creator API

1.2.0

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

Sprite

模块: cc

该组件用于在场景中渲染精灵。

示例:

// Create a new node and add sprite components.
 var node = new cc.Node("New Sprite");
 var sprite = node.addComponent(cc.Sprite);
 node.parent = this.node;

属性(properties)

spriteFrame SpriteFrame

精灵的精灵帧

示例:

sprite.spriteFrame = newSpriteFrame;

type Sprite.SpriteType

精灵渲染类型

示例:

sprite.type = cc.Sprite.Type.SIMPLE;

fillType Sprite.FillType

精灵填充类型,仅渲染类型设置为 cc.Sprite.SpriteType.FILLED 时有效。

示例:

sprite.fillType = cc.Sprite.FillType.HORIZONTAL;

fillCenter Vec2

填充中心点,仅渲染类型设置为 cc.Sprite.SpriteType.FILLED 时有效。

示例:

sprite.fillCenter = new cc.Vec2(0, 0);

fillStart Number

填充起始点,仅渲染类型设置为 cc.Sprite.SpriteType.FILLED 时有效。

示例:

// -1 To 1 between the numbers
sprite.fillStart = 0.5;

fillRange Number

填充范围,仅渲染类型设置为 cc.Sprite.SpriteType.FILLED 时有效。

示例:

// -1 To 1 between the numbers
sprite.fillRange = 1;

trim Boolean

是否使用裁剪模式

示例:

sprite.trim = true;

srcBlendFactor BlendFactor

指定原图的混合模式

示例:

sprite.srcBlendFactor = cc.BlendFunc.BlendFactor.ONE;

dstBlendFactor BlendFactor

指定目标的混合模式

示例:

sprite.dstBlendFactor = cc.BlendFunc.BlendFactor.ONE;

sizeMode Sprite.SizeMode

精灵尺寸调整模式

示例:

sprite.sizeMode = cc.Sprite.SizeMode.CUSTOM;

_sgNode _ccsg.Node private

Reference to the instance of _ccsg.Node If it is possible to return null from your overloaded _createSgNode, then you should always check for null before using this property and reimplement __preload.

node Node

继承自 Component:

该组件被附加到的节点。组件总会附加到一个节点。

示例:

cc.log(comp.node);

uuid String readOnly

继承自 Component:

组件的 uuid,用于编辑器。

示例:

cc.log(comp.uuid);

_enabled Boolean private

继承自 Component:

enabled Boolean

继承自 Component:

表示该组件自身是否启用。

示例:

comp.enabled = true;
cc.log(comp.enabled);

enabledInHierarchy Boolean readOnly

继承自 Component:

表示该组件是否被启用并且所在的节点也处于激活状态。。

示例:

cc.log(comp.enabledInHierarchy);

_isOnLoadCalled Boolean readOnly

继承自 Component:

onLoad 是否被调用。

示例:

cc.log(_isOnLoadCalled);

__eventTargets Array private

继承自 Component:

Register all related EventTargets, all event callbacks will be removed in _onPreDestroy

_name String private

_objFlags Number private

name String

该对象的名称。

示例:

obj.name = "New Obj";

isValid Boolean readOnly

表示该对象是否可用(被销毁后将不可用)。

示例:

cc.log(obj.isValid);

There are no properties that match your current filter settings. You can change your filter settings in the index section on this page. index

方法

setInsetLeft
(
  • insetLeft
)

设置精灵左边框-用于九宫格。

名称 类型 描述
insetLeft Number

The values to use for the cap inset.

示例:

sprite.setInsetLeft(5);

getInsetLeft ( ) Number

获取精灵左边框

返回:

类型: Number

The left sprite's cap inset.

示例:

var insetLeft = sprite.getInsetLeft();
cc.log("Inset Left:" + insetLeft);

setInsetTop
(
  • insetTop
)

设置精灵上边框-用于九宫格。

名称 类型 描述
insetTop Number

The values to use for the cap inset.

示例:

sprite.setInsetTop(5);

getInsetTop ( ) Number

获取精灵上边框。

返回:

类型: Number

The top sprite's cap inset.

示例:

var insetTop = sprite.getInsetTop();
cc.log("Inset Top:" + insetTop);

setInsetRight
(
  • insetRight
)

设置精灵右边框-用于九宫格。

名称 类型 描述
insetRight Number

The values to use for the cap inset.

示例:

sprite.setInsetRight(5);

getInsetRight ( ) Number

获取精灵右边框。

返回:

类型: Number

The right sprite's cap inset.

示例:

var insetRight = sprite.getInsetRight();
cc.log("Inset Right:" + insetRight);

setInsetBottom
(
  • bottomInset
)

设置精灵下边框-用于九宫格。

名称 类型 描述
bottomInset Number

The values to use for the cap inset.

示例:

sprite.setInsetBottom(5);

getInsetBottom ( ) Number

获取精灵下边框。

返回:

类型: Number

The bottom sprite's cap inset.

示例:

var insetBottom = sprite.getInsetBottom();
cc.log("Inset Bottom:" + insetBottom);

_createSgNode ( ) _ccsg.Node private

Create and returns your new scene graph node (SGNode) to add to scene graph. You should call the setContentSize of the SGNode if its size should be the same with the node's.

返回:

类型: _ccsg.Node

_initSgNode ( ) private

_removeSgNode ( ) private

update ( )

继承自 Component:

如果该组件启用,则每帧调用 update。

lateUpdate ( )

继承自 Component:

如果该组件启用,则每帧调用 LateUpdate。

__preload ( ) private

继承自 Component:

__preload is called before every onLoad. It is used to initialize the builtin components internally, to avoid checking whether onLoad is called before every public method calls. This method should be removed if script priority is supported.

onLoad ( )

继承自 Component:

当附加到一个激活的节点上或者其节点第一次激活时候调用。

start ( )

继承自 Component:

如果该组件第一次启用,则在所有组件的 update 之前调用。

onEnable ( )

继承自 Component:

当该组件被启用,并且它的节点也激活时。

onDisable ( )

继承自 Component:

当该组件被禁用或节点变为无效时调用。

onDestroy ( )

继承自 Component:

当该组件被销毁时调用

onFocusInEditor ( )

继承自 Component:

onLostFocusInEditor ( )

继承自 Component:

addComponent
(
  • typeOrTypename
)
Component

继承自 Component:

向节点添加一个组件类,你还可以通过传入脚本的名称来添加组件。

名称 类型 描述
typeOrTypename Function | String

the constructor or the class name of the component to add

返回:

类型: Component

the newly added component

示例:

var sprite = node.addComponent(cc.Sprite);
var test = node.addComponent("Test");

getComponent
(
  • typeOrClassName
)
Component

继承自 Component:

获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
传入参数也可以是脚本的名称。

名称 类型 描述
typeOrClassName Function | String

返回:

类型: Component

示例:

// get sprite component.
var sprite = node.getComponent(cc.Sprite);
// get custom test calss.
var test = node.getComponent("Test");

getComponents
(
  • typeOrClassName
)
Component[]

继承自 Component:

返回节点上指定类型的所有组件。

名称 类型 描述
typeOrClassName Function | String

返回:

类型: Component[]

示例:

var sprites = node.getComponents(cc.Sprite);
var tests = node.getComponents("Test");

getComponentInChildren
(
  • typeOrClassName
)
Component

继承自 Component:

递归查找所有子节点中第一个匹配指定类型的组件。

名称 类型 描述
typeOrClassName Function | String

返回:

类型: Component

示例:

var sprite = node.getComponentInChildren(cc.Sprite);
var Test = node.getComponentInChildren("Test");

getComponentsInChildren
(
  • typeOrClassName
)
Component[]

继承自 Component:

递归查找自身或所有子节点中指定类型的组件

名称 类型 描述
typeOrClassName Function | String

返回:

类型: Component[]

示例:

var sprites = node.getComponentsInChildren(cc.Sprite);
var tests = node.getComponentsInChildren("Test");

_getLocalBounds
(
  • out_rect
)

继承自 Component:

如果组件的包围盒与节点不同,您可以实现该方法以提供自定义的轴向对齐的包围盒(AABB), 以便编辑器的场景视图可以正确地执行点选测试。

名称 类型 描述
out_rect Rect

the Rect to receive the bounding box

onRestore ( )

继承自 Component:

onRestore 是用户在检查器菜单点击 Reset 时,对此组件执行撤消操作后调用的。

如果组件包含了“内部状态”(不在 CCClass 属性中定义的临时成员变量),那么你可能需要实现该方法。

编辑器执行撤销/重做操作时,将调用组件的 get set 来录制和还原组件的状态。 然而,在极端的情况下,它可能无法良好运作。
那么你就应该实现这个方法,手动根据组件的属性同步“内部状态”。 一旦你实现这个方法,当用户撤销或重做时,组件的所有 get set 都不会再被调用。 这意味着仅仅指定了默认值的属性将被编辑器记录和还原。

同样的,编辑可能无法在极端情况下正确地重置您的组件。
于是如果你需要支持组件重置菜单,你需要在该方法中手工同步组件属性到“内部状态”。
一旦你实现这个方法,组件的所有 get set 都不会在重置操作时被调用。 这意味着仅仅指定了默认值的属性将被编辑器重置。
此方法仅在编辑器下会被调用。

schedule
(
  • callback
  • [interval =0]
  • [repeat =cc.macro.REPEAT_FOREVER]
  • [delay =0]
)

继承自 Component:

调度一个自定义的回调函数。
如果回调函数已调度,那么将不会重复调度它,只会更新时间间隔参数。

名称 类型 描述
callback function

The callback function

interval optional Number 0

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

repeat optional Number cc.macro.REPEAT_FOREVER

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

delay optional Number 0

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

示例:

var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.schedule(timeCallback, 1);

scheduleOnce
(
  • callback
  • [delay =0]
)

继承自 Component:

调度一个只运行一次的回调函数,可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。

名称 类型 描述
callback function

A function wrapped as a selector

delay optional Number 0

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

示例:

var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.scheduleOnce(timeCallback, 2);

unschedule
(
  • callback_fn
)

继承自 Component:

取消调度一个自定义的回调函数。

名称 类型 描述
callback_fn function

A function wrapped as a selector

示例:

this.unschedule(_callback);

unscheduleAllCallbacks ( )

继承自 Component:

取消调度所有已调度的回调函数:定制的回调函数以及 'update' 回调函数。动作不受此方法影响。

示例:

this.unscheduleAllCallbacks();

destroy ( ) Boolean

销毁该对象,并释放所有它对其它对象的引用。
销毁后,CCObject 不再可用。您可以在访问对象之前使用 cc.isValid(obj) 来检查对象是否已被销毁。 实际销毁操作会延迟到当前帧渲染前执行。

返回:

类型: Boolean

whether it is the first time the destroy being called

示例:

obj.destroy();

_destruct ( ) private

Clear all references in the instance.

NOTE: this method will not clear the getter or setter functions which defined in the INSTANCE of CCObject. You can override the _destruct method if you need.

_onPreDestroy ( ) private

Called before the object being destroyed.

_serialize
(
  • exporting
)
object private

The customized serialization for this object. (Editor Only)

名称 类型 描述
exporting Boolean

返回:

类型: object

the serialized json data object

_deserialize
(
  • data
  • ctx
)
private

Init this object from the custom serialized data.

名称 类型 描述
data Object

the serialized json data

ctx _Deserializer

There are no methods that match your current filter settings. You can change your filter settings in the index section on this page. index