Class SoundUtil`Abstract`

Index

Constructors

constructor

Methods

Constructors

constructor

new SoundUtil(): SoundUtil
Returns SoundUtil

Methods

`Static`register

register<Catalog extends Record<string, any>>(catalog: Catalog): void
Type Parameters
- Catalog extends Record<string, any>
Parameters
- catalog: Catalog
Returns void
- Defined in src/utils/sound_util.ts:21

`Static`play

play(key: never, target: Player | Player[], options?: PlayerSoundOptions): void
Parameters
- key: never
- target: Player | Player[]
- Optionaloptions: PlayerSoundOptions
Returns void
- Defined in src/utils/sound_util.ts:28
play(key: never, target: Entity, options?: WorldSoundOptions): void
Parameters
- key: never
- target: Entity
- Optionaloptions: WorldSoundOptions
Returns void
- Defined in src/utils/sound_util.ts:29
play(key: never, target: Block, options?: WorldSoundOptions): void
Parameters
- key: never
- target: Block
- Optionaloptions: WorldSoundOptions
Returns void
- Defined in src/utils/sound_util.ts:30
play(
    key: never,
    target: { location: Vector3; dimension?: Dimension },
    options?: WorldSoundOptions,
): void
Parameters
- key: never
- target: { location: Vector3; dimension?: Dimension }
- Optionaloptions: WorldSoundOptions
Returns void
- Defined in src/utils/sound_util.ts:31
play(
    sound: Sound,
    target: Player | Player[],
    options?: PlayerSoundOptions,
): void
Parameters
- sound: Sound
- target: Player | Player[]
- Optionaloptions: PlayerSoundOptions
Returns void
- Defined in src/utils/sound_util.ts:32
play(sound: Sound, target: Entity, options?: WorldSoundOptions): void
Parameters
- sound: Sound
- target: Entity
- Optionaloptions: WorldSoundOptions
Returns void
- Defined in src/utils/sound_util.ts:33
play(sound: Sound, target: Block, options?: WorldSoundOptions): void
Parameters
- sound: Sound
- target: Block
- Optionaloptions: WorldSoundOptions
Returns void
- Defined in src/utils/sound_util.ts:34
play(
    sound: Sound,
    target: { location: Vector3; dimension?: Dimension },
    options?: WorldSoundOptions,
): void
Parameters
- sound: Sound
- target: { location: Vector3; dimension?: Dimension }
- Optionaloptions: WorldSoundOptions
Returns void
- Defined in src/utils/sound_util.ts:35

`Static`playAll

playAll(
    soundOrKey: Sound,
    options?: PlayerSoundOptions,
    filter?: (player: Player) => boolean,
): void
Parameters
- soundOrKey: Sound
- Optionaloptions: PlayerSoundOptions
- Optionalfilter: (player: Player) => boolean
Returns void
- Defined in src/utils/sound_util.ts:67

`Static`stop

stop(key: never, target: Player | Player[]): void
Parameters
- key: never
- target: Player | Player[]
Returns void
- Defined in src/utils/sound_util.ts:81
stop(sound: Sound, target: Player | Player[]): void
Parameters
- sound: Sound
- target: Player | Player[]
Returns void
- Defined in src/utils/sound_util.ts:82

`Static`stopAll

stopAll(target: Player | Player[]): void
Parameters
- target: Player | Player[]
Returns void
- Defined in src/utils/sound_util.ts:93

`Static`get

get(key: string): Sound | undefined
Parameters
- key: string
Returns Sound | undefined
- Defined in src/utils/sound_util.ts:100

`Static`has

has(key: string): boolean
Parameters
- key: string
Returns boolean
- Defined in src/utils/sound_util.ts:109

`Static`tryPlay

tryPlay(key: string, target: any, options?: any): boolean
Parameters
- key: string
- target: any
- Optionaloptions: any
Returns boolean
- Defined in src/utils/sound_util.ts:113

Class SoundUtilAbstract

Index

Constructors

Methods

Constructors

constructor

Returns SoundUtil

Methods

Staticregister

Type Parameters

Parameters

Returns void

Staticplay

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

StaticplayAll

Parameters

Returns void

Staticstop

Parameters

Returns void

Parameters

Returns void

StaticstopAll

Parameters

Returns void

Staticget

Parameters

Returns Sound | undefined

Statichas

Parameters

Returns boolean

StatictryPlay

Parameters

Returns boolean

Settings

On This Page

Class SoundUtil`Abstract`

`Static`register

`Static`play

`Static`playAll

`Static`stop

`Static`stopAll

`Static`get

`Static`has

`Static`tryPlay