Class AudioEffect

Deprecated

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

En

Clear all references in the instance.

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

Zh

清理实例的所有引用 注意：此方法不会清理实例上的 getter 与 setter 方法。

Deprecated

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

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;
              }
          }
      }

Deprecated

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

Deprecated

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

Deprecated

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

En

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

Zh

向节点添加一个指定类型的组件类，你还可以通过传入脚本的名称来添加组件。

Example

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

En

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

Zh

向节点添加一个指定类型的组件类，你还可以通过传入脚本的名称来添加组件。

Example

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

En

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.

Zh

获取节点上指定类型的组件，如果节点有附加指定类型的组件，则返回，如果没有则为空。
传入参数也可以是脚本的名称。

Example

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

En

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.

Zh

获取节点上指定类型的组件，如果节点有附加指定类型的组件，则返回，如果没有则为空。
传入参数也可以是脚本的名称。

Example

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

En

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

Zh

递归查找所有子节点中第一个匹配指定类型的组件。

Example

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

En

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

Zh

递归查找所有子节点中第一个匹配指定类型的组件。

Example

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

En

Returns all components of supplied type in the node.

Zh

返回节点上指定类型的所有组件。

Example

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

En

Returns all components of supplied type in the node.

Zh

返回节点上指定类型的所有组件。

Example

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

En

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

Zh

递归查找自身或所有子节点中指定类型的组件。

Example

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

En

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

Zh

递归查找自身或所有子节点中指定类型的组件。

Example

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

En

Get PCM data from specified channel. Currently it is only available in Native platform and Web Audio (including Web and ByteDance platforms).

Zh

通过指定的通道获取音频的 PCM data。 目前仅在原生平台和 Web Audio（包括 Web 和 字节平台）中可用。

Returns

A Promise to get the PCM data after audio is loaded.

Example

audioSource.getPCMData(0).then(dataView => {
  if (!dataView)  return;
  for (let i = 0; i < dataView.length; ++i) {
    console.log('data: ' + dataView.getData(i));
  }
});

En

Get the sample rate of audio. Currently it is only available in Native platform and Web Audio (including Web and ByteDance platforms).

Zh

获取音频的采样率。 目前仅在原生平台和 Web Audio（包括 Web 和 字节平台）中可用。

Returns

A Promise to get the sample rate after audio is loaded.

En

Pause the clip.

Zh

暂停播放。

En

Play the clip.
Restart if already playing.
Resume if paused.

NOTE: On Web platforms, the Auto Play Policy bans auto playing audios at the first time, because the user gesture is required. there are 2 ways to play audios at the first time:

• play audios in the callback of TOUCH_END or MOUSE_UP event
• play audios straightly, the engine will auto play audios at the next user gesture.

Zh

开始播放。
如果音频处于正在播放状态，将会重新开始播放音频。
如果音频处于暂停状态，则会继续播放音频。

注意:在 Web 平台，Auto Play Policy 禁止首次自动播放音频，因为需要发生用户交互之后才能播放音频。 有两种方式实现音频首次自动播放：

• 在 TOUCH_END 或者 MOUSE_UP 的事件回调里播放音频。
• 直接播放音频，引擎会在下一次发生用户交互时自动播放。

En

Plays an AudioClip, and scales volume by volumeScale. The result volume is audioSource.volume * volumeScale.

Zh

以指定音量倍数播放一个音频一次。最终播放的音量为 audioSource.volume * volumeScale。

En

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.

Zh

用来初始化组件或节点的一些属性，当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。这个回调只会在编辑器下调用。

En

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.

Zh

使用定时器系统调度一个自定义的回调任务。
如果回调任务已调度，那么将不会重复调度它，只会更新时间间隔参数。

Example

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

En

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

Zh

使用定时器系统调度一个只运行一次的回调任务，可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。

Method

scheduleOnce

See

schedule

Example

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

En

Stop the clip.

Zh

停止播放。

En

Un-schedules a custom task.

Zh

取消调度一个自定义的回调任务。

Example

this.unschedule(_callback);

En

unschedule all scheduled tasks.

Zh

取消调度所有已调度的回调函数。

Example

this.unscheduleAllCallbacks();