Class Sound

constructor

• new Sound(name: string, options?: PlayerSoundOptions | WorldSoundOptions): Sound

  Parameters

  • name: string
  • Optionaloptions: PlayerSoundOptions | WorldSoundOptions

  Returns Sound

Readonlyname

Readonlyoptions

play

• play(target: Player | Player[], options?: PlayerSoundOptions): void

  Parameters

  • target: Player | Player[]
  • Optionaloptions: PlayerSoundOptions

  Returns void

• play(target: Entity, options?: WorldSoundOptions): void

  Parameters

  • target: Entity
  • Optionaloptions: WorldSoundOptions

  Returns void

• play(target: Block, options?: WorldSoundOptions): void

  Parameters

  • target: Block
  • Optionaloptions: WorldSoundOptions

  Returns void

• play(target: Vector3, options?: WorldSoundOptions): void

  Parameters

  • target: Vector3
  • Optionaloptions: WorldSoundOptions

  Returns void

• play(target: DimensionLocation, options?: WorldSoundOptions): void

  Parameters

  • target: DimensionLocation
  • Optionaloptions: WorldSoundOptions

  Returns void

playAll

• playAll(
      options?: PlayerSoundOptions,
      filter?: (player: Player) => boolean,
  ): void

  Parameters

  • Optionaloptions: PlayerSoundOptions
  • Optionalfilter: (player: Player) => boolean

  Returns void

stop

• stop(target: Player | Player[]): void

  Parameters

  • target: Player | Player[]

  Returns void

StaticstopAll

• stopAll(target: Player | Player[]): void

  Parameters

  • target: Player | Player[]

  Returns void