Sound
CreatorHub

Memory category	Internal

Member index 51

History		Member
553		ChannelCount: int
601		EmitterSize: float
553		IsLoaded: bool
553		IsPaused: bool
553		IsPlaying: bool
562		IsSpatial: bool
553		LoopRegion: NumberRange
553		Looped: bool
601		MaxDistance: float
601		MinDistance: float
553		Pitch: float
553		PlayOnRemove: bool
553		PlaybackLoudness: double
553		PlaybackRegion: NumberRange
582		PlaybackRegionsEnabled: bool
553		PlaybackSpeed: float
553		Playing: bool
553		PlayingReplicator: bool
562		RollOffGain: float
553		RollOffMaxDistance: float
553		RollOffMinDistance: float
553		RollOffMode: RollOffMode
553		SoundGroup: SoundGroup
553		SoundId: Content
553		TimeLength: double
553		TimePosition: double
553		TimePositionReplicator: double
553		UsageContextPermission: UsageContext
553		Volume: float
553		isPlaying: bool
601		xmlRead_MaxDistance_3: float
601		xmlRead_MinDistance_3: float
573		Pause(): null
573		Play(): null
573		Resume(): null
573		Stop(): null
573		pause(): null
573		play(): null
573		stop(): null
462		DidLoop(soundId: string, numOfTimesLooped: int)
462		Ended(soundId: string)
462		Loaded(soundId: string)
462		Paused(soundId: string)
462		Played(soundId: string)
553		PlayingUpdatedFromClient(value: bool)
553		PlayingUpdatedFromServer(value: bool)
462		Resumed(soundId: string)
462		Stopped(soundId: string)
553		TimePositionUpdatedFromClient(newPositionSeconds: double, lastLuaSetTimePosition: double)
553		TimePositionUpdatedFromServer(newPositionSeconds: double, lastLuaSetTimePosition: double)
553		playbackActionSync(action: int)
68 members inherited from Instance
553		Archivable: bool
553		Attributes: string
553		AttributesReplicate: string
553		AttributesSerialize: BinaryString
635		Capabilities: SecurityCapabilities
553		ClassName: string
553		DataCost: int
619		DefinesCapabilities: bool
553		HistoryId: UniqueId
553		Name: string
553		Parent: Instance
553		PropertyStatusStudio: PropertyStatus
553		RobloxLocked: bool
635		Sandboxed: bool
616		SourceAssetId: int64
553		Tags: BinaryString
616		UniqueId: UniqueId
553		archivable: bool
553		className: string
553		numExpectedDirectChildren: int
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
486		GetChildren(): Objects
462		GetDebugId(scopeLength: int = 4): string
486		GetDescendants(): Array
486		GetFullName(): string
462		GetPropertyChangedSignal(property: string): RBXScriptSignal
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsA(className: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
580		IsPropertyModified(name: string): bool
573		Remove(): null
576		RemoveTag(tag: string): null
580		ResetPropertyToDefault(name: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
553		children(): Objects
553		clone(): Instance
573		destroy(): null
553		findFirstChild(name: string, recursive: bool = false): Instance
553		getChildren(): Objects
462		isA(className: string): bool
553		isDescendantOf(ancestor: Instance): bool
573		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		Changed(property: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
553		childAdded(child: Instance)

History 194
Hide member changes

601 Change PreferredDescriptor of xmlRead_MinDistance_3 from to RollOffMinDistance
601 Change Tags of xmlRead_MinDistance_3 from [Hidden, NotReplicated, NotScriptable] to [Hidden, NotReplicated, NotScriptable, Deprecated]
601 Change Tags of xmlRead_MaxDistance_3 from [Hidden, NotReplicated, NotScriptable] to [Hidden, NotReplicated, NotScriptable, Deprecated]
601 Change PreferredDescriptor of xmlRead_MaxDistance_3 from to RollOffMaxDistance
601 Change Tags of MinDistance from [] to [Deprecated]
601 Change PreferredDescriptor of MinDistance from to RollOffMinDistance
601 Change Tags of MaxDistance from [] to [Deprecated]
601 Change PreferredDescriptor of MaxDistance from to RollOffMaxDistance
601 Change Tags of EmitterSize from [] to [Deprecated]
601 Change PreferredDescriptor of EmitterSize from to RollOffMinDistance
599 Change Tags of MinDistance from [Deprecated] to []
599 Change PreferredDescriptor of MinDistance from RollOffMinDistance to
599 Change Tags of MaxDistance from [Deprecated] to []
599 Change PreferredDescriptor of MaxDistance from RollOffMaxDistance to
599 Change Tags of EmitterSize from [Deprecated] to []
599 Change PreferredDescriptor of EmitterSize from RollOffMinDistance to
582 Change Tags of PlaybackRegionsEnabled from [NotBrowsable] to []
573 Change ReturnType of stop from void to null
573 Change ReturnType of play from void to null
573 Change ReturnType of pause from void to null
573 Change ReturnType of Stop from void to null
573 Change ReturnType of Resume from void to null
573 Change ReturnType of Play from void to null
573 Change ReturnType of Pause from void to null
562 Add RollOffGain
562 Add IsSpatial
553 Add playbackActionSync
553 Add TimePositionUpdatedFromServer
553 Add TimePositionUpdatedFromClient
553 Add PlayingUpdatedFromServer
553 Add PlayingUpdatedFromClient
553 Change PreferredDescriptor of stop from to Stop
553 Change PreferredDescriptor of play from to Play
553 Change PreferredDescriptor of pause from to Pause
553 Add xmlRead_MinDistance_3
553 Add xmlRead_MaxDistance_3
553 Change Default of isPlaying from to false
553 Change PreferredDescriptor of isPlaying from to IsPlaying
553 Change Category of Volume from Data to Playback
553 Change Default of Volume from to 0.5
553 Change Default of UsageContextPermission from to Default
553 Add TimePositionReplicator
553 Change Category of TimePosition from Data to Playback
553 Change Default of TimePosition from to 0
553 Change Category of TimeLength from Data to Asset
553 Change Default of TimeLength from to 0
553 Change Category of SoundId from Data to Asset
553 Change Category of SoundGroup from Data to Routing
553 Change Default of SoundGroup from to
553 Change Category of RollOffMode from Data to Emitter
553 Change Default of RollOffMode from to Inverse
553 Change Category of RollOffMinDistance from Data to Emitter
553 Change Default of RollOffMinDistance from to 10
553 Change Default of RollOffMaxDistance from to 10000
553 Change Category of RollOffMaxDistance from Data to Emitter
553 Add PlayingReplicator
553 Change Category of Playing from Data to Playback
553 Change Default of Playing from to false
553 Change Category of PlaybackSpeed from Data to Playback
553 Change Default of PlaybackSpeed from to 1
553 Change Default of PlaybackRegionsEnabled from to false
553 Change Default of PlaybackRegion from to NumberRange(0 60000 )
553 Change Default of PlaybackLoudness from to 0
553 Change Category of PlaybackLoudness from Data to Playback
553 Change Default of PlayOnRemove from to false
553 Change PreferredDescriptor of Pitch from to PlaybackSpeed
553 Change Default of Pitch from to 1
553 Change PreferredDescriptor of MinDistance from to RollOffMinDistance
553 Change Default of MinDistance from to 10
553 Change PreferredDescriptor of MaxDistance from to RollOffMaxDistance
553 Change Default of MaxDistance from to 10000
553 Change Category of Looped from Data to Playback
553 Change Default of Looped from to false
553 Change Default of LoopRegion from to NumberRange(0 60000 )
553 Change Tags of IsPlaying from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
553 Change Default of IsPlaying from to false
553 Change Category of IsPlaying from Data to Playback
553 Change Category of IsPaused from Data to Playback
553 Change Tags of IsPaused from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
553 Change Default of IsPaused from to true
553 Change Category of IsLoaded from Data to Asset
553 Change Default of IsLoaded from to false
553 Change PreferredDescriptor of EmitterSize from to RollOffMinDistance
553 Change Default of EmitterSize from to 10
553 Change Category of ChannelCount from Data to Asset
553 Change Default of ChannelCount from to 0
549 Add PlaybackRegionsEnabled
549 Add PlaybackRegion
549 Add LoopRegion
516 Add UsageContextPermission
491 Add ChannelCount
486 Change ThreadSafety of isPlaying from ReadOnly to ReadSafe
486 Change ThreadSafety of Volume from ReadOnly to ReadSafe
486 Change ThreadSafety of TimePosition from ReadOnly to ReadSafe
486 Change ThreadSafety of TimeLength from ReadOnly to ReadSafe
486 Change ThreadSafety of SoundId from ReadOnly to ReadSafe
486 Change ThreadSafety of SoundGroup from ReadOnly to ReadSafe
486 Change ThreadSafety of RollOffMode from ReadOnly to ReadSafe
486 Change ThreadSafety of RollOffMinDistance from ReadOnly to ReadSafe
486 Change ThreadSafety of RollOffMaxDistance from ReadOnly to ReadSafe
486 Change ThreadSafety of Playing from ReadOnly to ReadSafe
486 Change ThreadSafety of PlaybackSpeed from ReadOnly to ReadSafe
486 Change ThreadSafety of PlaybackLoudness from ReadOnly to ReadSafe
486 Change ThreadSafety of PlayOnRemove from ReadOnly to ReadSafe
486 Change ThreadSafety of Pitch from ReadOnly to ReadSafe
486 Change ThreadSafety of MinDistance from ReadOnly to ReadSafe
486 Change ThreadSafety of MaxDistance from ReadOnly to ReadSafe
486 Change ThreadSafety of Looped from ReadOnly to ReadSafe
486 Change ThreadSafety of IsPlaying from ReadOnly to ReadSafe
486 Change ThreadSafety of IsPaused from ReadOnly to ReadSafe
486 Change ThreadSafety of IsLoaded from ReadOnly to ReadSafe
486 Change ThreadSafety of EmitterSize from ReadOnly to ReadSafe
462 Change ThreadSafety of Stopped from to Unsafe
462 Change ThreadSafety of Resumed from to Unsafe
462 Change ThreadSafety of Played from to Unsafe
462 Change ThreadSafety of Paused from to Unsafe
462 Change ThreadSafety of Loaded from to Unsafe
462 Change ThreadSafety of Ended from to Unsafe
462 Change ThreadSafety of DidLoop from to Unsafe
462 Change ThreadSafety of stop from to Unsafe
462 Change ThreadSafety of play from to Unsafe
462 Change ThreadSafety of pause from to Unsafe
462 Change ThreadSafety of Stop from to Unsafe
462 Change ThreadSafety of Resume from to Unsafe
462 Change ThreadSafety of Play from to Unsafe
462 Change ThreadSafety of Pause from to Unsafe
462 Change ThreadSafety of isPlaying from to ReadOnly
462 Change ThreadSafety of Volume from to ReadOnly
462 Change ThreadSafety of TimePosition from to ReadOnly
462 Change ThreadSafety of TimeLength from to ReadOnly
462 Change ThreadSafety of SoundId from to ReadOnly
462 Change ThreadSafety of SoundGroup from to ReadOnly
462 Change ThreadSafety of RollOffMode from to ReadOnly
462 Change ThreadSafety of RollOffMinDistance from to ReadOnly
462 Change ThreadSafety of RollOffMaxDistance from to ReadOnly
462 Change ThreadSafety of Playing from to ReadOnly
462 Change ThreadSafety of PlaybackSpeed from to ReadOnly
462 Change ThreadSafety of PlaybackLoudness from to ReadOnly
462 Change ThreadSafety of PlayOnRemove from to ReadOnly
462 Change ThreadSafety of Pitch from to ReadOnly
462 Change ThreadSafety of MinDistance from to ReadOnly
462 Change ThreadSafety of MaxDistance from to ReadOnly
462 Change ThreadSafety of Looped from to ReadOnly
462 Change ThreadSafety of IsPlaying from to ReadOnly
462 Change ThreadSafety of IsPaused from to ReadOnly
462 Change ThreadSafety of IsLoaded from to ReadOnly
462 Change ThreadSafety of EmitterSize from to ReadOnly
456 Add RollOffMinDistance
456 Add RollOffMaxDistance
456 Change Tags of MaxDistance from [] to [Deprecated]
456 Change Tags of EmitterSize from [] to [Deprecated]
417 Change Tags of TimePosition from [] to [NotReplicated]
417 Change Tags of Playing from [] to [NotReplicated]
389 Change Tags of PlaybackSpeed from [] to [NotReplicated]
329 Change ValueType of SoundGroup from Object to SoundGroup
266 Change Tags of RollOffMode from [Hidden] to []
264 Add SoundGroup
264 Add PlaybackLoudness
262 Add PlaybackSpeed
262 Change Tags of Pitch from [] to [Deprecated]
262 Change Tags of MinDistance from [] to [Deprecated]
262 Add EmitterSize
249 Add Resumed
249 Add Loaded
249 Add RollOffMode
249 Add Playing
249 Add IsLoaded
220 Add MinDistance
220 Add MaxDistance
204 Add Ended
182 Add Resume
179 Add Stopped
179 Add Played
179 Add Paused
179 Add DidLoop
178 Change ValueType of TimePosition from int to double
178 Change ValueType of TimeLength from int to double
176 Add TimePosition
176 Add TimeLength
50 Add pause
50 Add isPlaying
49 Add stop
47 Add play
47 Add Stop
47 Add Play
47 Add Pause
47 Add Volume
47 Add SoundId
47 Add PlayOnRemove
47 Add Pitch
47 Add Looped
47 Add IsPlaying
47 Add IsPaused
47 Add Sound

Members 51

ChannelCount
CreatorHub

Type		Default
int		0

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

It is not visible in Studio's object browser.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Asset
Loaded/Saved	false

History 3

553 Change Category of ChannelCount from Data to Asset
553 Change Default of ChannelCount from to 0
491 Add ChannelCount

Tags: [ReadOnly, NotReplicated, NotBrowsable]

DidLoop
CreatorHub

Parameters (2)
soundId	string
numOfTimesLooped	int

Thread safety	Unsafe

History 2

462 Change ThreadSafety of DidLoop from to Unsafe
179 Add DidLoop

EmitterSize
CreatorHub

Type		Default
float		10

It exists only for backward compatibility, and should not be used for new work. RollOffMinDistance should be used instead.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 10

601 Change Tags of EmitterSize from [] to [Deprecated]
601 Change PreferredDescriptor of EmitterSize from to RollOffMinDistance
599 Change Tags of EmitterSize from [Deprecated] to []
599 Change PreferredDescriptor of EmitterSize from RollOffMinDistance to
553 Change PreferredDescriptor of EmitterSize from to RollOffMinDistance
553 Change Default of EmitterSize from to 10
486 Change ThreadSafety of EmitterSize from ReadOnly to ReadSafe
462 Change ThreadSafety of EmitterSize from to ReadOnly
456 Change Tags of EmitterSize from [] to [Deprecated]
262 Add EmitterSize

Tags: [Deprecated]

Ended
CreatorHub

Parameters (1)
soundId	string

Thread safety	Unsafe

History 2

462 Change ThreadSafety of Ended from to Unsafe
204 Add Ended

IsLoaded
CreatorHub

Type		Default
bool		false

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Thread safety	ReadSafe
Category	Asset
Loaded/Saved	false

History 5

553 Change Category of IsLoaded from Data to Asset
553 Change Default of IsLoaded from to false
486 Change ThreadSafety of IsLoaded from ReadOnly to ReadSafe
462 Change ThreadSafety of IsLoaded from to ReadOnly
249 Add IsLoaded

Tags: [ReadOnly, NotReplicated]

IsPaused
CreatorHub

Type		Default
bool		true

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Playback
Loaded/Saved	false

History 6

553 Change Category of IsPaused from Data to Playback
553 Change Tags of IsPaused from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
553 Change Default of IsPaused from to true
486 Change ThreadSafety of IsPaused from ReadOnly to ReadSafe
462 Change ThreadSafety of IsPaused from to ReadOnly
47 Add IsPaused

Tags: [Hidden, ReadOnly, NotReplicated]

IsPlaying
CreatorHub

Type		Default
bool		false

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Playback
Loaded/Saved	false

History 6

553 Change Tags of IsPlaying from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
553 Change Default of IsPlaying from to false
553 Change Category of IsPlaying from Data to Playback
486 Change ThreadSafety of IsPlaying from ReadOnly to ReadSafe
462 Change ThreadSafety of IsPlaying from to ReadOnly
47 Add IsPlaying

Tags: [Hidden, ReadOnly, NotReplicated]

IsSpatial
CreatorHub

Type		Default
bool		false

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

It is not meant to be used, and may have unresolved issues.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	false

History 1

562 Add IsSpatial

Tags: [Hidden, ReadOnly, NotReplicated]

Loaded
CreatorHub

Parameters (1)
soundId	string

Thread safety	Unsafe

History 2

462 Change ThreadSafety of Loaded from to Unsafe
249 Add Loaded

LoopRegion
CreatorHub

Type		Default
NumberRange		0 60000

Thread safety	ReadSafe
Category	Regions
Loaded/Saved	true

History 2

553 Change Default of LoopRegion from to NumberRange(0 60000 )
549 Add LoopRegion

Looped
CreatorHub

Type		Default
bool		false

Thread safety	ReadSafe
Category	Playback
Loaded/Saved	true

History 5

553 Change Category of Looped from Data to Playback
553 Change Default of Looped from to false
486 Change ThreadSafety of Looped from ReadOnly to ReadSafe
462 Change ThreadSafety of Looped from to ReadOnly
47 Add Looped

MaxDistance
CreatorHub

Type		Default
float		10000

It exists only for backward compatibility, and should not be used for new work. RollOffMaxDistance should be used instead.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 10

601 Change Tags of MaxDistance from [] to [Deprecated]
601 Change PreferredDescriptor of MaxDistance from to RollOffMaxDistance
599 Change Tags of MaxDistance from [Deprecated] to []
599 Change PreferredDescriptor of MaxDistance from RollOffMaxDistance to
553 Change PreferredDescriptor of MaxDistance from to RollOffMaxDistance
553 Change Default of MaxDistance from to 10000
486 Change ThreadSafety of MaxDistance from ReadOnly to ReadSafe
462 Change ThreadSafety of MaxDistance from to ReadOnly
456 Change Tags of MaxDistance from [] to [Deprecated]
220 Add MaxDistance

Tags: [Deprecated]

MinDistance
CreatorHub

Type		Default
float		10

It exists only for backward compatibility, and should not be used for new work. RollOffMinDistance should be used instead.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true/false

History 10

601 Change Tags of MinDistance from [] to [Deprecated]
601 Change PreferredDescriptor of MinDistance from to RollOffMinDistance
599 Change Tags of MinDistance from [Deprecated] to []
599 Change PreferredDescriptor of MinDistance from RollOffMinDistance to
553 Change PreferredDescriptor of MinDistance from to RollOffMinDistance
553 Change Default of MinDistance from to 10
486 Change ThreadSafety of MinDistance from ReadOnly to ReadSafe
462 Change ThreadSafety of MinDistance from to ReadOnly
262 Change Tags of MinDistance from [] to [Deprecated]
220 Add MinDistance

Tags: [Deprecated]

Pause
CreatorHub

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

Thread safety	Unsafe

History 3

573 Change ReturnType of Pause from void to null
462 Change ThreadSafety of Pause from to Unsafe
47 Add Pause

Paused
CreatorHub

Parameters (1)
soundId	string

Thread safety	Unsafe

History 2

462 Change ThreadSafety of Paused from to Unsafe
179 Add Paused

Pitch
CreatorHub

Type		Default
float		1

It exists only for backward compatibility, and should not be used for new work. PlaybackSpeed should be used instead.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true/false

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
CreatorHub

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

Thread safety	Unsafe

History 3

573 Change ReturnType of Play from void to null
462 Change ThreadSafety of Play from to Unsafe
47 Add Play

PlayOnRemove
CreatorHub

Type		Default
bool		false

Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	true

History 4

553 Change Default of PlayOnRemove from to false
486 Change ThreadSafety of PlayOnRemove from ReadOnly to ReadSafe
462 Change ThreadSafety of PlayOnRemove from to ReadOnly
47 Add PlayOnRemove

PlaybackLoudness
CreatorHub

Type		Default
double		0

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Thread safety	ReadSafe
Category	Playback
Loaded/Saved	false

History 5

553 Change Default of PlaybackLoudness from to 0
553 Change Category of PlaybackLoudness from Data to Playback
486 Change ThreadSafety of PlaybackLoudness from ReadOnly to ReadSafe
462 Change ThreadSafety of PlaybackLoudness from to ReadOnly
264 Add PlaybackLoudness

Tags: [ReadOnly, NotReplicated]

PlaybackRegion
CreatorHub

Type		Default
NumberRange		0 60000

Thread safety	ReadSafe
Category	Regions
Loaded/Saved	true

History 2

553 Change Default of PlaybackRegion from to NumberRange(0 60000 )
549 Add PlaybackRegion

PlaybackRegionsEnabled
CreatorHub

Type		Default
bool		false

Thread safety	ReadSafe
Category	Playback
Loaded/Saved	true

History 3

582 Change Tags of PlaybackRegionsEnabled from [NotBrowsable] to []
553 Change Default of PlaybackRegionsEnabled from to false
549 Add PlaybackRegionsEnabled

PlaybackSpeed
CreatorHub

Type		Default
float		1

Its interface does not cross the network boundary.

Thread safety	ReadSafe
Category	Playback
Loaded/Saved	true

History 6

553 Change Category of PlaybackSpeed from Data to Playback
553 Change Default of PlaybackSpeed from to 1
486 Change ThreadSafety of PlaybackSpeed from ReadOnly to ReadSafe
462 Change ThreadSafety of PlaybackSpeed from to ReadOnly
389 Change Tags of PlaybackSpeed from [] to [NotReplicated]
262 Add PlaybackSpeed

Tags: [NotReplicated]

Played
CreatorHub

Parameters (1)
soundId	string

Thread safety	Unsafe

History 2

462 Change ThreadSafety of Played from to Unsafe
179 Add Played

Playing
CreatorHub

Type		Default
bool		false

Its interface does not cross the network boundary.

Thread safety	ReadSafe
Category	Playback
Loaded/Saved	true

History 6

553 Change Category of Playing from Data to Playback
553 Change Default of Playing from to false
486 Change ThreadSafety of Playing from ReadOnly to ReadSafe
462 Change ThreadSafety of Playing from to ReadOnly
417 Change Tags of Playing from [] to [NotReplicated]
249 Add Playing

Tags: [NotReplicated]

PlayingReplicator
CreatorHub

Type		Default
bool		false

It cannot be accessed by script code.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 1

553 Add PlayingReplicator

Tags: [Hidden, NotScriptable]

PlayingUpdatedFromClient
CreatorHub

Parameters (1)
value	bool

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

553 Add PlayingUpdatedFromClient

Tags: [Hidden]

PlayingUpdatedFromServer
CreatorHub

Parameters (1)
value	bool

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

553 Add PlayingUpdatedFromServer

Tags: [Hidden]

Resume
CreatorHub

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

Thread safety	Unsafe

History 3

573 Change ReturnType of Resume from void to null
462 Change ThreadSafety of Resume from to Unsafe
182 Add Resume

Resumed
CreatorHub

Parameters (1)
soundId	string

Thread safety	Unsafe

History 2

462 Change ThreadSafety of Resumed from to Unsafe
249 Add Resumed

RollOffGain
CreatorHub

Type		Default
float		1

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

It is not meant to be used, and may have unresolved issues.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Playback
Loaded/Saved	false

History 1

562 Add RollOffGain

Tags: [Hidden, ReadOnly, NotReplicated]

RollOffMaxDistance
CreatorHub

Type		Default
float		10000

Its interface does not cross the network boundary.

Thread safety	ReadSafe
Category	Emitter
Loaded/Saved	false

History 5

553 Change Default of RollOffMaxDistance from to 10000
553 Change Category of RollOffMaxDistance from Data to Emitter
486 Change ThreadSafety of RollOffMaxDistance from ReadOnly to ReadSafe
462 Change ThreadSafety of RollOffMaxDistance from to ReadOnly
456 Add RollOffMaxDistance

Tags: [NotReplicated]

RollOffMinDistance
CreatorHub

Type		Default
float		10

Its interface does not cross the network boundary.

Thread safety	ReadSafe
Category	Emitter
Loaded/Saved	false

History 5

553 Change Category of RollOffMinDistance from Data to Emitter
553 Change Default of RollOffMinDistance from to 10
486 Change ThreadSafety of RollOffMinDistance from ReadOnly to ReadSafe
462 Change ThreadSafety of RollOffMinDistance from to ReadOnly
456 Add RollOffMinDistance

Tags: [NotReplicated]

RollOffMode
CreatorHub

Type		Default
RollOffMode		Inverse

Thread safety	ReadSafe
Category	Emitter
Loaded/Saved	true

History 6

553 Change Category of RollOffMode from Data to Emitter
553 Change Default of RollOffMode from to Inverse
486 Change ThreadSafety of RollOffMode from ReadOnly to ReadSafe
462 Change ThreadSafety of RollOffMode from to ReadOnly
266 Change Tags of RollOffMode from [Hidden] to []
249 Add RollOffMode

SoundGroup
CreatorHub

Type		Default
SoundGroup

Thread safety	ReadSafe
Category	Routing
Loaded/Saved	true

History 6

553 Change Category of SoundGroup from Data to Routing
553 Change Default of SoundGroup from to
486 Change ThreadSafety of SoundGroup from ReadOnly to ReadSafe
462 Change ThreadSafety of SoundGroup from to ReadOnly
329 Change ValueType of SoundGroup from Object to SoundGroup
264 Add SoundGroup

SoundId
CreatorHub

Type		Default
Content

Thread safety	ReadSafe
Category	Asset
Loaded/Saved	true

History 4

553 Change Category of SoundId from Data to Asset
486 Change ThreadSafety of SoundId from ReadOnly to ReadSafe
462 Change ThreadSafety of SoundId from to ReadOnly
47 Add SoundId

Stop
CreatorHub

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

Thread safety	Unsafe

History 3

573 Change ReturnType of Stop from void to null
462 Change ThreadSafety of Stop from to Unsafe
47 Add Stop

Stopped
CreatorHub

Parameters (1)
soundId	string

Thread safety	Unsafe

History 2

462 Change ThreadSafety of Stopped from to Unsafe
179 Add Stopped

TimeLength
CreatorHub

Type		Default
double		0

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Thread safety	ReadSafe
Category	Asset
Loaded/Saved	false

History 6

553 Change Category of TimeLength from Data to Asset
553 Change Default of TimeLength from to 0
486 Change ThreadSafety of TimeLength from ReadOnly to ReadSafe
462 Change ThreadSafety of TimeLength from to ReadOnly
178 Change ValueType of TimeLength from int to double
176 Add TimeLength

Tags: [ReadOnly, NotReplicated]

TimePosition
CreatorHub

Type		Default
double		0

Its interface does not cross the network boundary.

Thread safety	ReadSafe
Category	Playback
Loaded/Saved	true

History 7

553 Change Category of TimePosition from Data to Playback
553 Change Default of TimePosition from to 0
486 Change ThreadSafety of TimePosition from ReadOnly to ReadSafe
462 Change ThreadSafety of TimePosition from to ReadOnly
417 Change Tags of TimePosition from [] to [NotReplicated]
178 Change ValueType of TimePosition from int to double
176 Add TimePosition

Tags: [NotReplicated]

TimePositionReplicator
CreatorHub

Type		Default
double		0

It cannot be accessed by script code.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 1

553 Add TimePositionReplicator

Tags: [Hidden, NotScriptable]

TimePositionUpdatedFromClient
CreatorHub

Parameters (2)
newPositionSeconds	double
lastLuaSetTimePosition	double

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

553 Add TimePositionUpdatedFromClient

Tags: [Hidden]

TimePositionUpdatedFromServer
CreatorHub

Parameters (2)
newPositionSeconds	double
lastLuaSetTimePosition	double

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

553 Add TimePositionUpdatedFromServer

Tags: [Hidden]

UsageContextPermission
CreatorHub

Type		Default
UsageContext		Default

Its interface does not cross the network boundary.

It is not meant to be used, and may have unresolved issues.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	false

History 2

553 Change Default of UsageContextPermission from to Default
516 Add UsageContextPermission

Tags: [Hidden, NotReplicated]

Volume
CreatorHub

Type		Default
float		0.5

Thread safety	ReadSafe
Category	Playback
Loaded/Saved	true

History 5

553 Change Category of Volume from Data to Playback
553 Change Default of Volume from to 0.5
486 Change ThreadSafety of Volume from ReadOnly to ReadSafe
462 Change ThreadSafety of Volume from to ReadOnly
47 Add Volume

isPlaying
CreatorHub

Type		Default
bool		false

It exists only for backward compatibility, and should not be used for new work. should be used instead.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 5

553 Change Default of isPlaying from to false
553 Change PreferredDescriptor of isPlaying from to IsPlaying
486 Change ThreadSafety of isPlaying from ReadOnly to ReadSafe
462 Change ThreadSafety of isPlaying from to ReadOnly
50 Add isPlaying

Tags: [ReadOnly, NotReplicated, Deprecated]

pause
CreatorHub

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

It exists only for backward compatibility, and should not be used for new work. Pause should be used instead.

Thread safety	Unsafe

History 4

573 Change ReturnType of pause from void to null
553 Change PreferredDescriptor of pause from to Pause
462 Change ThreadSafety of pause from to Unsafe
50 Add pause

Tags: [Deprecated]

play
CreatorHub

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

It exists only for backward compatibility, and should not be used for new work. Play should be used instead.

Thread safety	Unsafe

History 4

573 Change ReturnType of play from void to null
553 Change PreferredDescriptor of play from to Play
462 Change ThreadSafety of play from to Unsafe
47 Add play

Tags: [Deprecated]

playbackActionSync
CreatorHub

Parameters (1)
action	int

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

553 Add playbackActionSync

Tags: [Hidden]

stop
CreatorHub

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

It exists only for backward compatibility, and should not be used for new work. Stop should be used instead.

Thread safety	Unsafe

History 4

573 Change ReturnType of stop from void to null
553 Change PreferredDescriptor of stop from to Stop
462 Change ThreadSafety of stop from to Unsafe
49 Add stop

Tags: [Deprecated]

xmlRead_MaxDistance_3
CreatorHub

Type		Default
float		10000

It exists only for backward compatibility, and should not be used for new work. RollOffMaxDistance should be used instead.

It cannot be accessed by script code.

Its interface does not cross the network boundary.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 3

601 Change Tags of xmlRead_MaxDistance_3 from [Hidden, NotReplicated, NotScriptable] to [Hidden, NotReplicated, NotScriptable, Deprecated]
601 Change PreferredDescriptor of xmlRead_MaxDistance_3 from to RollOffMaxDistance
553 Add xmlRead_MaxDistance_3

Tags: [Hidden, NotReplicated, NotScriptable, Deprecated]

xmlRead_MinDistance_3
CreatorHub

Type		Default
float		10

It exists only for backward compatibility, and should not be used for new work. RollOffMinDistance should be used instead.

It cannot be accessed by script code.

Its interface does not cross the network boundary.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true/false

History 3

601 Change PreferredDescriptor of xmlRead_MinDistance_3 from to RollOffMinDistance
601 Change Tags of xmlRead_MinDistance_3 from [Hidden, NotReplicated, NotScriptable] to [Hidden, NotReplicated, NotScriptable, Deprecated]
553 Add xmlRead_MinDistance_3

Tags: [Hidden, NotReplicated, NotScriptable, Deprecated]

Engine API

Website

Related

History 3

History 2

History 10

History 2

History 5

History 6

History 6

History 1

History 2

History 2

History 5

History 10

History 10

History 3

History 2

History 6

History 3

History 4

History 5

History 2

History 3

History 6

History 2

History 6

History 1

History 1

History 1

History 3

History 2

History 1

History 5

History 5

History 6

History 6

History 4

History 3

History 2

History 6

History 7

History 1

History 1

History 1

History 2

History 5

History 5

History 4

History 4

History 1

History 4

History 3

History 3