RBX.lua.Sound (Object)

Derived Classes

None

Sound (extends Instance)

• Pause
• Play
• Stop
• Clone
• FindFirstChild
• GetChildren
• GetDebugId
• GetFullName
• IsA
• IsAncestorOf
• IsDescendantOf
• Destroy
• ClearAllChildren

• IsPaused
• IsPlaying
• Looped
• Pitch
• PlayOnRemove
• SoundId
• Volume
• Name
• Parent
• Archivable
• ClassName
• RobloxLocked
• DataCost

• AncestryChanged
• Changed
• ChildAdded
• ChildRemoved
• DescendantAdded
• DescendantRemoving

A sound is an object that emits sound, as the name implies. In Roblox, sounds have a Doppler effect, meaning that if they are speeding toward you they will get louder and be slightly higher in pitch, and if they are speeding away they will get quieter and lower in pitch.

There are two different Pause methods as shown below.

Pause( )
Returns	nil
Description:	Pauses the sound if it is playing.
Member of:	Sound

Pause( )
Returns	nil
Description:	Pauses the physics and scripts in a place.
Member of:	RunService

Play( )
Returns	nil
Description:	Plays a stopped or paused sound.
Member of:	Sound

Stop( )
Returns	nil
Description:	Stops a currently playing sound and returns the marker to the beginning of the sound file, or, if called on an AnimationTrack, discontinues the running animation.
Member of:	Sound

Clone( )
Returns	Instance
Description:	Returns a clone of the object and its children, unless its Archivable property is false. The clone will have the same properties as the original object and the same descendants (except those with an Archivable property set to false). The clone's Parent will be nil.
Member of:	Instance

FindFirstChild( string name, bool recursive = false )
Returns	Instance
Description:	Returns the first child found with a name of name. Returns nil if no such child exists. If the optional recursive argument is true, will recursively descend the hierarchy while searching rather than only searching the immediate object.
Member of:	Instance

GetChildren( )
Returns	table
Description:	Returns a read-only table of the object's children.
Member of:	Instance

GetDebugId( int scopeLength )
Returns	string
Description:	Returns a coded string of the object's DebugId used internally by Roblox.
Member of:	Instance

GetFullName( )
Returns	String path to object
Description:	Returns a string with a dot (.) character separating a path of object hierarchy excluding "game".
Member of:	Instance

IsA( string className )
Returns	bool
Description:	Returns true if the Instance is that class or a subclass.
Member of:	Instance

IsAncestorOf( Instance descendant )
Returns	boolean is ancestor
Description:	Returns true if the object is an ancestor of descendant.
Member of:	Instance

IsDescendantOf( Instance ancestor )
Returns	bool
Description:	Returns true if the object is an descendant of ancestor.
Member of:	Instance

Destroy( )
Returns	nil
Description:	Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.
Member of:	Instance

ClearAllChildren( )
Returns	nil
Description:	Removes all descendants of the Instance, but leaves the Instance itself.
Member of:	Instance

Up one category:
Properties

IsPaused
Property	Bool IsPaused
Description	This property will return true when the sound is not playing. This property does not restart the sound when IsPlaying is turned on again.
Member of	Sound

Up one category:
Properties

IsPlaying
Property	Bool IsPlaying
Description	This will return true when the sound is playing.
Member of	Sound

Up one category:
Properties

Looped
Property	Bool Looped
Description	This sets whether or not the sound repeats after a script tells it to play().
Member of	Sound

Up one category:
Properties

Pitch
Property	Number Pitch
Description	This sets how high pitched and fast a sound is when it is played with the Play() method. The greater the integer, the higher and faster the sound is.
Member of	Sound

Up one category:
Properties

PlayOnRemove
Property	Bool PlayOnRemove
Description	When true, the sound will play when removed.
Member of	Sound

Up one category:
Properties

SoundId
Property	Content SoundId
Description	This is the sound file that is played by the sound object.
Member of	Sound

Volume
Property	Number volume
Description	The volume of the sound played by the object.
Member of	Sound

Name
Type	string
Description	The name of the object, which is often used to identify it in the context of its parent. Note that names are not unique identifiers; multiple children of an object may share the same name. In a script where you want to access an object using a name, for example, game.Workspace["Brick"], the first object found with that name is that object. This "first object" can be found in the Explorer menu.Names are great for showing a very brief title or summary of an object.
Member of	Instance

Parent
Type	Instance
Description	The hierarchical parent of the object. When no scripts hold references to an object, it will still be maintained as long as it's parent is set to an object which does have references to it, either by other objects or scripts. The toplevel DataModel object (the one referred to as the "game" by scripts) has no parent, but always has a reference held to it by the game engine, and exists for the duration of a session.
Member of	Instance

Archivable
Type	bool
Description	Sets whether or not the object is saved when publishing or saving to file. Also sets whether or not the object is clonable.
Member of	Instance

ClassName
Type	string
Description	A unique string per type of Instance. Should only be used as a unique identifier, as it does not reveal any information about nature of the type hierarchy the type is in. For this use, see IsA.
Member of	Instance

RobloxLocked
Type	bool
Description	If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.
Member of	Instance

DataCost
Type	int
Description	How much saving this instance with SaveInstance will add to DataComplexity
Member of	Instance

AncestryChanged ( Instance child, Instance parent )
Description	Fired when an ancestor of the Instance the event which is a member of child has its parent changed to parent.
Member of:	Instance

Changed ( Property property )
Description	Fired whenever a property of the object changes.
Member of:	Instance

ChildAdded ( Instance child )
Description	Fired after a child is added.
Member of:	Instance

ChildRemoved ( Instance child )
Description	Fired when a child is removed from the object.
Member of:	Instance

DescendantAdded ( Instance descendant )
Description	Fired when a descendant is added to the object.
Member of:	Instance

DescendantRemoving ( Instance descendant )
Description	Fired when a descendant is being removed.
Member of:	Instance