Cocos Creator API

1.0.0

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

Mask

Module: cc

Properties

_sgNode _ccsg.Node private

The Reference to the instance of _ccsg.Node used when this component enabled

node Node

Inherited from Component:

The node this component is attached to. A component is always attached to a node.

examples:

cc.log(comp.node);

uuid String readOnly

Inherited from Component:

The uuid for editor.

examples:

cc.log(comp.uuid);

_enabled Boolean private

Inherited from Component:

enabled Boolean

Inherited from Component:

indicates whether this component is enabled or not.

examples:

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

enabledInHierarchy Boolean readOnly

Inherited from Component:

indicates whether this component is enabled and its node is also active in the hierarchy.

examples:

cc.log(comp.enabledInHierarchy);

_isOnLoadCalled Boolean readOnly

Inherited from Component:

TODO

examples:

cc.log(_isOnLoadCalled);

__eventTargets Array private

Inherited from Component:

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

_name String private

_objFlags Number private

name String

The name of the object.

examples:

obj.name = "New Obj";

isValid Boolean readOnly

Indicates whether the object is not yet destroyed.

examples:

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

Methods

_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.

returns:

type: _ccsg.Node

_initSgNode ( ) private

_removeSgNode ( ) private

update ( )

Inherited from Component:

Update is called every frame, if the Component is enabled.

lateUpdate ( )

Inherited from Component:

LateUpdate is called every frame, if the Component is enabled.

onLoad ( )

Inherited from Component:

When attaching to an active node or its node first activated.

start ( )

Inherited from Component:

Called before all scripts' update if the Component is enabled.

onEnable ( )

Inherited from Component:

Called when this component becomes enabled and its node is active.

onDisable ( )

Inherited from Component:

Called when this component becomes disabled or its node becomes inactive.

onDestroy ( )

Inherited from Component:

Called when this component will be destroyed.

onFocusInEditor ( )

Inherited from Component:

onLostFocusInEditor ( )

Inherited from Component:

addComponent
(
  • typeOrTypename
)
Component

Inherited from Component:

Adds a component class to the node. You can also add component to node by passing in the name of the script.

name type description
typeOrTypename Function | String

the constructor or the class name of the component to add

returns:

type: Component

the newly added component

examples:

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

getComponent
(
  • typeOrClassName
)
Component

Inherited from Component:

Returns the component of supplied type if the node has one attached, null if it doesn't.
You can also get component in the node by passing in the name of the script.

name type description
typeOrClassName Function | String

returns:

type: Component

examples:

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

getComponents
(
  • typeOrClassName
)
Component[]

Inherited from Component:

Returns all components of supplied Type in the node.

name type description
typeOrClassName Function | String

returns:

type: Component[]

examples:

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

getComponentInChildren
(
  • typeOrClassName
)
Component

Inherited from Component:

Returns the component of supplied type in any of its children using depth first search.

name type description
typeOrClassName Function | String

returns:

type: Component

examples:

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

getComponentsInChildren
(
  • typeOrClassName
)
Component[]

Inherited from Component:

Returns the components of supplied type in any of its children using depth first search.

name type description
typeOrClassName Function | String

returns:

type: Component[]

examples:

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

_getLocalBounds
(
  • out_rect
)

Inherited from Component:

If the component's bounding box is different from the node's, you can implement this method to supply a custom axis aligned bounding box (AABB), so the editor's scene view can perform hit test properly.

name type description
out_rect Rect

the Rect to receive the bounding box

onRestore ( )

Inherited from Component:

onRestore is called after the user clicks the Reset item in the Inspector's context menu or performs an undo operation on this component.

If the component contains the "internal state", short for "temporary member variables which not included
in its CCClass properties", then you may need to implement this function.

The editor will call the getset accessors of your component to record/restore the component's state
for undo/redo operation. However, in extreme cases, it may not works well. Then you should implement
this function to manually synchronize your component's "internal states" with its public properties.
Once you implement this function, all the getset accessors of your component will not be called when
the user performs an undo/redo operation. Which means that only the properties with default value
will be recorded or restored by editor.

Similarly, the editor may failed to reset your component correctly in extreme cases. Then if you need
to support the reset menu, you should manually synchronize your component's "internal states" with its
properties in this function. Once you implement this function, all the getset accessors of your component
will not be called during reset operation. Which means that only the properties with default value
will be reset by editor.

This function is only called in editor mode.

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

Inherited from Component:

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

name type description
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.

examples:

var squashAction = cc.scaleTo(0.2, 1, 0.6);
this.seq = cc.sequence(squashAction);

scheduleOnce
(
  • callback
  • [delay =0]
)

Inherited from Component:

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

name type description
callback function

A function wrapped as a selector
delay optional Number 0

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

examples:

var squashAction = cc.scaleTo(0.2, 1, 0.6);
this.seq = cc.scheduleOnce(squashAction);

unschedule
(
  • callback_fn
)

Inherited from Component:

Unschedules a custom callback function.

name type description
callback_fn function

A function wrapped as a selector

examples:

this.unschedule(_callback);

unscheduleAllCallbacks ( )

Inherited from Component:

unschedule all scheduled callback functions: custom callback functions, and the 'update' callback function.
Actions are not affected by this method.

examples:

this.unscheduleAllCallbacks();

destroy ( ) Boolean

Destroy this Object, and release all its own references to other objects.

After destroy, this CCObject is not usable any more.
You can use cc.isValid(obj) (or obj.isValid if obj is non-nil) to check whether the object is destroyed before accessing it.

returns:

type: Boolean

whether it is the first time the destroy being called

examples:

obj.destroy();

realDestroyInEditor ( )

In fact, Object's "destroy" will not trigger the destruct operation in Firebal Editor. The destruct operation will be executed by Undo system later.

examples:

cc.log(obj.realDestroyInEditor());

_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)

name type description
exporting Boolean

returns:

type: object

the serialized json data object

_deserialize
(
  • data
  • ctx
)
private

Init this object from the custom serialized data.

name type description
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