Sound

Class fields

Field	XML type	Value
`Name`	string	Sound
`ExplorerOrder`	string	1
`ExplorerImageIndex`	string	11

Properties

IsPaused

bool

Field	XML type	Value
`Name`	string	IsPaused

IsPlaying

bool

Field	XML type	Value
`Name`	string	IsPlaying

Looped

bool

Field	XML type	Value
`Name`	string	Looped

MaxDistance

float

Field	XML type	Value
`Name`	string	MaxDistance

MinDistance

float

Field	XML type	Value
`Name`	string	MinDistance

Pitch

float

Field	XML type	Value
`Name`	string	Pitch

PlayCount

int

Field	XML type	Value
`Name`	string	PlayCount

PlayOnRemove

bool

Field	XML type	Value
`Name`	string	PlayOnRemove
`summary`	string	The sound will play when it is removed from the Workspace. Looped sounds don't play

SoundId

Content

Field	XML type	Value
`Name`	string	SoundId

TimeLength

double

Field	XML type	Value
`Name`	string	TimeLength

TimePosition

double

Field	XML type	Value
`Name`	string	TimePosition

Volume

float

Field	XML type	Value
`Name`	string	Volume

isPlaying

bool

Field	XML type	Value
`Name`	string	isPlaying

Functions

Pause

() → void

Field	XML type	Value
`Name`	string	Pause

Play

() → void

Field	XML type	Value
`Name`	string	Play

Resume

() → void

Field	XML type	Value
`Name`	string	Resume

Stop

() → void

Field	XML type	Value
`Name`	string	Stop

pause

() → void

Field	XML type	Value
`Name`	string	pause

play

() → void

Field	XML type	Value
`Name`	string	play
`Deprecated`	bool	true
`summary`	string	Deprecated. Use Play() instead

stop

() → void

Field	XML type	Value
`Name`	string	stop

Events

DidLoop

(soundId: string, numOfTimesLooped: int) → void

Field	XML type	Value
`Name`	string	DidLoop

Ended

(soundId: string) → void

Field	XML type	Value
`Name`	string	Ended

Paused

(soundId: string) → void

Field	XML type	Value
`Name`	string	Paused

Played

(soundId: string) → void

Field	XML type	Value
`Name`	string	Played

SoundResumedFromServer

(currentTimePosition: int) → void

Field	XML type	Value
`Name`	string	SoundResumedFromServer

Stopped

(soundId: string) → void

Field	XML type	Value
`Name`	string	Stopped

TimePositionUpdated

(newPositionSeconds: int) → void

Field	XML type	Value
`Name`	string	TimePositionUpdated

TimePositionUpdatedFromScript

(newPositionSeconds: int) → void

Field	XML type	Value
`Name`	string	TimePositionUpdatedFromScript