listFiles
action_wheel
Action
BlockRaycastTypes A global API containing functions to interact with your avatar's metadata, and also to get information about the current script environment 
Gets the user's badges in a string.
overload 1:
AvatarAPI.badges(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Gets whether or not the viewer allows your avatar to edit your nameplate
overload 1:
AvatarAPI.canEditNameplate(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Gets whether or not the viewer allows your avatar to edit the vanilla models
overload 1:
AvatarAPI.canEditVanillaModel(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Gets whether or not your avatar is allowed to have custom player skull
overload 1:
AvatarAPI.canHaveCustomSkull(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Gets whether or not the viewer allows you to render the avatar off-screen
overload 1:
AvatarAPI.canRenderOffscreen(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Gets whether or not the viewer allows your avatar to play custom sounds
overload 1:
AvatarAPI.canUseCustomSounds(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
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:
AvatarAPI.color(color: Vector3): AvatarAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| color accepts | typings.2002444080||
| Return Value | typings.1575301601
overload 2:
AvatarAPI.color(r: Number, g: Number, b: Number): AvatarAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | typings.-1950496919||
| g accepts | typings.-1950496919||
| b accepts | typings.-1950496919||
| Return Value | typings.1575301601
overload 3:
AvatarAPI.color(color: Vector3, badgeName: String): AvatarAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| color accepts | typings.2002444080||
| badgeName accepts | typings.-1808118735||
| Return Value | typings.1575301601
overload 4:
AvatarAPI.color(r: Number, g: Number, b: Number, badgeName: String): AvatarAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | typings.-1950496919||
| g accepts | typings.-1950496919||
| b accepts | typings.-1950496919||
| badgeName accepts | typings.-1808118735||
| Return Value | typings.1575301601
Gets the current animation complexity of this avatar
overload 1:
AvatarAPI.getAnimationComplexity(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the number of Lua instructions used within animations
overload 1:
AvatarAPI.getAnimationCount(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the authors string of this avatar
overload 1:
AvatarAPI.getAuthors(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Gets the user's badges in a string.
overload 1:
AvatarAPI.getBadges(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Returns count of buffers open by this avatar
overload 1:
AvatarAPI.getBuffersCount(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the current color string of your avatar, used as your avatar theme
overload 1:
AvatarAPI.getColor(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Gets the current complexity of this avatar
overload 1:
AvatarAPI.getComplexity(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the current number of instructions that have been executed by your avatar
Resets to 0 at the beginning of certain events
overload 1:
AvatarAPI.getCurrentInstructions(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the number of events.ENTITY_INIT instructions of this avatar
overload 1:
AvatarAPI.getEntityInitCount(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Attempts to get the entity name of this avatar, defaulting to the avatar name
overload 1:
AvatarAPI.getEntityName(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Gets the number of initialization instructions of this avatar
overload 1:
AvatarAPI.getInitCount(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the maximum allowed animation complexity (number of playing channels) as permitted by the viewer
overload 1:
AvatarAPI.getMaxAnimationComplexity(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the maximum allowed Lua instructions in animations as permitted by the viewer
overload 1:
AvatarAPI.getMaxAnimationCount(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the max byte buffer size that this avatar can have
overload 1:
AvatarAPI.getMaxBufferSize(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Returns maximum allowed count of buffers can be open by this avatar
overload 1:
AvatarAPI.getMaxBuffersCount(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the maximum allowed model complexity (number of faces) as permitted by the viewer
overload 1:
AvatarAPI.getMaxComplexity(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the maximum allowed instructions during initialization as permitted by the viewer
overload 1:
AvatarAPI.getMaxInitCount(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the maximum allowed number of particles as permitted by the viewer
overload 1:
AvatarAPI.getMaxParticles(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the maximum allowed instructions in events.RENDER and Events.POST_RENDER as permitted by the viewer
overload 1:
AvatarAPI.getMaxRenderCount(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the maximum allowed number of sounds as permitted by the viewer
overload 1:
AvatarAPI.getMaxSounds(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the max dimensions of custom textures that this avatar can create
overload 1:
AvatarAPI.getMaxTextureSize(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the maximum allowed instructions in events.TICK as permitted by the viewer
overload 1:
AvatarAPI.getMaxTickCount(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the maximum allowed instructions in events.WORLD_RENDER and events.POST_WORLD_RENDER as permitted by the viewer
overload 1:
AvatarAPI.getMaxWorldRenderCount(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the maximum allowed instructions in events.WORLD_TICK as permitted by the viewer
overload 1:
AvatarAPI.getMaxWorldTickCount(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the NBT data this avatar is stored as
overload 1:
AvatarAPI.getNBT(): Table | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.80563118
Gets the name string of this avatar
overload 1:
AvatarAPI.getName(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Returns this avatar's current permission level
overload 1:
AvatarAPI.getPermissionLevel(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Gets the remaining amount of particles this avatar can summon
overload 1:
AvatarAPI.getRemainingParticles(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the remaining amount of sound this avatar can play
overload 1:
AvatarAPI.getRemainingSounds(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the number of events.RENDER and events.POST_RENDER instructions of this avatar's last frame
overload 1:
AvatarAPI.getRenderCount(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the file size of this avatar in bytes
overload 1:
AvatarAPI.getSize(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Gets the number of events.TICK instructions of this avatar last tick
overload 1:
AvatarAPI.getTickCount(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Returns the UUID of the owner of this avatar
overload 1:
AvatarAPI.getUUID(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Gets the version string of this avatar
overload 1:
AvatarAPI.getVersion(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
No description available
figura.docs.avatar.get_volume
overload 1:
AvatarAPI.getVolume(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the number of events.WORLD_RENDER and events.POST_WORLD_RENDER instructions of this avatar's last frame
overload 1:
AvatarAPI.getWorldRenderCount(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the number of events.WORLD_TICK instructions of this avatar's last tick
overload 1:
AvatarAPI.getWorldTickCount(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets whether this script currently has stopped due to an error (kinda useless lol)
overload 1:
AvatarAPI.hasScriptError(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Gets whether or not this avatar has a texture
overload 1:
AvatarAPI.hasTexture(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
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:
AvatarAPI.setColor(color: Vector3): AvatarAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| color accepts | typings.2002444080||
| Return Value | typings.1575301601
overload 2:
AvatarAPI.setColor(r: Number, g: Number, b: Number): AvatarAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | typings.-1950496919||
| g accepts | typings.-1950496919||
| b accepts | typings.-1950496919||
| Return Value | typings.1575301601
overload 3:
AvatarAPI.setColor(color: Vector3, badgeName: String): AvatarAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| color accepts | typings.2002444080||
| badgeName accepts | typings.-1808118735||
| Return Value | typings.1575301601
overload 4:
AvatarAPI.setColor(r: Number, g: Number, b: Number, badgeName: String): AvatarAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | typings.-1950496919||
| g accepts | typings.-1950496919||
| b accepts | typings.-1950496919||
| badgeName accepts | typings.-1808118735||
| Return Value | typings.1575301601
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:
AvatarAPI.store(key: String, value: AnyType): AvatarAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| key accepts | typings.-1808118735||
| value accepts | typings.821772070||
| Return Value | typings.1575301601