Class SoundEmitter

Hierarchy

EventEmitter
- SoundEmitter

Constructors

constructor

new SoundEmitter(sound: number, position?: Vector3, range?: number): SoundEmitter
Parameters
- sound: number
- position: Vector3 = ...
- range: number = 30
Returns SoundEmitter
Overrides EventEmitter.constructor
- Defined in src/class/SoundEmitter.ts:46

Properties

`Private` _steps

_steps: Timeout[]

destroyed

destroyed: boolean = false

If .destroy() has been called on the sound emitter.

global

global: boolean = false

Whether or not to play the sound globally

loop

loop: boolean = false

Whether or not to loop the sound

name

name: string

netId

netId: number

pitch

pitch: number = 1

Pitch of the sound emitted

playing

playing: boolean = false

position

position: Vector3 = ...

range

range: number = 30

Range of the sound emitted

sound

sound: number

Item id of the sound to use

startTime

startTime: Date

Used for attempting to sync the audio between clients

volume

volume: number = 1

Volume of the sound emitted

`Static` `Readonly` captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

`Static` captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

`Static` defaultMaxListeners

defaultMaxListeners: number

`Static` `Readonly` errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

`Static` soundEmitterId

soundEmitterId: number = 0

Methods

addListener

addListener(event: string | symbol, listener: ((...args: any[]) => void)): SoundEmitter
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns SoundEmitter
Inherited from EventEmitter.addListener
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:730

destroy

destroy(): Promise<never>
Remove the sound emitter from Game.world,
clear all event listeners,
and tell clients to delete the sound emitter.

Returns Promise<never>
- Defined in src/class/SoundEmitter.ts:77

emit

emit(event: string | symbol, ...args: any[]): boolean
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:740

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:745

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:737

listenerCount

listenerCount(type: string | symbol): number
Parameters
- type: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:741

listeners

listeners(event: string | symbol): Function[]
Parameters
- event: string | symbol
Returns Function[]
Inherited from EventEmitter.listeners
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:738

off

off(event: string | symbol, listener: ((...args: any[]) => void)): SoundEmitter
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns SoundEmitter
Inherited from EventEmitter.off
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:734

on

on(event: string | symbol, listener: ((...args: any[]) => void)): SoundEmitter
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns SoundEmitter
Inherited from EventEmitter.on
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:731

once

once(event: string | symbol, listener: ((...args: any[]) => void)): SoundEmitter
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns SoundEmitter
Inherited from EventEmitter.once
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:732

play

play(): Promise<boolean>
Play the sound

Returns Promise<boolean>
- Defined in src/class/SoundEmitter.ts:158

prependListener

prependListener(event: string | symbol, listener: ((...args: any[]) => void)): SoundEmitter
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns SoundEmitter
Inherited from EventEmitter.prependListener
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:743

prependOnceListener

prependOnceListener(event: string | symbol, listener: ((...args: any[]) => void)): SoundEmitter
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns SoundEmitter
Inherited from EventEmitter.prependOnceListener
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:744

rawListeners

rawListeners(event: string | symbol): Function[]
Parameters
- event: string | symbol
Returns Function[]
Inherited from EventEmitter.rawListeners
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:739

removeAllListeners

removeAllListeners(event?: string | symbol): SoundEmitter
Parameters
- Optional event: string | symbol
Returns SoundEmitter
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:735

removeListener

removeListener(event: string | symbol, listener: ((...args: any[]) => void)): SoundEmitter
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns SoundEmitter
Inherited from EventEmitter.removeListener
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:733

setGlobal

setGlobal(global: boolean): Promise<boolean>
Parameters
- global: boolean
Returns Promise<boolean>
- Defined in src/class/SoundEmitter.ts:146

setInterval

setInterval(callback: (() => void), delay: number): Timeout
Identical to setInterval, but will be cleared after the sound emitter is destroyed. Use this if you want to attach loops to sound emitters, but don't want to worry about clearing them after they're destroyed.
Parameters
- callback: (() => void)
  
  The callback function.
  - - (): void
    - Returns void
- delay: number
  
  The delay in milliseconds.
Returns Timeout
- Defined in src/class/SoundEmitter.ts:108

setLoop

setLoop(loop: boolean): Promise<boolean>
Set the looping of the sound emitter.
Parameters
- loop: boolean
Returns Promise<boolean>
- Defined in src/class/SoundEmitter.ts:135

setMaxListeners

setMaxListeners(n: number): SoundEmitter
Parameters
- n: number
Returns SoundEmitter
Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:736

setPitch

setPitch(pitch: number): Promise<boolean>
Set the pitch of the sound emitter.
Parameters
- pitch: number
Returns Promise<boolean>
- Defined in src/class/SoundEmitter.ts:129

setPosition

setPosition(position: Vector3): Promise<boolean>
Set the position of the sound emitter.
Parameters
- position: Vector3
Returns Promise<boolean>
- Defined in src/class/SoundEmitter.ts:117

setRange

setRange(range: number): Promise<boolean>
Set the range of the sound emitter.
Parameters
- range: number
Returns Promise<boolean>
- Defined in src/class/SoundEmitter.ts:141

setSound

setSound(sound: number): Promise<boolean>
Set the sound to emit.
Parameters
- sound: number
Returns Promise<boolean>
- Defined in src/class/SoundEmitter.ts:152

setVolume

setVolume(volume: number): Promise<boolean>
Set the volume of the sound emitter.
Parameters
- volume: number
Returns Promise<boolean>
- Defined in src/class/SoundEmitter.ts:123

stop

stop(): Promise<boolean>
Stop the sound

Returns Promise<boolean>
- Defined in src/class/SoundEmitter.ts:164

`Static` listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number
Deprecated
since v4.0.0
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/events.d.ts:18

`Static` on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>
Inherited from EventEmitter.on
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/events.d.ts:15

`Static` once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from EventEmitter.once
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/events.d.ts:13
once(emitter: DOMEventTarget, event: string): Promise<any[]>
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>
Inherited from EventEmitter.once
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/events.d.ts:14

Class SoundEmitter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

sound: number

position: Vector3 = ...

range: number = 30

Returns SoundEmitter

Properties

Private _steps

destroyed

global

loop

name

netId

pitch

playing

position

range

sound

startTime

volume

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Static soundEmitterId

Methods

addListener

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns SoundEmitter

destroy

Returns Promise<never>

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

listenerCount

Parameters

type: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

off

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns SoundEmitter

on

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns SoundEmitter

once

Parameters

event: string | symbol

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

`Private` _steps

`Static` `Readonly` captureRejectionSymbol

`Static` captureRejections

`Static` defaultMaxListeners

`Static` `Readonly` errorMonitor

`Static` soundEmitterId

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` event: string | symbol

`Rest` ...args: any[]