Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Sound

音效类
可监听的事件：ended

Hierarchy

Implements

  • IAnimatable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

data

data: any = undefined

扩展字段，可以用来存储任意数据

id

id: number = -1

节点ID，由编辑器生成

Accessors

currentTime

  • get currentTime(): number
  • set currentTime(value: number): void

  • 当前播放时长，单位为毫秒

    Returns number

  • 当前播放时长，单位为毫秒

    Parameters

    • value: number

    Returns void

destroyed

  • get destroyed(): boolean

  • 是否已经被销毁，销毁后，不能再执行任何操作

    Returns boolean

duration

  • get duration(): number
  • set duration(value: number): void

  • 播放持续时长，注意：更改持续时长会影响播放速率

    Returns number

  • 播放持续时长，注意：更改持续时长会影响播放速率

    Parameters

    • value: number

    Returns void

enabled

  • get enabled(): boolean
  • set enabled(value: boolean): void

  • 是否启用节点，如果不启用，则不可见，同时脚本不执行

    Returns boolean

  • 是否启用节点，如果不启用，则不可见，同时脚本不执行

    Parameters

    • value: boolean

    Returns void

globalEnabled

  • get globalEnabled(): boolean

  • 自己及自己的父节点是否激活

    Returns boolean

isInScene

  • get isInScene(): boolean

  • 是否还在场景中，如果自己或者自己的父节点被移除，则为false

    Returns boolean

muted

  • get muted(): boolean
  • set muted(value: boolean): void

  • 是否静音

    Returns boolean

  • 是否静音

    Parameters

    • value: boolean

    Returns void

name

  • get name(): string
  • set name(value: string): void

  • 节点名称

    Returns string

  • 节点名称

    Parameters

    • value: string

    Returns void

numChildren

  • get numChildren(): number

  • 子节点的数量

    Returns number

parent

  • get parent(): undefined | Node

  • 父亲节点，只有被添加到别的节点中，才会有值

    Returns undefined | Node

playbackRate

  • get playbackRate(): number
  • set playbackRate(value: number): void

  • 播放速率，1为正常速度播放，小于1则慢速播放，大于1则加速播放

    Returns number

  • 播放速率，1为正常速度播放，小于1则慢速播放，大于1则加速播放

    Parameters

    • value: number

    Returns void

playing

  • get playing(): boolean

  • 是否在播放

    Returns boolean

root

  • get root(): undefined | IAnimation

  • 获得所在的根节点，如果是互动组件，则是 Animation，否者和 this.scene 相同

    Returns undefined | IAnimation

scene

  • get scene(): undefined | Scene

  • 获得所在的场景节点，只有被添加到场景中，才会有值

    Returns undefined | Scene

url

  • get url(): string
  • set url(value: string): void

  • 声音网络地址

    Returns string

  • 声音网络地址

    Parameters

    • value: string

    Returns void

visible

  • get visible(): boolean
  • set visible(value: boolean): void

  • 节点是否可见，相比enabled，visible不影响脚本的执行

    Returns boolean

  • 节点是否可见，相比enabled，visible不影响脚本的执行

    Parameters

    • value: boolean

    Returns void

volume

  • get volume(): number
  • set volume(value: number): void

  • 音量大小

    Returns number

  • 音量大小

    Parameters

    • value: number

    Returns void

Methods

addChild

  • 添加子节点

    Parameters

    • node: Node

      子节点

    Returns Node

addChildAt

  • addChildAt(node: Node, index: number): Node

  • 在某个索引下添加子节点

    Parameters

    • node: Node

      子节点

    • index: number

      索引

    Returns Node

addScript

  • 添加脚本，脚本由场景统一驱动

    Parameters

    Returns undefined | Script

contains

  • contains(target: Node): boolean

  • 自己或者孩子是否包含该节点

    Parameters

    • target: Node

      目标节点

    Returns boolean

destroy

  • destroy(): void

  • 销毁节点

    Returns void

destroyChildren

  • destroyChildren(): void

  • 销毁所有子节点

    Returns void

destroyScripts

  • destroyScripts(scriptClass?: typeof Script): void

  • 销毁指定类型的脚本，如果类型参数为空，则删除当前对象身上的所有脚本

    Parameters

    • Optional scriptClass: typeof Script

      脚本类型

    Returns void

emit

  • emit(type: string, data?: unknown[]): void

  • 派发事件

    Parameters

    • type: string

      事件类型

    • Optional data: unknown[]

      派发的数据（可选）

    Returns void

fromJson

  • fromJson(json: INodeData): Promise<void>

  • 根据json创建节点信息

    Parameters

    • json: INodeData

      节点数据，一般是由编辑器生成的json数据

    Returns Promise<void>

getById

  • getById(id: number): undefined | Node

  • 从根节点（编辑器文件的根节点，如果没有则为this），根据id获得节点

    Parameters

    • id: number

      编辑器内的节点id

    Returns undefined | Node

getChildAt

  • getChildAt(index: number): Node

  • 根据索引获得子节点

    Parameters

    • index: number

      索引

    Returns Node

getChildByName

  • getChildByName(name: string, deep?: boolean): undefined | Node

  • 根据名称获得子节点

    Parameters

    • name: string

      名称

    • deep: boolean = false

      是否递归搜索

    Returns undefined | Node

getChildIndex

  • getChildIndex(node: Node): number

  • 获得子节点索引数

    Parameters

    • node: Node

      子节点

    Returns number

getScript

  • getScript<T>(ScriptClass?: T, deep?: boolean): undefined | InstanceType<T>

  • 获取绑定到该节点的第一个脚本实例

    Type parameters

    • T: new (...args: any[]) => Script

    Parameters

    • ScriptClass: T = ...

      脚本类型

    • deep: boolean = false

      如果是true，则遍历所有子对象，返回第一个脚本实例，默认为false

    Returns undefined | InstanceType<T>

    返回绑定到该节点的第一个脚本实例

getScriptByName

  • getScriptByName(name: string): undefined | Script

  • 根据名称获取绑定到该节点的所有脚本实例

    Parameters

    • name: string

      脚本名称

    Returns undefined | Script

    返回绑定到该节点的第一个脚本实例

getScripts

  • getScripts<T>(ScriptClass?: T, deep?: boolean): InstanceType<T>[]

  • 获取绑定到该节点的所有脚本实例

    Type parameters

    • T: new (...args: any[]) => Script

    Parameters

    • ScriptClass: T = ...

      脚本类型

    • deep: boolean = false

      如果是true，则遍历所有子对象的脚本实例，默认为false

    Returns InstanceType<T>[]

    返回绑定到该节点的所有脚本实例

gotoAndStop

  • gotoAndStop(time: number): void

  • 停止到某个时间点，这个函数不生效

    Parameters

    • time: number

      时间点，单位毫秒

    Returns void

load

  • load(url: string): Promise<void>

  • 根据地址加载节点数据并解析

    Parameters

    • url: string

      节点数据地址

    Returns Promise<void>

off

  • off(type: string, listener: (...args: any[]) => void, caller?: unknown): void

  • 取消事件监听

    Parameters

    • type: string

      事件类型

    • listener: (...args: any[]) => void

      监听函数

        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional caller: unknown

      函数的主体（一般是this，箭头函数可以省略）

    Returns void

offAll

  • offAll(caller?: unknown): void

  • 移除当前节点身上所有caller的事件监听 如果caller为空，则清理当前节点下的所有事件监听

    Parameters

    • Optional caller: unknown

    Returns void

on

  • on<A>(type: "click" | "mouseup" | "mousedown" | "mousemove" | "loaded" | "ended" | "enabled" | "textChanged", listener: A, caller?: unknown, args?: Parameters<A>): void
  • on<A>(type: string, listener: A, caller?: unknown, args?: Parameters<A>): void

  • 监听事件，不用或者销毁时，需要使用off函数清除

    Type parameters

    • A: (...args: any[]) => void

    Parameters

    • type: "click" | "mouseup" | "mousedown" | "mousemove" | "loaded" | "ended" | "enabled" | "textChanged"

      事件类型

    • listener: A

      监听函数

    • Optional caller: unknown

      函数的主体（一般是this，箭头函数可以省略）

    • Optional args: Parameters<A>

      传入的参数，在listener内可以接收到

    Returns void

  • Type parameters

    • A: (...args: any[]) => void

    Parameters

    • type: string
    • listener: A
    • Optional caller: unknown
    • Optional args: Parameters<A>

    Returns void

once

  • once<A>(type: string, listener: A, caller?: unknown, args?: Parameters<A>): void

  • 监听事件，在事件被执行后，取消继续监听，不用或者销毁时，需要使用off函数清除

    Type parameters

    • A: (...args: any[]) => void

    Parameters

    • type: string

      事件类型

    • listener: A

      监听函数

    • Optional caller: unknown

      函数的主体（一般是this，箭头函数可以省略）

    • Optional args: Parameters<A>

      传入的参数，在listener内可以接收到

    Returns void

play

  • play(): void

  • 开始播放

    Returns void

removeChild

  • 移除子节点

    Parameters

    • node: Node

      子节点

    Returns Node

removeChildAt

  • removeChildAt(index: number): Node

  • 根据索引移除子节点

    Parameters

    • index: number

      索引

    Returns Node

removeChildByName

  • removeChildByName(name: string): Node

  • 根据名称移除子节点

    Parameters

    • name: string

      节点名称

    Returns Node

removeChildren

  • removeChildren(): void

  • 移除所有子节点

    Returns void

removeSelf

  • 把自己从父节点删除

    Returns Node

setChildIndex

  • setChildIndex(node: Node, index: number): Node

  • 设置子节点索引

    Parameters

    • node: Node

      子节点

    • index: number

      索引

    Returns Node

setProp

  • setProp(prop: string, value: unknown): void

  • 设置节点的属性值

    Parameters

    • prop: string

      属性名

    • value: unknown

      属性值

    Returns void

stop

  • stop(): void

  • 停止播放

    Returns void