Show everything

Miscellaneous Types

math
Action Page
Animation
EntityNameplateCustomization NameplateCustomization NameplateCustomizationGroup
Biome BlockState ItemStack
VanillaModelGroup VanillaModelPart VanillaPart
BlockTask ItemTask RenderTask SpriteTask TextTask Vertex
LivingEntityAPI ViewerAPI
Event
Keybind
Vector2 Vector3 Vector4
Matrix2 Matrix3 Matrix4
Particle
Sound
PingFunction
Texture TextureAtlas
Made by applejuice

sounds
The global instance of SoundAPI
field signature:
sounds
Method Property Fluent Description Representation
Field Type a SoundAPI

SoundAPI.isPresent
Checks if this sound id is registered either by custom avatar sounds or a vanilla sound
overload 1:
sounds:isPresent(id)
Method Property Fluent Description Representation
id accepts a String
Return Value a Boolean

SoundAPI.stopSound
Stops the playing sounds from this avatar
If an id is specified, it only stops the sounds from that id
overload 1:
sounds:stopSound()
Method Property Fluent Description Representation
Return Value a SoundAPI
overload 2:
sounds:stopSound(id)
Method Property Fluent Description Representation
id accepts a String
Return Value a SoundAPI

SoundAPI.newSound
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:
sounds:newSound(name, byteArray)
Method Property Fluent Description Representation
name accepts a String
byteArray accepts a table
Return Value a SoundAPI
overload 2:
sounds:newSound(name, base64Text)
Method Property Fluent Description Representation
name accepts a String
base64Text accepts a String
Return Value a SoundAPI

SoundAPI.playSound
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:
sounds:playSound(sound, pos)
Method Property Fluent Description Representation
sound accepts a String
pos accepts a Vector3
Return Value a Sound
overload 2:
sounds:playSound(sound, posX, posY, posZ)
Method Property Fluent Description Representation
sound accepts a String
posX accepts a Number
posY accepts a Number
posZ accepts a Number
Return Value a Sound
overload 3:
sounds:playSound(sound, pos, volume, pitch, loop)
Method Property Fluent Description Representation
sound accepts a String
pos accepts a Vector3
volume accepts a Number
pitch accepts a Number
loop accepts a Boolean
Return Value a Sound
overload 4:
sounds:playSound(sound, posX, posY, posZ, volume, pitch, loop)
Method Property Fluent Description Representation
sound accepts a String
posX accepts a Number
posY accepts a Number
posZ accepts a Number
volume accepts a Number
pitch accepts a Number
loop accepts a Boolean
Return Value a Sound

SoundAPI.getCustomSounds
Returns a table with all registered custom sounds ids
overload 1:
sounds:getCustomSounds()
Method Property Fluent Description Representation
Return Value
a a