Cocos Creator API

Indicates whether the object is not yet destroyed. (It will not be available after being destroyed)
When an object's destroy is called, it is actually destroyed after the end of this frame.So isValid will return false from the next frame, while isValid in the current frame will still be true.If you want to determine whether the current frame has called destroy, use isValid(obj, true),but this is often caused by a particular logical requirements, which is not normally required.

isTrigger public

Gets or sets the collider is trigger, this will be always trigger if using builtin.

hideFlags public

After inheriting CCObject objects, control whether you need to hide, lock, serialize, and other functions.

enabledInHierarchy public

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

enabled public

Indicates whether this component is enabled or not.

center public

Gets or sets the center of the collider, in local space.

boundingSphere public

attachedRigidBody public

Get the rigid body component to which the collider is bound, possibly null.

type public

node public

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

__editorExtras__ protected

__prefab protected

_aabb protected

_boundingSphere protected

_center protected

_enabled protected

_id protected

_isSharedMaterial protected

_isTrigger protected

_material protected

_name protected

_needCollisionEvent protected

_needTriggerEvent protected

_objFlags protected

_sceneGetter protected

_shape protected

__scriptAsset protected

_isInitialized protected

_isOnLoadCalled protected

Returns a value which used to indicate the onLoad get called or not.

Inherited Methods

unscheduleAllCallbacks public

unschedule all scheduled tasks.

unschedule public

Un-schedules a custom task.

targetOff public

Removes all callbacks previously registered with the same target (passed as parameter).This is not for removing all listeners in the current event target,and this is not for removing all listeners the target parameter have registered.It's only for removing all listeners (callback and target couple) registered on the current event target by the target parameter.

setMask public

Sets the mask value.

setGroup public

Sets the group value.

scheduleOnce public

Use Scheduler system to schedule a task that runs only once, with a delay of 0 or larger.

schedule public

Use Scheduler system to schedule a custom task.
If the task is already scheduled, then the interval parameter will be updated without scheduling it again.

resetInEditor public

Called to initialize the component or node’s properties when adding the component the first time or when the Reset command is used.This function is only called in editor.

removeMask public

Subtract the mask value to fill in the group that does not need to be checked.

removeGroup public

Subtract the grouping value to fill in the group to be removed.

removeAll public

Removes all registered events of the specified target or type.

once public

Registers a callback associated with a trigger or collision event, which is automatically unregistered once executed.

onLostFocusInEditor public

onFocusInEditor public

on public

Registers callbacks associated with triggered or collision events.

off public

Unregisters callbacks associated with trigger or collision events that have been registered.

hasEventListener public

Checks whether there is correspond event listener registered on the given event.

getMask public

Gets the mask value.

getGroup public

Gets the group value.

getComponentsInChildren public

Returns all components of supplied type in self or any of its children.

getComponents public

Returns all components of supplied type in the node.

getComponentInChildren public

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

getComponent public

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.

emit public

Trigger an event directly with the event name and necessary arguments.

destroy public

addMask public

Add mask values to fill in groups that need to be checked.

addGroup public

Add a grouping value to fill in the group you want to join.

addComponent public

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

__preload protected

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

_destroyImmediate protected

_destruct protected

Clear all references in the instance.NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject.

_getLocalBounds protected

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

_getRenderScene protected

_instantiate protected

_onPreDestroy protected

lateUpdate protected

LateUpdate is called every frame, if the Component is enabled.
This is a lifecycle method. It may not be implemented in the super class.
You can only call its super class method inside it. It should not be called manually elsewhere.

onDestroy protected

onDisable protected

onEnable protected

onLoad protected

onRestore protected

onRestore is called after the user clicks the Reset item in the Inspector's context menu or performsan 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.

start protected

Called before all scripts' update if the Component is enabled the first time.
Usually used to initialize some logic which need to be called after all components' onload methods called.
This is a lifecycle method. It may not be implemented in the super class.
You can only call its super class method inside it. It should not be called manually elsewhere.

update protected

Update is called every frame, if the Component is enabled.
This is a lifecycle method. It may not be implemented in the super class.
You can only call its super class method inside it. It should not be called manually elsewhere.

Details

Constructors

public ConeCollider () : ConeCollider

Returns: ConeCollider

Properties

public radius : number

Gets or sets the radius of the circle on the cone body, in local space.

Defined in cocos/physics/framework/components/colliders/cone-collider.ts:59

public height : number

Gets or sets the cone body is at the corresponding axial height, in local space.

Defined in cocos/physics/framework/components/colliders/cone-collider.ts:78

public direction : _parsePolygonBoundingBox

Gets or sets the cone direction, in local space.

Defined in cocos/physics/framework/components/colliders/cone-collider.ts:99

protected _direction : _parsePolygonBoundingBox

default: EAxisDirection.Y_AXIS

Defined in cocos/physics/framework/components/colliders/cone-collider.ts:125

protected _height : number

default: 1

Defined in cocos/physics/framework/components/colliders/cone-collider.ts:122

protected _radius : number

default: 0.5

Defined in cocos/physics/framework/components/colliders/cone-collider.ts:119

Inherited Properties

public worldBounds : Readonly < AABB >

Inherited from: Collider.worldBounds

Defined in cocos/physics/framework/components/colliders/collider.ts:192

public uuid : string

Inherited from: Collider.uuid

The uuid for editor.

example

import { log } from 'cc';
log(comp.uuid);

Defined in cocos/core/components/component.ts:92

public sharedMaterial : null | _samplingEasingCurve

Inherited from: Collider.sharedMaterial

Gets or sets the physical material for this collider.

Defined in cocos/physics/framework/components/colliders/collider.ts:93

public shape : IConeShape

Defined in cocos/physics/framework/components/colliders/cone-collider.ts:112

public replicated : boolean

Inherited from: Collider.replicated

Defined in cocos/core/data/object.ts:248

public needTriggerEvent : boolean

Inherited from: Collider.needTriggerEvent

Defined in cocos/physics/framework/components/colliders/collider.ts:204

public needCollisionEvent : boolean

Inherited from: Collider.needCollisionEvent

Defined in cocos/physics/framework/components/colliders/collider.ts:208

public name : string

Inherited from: Collider.name

Defined in cocos/core/components/component.ts:62

public material : null | _samplingEasingCurve

Inherited from: Collider.material

Gets or sets the physics material for this collider, which in Shared state will generate a new instance.

Defined in cocos/physics/framework/components/colliders/collider.ts:111

public isValid : boolean

Inherited from: Collider.isValid

Indicates whether the object is not yet destroyed. (It will not be available after being destroyed)
When an object's `destroy` is called, it is actually destroyed after the end of this frame. So `isValid` will return false from the next frame, while `isValid` in the current frame will still be true. If you want to determine whether the current frame has called `destroy`, use `isValid(obj, true)`, but this is often caused by a particular logical requirements, which is not normally required.

example

import { Node, log } from 'cc';
const node = new Node();
log(node.isValid);    // true
node.destroy();
log(node.isValid);    // true, still valid in this frame
// after a frame...
log(node.isValid);    // false, destroyed in the end of last frame

Defined in cocos/core/data/object.ts:285

public isTrigger : boolean

Inherited from: Collider.isTrigger

Gets or sets the collider is trigger, this will be always trigger if using builtin.

Defined in cocos/physics/framework/components/colliders/collider.ts:151

public hideFlags : getTranslation

Inherited from: Collider.hideFlags

After inheriting CCObject objects, control whether you need to hide, lock, serialize, and other functions.

Defined in cocos/core/data/object.ts:240

public enabledInHierarchy : boolean

Inherited from: Collider.enabledInHierarchy

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

example

import { log } from 'cc';
log(comp.enabledInHierarchy);

Defined in cocos/core/components/component.ts:143

public enabled : boolean

Inherited from: Collider.enabled

Indicates whether this component is enabled or not.

example

import { log } from 'cc';
comp.enabled = true;
log(comp.enabled);

Defined in cocos/core/components/component.ts:116

public center : Vec3

Inherited from: Collider.center

Gets or sets the center of the collider, in local space.

Defined in cocos/physics/framework/components/colliders/collider.ts:171

public boundingSphere : Readonly < window >

Inherited from: Collider.boundingSphere

Defined in cocos/physics/framework/components/colliders/collider.ts:198

public attachedRigidBody : null | TWEEN_SCALE

Inherited from: Collider.attachedRigidBody

Get the rigid body component to which the collider is bound, possibly null.

Defined in cocos/physics/framework/components/colliders/collider.ts:78

public type : EColliderType

readonly

Inherited from: parent

Defined in cocos/physics/framework/components/colliders/collider.ts:212

public node : Node

default: NullNode

Inherited from: Collider.node

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

example

import { log } from 'cc';
log(comp.node);

Defined in cocos/core/components/component.ts:175

protected __editorExtras__ : unknown

Inherited from: Collider.__editorExtras__

Defined in cocos/core/data/object.ts:196

protected __prefab : null | fromHEX

default: null

Inherited from: Collider.__prefab

Defined in cocos/core/components/component.ts:187

protected _aabb : null | AABB

default: null

Inherited from: hashCode

Defined in cocos/physics/framework/components/colliders/collider.ts:217

protected _boundingSphere : null | window

default: null

Inherited from: returnToPool

Defined in cocos/physics/framework/components/colliders/collider.ts:218

protected _center : Vec3

readonly

Inherited from: Collider._center

Defined in cocos/physics/framework/components/colliders/collider.ts:231

protected _enabled : boolean

default: true

deprecated

Inherited from: setMaxCount

Deprecated: since v3.5.0, this is an engine private interface that will be removed in the future.

Defined in cocos/core/components/component.ts:181

protected _id : string

deprecated

Inherited from: Collider._id

Deprecated: since v3.5.0, this is an engine private interface that will be removed in the future.

Defined in cocos/core/components/component.ts:198

protected _isSharedMaterial : boolean

default: true

Inherited from: Collider._isSharedMaterial

Defined in cocos/physics/framework/components/colliders/collider.ts:219

protected _isTrigger : boolean

default: false

Inherited from: setMaxCount

Defined in cocos/physics/framework/components/colliders/collider.ts:228

protected _material : null | _samplingEasingCurve

default: null

Inherited from: Collider._material

Defined in cocos/physics/framework/components/colliders/collider.ts:225

protected _name : string

Inherited from: Collider._name

Defined in cocos/core/data/object.ts:202

protected _needCollisionEvent : boolean

default: false

Inherited from: toString

Defined in cocos/physics/framework/components/colliders/collider.ts:221

protected _needTriggerEvent : boolean

default: false

Inherited from: BoundingBoxDisplayData

Defined in cocos/physics/framework/components/colliders/collider.ts:220

protected _objFlags : number

Inherited from: Collider._objFlags

Defined in cocos/core/data/object.ts:201

protected _sceneGetter : null | (

() => _cachedCurrentTime

)

default: null

Inherited from: Collider._sceneGetter

Defined in cocos/core/components/component.ts:192

protected _shape : null | IBaseShape

default: null

Inherited from: transform

Defined in cocos/physics/framework/components/colliders/collider.ts:216

protected __scriptAsset : null

deprecated

Inherited from: Collider.__scriptAsset

Deprecated: since v3.5.0, this is an engine private interface that will be removed in the future.

Defined in cocos/core/components/component.ts:103

protected _isInitialized : boolean

Inherited from: Collider._isInitialized

Defined in cocos/physics/framework/components/colliders/collider.ts:233

protected _isOnLoadCalled : number

deprecated

Inherited from: Collider._isOnLoadCalled

Deprecated: since v3.5.0, this is an engine private interface that will be removed in the future.

Returns a value which used to indicate the onLoad get called or not.

example

import { log } from 'cc';
log(this._isOnLoadCalled > 0);

Defined in cocos/core/components/component.ts:159

Inherited Methods

public unscheduleAllCallbacks () : void

Inherited from: Collider.unscheduleAllCallbacks

unschedule all scheduled tasks.

Returns: void

example

this.unscheduleAllCallbacks();

Defined in cocos/core/components/component.ts:490

public unschedule (callback_fn : any) : void

Inherited from: Collider.unschedule

Un-schedules a custom task.

Input Parameters

Name	Type	Description
`callback_fn`	any	The callback function of the task

Returns: void

example

this.unschedule(_callback);

Defined in cocos/core/components/component.ts:474

public targetOff (typeOrTarget : any) : void

Inherited from: Collider.targetOff

Removes all callbacks previously registered with the same target (passed as parameter). This is not for removing all listeners in the current event target, and this is not for removing all listeners the target parameter have registered. It's only for removing all listeners (callback and target couple) registered on the current event target by the target parameter.

Input Parameters

Name	Type	Description
`typeOrTarget`	any	The target to be searched for all related listeners

Returns: void

public setMask (v : number) : void

Inherited from: Collider.setMask

Sets the mask value.

Input Parameters

Name	Type	Description
`v`	number	Mask value which is a 32-bits integer, the range is [2^0, 2^31]

Returns: void

Defined in cocos/physics/framework/components/colliders/collider.ts:379

public setGroup (v : number) : void

Inherited from: T

Sets the group value.

Input Parameters

Name	Type	Description
`v`	number	Group value which is a 32-bits integer, the range is [2^0, 2^31]

Returns: void

Defined in cocos/physics/framework/components/colliders/collider.ts:326

public scheduleOnce (callback : any, delay ?: number) : void

Inherited from: Collider.scheduleOnce

Use Scheduler system to schedule a task that runs only once, with a delay of 0 or larger.

Input Parameters

Name	Type	Description
`callback`	any	The callback function of the task
`delay`	number	The delay time for the first invocation, Unit: s

Returns: void

example

import { log } from 'cc';
this.scheduleOnce((dt) => void log(`time: ${dt}`), 2);

Defined in cocos/core/components/component.ts:461

public schedule (callback : any, interval ?: number, repeat ?: number, delay ?: number) : void

Inherited from: RectangleBoundingBoxData

Use Scheduler system to schedule a custom task.
If the task is already scheduled, then the interval parameter will be updated without scheduling it again.

Input Parameters

Name	Type	Description
`callback`	any	The callback function of the task
`interval`	number	The time interval between each invocation
`repeat`	number	The repeat count of this task, the task will be invoked (repeat + 1) times, use [[23290]] to repeat a task forever
`delay`	number	The delay time for the first invocation, Unit: s

Returns: void

example

import { log } from 'cc';
this.schedule((dt) => void log(`time: ${dt}`), 1);

Defined in cocos/core/components/component.ts:428

public resetInEditor () : void

Inherited from: Collider.resetInEditor

Called to initialize the component or node’s properties when adding the component the first time or when the Reset command is used. This function is only called in editor.

Returns: void

Defined in cocos/core/components/component.ts:592

public removeMask (v : number) : void

Inherited from: Collider.removeMask

Subtract the mask value to fill in the group that does not need to be checked.

Input Parameters

Name	Type	Description
`v`	number	Mask value which is a 32-bits integer, the range is [2^0, 2^31]

Returns: void

Defined in cocos/physics/framework/components/colliders/collider.ts:405

public removeGroup (v : number) : void

Inherited from: Collider.removeGroup

Subtract the grouping value to fill in the group to be removed.

Input Parameters

Name	Type	Description
`v`	number	Group value which is a 32-bits integer, the range is [2^0, 2^31]

Returns: void

Defined in cocos/physics/framework/components/colliders/collider.ts:352

public removeAll (typeOrTarget : Record < string, unknown > | TriggerEventType | _rawTextureAtlases) : void

Inherited from: Collider.removeAll

Removes all registered events of the specified target or type.

Input Parameters

Name	Type	Description
`typeOrTarget`	Record < string, unknown > \| TriggerEventType \| _rawTextureAtlases	The event type or target.

Returns: void

Defined in cocos/physics/framework/components/colliders/collider.ts:298

public once <TFunction extends

(...any : any []) => void

> (type : TriggerEventType | _rawTextureAtlases, callback : toString, target ?: any) : any

Inherited from: hashCode

Registers a callback associated with a trigger or collision event, which is automatically unregistered once executed.

Input Parameters

Name	Type	Description
`type`	TriggerEventType \| _rawTextureAtlases	The event type, onTriggerEnter\|onTriggerStay\|onTriggerExit\|onCollisionEnter\|onCollisionStay\|onCollisionExit;
`callback`	toString	The event callback, signature:`(event?:ICollisionEvent\|ITriggerEvent)=>void`.
`target`	any	The event callback target.

Returns: any

Defined in cocos/physics/framework/components/colliders/collider.ts:284

public onLostFocusInEditor () : void

Inherited from: Collider.onLostFocusInEditor

Returns: void

Defined in cocos/core/components/component.ts:585

public onFocusInEditor () : void

Inherited from: Collider.onFocusInEditor

Returns: void

Defined in cocos/core/components/component.ts:583

public on <TFunction extends

(...any : any []) => void

> (type : TriggerEventType | _rawTextureAtlases, callback : BaseObject, target ?: any, once ?: boolean) : any

Inherited from: Collider.on

Registers callbacks associated with triggered or collision events.

Input Parameters

Name	Type	Description
`type`	TriggerEventType \| _rawTextureAtlases	The event type, onTriggerEnter\|onTriggerStay\|onTriggerExit\|onCollisionEnter\|onCollisionStay\|onCollisionExit;
`callback`	BaseObject	The event callback, signature:`(event?:ICollisionEvent\|ITriggerEvent)=>void`.
`target`	any	The event callback target.
`once`	boolean	-

Returns: any

Defined in cocos/physics/framework/components/colliders/collider.ts:255

public off (type : TriggerEventType | _rawTextureAtlases, callback ?:

(...any : any []) => void

, target ?: any) : void

Inherited from: boundingBox

Unregisters callbacks associated with trigger or collision events that have been registered.

Input Parameters

Name	Type	Description
`type`	TriggerEventType \| _rawTextureAtlases	The event type, onTriggerEnter\|onTriggerStay\|onTriggerExit\|onCollisionEnter\|onCollisionStay\|onCollisionExit;
`callback`	(...any : any []) => void	The event callback, signature:`(event?:ICollisionEvent\|ITriggerEvent)=>void`.
`target`	any	The event callback target.

Returns: void

Defined in cocos/physics/framework/components/colliders/collider.ts:270

public hasEventListener (type : string, callback ?:

(...any : any []) => void

, target ?: any) : boolean

Inherited from: Collider.hasEventListener

Checks whether there is correspond event listener registered on the given event.

Input Parameters

Name	Type	Description
`type`	string	Event type.
`callback`	(...any : any []) => void	Callback function when event triggered.
`target`	any	Callback callee.

Returns: boolean

public getMask () : number

Inherited from: bones

Gets the mask value.

Returns: number

Defined in cocos/physics/framework/components/colliders/collider.ts:365

public getGroup () : number

Inherited from: Collider.getGroup

Gets the group value.

Returns: number

Defined in cocos/physics/framework/components/colliders/collider.ts:312

public getComponentsInChildren <T extends _updateTargetTexture> (classConstructor : Constructor < T >) : T []

Inherited from: Collider.getComponentsInChildren

Returns all components of supplied type in self or any of its children.

Input Parameters

Name	Type	Description
`classConstructor`	Constructor < T >	The class of components to be retrieved

Returns: T []

example

import { Sprite } from 'cc';
const sprites = node.getComponentsInChildren(Sprite);

public getComponentsInChildren (className : string) : _updateTargetTexture []

Inherited from: Collider.getComponentsInChildren

Returns all components of supplied type in self or any of its children.

Input Parameters

Name	Type	Description
`className`	string	A string for the class name of the components

Returns: _updateTargetTexture []

example

const tests = node.getComponentsInChildren("Test");

Defined in cocos/core/components/component.ts:342

public getComponents <T extends _updateTargetTexture> (classConstructor : Constructor < T >) : T []

Inherited from: containsPoint

Returns all components of supplied type in the node.

Input Parameters

Name	Type	Description
`classConstructor`	Constructor < T >	The class of components to be retrieved

Returns: T []

example

import { Sprite } from 'cc';
const sprites = node.getComponents(Sprite);

public getComponents (className : string) : _updateTargetTexture []

Inherited from: Collider.getComponents

Returns all components of supplied type in the node.

Input Parameters

Name	Type	Description
`className`	string	A string for the class name of the components

Returns: _updateTargetTexture []

example

const tests = node.getComponents("Test");

Defined in cocos/core/components/component.ts:288

public getComponentInChildren <T extends _updateTargetTexture> (classConstructor : Constructor < T >) : null | T

Inherited from: Collider.getComponentInChildren

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

Input Parameters

Name	Type	Description
`classConstructor`	Constructor < T >	The class of component to be retrieved

Returns: null | T

example

import { Sprite } from 'cc';
const sprite = node.getComponentInChildren(Sprite);

public getComponentInChildren (className : string) : null | _updateTargetTexture

Inherited from: Collider.getComponentInChildren

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

Input Parameters

Name	Type	Description
`className`	string	A string for the class name of the component

Returns: null | _updateTargetTexture

example

var Test = node.getComponentInChildren("Test");

Defined in cocos/core/components/component.ts:315

public getComponent <T extends _updateTargetTexture> (classConstructor : Constructor < T >) : null | T

Inherited from: type

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.

Input Parameters

Name	Type	Description
`classConstructor`	Constructor < T >	The class of component to be retrieved or to be created

Returns: null | T

example

import { Sprite } from 'cc';
// get sprite component.
var sprite = node.getComponent(Sprite);

public getComponent (className : string) : null | _updateTargetTexture

Inherited from: height

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.

Input Parameters

Name	Type	Description
`className`	string	A string for the class name of the component

Returns: null | _updateTargetTexture

example

// get custom test calss.
var test = node.getComponent("Test");

Defined in cocos/core/components/component.ts:256

public emit (type : EventType, arg0 ?: any, arg1 ?: any, arg2 ?: any, arg3 ?: any, arg4 ?: any) : void

Inherited from: Collider.emit

Trigger an event directly with the event name and necessary arguments.

Input Parameters

Name	Type	Description
`type`	EventType	event type
`arg0`	any	-
`arg1`	any	-
`arg2`	any	-
`arg3`	any	-
`arg4`	any	-

Returns: void

public destroy () : boolean

Inherited from: Collider.destroy

Returns: boolean

Defined in cocos/core/components/component.ts:361

public addMask (v : number) : void

Inherited from: BoneData

Add mask values to fill in groups that need to be checked.

Input Parameters

Name	Type	Description
`v`	number	Mask value which is a 32-bits integer, the range is [2^0, 2^31]

Returns: void

Defined in cocos/physics/framework/components/colliders/collider.ts:392

public addGroup (v : number) : void

Inherited from: Collider.addGroup

Add a grouping value to fill in the group you want to join.

Input Parameters

Name	Type	Description
`v`	number	Group value which is a 32-bits integer, the range is [2^0, 2^31]

Returns: void

Defined in cocos/physics/framework/components/colliders/collider.ts:339

public addComponent <T extends _updateTargetTexture> (classConstructor : Constructor < T >) : null | T

Inherited from: BaseObject

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

Input Parameters

Name	Type	Description
`classConstructor`	Constructor < T >	The class of component to be retrieved or to be created

Returns: null | T

example

import { Sprite } from 'cc';
const sprite = node.addComponent(Sprite);

public addComponent (className : string) : null | _updateTargetTexture

Inherited from: Collider.addComponent

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

Input Parameters

Name	Type	Description
`className`	string	A string for the class name of the component

Returns: null | _updateTargetTexture

example

const test = node.addComponent("Test");

Defined in cocos/core/components/component.ts:224

protected __preload () : void

Inherited from: Collider.__preload

`__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.

Returns: void

Defined in cocos/core/components/component.ts:530

protected _destroyImmediate () : void

deprecated

Inherited from: containsPoint

Returns: void

Defined in cocos/core/data/object.ts:372

protected _destruct () : void

deprecated

Inherited from: _onClear

Deprecated: since v3.5.0, this is an engine private interface that will be removed in the future.

Clear all references in the instance.

NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject.

Returns: void

example

// You can override the _destruct method if you need, for example:
     _destruct: function () {
         for (var key in this) {
             if (this.hasOwnProperty(key)) {
                 switch (typeof this[key]) {
                     case 'string':
                         this[key] = '';
                         break;
                     case 'object':
                     case 'function':
                         this[key] = null;
                         break;
             }
         }
     }

Defined in cocos/core/data/object.ts:359

protected _getLocalBounds (out_rect : DynamicStates) : void

Inherited from: Collider._getLocalBounds

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.

Input Parameters

Name	Type	Description
`out_rect`	DynamicStates	The rect to store the result bounding rect

Returns: void

Defined in cocos/core/components/component.ts:606

protected _getRenderScene () : _cachedCurrentTime

deprecated

Inherited from: borrowObject

Returns: _cachedCurrentTime

Defined in cocos/core/components/component.ts:205

protected _instantiate (cloned ?: _updateTargetTexture) : undefined | _updateTargetTexture

deprecated

Inherited from: hashCode

Input Parameters

Name	Type	Description
`cloned`	_updateTargetTexture	-

Returns: undefined | _updateTargetTexture

Defined in cocos/core/components/component.ts:397

protected _onPreDestroy () : void

deprecated

Inherited from: Collider._onPreDestroy

Returns: void

Defined in cocos/core/components/component.ts:383

protected lateUpdate (dt : number) : void

Inherited from: Collider.lateUpdate

Input Parameters

Name	Type	Description
`dt`	number	the delta time in seconds it took to complete the last frame

Returns: void

Defined in cocos/core/components/component.ts:517

protected onDestroy () : void

Inherited from: Collider.onDestroy

Returns: void

Defined in cocos/physics/framework/components/colliders/collider.ts:433

protected onDisable () : void

Inherited from: Collider.onDisable

Returns: void

Defined in cocos/physics/framework/components/colliders/collider.ts:427

protected onEnable () : void

Inherited from: Collider.onEnable

Returns: void

Defined in cocos/physics/framework/components/colliders/collider.ts:421

protected onLoad () : void

Inherited from: Collider.onLoad

Returns: void

Defined in cocos/physics/framework/components/colliders/collider.ts:413

protected onRestore () : void

Inherited from: Collider.onRestore

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.

Returns: void

Defined in cocos/core/components/component.ts:648

protected start () : void

Inherited from: Collider.start

Called before all scripts' update if the Component is enabled the first time.
Usually used to initialize some logic which need to be called after all components' `onload` methods called.
This is a lifecycle method. It may not be implemented in the super class.
You can only call its super class method inside it. It should not be called manually elsewhere.

Returns: void

Defined in cocos/core/components/component.ts:554

protected update (dt : number) : void

Inherited from: Collider.update

Input Parameters

Name	Type	Description
`dt`	number	the delta time in seconds it took to complete the last frame

Returns: void

Defined in cocos/core/components/component.ts:507