Options
All
  • Public
  • Public/Protected
  • All
Menu

Class YSound

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

id

  • get id(): number

  • Returns the numerical ID of the target Entity type.

    Returns number

Methods

Static disableMusic

  • Disables currently played music for the character.

    Parameters

    Returns void

Static get

  • Parameters

    • id: number

    Returns YSound

Static play2D

  • Plays a 2D sound of a given volume in the whole scene.

    Parameters

    Returns void

  • Plays a 2D sound of a given volume for the target player.

    Parameters

    Returns void

Static play3D

Static playMusicTrackLooped

  • Plays the selected music track on loop.

    Parameters

    Returns void

  • Plays the target list of music tracks to the selected player.

    Parameters

    Returns void

Static playMusicTrackOnce

Static playNote2D

  • playNote2D(instrument: number, octave: number, note: YNote, velocity: number, duration: number): void
  • playNote2D(player: YCharacter, instrument: number, octave: number, note: YNote, velocity: number, duration: number): void

  • Allows to play selected MIDI note everywhere.

    Parameters

    • instrument: number
    • octave: number
    • note: YNote
    • velocity: number
    • duration: number

    Returns void

  • Allows to play selected MIDI note to a player.

    Parameters

    • player: YCharacter
    • instrument: number
    • octave: number
    • note: YNote
    • velocity: number
    • duration: number

    Returns void

Static playNote3D

  • playNote3D(position: YVector3, audiableDistance: YAudibleDistance, instrument: number, octave: number, note: YNote, velocity: number, duration: number): void

  • Allows to play selected MIDI note at given position.

    Parameters

    Returns void

Static resetMusic

  • Resets the characters music to a default state.

    Parameters

    Returns void

Generated using TypeDoc