For internal usage.
该组件被附加到的节点。组件总会附加到一个节点。
返回一个值用来判断 onLoad 是否被调用过,不等于 0 时调用过,等于 0 时未调用。
以秒为单位获取当前播放时间。
以秒为单位设置当前播放时间。
要跳转到的播放时间
获取以秒为单位的音频总时长。
表示该组件自身是否启用。
表示该组件是否被启用并且所在的节点也处于激活状态。
表示该对象是否可用(被 destroy 后将不可用)。
当一个对象的 destroy
调用以后,会在这一帧结束后才真正销毁。
因此从下一帧开始 isValid
就会返回 false,而当前帧内 isValid
仍然会是 true。
如果希望判断当前帧是否调用过 destroy
,请使用 cc.isValid(obj, true)
,不过这往往是特殊的业务需求引起的,通常情况下不需要这样。
是否循环播放音频?
是否启用自动播放。
请注意,根据最新的自动播放策略,现在大部分时候,自动播放只会在第一次收到用户输入后生效。
参考:https://www.chromium.org/audio-video/autoplay
当前音频是否正在播放?
获取当前音频状态。
组件的 uuid,用于编辑器。
音频的音量(大小范围为 0.0 到 1.0 )。
请注意,在某些平台上,音量控制可能不起效。
__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), 以便编辑器的场景视图可以正确地执行点选测试。
提供包围盒的 Rect
向节点添加一个指定类型的组件类,你还可以通过传入脚本的名称来添加组件。
向节点添加一个指定类型的组件类,你还可以通过传入脚本的名称来添加组件。
获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
传入参数也可以是脚本的名称。
获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
传入参数也可以是脚本的名称。
递归查找所有子节点中第一个匹配指定类型的组件。
递归查找所有子节点中第一个匹配指定类型的组件。
返回节点上指定类型的所有组件。
返回节点上指定类型的所有组件。
递归查找自身或所有子节点中指定类型的组件。
递归查找自身或所有子节点中指定类型的组件。
如果该组件启用,则每帧调用 LateUpdate。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。
the delta time in seconds it took to complete the last frame
当该组件被启用,并且它的节点也激活时。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。
onRestore 是用户在检查器菜单点击 Reset 时,对此组件执行撤消操作后调用的。
如果组件包含了“内部状态”(不在 CCClass 属性中定义的临时成员变量),那么你可能需要实现该方法。
编辑器执行撤销/重做操作时,将调用组件的 get set 来录制和还原组件的状态。
然而,在极端的情况下,它可能无法良好运作。
那么你就应该实现这个方法,手动根据组件的属性同步“内部状态”。
一旦你实现这个方法,当用户撤销或重做时,组件的所有 get set 都不会再被调用。
这意味着仅仅指定了默认值的属性将被编辑器记录和还原。
同样的,编辑可能无法在极端情况下正确地重置您的组件。
于是如果你需要支持组件重置菜单,你需要在该方法中手工同步组件属性到“内部状态”。
一旦你实现这个方法,组件的所有 get set 都不会在重置操作时被调用。
这意味着仅仅指定了默认值的属性将被编辑器重置。
此方法仅在编辑器下会被调用。
暂停播放。
开始播放音频。
如果音频处于正在播放状态,将会重新开始播放音频。
如果音频处于暂停状态,则会继续播放音频。
以指定音量播放一个音频一次。
注意,对同一个音频片段,不同平台多重播放效果存在差异。
在 Web Audio 模式下,可以同时维护多个播放进度,达到多重播放。
其他模式下都不支持多重播放,如前一次尚未播完,则会立即重新播放。
要播放的音频
相对当前音量的缩放,默认为 1
用来初始化组件或节点的一些属性,当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。这个回调只会在编辑器下调用。
调度一个自定义的回调函数。
如果回调函数已调度,那么将不会重复调度它,只会更新时间间隔参数。
回调函数。
时间间隔,0 表示每帧都重复。
将被重复执行(repeat+ 1)次,您可以使用 cc.macro.REPEAT_FOREVER 进行无限次循环。
第一次执行前等待的时间(延时执行)。
调度一个只运行一次的回调函数,可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。
回调函数。
第一次执行前等待的时间(延时执行)。
如果该组件第一次启用,则在所有组件的 update 之前调用。通常用于需要在所有组件的 onLoad 初始化完毕后执行的逻辑。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。
停止播放。
取消调度一个自定义的回调函数。
回调函数。
取消调度所有已调度的回调函数:定制的回调函数以及 'update' 回调函数。动作不受此方法影响。
如果该组件启用,则每帧调用 update。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。
the delta time in seconds it took to complete the last frame
Generated using TypeDoc
音频组件,代表单个音源,提供播放、暂停、停止等基本功能。
用户可通过 cc.AudioSourceComponent 调用此类。