Polygon Collider.
Inherited from Component:
The node this component is attached to. A component is always attached to a node.
cc.log(comp.node);
Inherited from Component:
indicates whether this component is enabled or not.
comp.enabled = true;
cc.log(comp.enabled);
Inherited from Component:
indicates whether this component is enabled and its node is also active in the hierarchy.
cc.log(comp.enabledInHierarchy);
Inherited from Component:
Register all related EventTargets, all event callbacks will be removed in _onPreDestroy
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
Inherited from Component:
LateUpdate is called every frame, if the Component is enabled.
Inherited from 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.
Inherited from Component:
Called when this component becomes enabled and its node is active.
Inherited from Component:
Called when this component becomes disabled or its node becomes inactive.
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 |
var sprite = node.addComponent(cc.Sprite);
var test = node.addComponent("Test");
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.
// get sprite component.
var sprite = node.getComponent(cc.Sprite);
// get custom test calss.
var test = node.getComponent("Test");
Inherited from Component:
Returns all components of supplied Type in the node.
var sprites = node.getComponents(cc.Sprite);
var tests = node.getComponents("Test");
Inherited from Component:
Returns the components of supplied type in any of its children using depth first search.
var sprites = node.getComponentsInChildren(cc.Sprite);
var tests = node.getComponentsInChildren("Test");
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 |
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.
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. |
var timeCallback = function (dt) {
cc.log("time: " + dt);
}
this.schedule(timeCallback, 1);
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. |
var timeCallback = function (dt) {
cc.log("time: " + dt);
}
this.scheduleOnce(timeCallback, 2);
Inherited from Component:
Unschedules a custom callback function.
| name | type | description |
|---|---|---|
callback_fn
|
function |
A function wrapped as a selector |
this.unschedule(_callback);
Inherited from Component:
unschedule all scheduled callback functions: custom callback functions, and the 'update' callback function.
Actions are not affected by this method.
this.unscheduleAllCallbacks();
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.
obj.destroy();
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.
Called before the object being destroyed.
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