Cocos Creator API

1.3.0

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

Widget

Component
: cc

Stores and manipulate the anchoring based on its parent. Widget are used for GUI but can also be used for other things. Widget will adjust current node's position and size automatically, but the results after adjustment can not be obtained until the next frame.

isAlignTop Boolean

Whether to align the top.

isAlignVerticalCenter Boolean

Vertically aligns the midpoint, This will open the other vertical alignment options cancel.

isAlignBottom Boolean

Whether to align the bottom.

isAlignLeft Boolean

Whether to align the left.

isAlignHorizontalCenter Boolean

Horizontal aligns the midpoint. This will open the other horizontal alignment options canceled.

isAlignRight Boolean

Whether to align the right.

isStretchWidth Boolean readOnly

Whether the stretched horizontally, when enable the left and right alignment will be stretched horizontally, the width setting is invalid (read only).

isStretchHeight Boolean readOnly

Whether the stretched vertically, when enable the left and right alignment will be stretched vertically, then height setting is invalid (read only)

top Number

The margins between the top of this node and the top of parent node, the value can be negative, Only available in 'isAlignTop' open.

bottom Number

The margins between the bottom of this node and the bottom of parent node, the value can be negative, Only available in 'isAlignBottom' open.

left Number

The margins between the left of this node and the left of parent node, the value can be negative, Only available in 'isAlignLeft' open.

right Number

The margins between the right of this node and the right of parent node, the value can be negative, Only available in 'isAlignRight' open.

horizontalCenter Number

Horizontal aligns the midpoint offset value, the value can be negative, Only available in 'isAlignHorizontalCenter' open.

verticalCenter Number

Vertical aligns the midpoint offset value, the value can be negative, Only available in 'isAlignVerticalCenter' open.

isAbsoluteHorizontalCenter Boolean

If true, horizontalCenter is pixel margin, otherwise is percentage (0 - 1) margin.

isAbsoluteVerticalCenter Boolean

If true, verticalCenter is pixel margin, otherwise is percentage (0 - 1) margin.

isAbsoluteTop Boolean

If true, top is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's height.

isAbsoluteBottom Boolean

If true, bottom is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's height.

isAbsoluteLeft Boolean

If true, left is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's width.

isAbsoluteRight Boolean

If true, right is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's width.

isAlignOnce Boolean

TODO

_alignFlags Number private

node Node

Component:

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

:

cc.log(comp.node);

uuid String readOnly

Component:

The uuid for editor.

:

cc.log(comp.uuid);

_enabled Boolean private

Component:

enabled Boolean

Component:

indicates whether this component is enabled or not.

:

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

enabledInHierarchy Boolean readOnly

Component:

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

:

cc.log(comp.enabledInHierarchy);

_isOnLoadCalled Boolean readOnly

Component:

TODO

:

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

The name of the object.

:

obj.name = "New Obj";

isValid Boolean readOnly

Indicates whether the object is not yet destroyed.

:

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

update ( )

Component:

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

lateUpdate ( )

Component:

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

__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:

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

start ( )

Component:

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

onEnable ( )

Component:

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

onDisable ( )

Component:

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

onDestroy ( )

Component:

Called when this component will be destroyed.

onFocusInEditor ( )

Component:

onLostFocusInEditor ( )

Component:

addComponent
(
  • typeOrTypename
)
Component

Component:

Adds a component class to the node. You can also add component to node by passing in the name of the script.
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:

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

Returns all components of supplied Type in the node.
typeOrClassName Function | String

:

: Component[]

:

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

getComponentInChildren
(
  • typeOrClassName
)
Component

Component:

Returns the component of supplied type in any of its children using depth first search.
typeOrClassName Function | String

:

: Component

:

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

getComponentsInChildren
(
  • typeOrClassName
)
Component[]

Component:

Returns the components of supplied type in self or any of its children using depth first search.
typeOrClassName Function | String

:

: Component[]

:

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

_getLocalBounds
(
  • out_rect
)

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.
out_rect Rect

the Rect to receive the bounding box

onRestore ( )

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

Component:

Schedules a custom selector.
If the selector is already scheduled, then the interval parameter will be updated without scheduling it again.
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:

Schedules a callback function that runs only once, with a delay of 0 or larger.
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:

Unschedules a custom callback function.
callback_fn function

A function wrapped as a selector

:

this.unschedule(_callback);

unscheduleAllCallbacks ( )

Component:

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

:

this.unscheduleAllCallbacks();

destroy ( ) Boolean

Destroy this Object, and release all its own references to other objects.
Actual object destruction will delayed until before rendering.
After destroy, this CCObject is not usable any more. You can use cc.isValid(obj) to check whether the object is destroyed before accessing it.

:

: 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