listFiles
action_wheel
Action
BlockRaycastTypes A global API which is used to play Minecraft sounds
Accessed using the name "sounds" 
Returns a table with all registered custom sounds ids
overload 1:
SoundAPI.getCustomSounds(): java.util.Set | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1383343454
Checks if this sound id is registered either by custom avatar sounds or a vanilla sound
overload 1:
SoundAPI.isPresent(id: String): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| id accepts | typings.-1808118735||
| Return Value | typings.1729365000
Registers a new custom sound for this avatar
The first argument is the sound id while the second argument is either a byte array of the sound data or a base64 string representation of the same
overload 1:
SoundAPI.newSound(name: String, byteArray: Table): SoundAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| name accepts | typings.-1808118735||
| byteArray accepts | typings.80563118||
| Return Value | typings.1807272619
overload 2:
SoundAPI.newSound(name: String, base64Text: String): SoundAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| name accepts | typings.-1808118735||
| base64Text accepts | typings.-1808118735||
| Return Value | typings.1807272619
Plays the specified sound at the specified position with the given volume and pitch multipliers
The sound id is either an identifier or the custom sound name
Volume in Minecraft refers to how far away people can hear the sound from, not the actual loudness of it
If you don't give values for volume and pitch, the default values are 1
overload 1:
SoundAPI.playSound(sound: String, pos: Vector3): Sound | Method Property | Fluent Description | Representation |
|---|---|---|
| sound accepts | typings.-1808118735||
| pos accepts | typings.2002444080||
| Return Value | typings.80074991
overload 2:
SoundAPI.playSound(sound: String, posX: Number, posY: Number, posZ: Number): Sound | Method Property | Fluent Description | Representation |
|---|---|---|
| sound accepts | typings.-1808118735||
| posX accepts | typings.-1950496919||
| posY accepts | typings.-1950496919||
| posZ accepts | typings.-1950496919||
| Return Value | typings.80074991
overload 3:
SoundAPI.playSound(sound: String, pos: Vector3, volume: Number, pitch: Number, loop: Boolean): Sound | Method Property | Fluent Description | Representation |
|---|---|---|
| sound accepts | typings.-1808118735||
| pos accepts | typings.2002444080||
| volume accepts | typings.-1950496919||
| pitch accepts | typings.-1950496919||
| loop accepts | typings.1729365000||
| Return Value | typings.80074991
overload 4:
SoundAPI.playSound(sound: String, posX: Number, posY: Number, posZ: Number, volume: Number, pitch: Number, loop: Boolean): Sound | Method Property | Fluent Description | Representation |
|---|---|---|
| sound accepts | typings.-1808118735||
| posX accepts | typings.-1950496919||
| posY accepts | typings.-1950496919||
| posZ accepts | typings.-1950496919||
| volume accepts | typings.-1950496919||
| pitch accepts | typings.-1950496919||
| loop accepts | typings.1729365000||
| Return Value | typings.80074991
Stops the playing sounds from this avatar
If an id is specified, it only stops the sounds from that id
overload 1:
SoundAPI.stopSound(): SoundAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1807272619
overload 2:
SoundAPI.stopSound(id: String): SoundAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| id accepts | typings.-1808118735||
| Return Value | typings.1807272619