Skip to content

Sound

Sounds are objects that can be placed in the world and emit audio.

Inherits DynamicInstance

Events

Loaded

The event that is fired when the sound is loaded from the server.

Example

sound.Loaded:Connect(function()
    sound.Play()
end)

Methods

Play → void

Plays the sound.

Stop → void

Stops playing the sound.

Properties

Autoplay : boolean

Determines whether the sound should start playing automatically.

Length : number

Returns the length of the currently loaded audio

Loop : boolean

Determines whether the sound should loop or not.

Pitch : number

The pitch property of this sound

PlayInWorld : boolean

When enabled, the sound will be played in 3D world space rather than having the same volume for everyone.

Playing : boolean

Determines whether the sound is currently playing or not.

Size : Vector3

Property description (what?? change this later)

SoundID : number

The asset ID of the sound.

Time : number

The time position the track is currently on.

Volume : number

The volume of the sound.