An object that emits sound. This object can be placed within a
BasePart or Attachment to emit a sound from a particular position within a place or world, or it can be attached elsewhere to play the sound at a constant volume throughout the entire place.- Memory category
- Internal
- Own members
- 57
- Inherited members
- 75
- Subclasses
- 0
- Siblings
- 608
Properties58
Property categoryBehavior
- Determines if an
Instanceand its descendants can be cloned usingInstance:Clone(), and can be saved/published. - Deprecated: This deprecated property is a variant of
Instance.Archivablewhich should be used instead.Use Archivable instead.
Property categoryData
Property categoryPermissions
- The set of capabilities allowed to be used for scripts inside this container.
- Indicates whether the instance is inside a sandboxed container.
- When enabled, the instance can only access abilities in its
Capabilitieslist.
Defined bySound35
Property categoryAsset
Sound.AudioContent: Content A reference to an audio asset.Sound.ChannelCount: number = 0 Sound.IsLoaded: boolean = false This property istruewhen theSoundhas loaded from Roblox servers and is ready to play.Sound.SoundId: string = "" Content ID of the sound file to associate with theSound.Sound.TimeLength: number = 0 The length of theSoundin seconds.
Property categoryBehavior
Sound.AssetRepresentation: Enum.AssetRepresentation = Enum.AssetRepresentation.FullLength Sound.IsSpatial: boolean = false Sound.PlayOnRemove: boolean = false Whentrue, theSoundwill play when it is removed from the experience.Sound.UsageContextPermission: Enum.UsageContext = Enum.UsageContext.Default
Property categoryData
Sound.PlayingReplicator: boolean = false Sound.TimePositionReplicator: number = 0 Sound.EmitterSize: number = 10 Deprecated: This property has deprecated in favor ofSound.RollOffMinDistanceandSound.RollOffMaxDistancewhich should be used instead in new work.
The minimum distance, in studs, at which a 3DSound(direct child of aBasePartorAttachment) will begin to attenuate (decrease in volume).Use RollOffMinDistance instead.
Sound.MaxDistance: number = 10000 Deprecated: This property has deprecated in favor ofSound.RollOffMinDistanceandSound.RollOffMaxDistancewhich should be used instead in new work.
The maximum distance, in studs, a client's listener can be from theSound\sorigin and still hear it. Only applies to Sounds parented to aPartorAttachment(3D sounds).Use RollOffMaxDistance instead.
Sound.MinDistance: number = 10 Deprecated: MinDistance has been superseded bySound.EmitterSize, whose name better describes this properties behavior.
The minimum distance at which a 3DSound(direct child of aBasePartorAttachment) will begin to attenuate. Effectively, the emitter size.Use RollOffMinDistance instead.
Sound.Pitch: number = 1 Deprecated: This property has been deprecated in favor ofSound.PlaybackSpeedwhose name suits the behavior better.
Sets how high pitched and fast aSoundis when it is played. The greater the integer, the higher and faster theSoundis.Use PlaybackSpeed instead.
Sound.isPlaying: boolean = false Deprecated: This deprecated property is a variant ofSound.IsPlayingwhich should be used instead.Use IsPlaying instead.
Sound.xmlRead_MaxDistance_3: number = 10000 Use RollOffMaxDistance instead.
Sound.xmlRead_MinDistance_3: number = 10 Use RollOffMinDistance instead.
Property categoryEmitter
Sound.AcousticSimulationEnabled: boolean = true Sound.RollOffMaxDistance: number = 10000 The maximum distance, in studs, a client's listener can be from the sound's origin and still hear it. Only applies toSoundsparented to aBasePartorAttachment.Sound.RollOffMinDistance: number = 10 The minimum distance, in studs, at which aSoundwhich is parented to aBasePartorAttachmentwill begin to attenuate (decrease in volume).Sound.RollOffMode: Enum.RollOffMode = Enum.RollOffMode.Inverse Controls how the volume of aSoundwhich is parented to aBasePartorAttachmentattenuates (fades out) as the distance between the listener and parent changes.
Property categoryPlayback
Sound.IsPaused: boolean = true Read-only property which returnstruewhen theSoundis not playing.Sound.IsPlaying: boolean = false Read-only property which returnstruewhen theSoundis playing.Sound.Looped: boolean = false Sets whether or not theSoundrepeats once it has finished playing.Sound.PlaybackLoudness: number = 0 Sound.PlaybackRegionsEnabled: boolean = false Iftrue, this property gives yourSoundaccess to thePlaybackRegionandLoopRegionproperties which can more-accurately control its playback.Sound.PlaybackSpeed: number = 1 Determines the speed at which aSoundwill play, with higher values causing the sound to play faster and at a higher pitch.Sound.Playing: boolean = false Indicates whether theSoundis currently playing.Sound.RollOffGain: number = 1 Sound.TimePosition: number = 0 Sound.Volume: number = 0.5 The volume of theSound.
Property categoryRegions
Sound.LoopRegion: NumberRange = NumberRange.new(0, 60000) A range denoting a desired loop start and loop end within thePlaybackRegion, in seconds.Sound.PlaybackRegion: NumberRange = NumberRange.new(0, 60000) A range denoting a desired start and stop time within theTimeLength, in seconds.
Property categoryRouting
Sound.SoundGroup: SoundGroup TheSoundGroupthat is linked to thisSound.
No properties match the filters.
Methods52
Object:GetPropertyChangedSignal( property: string): RBXScriptSignal Get an event that fires when a given property of the object changes.Parameters Parameter Description property: stringThe property to connect to.Returns Type Description RBXScriptSignalA signal that fires whenever the property changes.- Returns true if an object's class matches or inherits from a given class.
Parameters Parameter Description className: stringThe class against which the Object's class will be checked. Case-sensitive.Returns Type Description booleanDescribes whether the Object's class matched or is a subclass of the given class. - Deprecated: This deprecated function is a variant of
Object:IsA()which should be used instead.Parameters Parameter className: stringReturns Type booleanUse IsA instead.
- Applies a tag to the instance.
Parameters Parameter Description tag: stringThe tag to apply to the instance. - This method destroys all of an instance's children.
- Create a copy of an instance and all its descendants, ignoring instances that are not
Archivable.Returns Type Description InstanceA copy of the instance, ornilif the instance is notArchivable. - Sets the
Instance.Parentproperty tonil, locks theInstance.Parentproperty, disconnects all connections, and callsDestroy()on all children. Instance:FindFirstAncestor( name: string): Instance Returns the first ancestor of theInstancewhoseInstance.Nameis equal to the given name.Parameters Parameter Description name: stringTheInstance.Nameto be looked for.Instance:FindFirstAncestorOfClass( className: string): Instance Returns the first ancestor of theInstancewhoseObject.ClassNameis equal to the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstAncestorWhichIsA( className: string): Instance Returns the first ancestor of theInstancefor whomObject:IsA()returns true for the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstChild( name: string, recursive: boolean? = false): Instance Returns the first child of theInstancefound with the given name.Parameters Parameter Description name: stringTheInstance.Nameto be searched for.recursive: boolean? = falseWhether or not the search should be conducted recursively.Instance:FindFirstChildOfClass( className: string): Instance Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstChildWhichIsA(className: string,recursive: boolean? = false,): Instance Returns the first child of theInstancefor whomObject:IsA()returns true for the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be searched for.recursive: boolean? = falseWhether or not the search should be conducted recursively.Instance:FindFirstDescendant( name: string): Instance Returns the first descendant found with the givenInstance.Name.Parameters Parameter Description name: stringTheInstance.Nameto search for.- Returns the
Actorassociated with the Instance, if any. Instance:GetAttribute( attribute: string): any Returns the value which has been assigned to the given attribute name.Parameters Parameter Description attribute: stringThe name of the attribute being retrieved.Returns Type Description anyThe value which has been assigned to the given attribute name. If no attribute has been assigned,nilis returned.Instance:GetAttributeChangedSignal( attribute: string): RBXScriptSignal Returns an event that fires when the given attribute changes.Parameters Parameter Description attribute: stringThe name of the specified attribute for which the change signal is being returned.Returns Type Description RBXScriptSignalAn event that fires when the given attribute changes.- Returns a dictionary of the instance's attributes.
Returns Type Description { [string]: any }A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value. - Returns an array containing all of the instance's children.
Returns Type Description { Instance }An array containing the instance's children. Instance:GetDebugId( scopeLength: number? = 4): string Returns a coded string of the debug ID used internally by Roblox.Parameters Parameter Description scopeLength: number? = 4The scope length.Returns Type Description stringThe Debug ID string.- Returns an array containing all of the descendants of the instance.
Returns Type Description { Instance }An array containing the instance's descendants. - Returns a string describing the instance's ancestry.
- Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Parameters Parameter Description name: stringName of the property to query.selector: string?Optional selector for the pseudo instance you are targeting on the instance.Returns Type Description anyThe styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. Instance:GetStyledPropertyChangedSignal( property: string): RBXScriptSignal Returns an event that fires when the given style property changes on the instance.Parameters Parameter Description property: stringName of the style property for which to listen for changes.Returns Type Description RBXScriptSignalEvent that fires when the given style property changes.- Gets an array of all tags applied to the instance.
Returns Type Description { any }An array of strings, each representing a tag applied to the instance. - Check whether the instance has a given tag.
Parameters Parameter Description tag: stringThe tag to check for on the instance.Returns Type Description booleantrueif the instance has the given tag,falseotherwise. Instance:IsAncestorOf( descendant: Instance): boolean Returns true if anInstanceis an ancestor of the given descendant.Instance:IsDescendantOf( ancestor: Instance): boolean Returnstrueif anInstanceis a descendant of the given ancestor.Instance:IsPropertyModified( property: string): boolean Returnstrueif the value stored in the specified property is not equal to the code-instantiated default.Parameters Parameter Description property: stringName of the property to query.Returns Type Description booleanBoolean indicating whether the property is modified from its code‑instantiated default.Instance:QueryDescendants( selector: string): { Instance } Returns an array containing all descendants of the instance that match theselectorstring.Parameters Parameter Description selector: stringSelector string used to filter elements.Returns Type Description { Instance }An array of instances (empty if nothing matched the selector).- Removes a tag from the instance.
Parameters Parameter Description tag: stringThe tag to remove from the instance. Instance:ResetPropertyToDefault( property: string) Resets a property to its default value.Parameters Parameter Description property: stringName of the property to reset.Instance:SetAttribute( attribute: string, value: any) Sets the attribute with the given name to the given value.Instance:WaitForChild( childName: string, timeOut: number): Instance Returns the child of theInstancewith the given name. If the child does not exist, it will yield the current thread until it does.Parameters Parameter Description childName: stringTheInstance.Nameto be looked for.timeOut: numberAn optional time out parameter.- Deprecated: This item is deprecated in favor of
Instance:Destroy()andInstance:ClearAllChildren(). If you must remove an object from the game, and wish to use the object later, set itsParentproperty tonilinstead of using this method.
Sets the object'sParenttonil, and does the same for all its descendants. - Deprecated: This item has been superseded by
Instance:GetChildren()which should be used in all new work.
Returns an array of the object's children.Returns Type Description { Instance }Array of child objects/instances.Use GetChildren instead.
- Deprecated: This deprecated function is a variant of
Instance:Clone()which should be used instead.Returns Type InstanceUse Clone instead.
- Deprecated: This deprecated function is a variant of
Instance:Destroy()which should be used instead.Use Destroy instead.
Instance:findFirstChild( name: string, recursive: boolean? = false): Instance Deprecated: This deprecated function is a variant ofInstance:FindFirstChild()which should be used instead.Returns Type InstanceUse FindFirstChild instead.
- Deprecated: This deprecated function is a variant of
Instance:GetChildren()which should be used instead.Returns Type { Instance }Use GetChildren instead.
Instance:isDescendantOf( ancestor: Instance): boolean Deprecated: This deprecated function is a variant ofInstance:IsDescendantOf()which should be used instead.Parameters Parameter ancestor: InstanceReturns Type booleanUse IsDescendantOf instead.
- Deprecated: This deprecated function is a variant of
Instance:Remove()which has also been deprecated. Neither function should be used in new work.Use Remove instead.
Defined bySound10
Sound:GetPlaybackState( ): string Returns Type stringSound:GetUnderlyingAudioPlayer( ): AudioPlayer Returns Type AudioPlayerSound:GetWorldCFrame( ): CFrame? Returns Type CFrame?- Pauses playback of the
Soundif it is playing. - Plays the
Sound. - Resumes the
Sound. - Stops the
Sound. - Deprecated: This deprecated function is a variant of
Sound:Pause()which should be used instead.Use Pause instead.
- Deprecated: This deprecated function is a variant of
Sound:Play()which should be used instead.Use Play instead.
- Deprecated: This deprecated function is a variant of
Sound:Stop()which should be used instead.Use Stop instead.
No methods match the filters.
Events22
Object.Changed: RBXScriptSignal<( property: string)> Fires immediately after a property of the object changes, with some limitations.Parameters Parameter property: string
Instance.AncestryChanged: RBXScriptSignal<( child: Instance, parent: Instance)> Fires when theInstance.Parentproperty of this object or one of its ancestors is changed.Instance.AttributeChanged: RBXScriptSignal<( attribute: string)> Fires whenever an attribute is changed on theInstance.Parameters Parameter attribute: stringInstance.ChildAdded: RBXScriptSignal<( child: Instance)> Fires after an object is parented to thisInstance.Parameters Parameter child: InstanceInstance.ChildRemoved: RBXScriptSignal<( child: Instance)> Fires after a child is removed from thisInstance.Parameters Parameter child: InstanceInstance.DescendantAdded: RBXScriptSignal<( descendant: Instance)> Fires after a descendant is added to theInstance.Parameters Parameter descendant: InstanceInstance.DescendantRemoving: RBXScriptSignal<( descendant: Instance)> Fires immediately before a descendant of theInstanceis removed.Parameters Parameter descendant: Instance- Fires immediately before (or is deferred until after) the instance is destroyed via
Instance:Destroy(). - Fires whenever any style property is changed on the instance, including when a property is set to
nil. Instance.childAdded: RBXScriptSignal<( child: Instance)> Deprecated: This deprecated event is a variant ofInstance.ChildAddedwhich should be used instead.Parameters Parameter child: InstanceUse ChildAdded instead.
Defined bySound12
Sound.DidLoop: RBXScriptSignal<( soundId: string, numOfTimesLooped: number)> Fires whenever theSoundloops.Sound.Ended: RBXScriptSignal<( soundId: string)> Fires when theSoundhas completed playback and stopped.Parameters Parameter soundId: stringSound.Loaded: RBXScriptSignal<( soundId: string)> Fires when theSoundis loaded.Parameters Parameter soundId: stringSound.Paused: RBXScriptSignal<( soundId: string)> Parameters Parameter soundId: stringSound.Played: RBXScriptSignal<( soundId: string)> Parameters Parameter soundId: stringSound.PlayingUpdatedFromClient: RBXScriptSignal<( value: boolean)> Parameters Parameter value: booleanSound.PlayingUpdatedFromServer: RBXScriptSignal<( value: boolean)> Parameters Parameter value: booleanSound.Resumed: RBXScriptSignal<( soundId: string)> Parameters Parameter soundId: stringSound.Stopped: RBXScriptSignal<( soundId: string)> Parameters Parameter soundId: stringSound.TimePositionUpdatedFromClient: RBXScriptSignal<(newPositionSeconds: number,lastLuaSetTimePosition: number,)> Sound.TimePositionUpdatedFromServer: RBXScriptSignal<(newPositionSeconds: number,lastLuaSetTimePosition: number,)> Sound.playbackActionSync: RBXScriptSignal<( action: number)> Parameters Parameter action: number
No events match the filters.