Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Sound

Summary

Member index 51

HistoryMember
553ChannelCount: int
601EmitterSize: float
553IsLoaded: bool
553LoopRegion: NumberRange
553Looped: bool
601MaxDistance: float
601MinDistance: float
553Pitch: float
553PlayOnRemove: bool
553PlaybackLoudness: double
553PlaybackRegion: NumberRange
582PlaybackRegionsEnabled: bool
553PlaybackSpeed: float
553Playing: bool
553RollOffMaxDistance: float
553RollOffMinDistance: float
553RollOffMode: RollOffMode
553SoundGroup: SoundGroup
553SoundId: Content
553TimeLength: double
553TimePosition: double
553Volume: float
553isPlaying: bool
573Pause(): null
573Play(): null
573Resume(): null
573Stop(): null
573pause(): null
573play(): null
573stop(): null
462DidLoop(soundId: string, numOfTimesLooped: int)
462Ended(soundId: string)
462Loaded(soundId: string)
462Paused(soundId: string)
462Played(soundId: string)
462Resumed(soundId: string)
462Stopped(soundId: string)
inherited from Instance
553Archivable: bool
619Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
619Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
486GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

History 194

Members 51

ChannelCount

TypeDefault
int0
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
This property is not browsable. It is not visible in Studio's object browser.

History 3

Tags: [ReadOnly, NotReplicated, NotBrowsable]

DidLoop

Parameters (2)
soundIdstring
numOfTimesLoopedint

History 2

EmitterSize

TypeDefault
float10
This property is deprecated. It exists only for backward compatibility, and should not be used for new work. RollOffMinDistance should be used instead.

History 10

Tags: [Deprecated]

Ended

Parameters (1)
soundIdstring

History 2

IsLoaded

TypeDefault
boolfalse
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 5

Tags: [ReadOnly, NotReplicated]

Loaded

Parameters (1)
soundIdstring

History 2

LoopRegion

TypeDefault
NumberRange0 60000

History 2

Looped

TypeDefault
boolfalse

History 5

MaxDistance

TypeDefault
float10000
This property is deprecated. It exists only for backward compatibility, and should not be used for new work. RollOffMaxDistance should be used instead.

History 10

Tags: [Deprecated]

MinDistance

TypeDefault
float10
This property is deprecated. It exists only for backward compatibility, and should not be used for new work. RollOffMinDistance should be used instead.

History 10

Tags: [Deprecated]

Pause

Parameters (0)
No parameters.
Returns (1)
null

History 3

Paused

Parameters (1)
soundIdstring

History 2

Pitch

TypeDefault
float1
This property is deprecated. It exists only for backward compatibility, and should not be used for new work. PlaybackSpeed should be used instead.

History 6

  • 553 Change PreferredDescriptor of Pitch from to PlaybackSpeed
  • 553 Change Default of Pitch from to 1
  • 486 Change ThreadSafety of Pitch from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Pitch from to ReadOnly
  • 262 Change Tags of Pitch from [] to [Deprecated]
  • 47 Add Pitch
Tags: [Deprecated]

Play

Parameters (0)
No parameters.
Returns (1)
null

History 3

PlayOnRemove

TypeDefault
boolfalse

History 4

PlaybackLoudness

TypeDefault
double0
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 5

Tags: [ReadOnly, NotReplicated]

PlaybackRegion

TypeDefault
NumberRange0 60000

History 2

PlaybackRegionsEnabled

TypeDefault
boolfalse

History 3

PlaybackSpeed

TypeDefault
float1
This property is not replicated. Its interface does not cross the network boundary.

History 6

Tags: [NotReplicated]

Played

Parameters (1)
soundIdstring

History 2

Playing

TypeDefault
boolfalse
This property is not replicated. Its interface does not cross the network boundary.

History 6

Tags: [NotReplicated]

Resume

Parameters (0)
No parameters.
Returns (1)
null

History 3

Resumed

Parameters (1)
soundIdstring

History 2

RollOffMaxDistance

TypeDefault
float10000
This property is not replicated. Its interface does not cross the network boundary.

History 5

Tags: [NotReplicated]

RollOffMinDistance

TypeDefault
float10
This property is not replicated. Its interface does not cross the network boundary.

History 5

Tags: [NotReplicated]

RollOffMode

TypeDefault
RollOffModeInverse

History 6

SoundGroup

TypeDefault
SoundGroup

History 6

SoundId

TypeDefault
Content

History 4

Stop

Parameters (0)
No parameters.
Returns (1)
null

History 3

Stopped

Parameters (1)
soundIdstring

History 2

TimeLength

TypeDefault
double0
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 6

Tags: [ReadOnly, NotReplicated]

TimePosition

TypeDefault
double0
This property is not replicated. Its interface does not cross the network boundary.

History 7

Tags: [NotReplicated]

Volume

TypeDefault
float0.5

History 5

isPlaying

TypeDefault
boolfalse
This property is deprecated. It exists only for backward compatibility, and should not be used for new work. should be used instead.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 5

Tags: [ReadOnly, NotReplicated, Deprecated]

pause

Parameters (0)
No parameters.
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. Pause should be used instead.

History 4

Tags: [Deprecated]

play

Parameters (0)
No parameters.
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. Play should be used instead.

History 4

Tags: [Deprecated]

stop

Parameters (0)
No parameters.
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. Stop should be used instead.

History 4

Tags: [Deprecated]

Settings