Skip to content

class Sound (client-side)

Available since version: 0.3.0

Constructor

Sound.new(string file)

Parameters:

  • string file: Sound file path.

Properties

string file

Gets or sets the sound file path.


number playingTime (read-only)

Returns the current playback time.


number volume

Gets or sets the playback volume.


bool looping

Gets or sets whether the sound should loop.


number balance

Gets or sets the stereo balance (pan).


Methods

play

Starts sound playback.

void play()

stop

Stops sound playback.

void stop()

isPlaying

Returns whether the sound is currently playing.

bool isPlaying()

Returns bool:

True if the sound is playing.


Callbacks

No callbacks.