Sound

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

Inherits: Dynamic

Properties

• Audio: AudioAsset
• Volume: number
• Pitch: number
• Autoplay: boolean
• Loop: boolean
• PlayInWorld: boolean
• Paused: boolean
• MaxDistance: number
• Time: number
• Playing: boolean
• Loading: boolean
• Length: number

Methods

Play() → nil

Starts playing the sound.

PlayOneShot(volume: number) → nil

Plays the sound once at the specified volume without affecting the current playback.

Pause() → nil

Pause the sound if it is currently playing.

Stop() → nil

Stops the sound if it is currently playing.

Events

• Loaded: Fires when this sound has loaded