Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Audio

Hierarchy

  • Audio

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static Private Readonly audioFlags

audioFlags: string[] = ...

Static Protected cachedMusicFile

cachedMusicFile: string

Methods

Static hasSoundFinished

  • hasSoundFinished(soundId: number): boolean

  • Parameters

    • soundId: number

    Returns boolean

Static playMusic

  • playMusic(musicFile: string): void

  • Parameters

    • musicFile: string

    Returns void

Static playSound

  • playSound(soundFile: string, soundSet: string): void

  • Parameters

    • soundFile: string
    • soundSet: string

    Returns void

Static playSoundAt

  • playSoundAt(position: Vector3, sound: string, set?: string, generateSoundId?: boolean): number

  • Parameters

    • position: Vector3
    • sound: string
    • Optional set: string
    • generateSoundId: boolean = true

    Returns number

Static playSoundFromEntity

  • playSoundFromEntity(entity: Entity, sound: string, set?: string, generateSoundId?: boolean): number

  • Parameters

    • entity: Entity
    • sound: string
    • Optional set: string
    • generateSoundId: boolean = true

    Returns number

Static playSoundFrontEnd

  • playSoundFrontEnd(sound: string, set?: string, generateSoundId?: boolean): number

  • Parameters

    • sound: string
    • Optional set: string
    • generateSoundId: boolean = true

    Returns number

Static releaseSound

  • releaseSound(soundId: number): void

  • Parameters

    • soundId: number

    Returns void

Static setAudioFlag

  • setAudioFlag(flag: string | AudioFlag, toggle: boolean): void

Static stopMusic

  • stopMusic(musicFile?: string): void

  • Parameters

    • Optional musicFile: string

    Returns void

Static stopSound

  • stopSound(soundId: number): void

  • Parameters

    • soundId: number

    Returns void

Generated using TypeDoc