节点可能发出的事件类型
空间变换操作的坐标系
节点变换更新的具体部分,可用于判断 SystemEventType.TRANSFORM_CHANGED 事件的具体类型
节点变换更新的具体部分
如果为true,则该节点是一个常驻节点,不会在场景转换期间被销毁。 如果为false,节点将在加载新场景时自动销毁。默认为 false。
如果为true,则该节点是一个常驻节点,不会在场景转换期间被销毁。 如果为false,节点将在加载新场景时自动销毁。默认为 false。
当前节点的自身激活状态。 值得注意的是,一个节点的父节点如果不被激活,那么即使它自身设为激活,它仍然无法激活。 如果你想检查节点在场景中实际的激活状态可以使用 activeInHierarchy
当前节点的自身激活状态。 值得注意的是,一个节点的父节点如果不被激活,那么即使它自身设为激活,它仍然无法激活。 如果你想检查节点在场景中实际的激活状态可以使用 activeInHierarchy
表示此节点是否在场景中激活。
本地坐标系下的旋转,用欧拉角表示,但是限定在 z 轴上。
本地坐标系下的旋转,用欧拉角表示,但是限定在 z 轴上。
节点的所有子节点。
获取附加到此节点的所有组件。
本地坐标系下的旋转,用欧拉角表示
本地坐标系下的旋转,用欧拉角表示
当前节点的事件处理器,提供 EventTarget 能力。
这个节点的空间变换信息在当前帧内是否有变过?
这个节点的空间变换信息在当前帧内是否有变过?
表示该对象是否可用(被 destroy 后将不可用)。
当一个对象的 destroy
调用以后,会在这一帧结束后才真正销毁。
因此从下一帧开始 isValid
就会返回 false,而当前帧内 isValid
仍然会是 true。
如果希望判断当前帧是否调用过 destroy
,请使用 isValid(obj, true)
,不过这往往是特殊的业务需求引起的,通常情况下不需要这样。
本地坐标系变换矩阵
该节点名称。
该节点名称。
父节点
父节点
此节点属于哪个场景。
主要用于编辑器的 uuid,在编辑器下可用于持久化存储,在项目构建之后将变成自增的 id。
世界坐标系变换矩阵
Ensures that this node has already had the specified component(s). If not, this method throws.
Constructor of the component.
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, 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; } } }
Set _scene
field of this node.
The derived Scene
overrides this method to behavior differently.
添加一个子节点。
the child node to be added
向节点添加一个指定类型的组件类,你还可以通过传入脚本的名称来添加组件。
The class of the component to add
向节点添加一个指定类型的组件类,你还可以通过传入脚本的名称来添加组件。
The class name of the component to add
属性配置函数。在 attrs 的所有属性将被设置为节点属性。
Properties to be set to node
销毁所有子节点,并释放所有它们对其它对象的引用。 实际销毁操作会延迟到当前帧渲染前执行。
分发事件到事件流中。
The Event object that is dispatched into the event flow
通过事件名发送自定义事件
event type
First argument in callback
Second argument in callback
Third argument in callback
Fourth argument in callback
通过名称获取节点的子节点。
A name to find the child node.
a CCNode object whose name equals to the input parameter
通过路径获取节点的子节点。
A path to find the child node.
a Node object whose path equals to the input parameter
通过 uuid 获取节点的子节点。
The uuid to find the child node.
a Node whose uuid equals to the input parameter
获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。 传入参数也可以是脚本的名称。
The class of the target component
获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。 传入参数也可以是脚本的名称。
The class name of the target component
递归查找所有子节点中第一个匹配指定类型的组件。
The class of the target component
递归查找所有子节点中第一个匹配指定类型的组件。
The class name of the target component
返回节点上指定类型的所有组件。
The class of the target component
返回节点上指定类型的所有组件。
The class name of the target component
递归查找自身或所有子节点中指定类型的组件
The class of the target component
递归查找自身或所有子节点中指定类型的组件
The class name of the target component
获取该节点的父节点。
获取当前节点在父节点的 children 数组中的位置。
检查事件目标对象是否有为特定类型的事件注册的回调。
The type of event.
The callback function of the event listener, if absent all event listeners for the given type will be removed
The callback callee of the event listener
True if a callback of the specified type is registered; false otherwise.
插入子节点到指定位置
the child node to be inserted
the sibling index to place the child in
递归标记节点世界变换为 dirty
The dirty bits to setup to children, can be composed with multiple dirty bits
是否是指定节点的子节点?
True if this node is a child, deep child or identical to the given node.
删除之前与同类型,回调,目标或 useCapture 注册的回调。
A string representing the event type being removed.
The callback to remove.
The target (this object) to invoke the callback, if it's not given, only callback without target will be removed
When set to true, the listener will be triggered at capturing phase which is ahead of the final target emit, otherwise it will be triggered during bubbling phase.
在节点上注册指定类型的回调函数,也可以设置 target 用于绑定响应函数的 this 对象。 鼠标或触摸事件会被系统调用 dispatchEvent 方法触发,触发的过程包含三个阶段:
_getCapturingTargets
获取),比如,节点树中注册了捕获阶段的父节点,从根节点开始派发直到目标节点。_getBubblingTargets
获取),比如,节点树中注册了冒泡阶段的父节点,从目标节点开始派发直到根节点。
同时您可以将事件派发到父节点或者通过调用 stopPropagation 拦截它。
推荐使用这种方式来监听节点上的触摸或鼠标事件,请不要在节点上直接使用 eventManager
。
你也可以注册自定义事件到节点上,并通过 emit 方法触发此类事件,对于这类事件,不会发生捕获冒泡阶段,只会直接派发给注册在该节点上的监听器
你可以通过在 emit 方法调用时在 type 之后传递额外的参数作为事件回调的参数列表A string representing the event type to listen for.
See {{#crossLink "Node/EventType/POSITION_CHANGED"}}Node Events{{/crossLink}} for all builtin events.
The callback that will be invoked when the event is dispatched. The callback is ignored if it is a duplicate (the callbacks are unique).
The target (this object) to invoke the callback, can be null
When set to true, the listener will be triggered at capturing phase which is ahead of the final target emit, otherwise it will be triggered during bubbling phase.
注册节点的特定事件类型回调,回调会在第一时间被触发后删除自身。
A string representing the event type to listen for.
The callback that will be invoked when the event is dispatched. The callback is ignored if it is a duplicate (the callbacks are unique).
The target (this object) to invoke the callback, can be null
暂停所有 SystemEvent 派发的系统事件。 如果传递 recursive 为 true,那么这个 API 将暂停本节点和它的子树上所有节点的节点系统事件。
Whether pause system events recursively for the child node tree
移除节点所有的子节点。
移除节点中指定的子节点。
The child node which will be removed.
删除节点上的指定组件,传入参数可以是一个组件构造函数或组件名,也可以是已经获得的组件引用。 如果你已经获得组件引用,你也可以直接调用 component.destroy()
The class of the component to remove
删除节点上的指定组件,传入参数可以是一个组件构造函数或组件名,也可以是已经获得的组件引用。 如果你已经获得组件引用,你也可以直接调用 component.destroy()
The class name of the component to remove or the component instance to be removed
从父节点中删除该节点。 如果这个节点是一个孤立节点,那么什么都不会发生。
恢复所有 SystemEvent 派发的系统事件。 如果传递 recursive 为 true,那么这个 API 将恢复本节点和它的子树上所有节点的节点系统事件。
Whether resume system events recursively for the child node tree
设置该节点的父节点。
Parent node
Whether keep node's current world transform unchanged after this operation
设置本地坐标
Target position
设置本地坐标
X axis position
Y axis position
Z axis position
用四元数设置本地旋转
Rotation in quaternion
用四元数设置本地旋转
X value in quaternion
Y value in quaternion
Z value in quaternion
W value in quaternion
用欧拉角设置本地旋转
Rotation in vector
用欧拉角设置本地旋转
X axis rotation
Y axis rotation
设置本地缩放
Target scale
设置本地缩放
X axis scale
Y axis scale
Z axis scale
设置当前节点在父节点的 children 数组中的位置。
设置世界坐标
Target position
设置世界坐标
X axis position
Y axis position
Z axis position
用四元数设置世界坐标系下的旋转
Rotation in quaternion
用四元数设置世界坐标系下的旋转
X value in quaternion
Y value in quaternion
Z value in quaternion
W value in quaternion
用欧拉角设置世界坐标系下的旋转
X axis rotation
Y axis rotation
Z axis rotation
设置世界坐标系下的缩放
Target scale
设置世界坐标系下的缩放
X axis scale
Y axis scale
Z axis scale
移除目标上的所有注册事件。
The target to be searched for all related callbacks
更新节点的世界变换信息
遍历该节点的子树里的所有节点并按规则执行回调函数。 对子树中的所有节点,包含当前节点,会执行两次回调,preFunc 会在访问它的子节点之前调用,postFunc 会在访问所有子节点之后调用。 这个函数的实现不是基于递归的,而是基于栈展开递归的方式。 请不要在 walk 过程中对任何其他的节点嵌套执行 walk。
The callback to process node when reach the node for the first time
The callback to process node when re-visit the node after walked all children in its sub tree
Call _updateScene
of specified node.
The node.
指定对象是否是普通的节点?如果传入 Scene 会返回 false。
Generated using TypeDoc
Cocos Creator 场景中的私有节点类。
私有节点在编辑器中不可见,对用户透明。
通常私有节点是被一些特殊的组件创建出来作为父节点的一部分而存在的,理论上来说,它们不是子节点,而是父节点的组成部分。
私有节点有两个非常重要的特性:
目前在引擎中,RichText 和 TileMap 都有可能生成私有节点。