For internal usage.
该组件被附加到的节点。组件总会附加到一个节点。
刚体类型的枚举。
返回一个值用来判断 onLoad 是否被调用过,不等于 0 时调用过,等于 0 时未调用。
获取或设置是否允许休眠。
获取或设置是否允许休眠。
获取或设置旋转阻尼。
获取或设置旋转阻尼。
获取封装对象,通过此对象可以访问到底层实例。
表示该组件自身是否启用。
表示该组件自身是否启用。
表示该组件是否被启用并且所在的节点也处于激活状态。
获取或设置分组。
获取或设置分组。
获取是否是唤醒的状态。
获取或设置刚体是否是动力学态类型的(将根据物理动力学控制运动)。
获取或设置刚体是否是动力学态类型的(将根据物理动力学控制运动)。
获取或设置刚体是否是运动态类型的(将由用户来控制运动)。
获取或设置刚体是否是运动态类型的(将由用户来控制运动)。
获取是否是正在休眠的状态。
获取是否是可进入休眠的状态。
获取或设置刚体是否是静态类型的(静止不动的)。
获取或设置刚体是否是静态类型的(静止不动的)。
表示该对象是否可用(被 destroy 后将不可用)。
当一个对象的 destroy
调用以后,会在这一帧结束后才真正销毁。
因此从下一帧开始 isValid
就会返回 false,而当前帧内 isValid
仍然会是 true。
如果希望判断当前帧是否调用过 destroy
,请使用 isValid(obj, true)
,不过这往往是特殊的业务需求引起的,通常情况下不需要这样。
获取或设置线性阻尼。
获取或设置线性阻尼。
获取或设置刚体的质量。
获取或设置刚体的质量。
获取或设置进入休眠的速度临界值。
获取或设置进入休眠的速度临界值。
获取或设置刚体类型。
获取或设置刚体类型。
获取或设置刚体是否使用重力。
获取或设置刚体是否使用重力。
组件的 uuid,用于编辑器。
__preload
在每次onLoad之前调用。
它用于在内部初始化内置组件,
以避免在每次公有方法调用之前检查是否调用了onLoad。
如果支持脚本优先级,则应删除此方法。
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; } } }
如果组件的包围盒与节点不同,您可以实现该方法以提供自定义的轴向对齐的包围盒(AABB), 以便编辑器的场景视图可以正确地执行点选测试。
The rect to store the result bounding rect
向节点添加一个指定类型的组件类,你还可以通过传入脚本的名称来添加组件。
The class of component to be retrieved or to be created
向节点添加一个指定类型的组件类,你还可以通过传入脚本的名称来添加组件。
A string for the class name of the component
添加分组值,可填要加入的 group。
整数,范围为 2 的 0 次方 到 2 的 31 次方
添加掩码值,可填入需要检查的 group。
整数,范围为 2 的 0 次方 到 2 的 31 次方
在本地空间中,对刚体施加扭矩。
扭矩
在世界空间中,对刚体施加扭矩。
扭矩
清除刚体受到的力。
清除刚体受到的力和速度。
清除刚体的速度。
获取旋转速度。
速度 Vec3
获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
传入参数也可以是脚本的名称。
The class of component to be retrieved or to be created
获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
传入参数也可以是脚本的名称。
A string for the class name of the component
递归查找所有子节点中第一个匹配指定类型的组件。
The class of component to be retrieved
递归查找所有子节点中第一个匹配指定类型的组件。
A string for the class name of the component
返回节点上指定类型的所有组件。
The class of components to be retrieved
返回节点上指定类型的所有组件。
A string for the class name of the components
递归查找自身或所有子节点中指定类型的组件。
The class of components to be retrieved
递归查找自身或所有子节点中指定类型的组件。
A string for the class name of the components
获取分组值。
整数,范围为 2 的 0 次方 到 2 的 31 次方
获取线性速度。
速度 Vec3
获取掩码值。
整数,范围为 2 的 0 次方 到 2 的 31 次方
如果该组件启用,则每帧调用 LateUpdate。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。
the delta time in seconds it took to complete the last frame
onRestore 是用户在检查器菜单点击 Reset 时,对此组件执行撤消操作后调用的。
如果组件包含了“内部状态”(不在 CCClass 属性中定义的临时成员变量),那么你可能需要实现该方法。
编辑器执行撤销/重做操作时,将调用组件的 get set 来录制和还原组件的状态。
然而,在极端的情况下,它可能无法良好运作。
那么你就应该实现这个方法,手动根据组件的属性同步“内部状态”。
一旦你实现这个方法,当用户撤销或重做时,组件的所有 get set 都不会再被调用。
这意味着仅仅指定了默认值的属性将被编辑器记录和还原。
同样的,编辑可能无法在极端情况下正确地重置您的组件。
于是如果你需要支持组件重置菜单,你需要在该方法中手工同步组件属性到“内部状态”。
一旦你实现这个方法,组件的所有 get set 都不会在重置操作时被调用。
这意味着仅仅指定了默认值的属性将被编辑器重置。
此方法仅在编辑器下会被调用。
减去分组值,可填要移除的 group。
整数,范围为 2 的 0 次方 到 2 的 31 次方
减去掩码值,可填入不需要检查的 group。
整数,范围为 2 的 0 次方 到 2 的 31 次方
用来初始化组件或节点的一些属性,当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。这个回调只会在编辑器下调用。
调度一个自定义的回调任务。
如果回调任务已调度,那么将不会重复调度它,只会更新时间间隔参数。
The callback function of the task
The time interval between each invocation
The repeat count of this task, the task will be invoked (repeat + 1) times, use macro.REPEAT_FOREVER to repeat a task forever
The delay time for the first invocation, Unit: s
调度一个只运行一次的回调任务,可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。
The callback function of the task
The delay time for the first invocation, Unit: s
设置旋转速度。
速度 Vec3
设置分组值。
整数,范围为 2 的 0 次方 到 2 的 31 次方
设置线性速度。
速度 Vec3
设置掩码值。
整数,范围为 2 的 0 次方 到 2 的 31 次方
休眠刚体。
如果该组件第一次启用,则在所有组件的 update 之前调用。通常用于需要在所有组件的 onLoad 初始化完毕后执行的逻辑。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。
取消调度一个自定义的回调任务。
The callback function of the task
取消调度所有已调度的回调函数。
如果该组件启用,则每帧调用 update。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。
the delta time in seconds it took to complete the last frame
唤醒刚体。
Generated using TypeDoc
刚体组件。