Show everything

Miscellaneous Types

math
Action Page
Animation
EntityNameplateCustomization NameplateCustomization NameplateCustomizationGroup
Biome BlockState ItemStack
VanillaModelGroup VanillaModelPart VanillaPart
BlockTask EntityTask ItemTask RenderTask SpriteTask TextTask Vertex
LivingEntityAPI ViewerAPI
Event
Keybind
Vector2 Vector3 Vector4
Matrix2 Matrix3 Matrix4
Particle
Sound
PingFunction
Texture TextureAtlas
Buffer Future InputStream OutputStream
JsonArray JsonBuilder JsonObject JsonSerializer
HttpAPI HttpRequestBuilder HttpResponse Socket SocketAPI
Made by applejuice

AvatarAPI
A global API containing functions to interact with your avatar's metadata, and also to get information about the current script environment

AvatarAPI.getName
Gets the name string of this avatar
overload 1:
avatar:getName()
Method Property Fluent Description Representation
Return Value a String

AvatarAPI.store
Store the given key-value pair inside your current avatar's metadata
Someone else can get this information from a different script with the avatarVars() function in World
The key must be a string
overload 1:
avatar:store(key, value)
Method Property Fluent Description Representation
key accepts a String
value accepts anything
Return Value an AvatarAPI

AvatarAPI.getSize
Gets the file size of this avatar in bytes
overload 1:
avatar:getSize()
Method Property Fluent Description Representation
Return Value a Number

AvatarAPI.getVersion
Gets the version string of this avatar
overload 1:
avatar:getVersion()
Method Property Fluent Description Representation
Return Value a String

AvatarAPI.setColor
Sets the current color string of your avatar, used as your avatar theme, if the user has a special badge, they can pass in the badge's name to set the color for it.
overload 1:
avatar:setColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an AvatarAPI
overload 2:
avatar:setColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an AvatarAPI
overload 3:
avatar:setColor(color, badgeName)
Method Property Fluent Description Representation
color accepts a Vector3
badgeName accepts a String
Return Value an AvatarAPI
overload 4:
avatar:setColor(r, g, b, badgeName)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
badgeName accepts a String
Return Value an AvatarAPI

AvatarAPI.getEntityName
Attempts to get the entity name of this avatar, defaulting to the avatar name
overload 1:
avatar:getEntityName()
Method Property Fluent Description Representation
Return Value a String

AvatarAPI.getAuthors
Gets the authors string of this avatar
overload 1:
avatar:getAuthors()
Method Property Fluent Description Representation
Return Value a String

AvatarAPI.getInitCount
Gets the number of initialization instructions of this avatar
overload 1:
avatar:getInitCount()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getMaxInitCount
Gets the maximum allowed instructions during initialization as permitted by the viewer
overload 1:
avatar:getMaxInitCount()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getTickCount
Gets the number of events.TICK instructions of this avatar last tick
overload 1:
avatar:getTickCount()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getNBT
Gets the NBT data this avatar is stored as
overload 1:
avatar:getNBT()
Method Property Fluent Description Representation
Return Value a table

AvatarAPI.hasTexture
Gets whether or not this avatar has a texture
overload 1:
avatar:hasTexture()
Method Property Fluent Description Representation
Return Value a Boolean

AvatarAPI.hasScriptError
Gets whether this script currently has stopped due to an error (kinda useless lol)
overload 1:
avatar:hasScriptError()
Method Property Fluent Description Representation
Return Value a Boolean

AvatarAPI.getEntityInitCount
Gets the number of events.ENTITY_INIT instructions of this avatar
overload 1:
avatar:getEntityInitCount()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getMaxComplexity
Gets the maximum allowed model complexity (number of faces) as permitted by the viewer
overload 1:
avatar:getMaxComplexity()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getMaxParticles
Gets the maximum allowed number of particles as permitted by the viewer
overload 1:
avatar:getMaxParticles()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getWorldTickCount
Gets the number of events.WORLD_TICK instructions of this avatar's last tick
overload 1:
avatar:getWorldTickCount()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getRemainingSounds
Gets the remaining amount of sound this avatar can play
overload 1:
avatar:getRemainingSounds()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getMaxSounds
Gets the maximum allowed number of sounds as permitted by the viewer
overload 1:
avatar:getMaxSounds()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getMaxTickCount
Gets the maximum allowed instructions in events.TICK as permitted by the viewer
overload 1:
avatar:getMaxTickCount()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getRenderCount
Gets the number of events.RENDER and events.POST_RENDER instructions of this avatar's last frame
overload 1:
avatar:getRenderCount()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getAnimationCount
Gets the number of Lua instructions used within animations
overload 1:
avatar:getAnimationCount()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getMaxRenderCount
Gets the maximum allowed instructions in events.RENDER and Events.POST_RENDER as permitted by the viewer
overload 1:
avatar:getMaxRenderCount()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.canUseCustomSounds
Gets whether or not the viewer allows your avatar to play custom sounds
overload 1:
avatar:canUseCustomSounds()
Method Property Fluent Description Representation
Return Value a Boolean

AvatarAPI.canHaveCustomSkull
Gets whether or not your avatar is allowed to have custom player skull
overload 1:
avatar:canHaveCustomSkull()
Method Property Fluent Description Representation
Return Value a Boolean

AvatarAPI.getBuffersCount
Returns count of buffers open by this avatar
overload 1:
avatar:getBuffersCount()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getSocketsCount
Returns count of sockets open by this avatar
overload 1:
avatar:getSocketsCount()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getMaxTextureSize
Gets the max dimensions of custom textures that this avatar can create
overload 1:
avatar:getMaxTextureSize()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.canEditNameplate
Gets whether or not the viewer allows your avatar to edit your nameplate
overload 1:
avatar:canEditNameplate()
Method Property Fluent Description Representation
Return Value a Boolean

AvatarAPI.getMaxBufferSize
Gets the max byte buffer size that this avatar can have
overload 1:
avatar:getMaxBufferSize()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getMaxBuffersCount
Returns maximum allowed count of buffers can be open by this avatar
overload 1:
avatar:getMaxBuffersCount()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getMaxSocketsCount
Returns maximum allowed count of sockets can be open by this avatar
overload 1:
avatar:getMaxSocketsCount()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.canRenderOffscreen
Gets whether or not the viewer allows you to render the avatar off-screen
overload 1:
avatar:canRenderOffscreen()
Method Property Fluent Description Representation
Return Value a Boolean

AvatarAPI.getMaxWorldRenderCount
Gets the maximum allowed instructions in events.WORLD_RENDER and events.POST_WORLD_RENDER as permitted by the viewer
overload 1:
avatar:getMaxWorldRenderCount()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getCurrentInstructions
Gets the current number of instructions that have been executed by your avatar
Resets to 0 at the beginning of certain events
overload 1:
avatar:getCurrentInstructions()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getRemainingParticles
Gets the remaining amount of particles this avatar can summon
overload 1:
avatar:getRemainingParticles()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getAnimationComplexity
Gets the current animation complexity of this avatar
overload 1:
avatar:getAnimationComplexity()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getMaxAnimationCount
Gets the maximum allowed Lua instructions in animations as permitted by the viewer
overload 1:
avatar:getMaxAnimationCount()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getWorldRenderCount
Gets the number of events.WORLD_RENDER and events.POST_WORLD_RENDER instructions of this avatar's last frame
overload 1:
avatar:getWorldRenderCount()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.canEditVanillaModel
Gets whether or not the viewer allows your avatar to edit the vanilla models
overload 1:
avatar:canEditVanillaModel()
Method Property Fluent Description Representation
Return Value a Boolean

AvatarAPI.getMaxWorldTickCount
Gets the maximum allowed instructions in events.WORLD_TICK as permitted by the viewer
overload 1:
avatar:getMaxWorldTickCount()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getMaxAnimationComplexity
Gets the maximum allowed animation complexity (number of playing channels) as permitted by the viewer
overload 1:
avatar:getMaxAnimationComplexity()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getUUID
Returns the UUID of the owner of this avatar
overload 1:
avatar:getUUID()
Method Property Fluent Description Representation
Return Value a String

AvatarAPI.getComplexity
Gets the current complexity of this avatar
overload 1:
avatar:getComplexity()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getPermissionLevel
Returns this avatar's current permission level
overload 1:
avatar:getPermissionLevel()
Method Property Fluent Description Representation
Return Value a String

AvatarAPI.getVolume
figura.docs.avatar.get_volume
overload 1:
avatar:getVolume()
Method Property Fluent Description Representation
Return Value an Integer

AvatarAPI.getBadges
Gets the user's badges in a string.
overload 1:
avatar:getBadges()
Method Property Fluent Description Representation
Return Value a String

AvatarAPI.getColor
Gets the current color string of your avatar, used as your avatar theme
overload 1:
avatar:getColor()
Method Property Fluent Description Representation
Return Value a String

AvatarAPI.color
Sets the current color string of your avatar, used as your avatar theme, if the user has a special badge, they can pass in the badge's name to set the color for it.
overload 1:
avatar:color(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an AvatarAPI
overload 2:
avatar:color(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an AvatarAPI
overload 3:
avatar:color(color, badgeName)
Method Property Fluent Description Representation
color accepts a Vector3
badgeName accepts a String
Return Value an AvatarAPI
overload 4:
avatar:color(r, g, b, badgeName)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
badgeName accepts a String
Return Value an AvatarAPI

AvatarAPI.badges
Gets the user's badges in a string.
overload 1:
avatar:badges()
Method Property Fluent Description Representation
Return Value a String
a a