Class SoundDataUpdate

Hierarchy

DataType
- SoundDataUpdate

Index

Constructors

constructor

new SoundDataUpdate(
    type: SoundDataUpdateType,
    volume?: number,
    pitch?: number,
    duration?: number,
    targetVolume?: number,
    seconds?: number,
): SoundDataUpdate
Parameters
- type: SoundDataUpdateType
- volume: number = 0
- pitch: number = 0
- duration: number = 0
- targetVolume: number = 0
- seconds: number = 0
Returns SoundDataUpdate
Overrides DataType.constructor
- Defined in packages/protocol/src/proto/types/sound-data-update.ts:41

Properties

duration

duration: number

The duration of the fade in seconds. Only used if the type is SoundDataUpdateType.Fade.

pitch

pitch: number

The new pitch of the sound. Only used if the type is SoundDataUpdateType.SetPitch.

seconds

seconds: number

The position in seconds to seek to. Only used if the type is SoundDataUpdateType.SeekTo.

targetVolume

targetVolume: number

The volume to fade to. Only used if the type is SoundDataUpdateType.Fade.

type

type: SoundDataUpdateType

The type of the sound data update.

volume

volume: number

The new volume of the sound. Only used if the type is SoundDataUpdateType.SetVolume.

Methods

`Static`read

read(stream: BinaryStream): SoundDataUpdate
Read a value from the stream.
Parameters
- stream: BinaryStream
  The BinaryStream to read from.
Returns SoundDataUpdate
The value read from the stream.
Overrides DataType.read
- Defined in packages/protocol/src/proto/types/sound-data-update.ts:58

`Static`write

write(stream: BinaryStream, value: SoundDataUpdate): void
Write a value to the stream.
Parameters
- stream: BinaryStream
  The BinaryStream to write to.
- value: SoundDataUpdate
  The value to write.
Returns void
Overrides DataType.write
- Defined in packages/protocol/src/proto/types/sound-data-update.ts:91

Class SoundDataUpdate

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SoundDataUpdate

Properties

duration

pitch

seconds

targetVolume

type

volume

Methods

`Static`read

Parameters

Returns SoundDataUpdate

`Static`write

Parameters

Returns void

Settings

On This Page

Class SoundDataUpdate

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SoundDataUpdate

Properties

duration

pitch

seconds

targetVolume

type

volume

Methods

Staticread

Parameters

Returns SoundDataUpdate

Staticwrite

Parameters

Returns void

Settings

On This Page

`Static`read

`Static`write