Class AudioSource3D

Hierarchy

Constructors

Properties

_coneInnerAngle: number
_coneOuterAngle: number
_coneOuterGain: number
_distanceModel: DistanceModelType
_enablePosition: boolean = true
_entity: Entity
_loop: boolean = true
_maxDistance: number
_panningModel: PanningModelType
_refDistance: number
_rolloffFactor: number
_volume: number
buffer: AudioBuffer
enabled: boolean = true

是否启用update方法

gain: GainNode
hideFlags: HideFlags = HideFlags.None

隐藏标记,用于控制是否在层级界面、检查器显示,是否保存

panner: PannerNode
runEnvironment: RunEnvironment = RunEnvironment.all

可运行环境

source: AudioBufferSourceNode
url: string = ''

声音文件路径

Accessors

  • get distanceModel(): DistanceModelType
  • 该接口的distanceModel属性PannerNode是一个枚举值,用于确定在音频源离开收听者时用于减少音频源音量的算法。

    可能的值是:

    • linear:根据以下公式计算由距离引起的增益的线性距离模型: 1 - rolloffFactor * (distance - refDistance) / (maxDistance - refDistance)
    • inverse:根据以下公式计算由距离引起的增益的反距离模型: refDistance / (refDistance + rolloffFactor * (distance - refDistance))
    • exponential:按照下式计算由距离引起的增益的指数距离模型 pow(distance / refDistance, -rolloffFactor)。

    inverse是的默认值distanceModel。

    Returns DistanceModelType

  • set distanceModel(v: DistanceModelType): void
  • Parameters

    Returns void

  • get entity(): Entity
  • 此组件附加到的游戏对象。组件总是附加到游戏对象上。

    Returns Entity

  • get isVisibleAndEnabled(): boolean
  • Has the Behaviour had enabled called. 是否所在Object3D显示且该行为已启动。

    Returns boolean

  • get maxDistance(): number
  • 表示音频源和收听者之间的最大距离,之后音量不会再降低。该值仅由linear距离模型使用。默认值是10000。

    Returns number

  • set maxDistance(v: number): void
  • Parameters

    • v: number

    Returns void

Methods

  • 返回游戏对象附加的一个指定类型的组件,如果没有,则返回 null。

    使用 Entity.GetComponent 将返回找到的第一个组件。如果您希望有多个相同类型的组件,请改用 Entity.GetComponents,并循环通过返回的组件测试某些唯一属性。

    Returns

    要检索的组件。

    Type Parameters

    Parameters

    • component: K

      要检索的组件类型。

    Returns ComponentMap[K]

  • 使用深度优先搜索返回 Entity 或其任何子项中的 Type 组件。

    Returns

    匹配类型的组件(如果找到)。

    Type Parameters

    Parameters

    • component: K

      要检索的组件类型。

    • includeInactive: boolean = false

      是否包含不活跃组件。

    Returns ComponentMap[K]

  • 检索 Entity 或其任何父项type中的 Type 组件。

    此方法向上递归,直到找到具有匹配组件的 Entity。仅匹配活动游戏对象上的组件。

    Returns

    如果找到与类型匹配的组件,则返回一个组件。否则返回 null。

    Type Parameters

    Parameters

    • component: K

      要查找的组件类型。

    • includeInactive: boolean = false

      是否包含不活跃组件。

    Returns ComponentMap[K]

  • 使用深度优先搜索返回 当前实体 或其任何子子项中 Type 的所有组件。递归工作。

    在子游戏对象上递归搜索组件。这意味着它还包括目标实体的所有子实体,以及所有后续子实体。

    Returns

    所有找到的组件。

    Type Parameters

    Parameters

    • component: K

      要检索的组件类型。

    • includeInactive: boolean = false

      非活动游戏对象上的组件是否应该包含在搜索结果中?

    • results: ComponentMap[K][] = []

      列出接收找到的组件。

    Returns ComponentMap[K][]

Generated using TypeDoc