Sound
Plays audio files with various playback options.
Properties
| Property | Type | Default |
|---|---|---|
SoundId | string | "./src/assets/sounds/bqqchickenalert.mp3" |
Volume | number | 1.0 |
Pitch | number | 1.0 |
Looped | boolean | false |
Playing | boolean | false |
TimePosition | number | 0 |
PlayOnRemove | boolean | false |
IsLoaded | boolean | false |
Name | string | "Sound" |
AudioBackend | EnumItem | Enum.AudioBackend.RAUDIO |
IsStream | boolean | false |
SoundGroup | any | nil |
_effectiveVolume | number | 1.0 |
_fadeVolume | number | 1.0 |
Position | Vector3 | Vector3.new(0, 0, 0) |
Velocity | Vector3 | Vector3.new(0, 0, 0) |
Direction | Vector3 | Vector3.new(0, 0, -1) |
Up | Vector3 | Vector3.new(0, 1, 0) |
MinDistance | number | 10.0 |
MaxDistance | number | 1000.0 |
RollOffMode | number | 0 |
Is3D | boolean | false |
Functions
`updateVolume`
`updatePitch`
`loadAudio`
`fadeTo`
`instance.Play`
Plays the audio with an optional fade duration.
`instance.Stop`
Stops the audio with an optional fade duration.
`instance.Pause`
Pauses the audio with an optional fade duration.
`instance.Resume`
Resumes the audio.
updateVolume
Arguments
This function takes no arguments.
Returns
This function returns nothing.
updatePitch
Arguments
This function takes no arguments.
Returns
This function returns nothing.
loadAudio
Arguments
This function takes no arguments.
Returns
This function returns nothing.
fadeTo
Arguments
targetFade, durationReturns
This function returns nothing.
instance.Play
Plays the audio with an optional fade duration.
Arguments
self: table, fadeDuration: numberReturns
This function returns nothing.
instance.Stop
Stops the audio with an optional fade duration.
Arguments
self: table, fadeDuration: numberReturns
This function returns nothing.
instance.Pause
Pauses the audio with an optional fade duration.
Arguments
self: table, fadeDuration: numberReturns
This function returns nothing.
instance.Resume
Resumes the audio.
Arguments
self: table, fadeDuration: numberReturns
This function returns nothing.
API
instance:updateVolume()
instance:updatePitch()
instance:loadAudio()
instance:fadeTo(targetFade, duration)
instance:Play(self: table, fadeDuration: number)
instance:Stop(self: table, fadeDuration: number)
instance:Pause(self: table, fadeDuration: number)
instance:Resume(self: table, fadeDuration: number)