Sound

An object that is useful for loading and playing sound assets

Properties

Name Type Description
Inherited from Dynamic Name Enabled Root Tag Position Rotation LocalRotation Size Parent TextureID TextureTiling TextureTilingY

Functions

Name Returns Description
PlayVoidStarts playing the sound attatched to this object.
StopVoidStops playing the sound attatched to this object.
PauseVoidPauses the sound attatched to this object.
UnpauseVoidUnpauses the sound attatched to this object.
SetVolumeVoidSets the volume of the attached sound object.
SetPitchVoidSets the pitch of the attached sound object.
SetSpatialBlendVoidSets the spatial blend (played locally vs globally, 2D or 3D sound) of the attached sound object
Set3DSoundVoidEnable/Disable set 3D Sound
GetVolumeNumberSets the pitch of the attached sound object.
GetPitchNumberGets the current pitch of the attached sound object.
SetSoundIDVoid
GetLengthNumber
SetDopplerLevelVoidSets the doppler level of the sound (0 to 5)
GetDopplerLevelNumberGets the current doppler level of the sound
SetSpreadVoidSets the spread angle (in degrees) of a 3D stereo or multichannel sound in speaker space
GetSpreadNumberGets the current spread angle of the sound
SetMinDistanceVoidSets the distance at which the sound starts to attenuate
GetMinDistanceNumberGets the current minimum distance of the sound
SetMaxDistanceVoidSets the distance at which the sound stops attenuating
GetLoopBooleanGets whether the sound is currently looping
SetLoopVoidSets whether the sound should loop
IsPlayingBooleanChecks if the sound is currently playing
Inherited from Dynamic SetParent Log IsA FindFirstChild FindFirstChildOfClass FindFirstParentOfClass MoveTo NetworkSync LookAt LocalToWorldPoint Clone GetChildren ClearChildren Destroy

Events

Name Description