log

Example by applejuice:
figura.docs.globals.log
overload 1:
log(...)
Method Property Fluent Description Representation
... accepts anything
Return Value nil

logJson

figura.docs.globals.log_json
overload 1:
logJson(json)
Method Property Fluent Description Representation
json accepts a String
Return Value nil

logTable

Example by ChloeSpacedOut:
figura.docs.globals.log_table
overload 1:
logTable(table)
Method Property Fluent Description Representation
table accepts a table
Return Value nil
overload 2:
logTable(javaObject)
Method Property Fluent Description Representation
javaObject accepts an Userdata
Return Value nil
overload 3:
logTable(table, maxDepth)
Method Property Fluent Description Representation
table accepts a table
maxDepth accepts an Integer
Return Value nil
overload 4:
logTable(javaObject, maxDepth)
Method Property Fluent Description Representation
javaObject accepts an Userdata
maxDepth accepts an Integer
Return Value nil

print

Example by ChloeSpacedOut:
A function that writes its arguments to chat
Even though the syntax says only one argument,
you can put as many as you want
All of them will print,
and they'll be separated by a tab space
Returns the string representation of all values
overload 1:
print(...)
Method Property Fluent Description Representation
... accepts anything
Return Value nil

printJson

Takes a Minecraft JSON string as an argument, and prints it to the chat formatted, without the lua print header
Even though the syntax says only one argument,
you can put as many as you want
All of them will print,
and they'll be appended in the end of the previous argument
Returns the formatted string
overload 1:
printJson(json)
Method Property Fluent Description Representation
json accepts a String
Return Value nil

printTable

Example by ChloeSpacedOut:
The first argument is either a Table, or it's a Userdata, which refers to any of the added Figura types
Prints the table out to chat,
specially formatted
If userdata is passed in, it is automatically converted to a table or string,
and displayed
In the case of tables inside of tables,
the "maxDepth" parameter will be used to determine how far to go
Default value for maxDepth is 1
Third argument,
"silent", will skip the chat print and will only return the string
overload 1:
printTable(table)
Method Property Fluent Description Representation
table accepts a table
Return Value nil
overload 2:
printTable(javaObject)
Method Property Fluent Description Representation
javaObject accepts an Userdata
Return Value nil
overload 3:
printTable(table, maxDepth)
Method Property Fluent Description Representation
table accepts a table
maxDepth accepts an Integer
Return Value nil
overload 4:
printTable(javaObject, maxDepth)
Method Property Fluent Description Representation
javaObject accepts an Userdata
maxDepth accepts an Integer
Return Value nil

require

Example by ChloeSpacedOut:
The require() function takes the name of one of your scripts, without the .lua extension
If this script has not been already run before,
it will run that script and return the value that script returns
If it has been run before,
then it will not run the file again, but it will return the same thing as the first time
If a required script has no returns,
then require() will return true
If the name you give isn't any of your scripts,
it will error
Scripts can be accessed relative to the executing script using `./` and `../`
overload 1:
require(scriptName)
Method Property Fluent Description Representation
scriptName accepts a String
Return Value anything

action_wheel

The global instance of the ActionWheelAPI and its subtypes
field signature:
action_wheel
Method Property Fluent Description Representation
Field Type an ActionWheelAPI

ActionWheelAPI.execute

Example by ChloeSpacedOut:
examplePage = action_wheel:createPage()
action_wheel:setPage(examplePage)
examplePage:newAction(1):onRightClick(function() log('chat spam :3') end)

events.TICK:register(function()
action_wheel:execute(1,true)
end)
-- this will only run if the action wheel is open
Executes the action of the given index
If the index is null,
it will execute the last selected action
A second parameter can be given to specify if it should be executed the left or right action
overload 1:
action_wheel:execute()
Method Property Fluent Description Representation
Return Value nil
overload 2:
action_wheel:execute(index)
Method Property Fluent Description Representation
index accepts an Integer
Return Value nil
overload 3:
action_wheel:execute(index, rightClick)
Method Property Fluent Description Representation
index accepts an Integer
rightClick accepts a Boolean
Return Value nil

ActionWheelAPI.isEnabled

Example by ChloeSpacedOut:
Returns if the Action Wheel is being currently rendered or not
overload 1:
action_wheel:isEnabled()
Method Property Fluent Description Representation
Return Value a Boolean

ActionWheelAPI.getPage

Returns a stored Page by the given title
If no title is given,
returns a table with all registered Pages
overload 1:
action_wheel:getPage(pageTitle)
Method Property Fluent Description Representation
pageTitle accepts a String
Return Value either a Page or nil

ActionWheelAPI.getCurrentPage

Returns the current set Page from the Action Wheel, or NIL if no Page has been set
overload 1:
action_wheel:getCurrentPage()
Method Property Fluent Description Representation
Return Value either a Page or nil

ActionWheelAPI.getSelected

Example by ChloeSpacedOut:
Returns the index of the currently selected action
overload 1:
action_wheel:getSelected()
Method Property Fluent Description Representation
Return Value an Integer

ActionWheelAPI.createPage

Example by ChloeSpacedOut:
figura.docs.action_wheel.create_page
overload 1:
action_wheel:createPage()
Method Property Fluent Description Representation
Return Value a Page
overload 2:
action_wheel:createPage(title)
Method Property Fluent Description Representation
title accepts a String
Return Value a Page

ActionWheelAPI.setPage

Example by ChloeSpacedOut:
examplePage = action_wheel:createPage()
action_wheel:setPage(examplePage)
Sets the Page of the action wheel to the given Title or Page
overload 1:
action_wheel:setPage(pageTitle)
Method Property Fluent Description Representation
pageTitle accepts a String
Return Value nil
overload 2:
action_wheel:setPage(page)
Method Property Fluent Description Representation
page accepts a Page
Return Value nil

ActionWheelAPI.leftClick

Example by ChloeSpacedOut:
examplePage = action_wheel:createPage('pageName')
action_wheel:setPage(examplePage)

function action_wheel.leftClick()
log('you just left clicked while in the action wheel!')
end
Function that is executed when the left mouse button is clicked
field signature:
leftClick
Method Property Fluent Description Representation
Field Type a function that takes nothing and will return anything
() -> AnyType

ActionWheelAPI.rightClick

Example by ChloeSpacedOut:
examplePage = action_wheel:createPage('pageName')
action_wheel:setPage(examplePage)

function action_wheel.rightClick()
log('you just left clicked while in the action wheel!')
end
Function that is executed when the right mouse button is clicked
field signature:
rightClick
Method Property Fluent Description Representation
Field Type a function that takes nothing and will return anything
() -> AnyType

ActionWheelAPI.scroll

Example by ChloeSpacedOut:
examplePage = action_wheel:createPage('pageName')
action_wheel:setPage(examplePage)

function action_wheel.scroll(direction)
log(direction)
end
Function that is executed when the mouse is scrolled
field signature:
scroll
Method Property Fluent Description Representation
Field Type a function that takes a Number and will return anything

animations

The global instance of the AnimationsAPI and its subtypes
field signature:
animations
Method Property Fluent Description Representation
Field Type a table

avatar

The global instance of AvatarAPI
field signature:
avatar
Method Property Fluent Description Representation
Field Type an AvatarAPI

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 nil

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 nil
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 nil

AvatarAPI.getAuthors

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

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.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.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.getAnimationComplexity

Gets the current animation complexity of this avatar
overload 1:
avatar:getAnimationComplexity()
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.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.getComplexity

Gets the current complexity of this avatar
overload 1:
avatar:getComplexity()
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.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.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.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.hasTexture

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

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.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.getInitCount

Gets the number of initialization instructions of this avatar
overload 1:
avatar:getInitCount()
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.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.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.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.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.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.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.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.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.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

client

The global instance of ClientAPI
field signature:
client
Method Property Fluent Description Representation
Field Type a ClientAPI

ClientAPI.getVersion

Example by ChloeSpacedOut:
Returns the Minecraft version of your client
overload 1:
client.getVersion()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.isDebugOverlayEnabled

Example by ChloeSpacedOut:
Returns true if the F3 screen is currently open
overload 1:
client.isDebugOverlayEnabled()
Method Property Fluent Description Representation
Return Value a Boolean

ClientAPI.getScaledWindowSize

Example by ChloeSpacedOut:
Returns the size of the window in Minecraft's internal GUI units
overload 1:
client.getScaledWindowSize()
Method Property Fluent Description Representation
Return Value a Vector2

ClientAPI.compareVersions

Compares two versions if they are less than (-1), equals (0) or greater than (1)
overload 1:
client.compareVersions(version1, version2)
Method Property Fluent Description Representation
version1 accepts a String
version2 accepts a String
Return Value an Integer

ClientAPI.getEntityStatistics

Returns a string containing information about the loaded entities on the client
This string appears in the F3 menu
overload 1:
client.getEntityStatistics()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getServerBrand

Example by ChloeSpacedOut:
Returns the type of server you're on
In singleplayer,
this is "Integrated"
overload 1:
client.getServerBrand()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getMaxMemory

Example by ChloeSpacedOut:
Returns the maximum amount of memory that Minecraft will try to use
overload 1:
client.getMaxMemory()
Method Property Fluent Description Representation
Return Value an Integer

ClientAPI.getFPSString

Example by ChloeSpacedOut:
Gets the FPS string of the client, displayed in the F3 menu
Contains info on the fps,
the fps limit, vsync, cloud types, and biome blend radius
overload 1:
client.getFPSString()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getFPS

Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getFPS())
end)
Gets the FPS of the client
Returns 0 if the fps counter isn't ready yet (or if your PC is just that bad)
overload 1:
client.getFPS()
Method Property Fluent Description Representation
Return Value an Integer

ClientAPI.getCurrentEffect

Example by ChloeSpacedOut:
Returns the path to the currently applied shader, used when spectating an entity that has different vision than normal
Normally returns nil
overload 1:
client.getCurrentEffect()
Method Property Fluent Description Representation
Return Value either a String or nil

ClientAPI.getEntityCount

Example by ChloeSpacedOut:
Returns the number of currently loaded entities
overload 1:
client.getEntityCount()
Method Property Fluent Description Representation
Return Value an Integer

ClientAPI.getVersionType

Example by ChloeSpacedOut:
figura.docs.client.get_version_type
overload 1:
client.getVersionType()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getJavaVersion

Example by ChloeSpacedOut:
Returns your current Java version you're playing Minecraft with
overload 1:
client.getJavaVersion()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getChunkStatistics

Returns a string containing information about the player's chunk
This string appears in the F3 menu
overload 1:
client.getChunkStatistics()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getSoundStatistics

Returns a string containing information about the currently playing sounds on the client
This string appears in the F3 menu
overload 1:
client.getSoundStatistics()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getParticleCount

Example by ChloeSpacedOut:
Returns the number of currently loaded particles
overload 1:
client.getParticleCount()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getUsedMemory

Example by ChloeSpacedOut:
Returns the number of bytes of memory Minecraft is currently using
overload 1:
client.getUsedMemory()
Method Property Fluent Description Representation
Return Value an Integer

ClientAPI.getAllocatedMemory

Returns the maximum amount of memory that Minecraft could possibly use
overload 1:
client.getAllocatedMemory()
Method Property Fluent Description Representation
Return Value an Integer

ClientAPI.isPaused

Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.isPaused())
end)
Returns true if the client is paused
overload 1:
client.isPaused()
Method Property Fluent Description Representation
Return Value a Boolean

ClientAPI.hasIrisShader

figura.docs.client.has_iris_shader
overload 1:
client.hasIrisShader()
Method Property Fluent Description Representation
Return Value a Boolean

ClientAPI.getTextHeight

Example by ChloeSpacedOut:
Returns the height of the given text in pixels
overload 1:
client.getTextHeight(text)
Method Property Fluent Description Representation
text accepts a String
Return Value an Integer

ClientAPI.hasIris

figura.docs.client.has_iris
overload 1:
client.hasIris()
Method Property Fluent Description Representation
Return Value a Boolean

ClientAPI.getFiguraVersion

Gets the client Figura version
overload 1:
client.getFiguraVersion()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getSystemTime

Example by ChloeSpacedOut:
Returns the current system time in milliseconds
overload 1:
client.getSystemTime()
Method Property Fluent Description Representation
Return Value an Integer

ClientAPI.getCameraRot

Example by ChloeSpacedOut:
Returns the rotation of the viewer's camera
overload 1:
client.getCameraRot()
Method Property Fluent Description Representation
Return Value a Vector3

ClientAPI.isHudEnabled

Example by ChloeSpacedOut:
Returns true if the hud is enabled (F1 disables the HUD)
overload 1:
client.isHudEnabled()
Method Property Fluent Description Representation
Return Value a Boolean

ClientAPI.getFOV

Example by ChloeSpacedOut:
Returns the current FOV option of the client, not including additional effects such as speed or sprinting
overload 1:
client.getFOV()
Method Property Fluent Description Representation
Return Value a Number

ClientAPI.getWindowSize

Example by ChloeSpacedOut:
Returns the size of the Minecraft window in pixels, as {width, height}
overload 1:
client.getWindowSize()
Method Property Fluent Description Representation
Return Value a Vector2

ClientAPI.isWindowFocused

Example by ChloeSpacedOut:
Returns true if the Minecraft window is currently focused
overload 1:
client.isWindowFocused()
Method Property Fluent Description Representation
Return Value a Boolean

ClientAPI.getGuiScale

Example by ChloeSpacedOut:
Returns the current value of your Gui Scale setting
If you use auto,
then it gets the actual current scale
overload 1:
client.getGuiScale()
Method Property Fluent Description Representation
Return Value a Number

ClientAPI.getMousePos

Example by ChloeSpacedOut:
Returns the position of the mouse in pixels, relative to the top-left corner
overload 1:
client.getMousePos()
Method Property Fluent Description Representation
Return Value a Vector2

ClientAPI.getCameraPos

Example by ChloeSpacedOut:
Returns the position of the viewer's camera
overload 1:
client.getCameraPos()
Method Property Fluent Description Representation
Return Value a Vector3

ClientAPI.getTextWidth

Example by ChloeSpacedOut:
Returns the width of the given text in pixels
In case of multiple lines,
return the largest width of all lines
overload 1:
client.getTextWidth(text)
Method Property Fluent Description Representation
text accepts a String
Return Value an Integer

ClientAPI.getActiveLang

Example by ChloeSpacedOut:
Returns a string representation of the current game language
overload 1:
client.getActiveLang()
Method Property Fluent Description Representation
Return Value a String

events

The global instance of the EventsAPI and its subtypes
field signature:
events
Method Property Fluent Description Representation
Field Type an EventsAPI

EventsAPI.TICK

The TICK event is run every tick in-game if this avatar's entity exists
field signature:
TICK
Method Property Fluent Description Representation
Field Type an Event

EventsAPI.WORLD_TICK

The WORLD_TICK event is run every in-game tick
field signature:
WORLD_TICK
Method Property Fluent Description Representation
Field Type an Event

EventsAPI.RENDER

The RENDER event is run every frame, before the avatar is rendered
Takes a parameter delta,
which is a number from 0 to 1 indicating the proportion of the way the game is between ticks
A second parameter,
giving out context of the current RenderMode, with is a string with the name of the source of this render event
And a third paramenter,
being the source matrix used to render the Avatar
field signature:
RENDER
Method Property Fluent Description Representation
Field Type an Event

EventsAPI.POST_RENDER

The POST_RENDER event runs every frame after the avatar is rendered
Takes a parameter delta,
which is a number from 0 to 1 indicating the proportion of the way the game is between ticks
A second parameter,
giving out context of the current RenderMode, with is a string with the name of the source of this render event
And a third parameter,
being the source matrix used to render the Avatar
field signature:
POST_RENDER
Method Property Fluent Description Representation
Field Type an Event

EventsAPI.WORLD_RENDER

The WORLD_RENDER event is run every frame before the world is rendered
Always runs when a world is visible,
even when the avatar itself is not, so this runs even in first person
Takes a parameter delta,
which is a number from 0 to 1 indicating the proportion of the way the game is between ticks
field signature:
WORLD_RENDER
Method Property Fluent Description Representation
Field Type an Event

EventsAPI.POST_WORLD_RENDER

The POST_WORLD_RENDER event runs every frame after the world is rendered
Always runs when a world is visible,
even when the avatar itself is not, so this runs even in first person
Takes a parameter delta,
which is a number from 0 to 1 indicating the proportion of the way the game is between ticks
field signature:
POST_WORLD_RENDER
Method Property Fluent Description Representation
Field Type an Event

EventsAPI.CHAT_SEND_MESSAGE

The CHAT_SEND_MESSAGE event is run every time you send a message in chat
A string parameter is passed in,
which contains the message that was sent
The return value is chained to the next events of the same type,
whereas NIL cancels the message from being sent and any other value will modify the sent message (if allowed in the settings)
field signature:
CHAT_SEND_MESSAGE
Method Property Fluent Description Representation
Field Type an Event

EventsAPI.CHAT_RECEIVE_MESSAGE

The CHAT_RECEIVE_MESSAGE event is run every time a message is received in chat
The first argument is the raw string of the received text
The second argument is a JSON string representation of the received text
If the first return value is not nil,
the message will be replaced with that value
If the first return value is false,
it will suppress adding this message
The second return value is,
optionally, an RGB vector which will be used as the background color for this message
field signature:
CHAT_RECEIVE_MESSAGE
Method Property Fluent Description Representation
Field Type an Event

EventsAPI.SKULL_RENDER

Called on every one of your skull blocks placed in the world
It have 5 arguments,
as listed below:
(number) - the tick delta
(blockstate) - the block,
when rendered from a block
(itemstack) - the item,
when rendered from an item
(entity) - the entity, when rendered from an entity
(string) - the type of the rendering (LEFT_HAND,
HEAD, BLOCK, …)
If the return value is true, the skull will not render
field signature:
SKULL_RENDER
Method Property Fluent Description Representation
Field Type an Event

figuraMetatables

A table containing all the metatables for Figura's object types
The metatables are editable
field signature:
figuraMetatables
Method Property Fluent Description Representation
Field Type a table

host

The global instance of HostAPI
field signature:
host
Method Property Fluent Description Representation
Field Type a HostAPI

HostAPI.getSlot

Gets an ItemStack for the item in the given slot
The slot is either their numerical id (0 indexed) or the slot string,
as used in the /item command
overload 1:
host:getSlot(slot)
Method Property Fluent Description Representation
slot accepts a String
Return Value an ItemStack

HostAPI.setTitle

Sets the current title to the given text
The text is given as json
overload 1:
host:setTitle(text)
Method Property Fluent Description Representation
text accepts a String
Return Value nil

HostAPI.isHost

Returns true if this instance of the script is running on host
overload 1:
host:isHost()
Method Property Fluent Description Representation
Return Value a Boolean

HostAPI.sendChatMessage

Sends the given message in the chat
overload 1:
host:sendChatMessage(text)
Method Property Fluent Description Representation
text accepts a String
Return Value nil

HostAPI.setSubtitle

Sets the current subtitle to the given text
The text is given as a JSON string
overload 1:
host:setSubtitle(text)
Method Property Fluent Description Representation
text accepts a String
Return Value nil

HostAPI.setChatColor

Sets the color of the text that is currently being typed into the chat window
overload 1:
host:setChatColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value nil
overload 2:
host:setChatColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value nil

HostAPI.setTitleTimes

Sets the duration of the title on the screen, also its fade-in and fade-out durations
overload 1:
host:setTitleTimes(timesData)
Method Property Fluent Description Representation
timesData accepts a Vector3
Return Value nil
overload 2:
host:setTitleTimes(fadeInTime, stayTime, fadeOutTime)
Method Property Fluent Description Representation
fadeInTime accepts an Integer
stayTime accepts an Integer
fadeOutTime accepts an Integer
Return Value nil

HostAPI.getTargetedEntity

figura.docs.host.get_targeted_entity
overload 1:
host:getTargetedEntity()
Method Property Fluent Description Representation
Return Value an EntityAPI

HostAPI.swingArm

Animates swinging the player's arm
If the boolean is true,
then the offhand is the one that swings
overload 1:
host:swingArm()
Method Property Fluent Description Representation
Return Value nil
overload 2:
host:swingArm(offhand)
Method Property Fluent Description Representation
offhand accepts a Boolean
Return Value nil

HostAPI.setActionbar

Sets the action bar message to the given text
The boolean parameter defaults to false
overload 1:
host:setActionbar(text)
Method Property Fluent Description Representation
text accepts a String
Return Value nil
overload 2:
host:setActionbar(text, animated)
Method Property Fluent Description Representation
text accepts a String
animated accepts a Boolean
Return Value nil

HostAPI.getChatText

Gets the text that is currently being typed into the chat window
overload 1:
host:getChatText()
Method Property Fluent Description Representation
Return Value a String

HostAPI.clearTitle

Clears the current title from the GUI
overload 1:
host:clearTitle()
Method Property Fluent Description Representation
Return Value nil

HostAPI.setChatText

Sets the text currently being typed in the chat window to the given string
overload 1:
host:setChatText(text)
Method Property Fluent Description Representation
text accepts a String
Return Value nil

HostAPI.getScreen

Gets the class name of the screen the player is currently on
If the player is not currently in a screen,
returns nil
overload 1:
host:getScreen()
Method Property Fluent Description Representation
Return Value either a String or nil

HostAPI.isChatOpen

Checks if the host has the chat screen opened
overload 1:
host:isChatOpen()
Method Property Fluent Description Representation
Return Value a Boolean

HostAPI.isContainerOpen

Checks if the host has a container screen opened
overload 1:
host:isContainerOpen()
Method Property Fluent Description Representation
Return Value a Boolean

HostAPI.unlockCursor

Setting this value to true will unlock your cursor, letting you move it freely on the screen instead of it controlling your player's rotation
field signature:
unlockCursor
Method Property Fluent Description Representation
Field Type a Boolean

keybind

figura.docs.globals.keybind
field signature:
keybind
Method Property Fluent Description Representation
Field Type a KeybindAPI

KeybindAPI.create

figura.docs.keybind_api.create
overload 1:
keybind:create(name, key)
typings.568216823
Method Property Fluent Description Representation
name accepts a String
key accepts
Return Value a Keybind
overload 2:
keybind:create(name, key, gui)
typings.568216823
Method Property Fluent Description Representation
name accepts a String
key accepts
gui accepts a Boolean
Return Value a Keybind
overload 3:
keybind:create(name, key, gui, override)
typings.568216823
Method Property Fluent Description Representation
name accepts a String
key accepts
gui accepts a Boolean
override accepts a Boolean
Return Value a Keybind

KeybindAPI.getVanillaKey

figura.docs.keybind_api.get_vanilla_key
overload 1:
keybind:getVanillaKey(id)
Method Property Fluent Description Representation
id accepts a KeyIDs
Return Value a String

matrices

The global instance of the MatricesAPI and its subtypes
field signature:
matrices
Method Property Fluent Description Representation
Field Type a MatricesAPI

MatricesAPI.scale2

Creates a new Matrix2 that scales by the specified factors
overload 1:
matrices.scale2(vec)
Method Property Fluent Description Representation
vec accepts a Vector2
Return Value a Matrix2
overload 2:
matrices.scale2(x, y)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
Return Value a Matrix2

MatricesAPI.mat2

Creates a Matrix2 using the given parameters as columns
If you call the function with no parameters,
returns the 2x2 identity matrix
overload 1:
matrices.mat2()
Method Property Fluent Description Representation
Return Value a Matrix2
overload 2:
matrices.mat2(col1, col2)
Method Property Fluent Description Representation
col1 accepts a Vector2
col2 accepts a Vector2
Return Value a Matrix2

MatricesAPI.rotation3

Creates a new Matrix3 that rotates by the specified angles
Angles are given in degrees,
and the rotation order is ZYX
overload 1:
matrices.rotation3(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Matrix3
overload 2:
matrices.rotation3(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Matrix3

MatricesAPI.zRotation3

Creates a new Matrix3 that rotates by the specified angle around the Z axis
Angle is given in degrees
overload 1:
matrices.zRotation3(angle)
Method Property Fluent Description Representation
angle accepts a Number
Return Value a Matrix3

MatricesAPI.rotation2

Creates a new Matrix2 that rotates by the specified angle
Angle is given in degrees
overload 1:
matrices.rotation2(angle)
Method Property Fluent Description Representation
angle accepts a Number
Return Value a Matrix2

MatricesAPI.yRotation3

Creates a new Matrix3 that rotates by the specified angle around the Y axis
Angle is given in degrees
overload 1:
matrices.yRotation3(angle)
Method Property Fluent Description Representation
angle accepts a Number
Return Value a Matrix3

MatricesAPI.mat3

Creates a Matrix3 using the given parameters as columns
If you call the function with no parameters,
returns the 3x3 identity matrix
overload 1:
matrices.mat3()
Method Property Fluent Description Representation
Return Value a Matrix3
overload 2:
matrices.mat3(col1, col2, col3)
Method Property Fluent Description Representation
col1 accepts a Vector3
col2 accepts a Vector3
col3 accepts a Vector3
Return Value a Matrix3

MatricesAPI.xRotation4

Creates a new Matrix4 that rotates by the specified angle around the X axis
Angle is given in degrees
overload 1:
matrices.xRotation4(angle)
Method Property Fluent Description Representation
angle accepts a Number
Return Value a Matrix4

MatricesAPI.yRotation4

Creates a new Matrix4 that rotates by the specified angle around the Y axis
Angle is given in degrees
overload 1:
matrices.yRotation4(angle)
Method Property Fluent Description Representation
angle accepts a Number
Return Value a Matrix4

MatricesAPI.xRotation3

Creates a new Matrix3 that rotates by the specified angle around the X axis
Angle is given in degrees
overload 1:
matrices.xRotation3(angle)
Method Property Fluent Description Representation
angle accepts a Number
Return Value a Matrix3

MatricesAPI.rotation4

Creates a new Matrix4 that rotates by the specified angles
Angles are given in degrees,
and the rotation order is ZYX
overload 1:
matrices.rotation4(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Matrix4
overload 2:
matrices.rotation4(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Matrix4

MatricesAPI.mat4

Creates a Matrix4 using the given parameters as columns
If you call the function with no parameters,
returns the 4x4 identity matrix
overload 1:
matrices.mat4()
Method Property Fluent Description Representation
Return Value a Matrix4
overload 2:
matrices.mat4(col1, col2, col3, col4)
Method Property Fluent Description Representation
col1 accepts a Vector4
col2 accepts a Vector4
col3 accepts a Vector4
col4 accepts a Vector4
Return Value a Matrix4

MatricesAPI.translate4

Creates a new Matrix4 that translates by the specified offset
overload 1:
matrices.translate4(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Matrix4
overload 2:
matrices.translate4(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Matrix4

MatricesAPI.zRotation4

Creates a new Matrix4 that rotates by the specified angle around the Z axis
Angle is given in degrees
overload 1:
matrices.zRotation4(angle)
Method Property Fluent Description Representation
angle accepts a Number
Return Value a Matrix4

MatricesAPI.translate3

Creates a new Matrix3 that translates by the specified offset
overload 1:
matrices.translate3(vec)
Method Property Fluent Description Representation
vec accepts a Vector2
Return Value a Matrix3
overload 2:
matrices.translate3(x, y)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
Return Value a Matrix3

MatricesAPI.scale4

Creates a new Matrix4 that scales by the specified factors
overload 1:
matrices.scale4(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Matrix4
overload 2:
matrices.scale4(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Matrix4

MatricesAPI.scale3

Creates a new Matrix3 that scales by the specified factors
overload 1:
matrices.scale3(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Matrix3
overload 2:
matrices.scale3(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Matrix3

models

The global instance of the Avatar Models and its subtypes
field signature:
models
Method Property Fluent Description Representation
Field Type a ModelPart

ModelPart.getName

The name of this model part
overload 1:
models:getName()
Method Property Fluent Description Representation
Return Value a String

ModelPart.getParent

Gets the parent part of this part
If this part has no parent,
returns nil
overload 1:
models:getParent()
Method Property Fluent Description Representation
Return Value either a ModelPart or nil

ModelPart.getType

Returns whether this part is a "GROUP", a "CUBE", or a "MESH"
overload 1:
models:getType()
Method Property Fluent Description Representation
Return Value a String

ModelPart.getChildren

Gets the children of this part, stored in a table
overload 1:
models:getChildren()
Method Property Fluent Description Representation
Return Value an array of ModelParts

ModelPart.setColor

Sets the color multiplier for this part for primary and secondary colors
Values are RGB from 0 to 1
overload 1:
models:setColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value nil
overload 2:
models:setColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value nil

ModelPart.setScale

Sets the scale factor for this part
Nil values for scale are assumed to be 1
overload 1:
models:setScale(scale)
Method Property Fluent Description Representation
scale accepts a Vector3
Return Value nil
overload 2:
models:setScale(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

ModelPart.addItem

figura.docs.model_part.add_item
overload 1:
models:addItem(taskName)
Method Property Fluent Description Representation
taskName accepts a String
Return Value a RenderTask

ModelPart.getTask

Gets the Render Task with the given name from this part
Returns a table with all tasks if a name is not given
overload 1:
models:getTask()
Method Property Fluent Description Representation
Return Value a table mapping a String to a RenderTask
overload 2:
models:getTask(taskName)
Method Property Fluent Description Representation
taskName accepts a String
Return Value a RenderTask

ModelPart.offsetRot

figura.docs.model_part.offset_rot
overload 1:
models:offsetRot(offsetRot)
Method Property Fluent Description Representation
offsetRot accepts a Vector3
Return Value nil
overload 2:
models:offsetRot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

ModelPart.getPositionMatrixRaw

Returns the position matrix for this model part
The Raw version of the function is different in that it doesn't recalculate the matrix before getting it
overload 1:
models:getPositionMatrixRaw()
Method Property Fluent Description Representation
Return Value a Matrix4

ModelPart.setPrimaryRenderType

Sets the current primary render type of this model part
Nil by default,
meaning the part copies the primary render type of its parent during rendering
Check the docs enum command for all render types
overload 1:
models:setPrimaryRenderType(renderType)
Method Property Fluent Description Representation
renderType accepts a String
Return Value nil

ModelPart.setSecondaryRenderType

Sets the current secondary render type of this model part
Nil by default,
meaning the part copies the secondary render type of its parent during rendering
Check the docs enum command for all render types
overload 1:
models:setSecondaryRenderType(renderType)
Method Property Fluent Description Representation
renderType accepts a String
Return Value nil

ModelPart.setSecondaryTexture

Sets the secondary texture override of this part
Check the TextureType types in the list docs
If using "resource",
the second parameter should indicate the path to the Minecraft texture you want to use
If using "custom",
the second parameter should indicate a texture object
overload 1:
models:setSecondaryTexture(textureType)
Method Property Fluent Description Representation
textureType accepts a String
Return Value nil
overload 2:
models:setSecondaryTexture(resource, path)
Method Property Fluent Description Representation
resource accepts a String
path accepts a String
Return Value nil

ModelPart.getPrimaryRenderType

Gets the current primary render type of this model part
Nil by default,
meaning the part copies the primary render type of its parent
overload 1:
models:getPrimaryRenderType()
Method Property Fluent Description Representation
Return Value either a RenderTypes or nil

ModelPart.getSecondaryRenderType

Gets the current secondary render type of this model part
Nil by default,
meaning the part copies the secondary render type of its parent
overload 1:
models:getSecondaryRenderType()
Method Property Fluent Description Representation
Return Value either a RenderTypes or nil

ModelPart.setVisible

Sets this part to be visible or invisible
The default value is nil,
meaning the part copies its visibility from its parent part
overload 1:
models:setVisible(visible)
Method Property Fluent Description Representation
visible accepts a Boolean
Return Value nil

ModelPart.getVisible

Gets whether or not this model part is visible
The default value is nil,
meaning it copies the visibility of its parent part during rendering
overload 1:
models:getVisible()
Method Property Fluent Description Representation
Return Value either a Boolean or nil

ModelPart.getScale

Gets the scale of the model part, as a multiple of its Blockbench size
Only changes from {1,
1,1} when you call setScale()
overload 1:
models:getScale()
Method Property Fluent Description Representation
Return Value a Vector3

ModelPart.setPos

Sets the position offset for this part from its Blockbench position
Nil values for position are assumed to be 0
overload 1:
models:setPos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value nil
overload 2:
models:setPos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

ModelPart.getPos

Gets the position of the model part, as an offset from its position in Blockbench
Only changes from {0,
0,0} when you call setPos()
overload 1:
models:getPos()
Method Property Fluent Description Representation
Return Value a Vector3

ModelPart.getOpacity

Gets the opacity multiplier of this part
Note that opacity settings will only take effect if the part has a suitable Render Type for them,
mainly TRANSLUCENT
Check out modelPart.setPrimaryRenderType() for how to do this
overload 1:
models:getOpacity()
Method Property Fluent Description Representation
Return Value a Number

ModelPart.offsetPivot

figura.docs.model_part.offset_pivot
overload 1:
models:offsetPivot(offsetPivot)
Method Property Fluent Description Representation
offsetPivot accepts a Vector3
Return Value nil
overload 2:
models:offsetPivot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

ModelPart.getColor

Returns the average set color from this part, as adding the primary color with the secondary, then dividing them
Values are RGB from 0 to 1
overload 1:
models:getColor()
Method Property Fluent Description Representation
Return Value a Vector3

ModelPart.getAnimRot

Gets the rotation offset provided by the currently active animation of this model part
overload 1:
models:getAnimRot()
Method Property Fluent Description Representation
Return Value a Vector3

ModelPart.getPivot

Gets the pivot point of the model part, including its pivot in Blockbench
For relative values,
check out the "offset" pivot functions
overload 1:
models:getPivot()
Method Property Fluent Description Representation
Return Value a Vector3

ModelPart.getRot

Gets the rotation of the model part, including its rotation in Blockbench
For relative rotation values,
check out the "offset" rot functions
overload 1:
models:getRot()
Method Property Fluent Description Representation
Return Value a Vector3

ModelPart.setRot

Sets the absolute rotation for this part
Nil values for rotation are assumed to be 0
Angles are given in degrees
For relative rotation values,
check out the "offset" rot functions
overload 1:
models:setRot(rot)
Method Property Fluent Description Representation
rot accepts a Vector3
Return Value nil
overload 2:
models:setRot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

ModelPart.getOffsetRot

Gets the rotation offset of the model part, offset from its rotation in Blockbench
For absolute rotation values,
check out the non-offset rot functions
overload 1:
models:getOffsetRot()
Method Property Fluent Description Representation
Return Value a Vector3

ModelPart.getAnimScale

Gets the scale multiplier provided by the currently active animation of this model part
overload 1:
models:getAnimScale()
Method Property Fluent Description Representation
Return Value a Vector3

ModelPart.setMatrix

Sets the given matrix as the position matrix for this model part
The normal matrix is automatically calculated as the inverse transpose of this matrix
Calling this DOES NOT CHANGE the values of position,
rot, or scale in the model part
If you call setPos() or a similar function,
the effects of setMatrix() will be overwritten
overload 1:
models:setMatrix(matrix)
Method Property Fluent Description Representation
matrix accepts a Matrix4
Return Value nil

ModelPart.getAnimPos

Gets the position offset provided by the currently active animation of this model part
overload 1:
models:getAnimPos()
Method Property Fluent Description Representation
Return Value a Vector3

ModelPart.getOffsetPivot

Gets the pivot offset of the model part, offset from its pivot in Blockbench
For absolute pivot point values,
check out the non-offset pivot functions
overload 1:
models:getOffsetPivot()
Method Property Fluent Description Representation
Return Value a Vector3

ModelPart.getTextureSize

Gets the width, height of this part's texture in pixels
Throws an error if this part has multiple different-sized textures on it,
or if the part is a Group
overload 1:
models:getTextureSize()
Method Property Fluent Description Representation
Return Value a Vector2

ModelPart.partToWorldMatrix

Gets a matrix which transforms a point from this part's position to a world location
Recommended to use this in POST_RENDER,
as by then the matrix is updated
In RENDER it will be 1 frame behind the part's visual position for that frame
Also,
if the model is not rendered in-world, the part's matrix will not be updated
Paperdoll rendering and other UI renderings will not affect this matrix
overload 1:
models:partToWorldMatrix()
Method Property Fluent Description Representation
Return Value a Matrix4

ModelPart.getPositionMatrix

Recalculates the matrix for this model part, based on its current position, rotation, scale, and pivot, then returns this matrix
overload 1:
models:getPositionMatrix()
Method Property Fluent Description Representation
Return Value a Matrix4

ModelPart.setPivot

Sets the absolute pivot for this part
Nil values are assumed to be 0
For relative pivot offsets,
check out the "offset" pivot functions
overload 1:
models:setPivot(pivot)
Method Property Fluent Description Representation
pivot accepts a Vector3
Return Value nil
overload 2:
models:setPivot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

ModelPart.setPrimaryTexture

Sets the primary texture override of this part
Check the TextureType types in the list docs
If using "resource",
the second parameter should indicate the path to the Minecraft texture you want to use
If using "custom",
the second parameter should indicate a texture object
overload 1:
models:setPrimaryTexture(textureType)
Method Property Fluent Description Representation
textureType accepts a String
Return Value nil
overload 2:
models:setPrimaryTexture(resource, path)
Method Property Fluent Description Representation
resource accepts a String
path accepts a String
Return Value nil

ModelPart.setUV

Sets the UV of this part
This function is normalized,
meaning it works with values 0 to 1
If you say setUV(0.5,
0.25), for example, it will scroll by half of your texture width to the right, and one-fourth of the texture width downwards
overload 1:
models:setUV(uv)
Method Property Fluent Description Representation
uv accepts a Vector2
Return Value nil
overload 2:
models:setUV(u, v)
Method Property Fluent Description Representation
u accepts a Number
v accepts a Number
Return Value nil

ModelPart.getNormalMatrix

Recalculates the normal matrix for this model part, based on its current position, rotation, scale, and pivot, then returns this matrix
overload 1:
models:getNormalMatrix()
Method Property Fluent Description Representation
Return Value a Matrix3

ModelPart.getNormalMatrixRaw

Returns the normal matrix for this model part
The Raw version of the function is different in that it doesn't recalculate the matrix before returning it
overload 1:
models:getNormalMatrixRaw()
Method Property Fluent Description Representation
Return Value a Matrix3

ModelPart.setUVMatrix

Sets the UV matrix of this part
This matrix is applied to all UV points during the transform,
with the UVs treated as homogeneous vectors
setUV() and setUVPixels() are just simpler ways of setting this matrix
overload 1:
models:setUVMatrix(matrix)
Method Property Fluent Description Representation
matrix accepts a Matrix3
Return Value nil

ModelPart.setParentType

Sets the parent type of the part
See the ParentType parts in the list docs for legal types
overload 1:
models:setParentType(parentType)
Method Property Fluent Description Representation
parentType accepts a String
Return Value nil

ModelPart.addBlock

figura.docs.model_part.add_block
overload 1:
models:addBlock(taskName)
Method Property Fluent Description Representation
taskName accepts a String
Return Value a RenderTask

ModelPart.setOpacity

Sets the opacity multiplier of this part
Note that opacity settings will only take effect if the part has a suitable Render Type for them,
mainly TRANSLUCENT
Check out modelPart.setPrimaryRenderType() for how to do this
overload 1:
models:setOpacity(opacity)
Method Property Fluent Description Representation
opacity accepts a Number
Return Value nil

ModelPart.getLight

Gets the light level you set earlier to this part
Does not interact with Minecraft's lighting system,
only retrieving values you set earlier with setLight()
overload 1:
models:getLight()
Method Property Fluent Description Representation
Return Value a Vector2

ModelPart.setLight

Sets the light level to be used when rendering this part
Values you give are 0 to 15,
indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this part
overload 1:
models:setLight(light)
Method Property Fluent Description Representation
light accepts a Vector2
Return Value nil
overload 2:
models:setLight(blockLight, skyLight)
Method Property Fluent Description Representation
blockLight accepts an Integer
skyLight accepts an Integer
Return Value nil

ModelPart.setUVPixels

Sets the UV of this part in pixels
Automatically divides by the results of getTextureSize(),
so you can just input the number of pixels you want the UV to scroll by
Errors if the part has multiple different-sized textures
If this part is a Group,
it will attempt to setUVPixels on its children
overload 1:
models:setUVPixels(uv)
Method Property Fluent Description Representation
uv accepts a Vector2
Return Value nil
overload 2:
models:setUVPixels(u, v)
Method Property Fluent Description Representation
u accepts a Number
v accepts a Number
Return Value nil

ModelPart.getParentType

Returns the current parent type of the part
overload 1:
models:getParentType()
Method Property Fluent Description Representation
Return Value a String

ModelPart.addText

figura.docs.model_part.add_text
overload 1:
models:addText(taskName)
Method Property Fluent Description Representation
taskName accepts a String
Return Value a RenderTask

ModelPart.removeTask

Removes the Task with the given name from this part
Removes ALL tasks if a name is not given
overload 1:
models:removeTask(taskName)
Method Property Fluent Description Representation
taskName accepts a String
Return Value nil

nameplate

The global instance of the NameplateAPI and its subtypes
field signature:
nameplate
Method Property Fluent Description Representation
Field Type a NameplateAPI

NameplateAPI.CHAT

A customization for your nameplate in the chat
field signature:
CHAT
Method Property Fluent Description Representation
Field Type a NameplateCustomization

NameplateAPI.ENTITY

A customization for your nameplate above your head
field signature:
ENTITY
Method Property Fluent Description Representation
Field Type an EntityNameplateCustomization

NameplateAPI.LIST

A customization for your nameplate in the tab list
field signature:
LIST
Method Property Fluent Description Representation
Field Type a NameplateCustomization

NameplateAPI.ALL

A group that manages all your nameplate customizations at once
field signature:
ALL
Method Property Fluent Description Representation
Field Type a NameplateCustomizationGroup

particles

The global instance of ParticleAPI
field signature:
particles
Method Property Fluent Description Representation
Field Type a ParticleAPI

ParticleAPI.addParticle

figura.docs.particles.add_particle
overload 1:
particles:addParticle(name, posVel)
typings.2002444083
Method Property Fluent Description Representation
name accepts a String
posVel accepts
Return Value nil
overload 2:
particles:addParticle(name, pos)
Method Property Fluent Description Representation
name accepts a String
pos accepts a Vector3
Return Value nil
overload 3:
particles:addParticle(name, pos, vel)
Method Property Fluent Description Representation
name accepts a String
pos accepts a Vector3
vel accepts a Vector3
Return Value nil
overload 4:
particles:addParticle(name, posX, posY, posZ)
Method Property Fluent Description Representation
name accepts a String
posX accepts a Number
posY accepts a Number
posZ accepts a Number
Return Value nil
overload 5:
particles:addParticle(name, pos, velX, velY, velZ)
Method Property Fluent Description Representation
name accepts a String
pos accepts a Vector3
velX accepts a Number
velY accepts a Number
velZ accepts a Number
Return Value nil
overload 6:
particles:addParticle(name, posX, posY, posZ, vel)
Method Property Fluent Description Representation
name accepts a String
posX accepts a Number
posY accepts a Number
posZ accepts a Number
vel accepts a Vector3
Return Value nil
overload 7:
particles:addParticle(name, posX, posY, posZ, velX, velY, velZ)
Method Property Fluent Description Representation
name accepts a String
posX accepts a Number
posY accepts a Number
posZ accepts a Number
velX accepts a Number
velY accepts a Number
velZ accepts a Number
Return Value nil

pings

The global instance of PingAPI
field signature:
pings
Method Property Fluent Description Representation
Field Type a PingAPI

player

The global instance of the EntityAPI and its subtypes
field signature:
player
Method Property Fluent Description Representation
Field Type a PlayerAPI

PlayerAPI.getExperienceProgress

Gets the progress of the way towards the player's next level, as a value from 0 to 1
overload 1:
player:getExperienceProgress()
Method Property Fluent Description Representation
Return Value a Number

PlayerAPI.getFood

Example by JimmyHelp:
Gets the current food level of the player, from 0 to 20
overload 1:
player:getFood()
Method Property Fluent Description Representation
Return Value an Integer

PlayerAPI.isFlying

Example by JimmyHelp:
figura.docs.player.is_flying
overload 1:
player:isFlying()
Method Property Fluent Description Representation
Return Value a Boolean

PlayerAPI.getGamemode

Example by JimmyHelp:
Returns "SURVIVAL", "CREATIVE", "ADVENTURE", or "SPECTATOR" depending on the player's gamemode
If the gamemode is unknown,
returns nil
overload 1:
player:getGamemode()
Method Property Fluent Description Representation
Return Value either a String or nil

PlayerAPI.getExperienceLevel

Example by JimmyHelp:
Gets the player's current level
overload 1:
player:getExperienceLevel()
Method Property Fluent Description Representation
Return Value a Number

PlayerAPI.getModelType

Example by JimmyHelp:
Returns "SLIM" or "DEFAULT", depending on the player's model type
overload 1:
player:getModelType()
Method Property Fluent Description Representation
Return Value a String

PlayerAPI.getSaturation

Example by JimmyHelp:
Gets the current saturation level of the player
overload 1:
player:getSaturation()
Method Property Fluent Description Representation
Return Value a Number

PlayerAPI.getActiveItem

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns an ItemStack representing the item the entity is currently using
If they're not using any item,
returns air
overload 1:
player:getActiveItem()
Method Property Fluent Description Representation
Return Value an ItemStack

PlayerAPI.getMaxHealth

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns the maximum amount of health this entity can have
overload 1:
player:getMaxHealth()
Method Property Fluent Description Representation
Return Value a Number

PlayerAPI.getArrowCount

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns the number of arrows sticking out of this entity
overload 1:
player:getArrowCount()
Method Property Fluent Description Representation
Return Value an Integer

PlayerAPI.isLeftHanded

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns true if the entity's main hand is its left
overload 1:
player:isLeftHanded()
Method Property Fluent Description Representation
Return Value a Boolean

PlayerAPI.isUsingItem

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns true if the entity is currently using an item
overload 1:
player:isUsingItem()
Method Property Fluent Description Representation
Return Value a Boolean

PlayerAPI.getActiveHand

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns "OFF_HAND" or "MAIN_HAND", depending on which hand this entity uses an item with
overload 1:
player:getActiveHand()
Method Property Fluent Description Representation
Return Value a String

PlayerAPI.getBodyYaw

Inherited from LivingEntityAPI

Example by JimmyHelp:
Gets the yaw of this entity's body in degrees
If delta is passed in,
then it will be used to linearly interpolate the rotation of the body between the previous tick and the current tick
The default value of delta is 1
overload 1:
player:getBodyYaw()
Method Property Fluent Description Representation
Return Value a Number
overload 2:
player:getBodyYaw(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Number

PlayerAPI.getHealth

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns the amount of health this entity has remaining
overload 1:
player:getHealth()
Method Property Fluent Description Representation
Return Value a Number

PlayerAPI.getDeathTime

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns the number of ticks this entity has been dead for
overload 1:
player:getDeathTime()
Method Property Fluent Description Representation
Return Value a Number

PlayerAPI.getStatusEffects

Inherited from LivingEntityAPI

Example by JimmyHelp:
figura.docs.living_entity.get_status_effects
overload 1:
player:getStatusEffects()
Method Property Fluent Description Representation
Return Value a table

PlayerAPI.getStingerCount

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns the number of bee stingers sticking out of this entity
overload 1:
player:getStingerCount()
Method Property Fluent Description Representation
Return Value an Integer

PlayerAPI.getHeldItem

Inherited from LivingEntityAPI

Returns an ItemStack representing the item in this entity's main hand
If true is passed in for "offhand",
then it will instead look at the item in the entity's offhand
If the entity isn't holding an item in that hand,
returns air
overload 1:
player:getHeldItem()
Method Property Fluent Description Representation
Return Value an ItemStack
overload 2:
player:getHeldItem(offhand)
Method Property Fluent Description Representation
offhand accepts a Boolean
Return Value an ItemStack

PlayerAPI.getArmor

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns the amount of armor points this entity has
overload 1:
player:getArmor()
Method Property Fluent Description Representation
Return Value a Number

PlayerAPI.isClimbing

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns true if the entity is currently using a climbable block, like a ladder or vine
overload 1:
player:isClimbing()
Method Property Fluent Description Representation
Return Value a Boolean

PlayerAPI.getName

Inherited from LivingEntityAPI

Example by JimmyHelp:
Gets the name of this entity, if it has a custom name
If it doesn't,
returns a translated form of getType()
overload 1:
player:getName()
Method Property Fluent Description Representation
Return Value a String

PlayerAPI.getType

Inherited from LivingEntityAPI

Example by JimmyHelp:
Gets the Minecraft identifier of this entity
For instance,
"minecraft:pig"
overload 1:
player:getType()
Method Property Fluent Description Representation
Return Value a String

PlayerAPI.isLoaded

Inherited from LivingEntityAPI

Example by JimmyHelp:
Checks if this entity object is still being updated and loaded
A non-loaded entity would be someone or something which is in another dimension or out of the render distance for example
overload 1:
player:isLoaded()
Method Property Fluent Description Representation
Return Value a Boolean

PlayerAPI.getItem

Inherited from LivingEntityAPI

Example by JimmyHelp:
Gets an ItemStack for the item in the given slot
For the player,
slots are indexed with 1 as the main hand, 2 as the off hand, and 3,4,5,6 as the 4 armor slots from the boots to the helmet
If an invalid slot number is given,
this will return nil
overload 1:
player:getItem(index)
Method Property Fluent Description Representation
index accepts an Integer
Return Value an ItemStack

PlayerAPI.getPos

Inherited from LivingEntityAPI

Example by JimmyHelp:
Gets the position of the entity in the world
If delta is passed in,
then it will be used to linearly interpolate the position of the entity between the previous tick and the current tick
The default value of delta is 1
overload 1:
player:getPos()
Method Property Fluent Description Representation
Return Value a Vector3
overload 2:
player:getPos(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Vector3

PlayerAPI.getNbt

Inherited from LivingEntityAPI

Gets a table containing the NBT of this entity
Please note that not all values in the entity's NBT may be synced,
as some are handled only on the server side
overload 1:
player:getNbt()
Method Property Fluent Description Representation
Return Value a table

PlayerAPI.getRot

Inherited from LivingEntityAPI

Example by JimmyHelp:
Gets the rotation of the entity in degrees
If delta is passed in,
then it will be used to linearly interpolate the rotation of the entity between the previous tick and the current tick
The default value of delta is 1
overload 1:
player:getRot()
Method Property Fluent Description Representation
Return Value a Vector2
overload 2:
player:getRot(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Vector2

PlayerAPI.isOnGround

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns whether or not this entity is currently on the ground
overload 1:
player:isOnGround()
Method Property Fluent Description Representation
Return Value a Boolean

PlayerAPI.getUUID

Inherited from LivingEntityAPI

Gets the UUID of the proxied entity
overload 1:
player:getUUID()
Method Property Fluent Description Representation
Return Value a String

PlayerAPI.getEyeHeight

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns the current eye height of this entity
overload 1:
player:getEyeHeight()
Method Property Fluent Description Representation
Return Value a Number

PlayerAPI.getPose

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns the current pose of the player
This can be one of: "STANDING",
"FALL_FLYING", "SLEEPING", "SWIMMING", "SPIN_ATTACK", "CROUCHING", "LONG_JUMPING", or "DYING"
overload 1:
player:getPose()
Method Property Fluent Description Representation
Return Value a String

PlayerAPI.getBoundingBox

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns the size of this entity's bounding box as a Vector3
{x,
y, z} are the width, height, and width
Minecraft entity hitboxes always have square bases
overload 1:
player:getBoundingBox()
Method Property Fluent Description Representation
Return Value a Vector3

PlayerAPI.isHamburger

Inherited from LivingEntityAPI

Example by JimmyHelp:
figura.docs.entity.is_hamburger
overload 1:
player:isHamburger()
Method Property Fluent Description Representation
Return Value a Boolean

PlayerAPI.getLookDir

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns a unit vector pointing in the direction that this entity is looking
See the blue line in the F3+B screen for an example
overload 1:
player:getLookDir()
Method Property Fluent Description Representation
Return Value a Vector3

PlayerAPI.getFrozenTicks

Inherited from LivingEntityAPI

Example by JimmyHelp:
Gets the number of ticks this entity has been freezing in powder snow for
overload 1:
player:getFrozenTicks()
Method Property Fluent Description Representation
Return Value an Integer

PlayerAPI.getMaxAir

Inherited from LivingEntityAPI

Example by JimmyHelp:
Gets the maximum amount of air this entity can have
overload 1:
player:getMaxAir()
Method Property Fluent Description Representation
Return Value an Integer

PlayerAPI.getFireTicks

Inherited from LivingEntityAPI

figura.docs.entity.get_fire_ticks
overload 1:
player:getFireTicks()
Method Property Fluent Description Representation
Return Value an Integer

PlayerAPI.getDimensionName

Inherited from LivingEntityAPI

Gets the Minecraft identifier of the dimension this entity is in
overload 1:
player:getDimensionName()
Method Property Fluent Description Representation
Return Value a String

PlayerAPI.getVehicle

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns a proxy for the entity that this player is currently riding
If the player isn't riding anything,
returns nil
overload 1:
player:getVehicle()
Method Property Fluent Description Representation
Return Value an EntityAPI

PlayerAPI.getVelocity

Inherited from LivingEntityAPI

Example by JimmyHelp:
Gets the current velocity of this entity in world coordinates, calculated as its position this tick minus its position last tick
overload 1:
player:getVelocity()
Method Property Fluent Description Representation
Return Value a Vector3

PlayerAPI.getAir

Inherited from LivingEntityAPI

Example by JimmyHelp:
figura.docs.entity.get_air
overload 1:
player:getAir()
Method Property Fluent Description Representation
Return Value an Integer

PlayerAPI.getTargetedBlock

Inherited from LivingEntityAPI

Returns a proxy for your currently targeted BlockState
This BlockState appears on the F3 screen
The maximum (and default) distance is 20,
minimum is -20
Returns the block, the hit position,
and the targeted block face as three separate values
overload 1:
player:getTargetedBlock()
Method Property Fluent Description Representation
Return Value a BlockState
overload 2:
player:getTargetedBlock(ignoreLiquids)
Method Property Fluent Description Representation
ignoreLiquids accepts a Boolean
Return Value a BlockState
overload 3:
player:getTargetedBlock(ignoreLiquids, distance)
Method Property Fluent Description Representation
ignoreLiquids accepts a Boolean
distance accepts a Number
Return Value a BlockState

PlayerAPI.isInWater

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns true if this entity is currently in a water block, including waterlogging
overload 1:
player:isInWater()
Method Property Fluent Description Representation
Return Value a Boolean

PlayerAPI.isInRain

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns true if this entity is currently standing in rain
overload 1:
player:isInRain()
Method Property Fluent Description Representation
Return Value a Boolean

PlayerAPI.isInvisible

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns true if this entity is invisible, for one reason or another
overload 1:
player:isInvisible()
Method Property Fluent Description Representation
Return Value a Boolean

PlayerAPI.hasAvatar

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns true if Figura has an avatar loaded for this entity
overload 1:
player:hasAvatar()
Method Property Fluent Description Representation
Return Value a Boolean

PlayerAPI.isGlowing

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns true if this entity is currently glowing
overload 1:
player:isGlowing()
Method Property Fluent Description Representation
Return Value a Boolean

PlayerAPI.isUnderwater

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns true if this entity's eyes are touching water
overload 1:
player:isUnderwater()
Method Property Fluent Description Representation
Return Value a Boolean

PlayerAPI.isWet

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns true in any of three conditions: if the entity is in water, if the entity is in rain, or if the entity is in a bubble column
Otherwise,
returns false
overload 1:
player:isWet()
Method Property Fluent Description Representation
Return Value a Boolean

PlayerAPI.getEyeY

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns the Y level of this entity's eyes
Not to be confused with getEyeHeight,
this function also takes the entity itself's Y position into account
overload 1:
player:getEyeY()
Method Property Fluent Description Representation
Return Value a Number

PlayerAPI.isSilent

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns true if this entity is silent
overload 1:
player:isSilent()
Method Property Fluent Description Representation
Return Value a Boolean

PlayerAPI.isSneaking

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns true if this entity is logically sneaking (can't fall from blocks edges, can't see nameplate behind walls, etc)
overload 1:
player:isSneaking()
Method Property Fluent Description Representation
Return Value a Boolean

PlayerAPI.isSprinting

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns true if this entity is currently sprinting
overload 1:
player:isSprinting()
Method Property Fluent Description Representation
Return Value a Boolean

PlayerAPI.isOnFire

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns true if this entity is currently on fire
overload 1:
player:isOnFire()
Method Property Fluent Description Representation
Return Value a Boolean

PlayerAPI.isInLava

Inherited from LivingEntityAPI

Example by JimmyHelp:
Returns true if this entity is currently in lava
overload 1:
player:isInLava()
Method Property Fluent Description Representation
Return Value a Boolean

PlayerAPI.getVariable

Inherited from LivingEntityAPI

Gets the value of a variable this entity stored in themselves using the Avatar API's store() function
overload 1:
player:getVariable(key)
Method Property Fluent Description Representation
key accepts a String
Return Value anything

renderer

The global instance of RendererAPI
field signature:
renderer
Method Property Fluent Description Representation
Field Type a RendererAPI

RendererAPI.setCameraPivot

Sets the absolute pivot for the camera
The pivot will also move the camera
Its values are relative to the World
Nil values for pivot are assumed to be 0
For relative rotation values,
check out the "offset" pivot function
overload 1:
renderer:setCameraPivot(pivot)
Method Property Fluent Description Representation
pivot accepts a Vector3
Return Value nil
overload 2:
renderer:setCameraPivot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

RendererAPI.setCameraPos

Sets the position offset for the camera
Nil values for position are assumed to be 0
overload 1:
renderer:setCameraPos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value nil
overload 2:
renderer:setCameraPos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

RendererAPI.setShadowRadius

Sets the radius of your shadow
The default value is nil,
which means to use the vanilla default of 0.5 for players
The maximum value is 12
overload 1:
renderer:setShadowRadius()
Method Property Fluent Description Representation
Return Value nil
overload 2:
renderer:setShadowRadius(radius)
Method Property Fluent Description Representation
radius accepts a Number
Return Value nil

RendererAPI.offsetCameraPivot

figura.docs.renderer.offset_camera_pivot
overload 1:
renderer:offsetCameraPivot(pivot)
Method Property Fluent Description Representation
pivot accepts a Vector3
Return Value nil
overload 2:
renderer:offsetCameraPivot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

RendererAPI.setCameraRot

Sets the absolute rotation of the camera
The position is not taken into account for roll
Nil values for rotation are assumed to be 0
For relative rotation values,
check out the "offset" rot function
overload 1:
renderer:setCameraRot(rot)
Method Property Fluent Description Representation
rot accepts a Vector3
Return Value nil
overload 2:
renderer:setCameraRot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

RendererAPI.offsetCameraRot

figura.docs.renderer.offset_camera_rot
overload 1:
renderer:offsetCameraRot(rot)
Method Property Fluent Description Representation
rot accepts a Vector3
Return Value nil
overload 2:
renderer:offsetCameraRot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

RendererAPI.getShadowRadius

Gets the radius of your shadow
overload 1:
renderer:getShadowRadius()
Method Property Fluent Description Representation
Return Value a Number

RendererAPI.isCameraBackwards

Checks if your camera is in the backward third person view
overload 1:
renderer:isCameraBackwards()
Method Property Fluent Description Representation
Return Value a Boolean

RendererAPI.isFirstPerson

Checks if your camera is in the first person view
overload 1:
renderer:isFirstPerson()
Method Property Fluent Description Representation
Return Value a Boolean

RendererAPI.setPostEffect

Sets the current rendering effect
Same as the discontinued Super Secret Settings
overload 1:
renderer:setPostEffect(effect)
Method Property Fluent Description Representation
effect accepts a String
Return Value nil

RendererAPI.renderFire

Whether or not you should visually have the fire effect while on fire
True by default
field signature:
renderFire
Method Property Fluent Description Representation
Field Type a Boolean

RendererAPI.renderVehicle

Whether or not your vehicle (boat, minecart, horse, whatever) will be rendered
True by default
field signature:
renderVehicle
Method Property Fluent Description Representation
Field Type a Boolean

sounds

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

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 nil
overload 2:
sounds:stopSound(id)
Method Property Fluent Description Representation
id accepts a String
Return Value nil

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 nil
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 nil
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 nil
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 nil

SoundAPI.addSound

figura.docs.sounds.add_sound
overload 1:
sounds:addSound(name, byteArray)
Method Property Fluent Description Representation
name accepts a String
byteArray accepts a table
Return Value nil
overload 2:
sounds:addSound(name, base64Text)
Method Property Fluent Description Representation
name accepts a String
base64Text accepts a String
Return Value nil

type

Figura overrides lua's type() function
When used on Figura types,
returns the type's name as seen in the docs and in the figuraMetatables global
When called on a table that has a metatable with a __type key,
returns the corresponding value
field signature:
type
Method Property Fluent Description Representation
Field Type a function that takes anything and will return a String

user

An alias for player, just in case the user of your avatar isn't a player
(Foreshadowing?)
field signature:
user
Method Property Fluent Description Representation
Field Type an EntityAPI

EntityAPI.getName

Gets the name of this entity, if it has a custom name
If it doesn't,
returns a translated form of getType()
overload 1:
user:getName()
Method Property Fluent Description Representation
Return Value a String

EntityAPI.getType

Gets the Minecraft identifier of this entity
For instance,
"minecraft:pig"
overload 1:
user:getType()
Method Property Fluent Description Representation
Return Value a String

EntityAPI.isLoaded

Checks if this entity object is still being updated and loaded
A non-loaded entity would be someone or something which is in another dimension or out of the render distance for example
overload 1:
user:isLoaded()
Method Property Fluent Description Representation
Return Value a Boolean

EntityAPI.getItem

Gets an ItemStack for the item in the given slot
For the player,
slots are indexed with 1 as the main hand, 2 as the off hand, and 3,4,5,6 as the 4 armor slots from the boots to the helmet
If an invalid slot number is given,
this will return nil
overload 1:
user:getItem(index)
Method Property Fluent Description Representation
index accepts an Integer
Return Value either an ItemStack or nil

EntityAPI.getPos

Gets the position of the entity in the world
If delta is passed in,
then it will be used to linearly interpolate the position of the entity between the previous tick and the current tick
The default value of delta is 1
overload 1:
user:getPos()
Method Property Fluent Description Representation
Return Value a Vector3
overload 2:
user:getPos(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Vector3

EntityAPI.getNbt

Gets a table containing the NBT of this entity
Please note that not all values in the entity's NBT may be synced,
as some are handled only on the server side
overload 1:
user:getNbt()
Method Property Fluent Description Representation
Return Value a table

EntityAPI.getRot

Gets the rotation of the entity in degrees
If delta is passed in,
then it will be used to linearly interpolate the rotation of the entity between the previous tick and the current tick
The default value of delta is 1
overload 1:
user:getRot()
Method Property Fluent Description Representation
Return Value a Vector2
overload 2:
user:getRot(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Vector2

EntityAPI.isOnGround

Returns whether or not this entity is currently on the ground
overload 1:
user:isOnGround()
Method Property Fluent Description Representation
Return Value a Boolean

EntityAPI.getUUID

Gets the UUID of the proxied entity
overload 1:
user:getUUID()
Method Property Fluent Description Representation
Return Value a String

EntityAPI.getEyeHeight

Returns the current eye height of this entity
overload 1:
user:getEyeHeight()
Method Property Fluent Description Representation
Return Value a Number

EntityAPI.getPose

Returns the current pose of the player
This can be one of: "STANDING",
"FALL_FLYING", "SLEEPING", "SWIMMING", "SPIN_ATTACK", "CROUCHING", "LONG_JUMPING", or "DYING"
overload 1:
user:getPose()
Method Property Fluent Description Representation
Return Value a String

EntityAPI.getBoundingBox

Returns the size of this entity's bounding box as a Vector3
{x,
y, z} are the width, height, and width
Minecraft entity hitboxes always have square bases
overload 1:
user:getBoundingBox()
Method Property Fluent Description Representation
Return Value a Vector3

EntityAPI.isHamburger

figura.docs.entity.is_hamburger
overload 1:
user:isHamburger()
Method Property Fluent Description Representation
Return Value a Boolean

EntityAPI.getLookDir

Returns a unit vector pointing in the direction that this entity is looking
See the blue line in the F3+B screen for an example
overload 1:
user:getLookDir()
Method Property Fluent Description Representation
Return Value a Vector3

EntityAPI.getFrozenTicks

Gets the number of ticks this entity has been freezing in powder snow for
overload 1:
user:getFrozenTicks()
Method Property Fluent Description Representation
Return Value an Integer

EntityAPI.getMaxAir

Gets the maximum amount of air this entity can have
overload 1:
user:getMaxAir()
Method Property Fluent Description Representation
Return Value an Integer

EntityAPI.getFireTicks

figura.docs.entity.get_fire_ticks
overload 1:
user:getFireTicks()
Method Property Fluent Description Representation
Return Value an Integer

EntityAPI.getDimensionName

Gets the Minecraft identifier of the dimension this entity is in
overload 1:
user:getDimensionName()
Method Property Fluent Description Representation
Return Value a String

EntityAPI.getVehicle

Returns a proxy for the entity that this player is currently riding
If the player isn't riding anything,
returns nil
overload 1:
user:getVehicle()
Method Property Fluent Description Representation
Return Value either an EntityAPI or nil

EntityAPI.getVelocity

Gets the current velocity of this entity in world coordinates, calculated as its position this tick minus its position last tick
overload 1:
user:getVelocity()
Method Property Fluent Description Representation
Return Value a Vector3

EntityAPI.getAir

figura.docs.entity.get_air
overload 1:
user:getAir()
Method Property Fluent Description Representation
Return Value an Integer

EntityAPI.getTargetedBlock

Returns a proxy for your currently targeted BlockState
This BlockState appears on the F3 screen
The maximum (and default) distance is 20,
minimum is -20
Returns the block, the hit position,
and the targeted block face as three separate values
overload 1:
user:getTargetedBlock()
Method Property Fluent Description Representation
Return Value a BlockState
overload 2:
user:getTargetedBlock(ignoreLiquids)
Method Property Fluent Description Representation
ignoreLiquids accepts a Boolean
Return Value a BlockState
overload 3:
user:getTargetedBlock(ignoreLiquids, distance)
Method Property Fluent Description Representation
ignoreLiquids accepts a Boolean
distance accepts a Number
Return Value a BlockState

EntityAPI.isInWater

Returns true if this entity is currently in a water block, including waterlogging
overload 1:
user:isInWater()
Method Property Fluent Description Representation
Return Value a Boolean

EntityAPI.isInRain

Returns true if this entity is currently standing in rain
overload 1:
user:isInRain()
Method Property Fluent Description Representation
Return Value a Boolean

EntityAPI.isInvisible

Returns true if this entity is invisible, for one reason or another
overload 1:
user:isInvisible()
Method Property Fluent Description Representation
Return Value a Boolean

EntityAPI.hasAvatar

Returns true if Figura has an avatar loaded for this entity
overload 1:
user:hasAvatar()
Method Property Fluent Description Representation
Return Value a Boolean

EntityAPI.isGlowing

Returns true if this entity is currently glowing
overload 1:
user:isGlowing()
Method Property Fluent Description Representation
Return Value a Boolean

EntityAPI.isUnderwater

Returns true if this entity's eyes are touching water
overload 1:
user:isUnderwater()
Method Property Fluent Description Representation
Return Value a Boolean

EntityAPI.isWet

Returns true in any of three conditions: if the entity is in water, if the entity is in rain, or if the entity is in a bubble column
Otherwise,
returns false
overload 1:
user:isWet()
Method Property Fluent Description Representation
Return Value a Boolean

EntityAPI.getEyeY

Returns the Y level of this entity's eyes
Not to be confused with getEyeHeight,
this function also takes the entity itself's Y position into account
overload 1:
user:getEyeY()
Method Property Fluent Description Representation
Return Value a Number

EntityAPI.isSilent

Returns true if this entity is silent
overload 1:
user:isSilent()
Method Property Fluent Description Representation
Return Value a Boolean

EntityAPI.isSneaking

Returns true if this entity is logically sneaking (can't fall from blocks edges, can't see nameplate behind walls, etc)
overload 1:
user:isSneaking()
Method Property Fluent Description Representation
Return Value a Boolean

EntityAPI.isSprinting

Returns true if this entity is currently sprinting
overload 1:
user:isSprinting()
Method Property Fluent Description Representation
Return Value a Boolean

EntityAPI.isOnFire

Returns true if this entity is currently on fire
overload 1:
user:isOnFire()
Method Property Fluent Description Representation
Return Value a Boolean

EntityAPI.isInLava

Returns true if this entity is currently in lava
overload 1:
user:isInLava()
Method Property Fluent Description Representation
Return Value a Boolean

EntityAPI.getVariable

Gets the value of a variable this entity stored in themselves using the Avatar API's store() function
overload 1:
user:getVariable(key)
Method Property Fluent Description Representation
key accepts a String
Return Value anything

vanilla_model

The global instance of the VanillaModelAPI and its subtypes
field signature:
vanilla_model
Method Property Fluent Description Representation
Field Type a VanillaModelAPI

VanillaModelAPI.HEAD

The head of the player, not including the hat
field signature:
HEAD
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.BODY

The body of the player, not including the outer layer
field signature:
BODY
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.LEFT_ARM

The left arm of the player, not including the outer layer
field signature:
LEFT_ARM
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.RIGHT_ARM

The right arm of the player, not including the outer layer
field signature:
RIGHT_ARM
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.LEFT_LEG

The left leg of the player, not including the outer layer
field signature:
LEFT_LEG
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.RIGHT_LEG

The right leg of the player, not including the outer layer
field signature:
RIGHT_LEG
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.HAT

The outer layer of the player's head
field signature:
HAT
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.JACKET

The outer layer of the player's body
field signature:
JACKET
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.LEFT_SLEEVE

The outer layer of the player's left arm
field signature:
LEFT_SLEEVE
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.RIGHT_SLEEVE

The outer layer of the player's right arm
field signature:
RIGHT_SLEEVE
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.LEFT_PANTS

The outer layer of the player's left leg
field signature:
LEFT_PANTS
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.RIGHT_PANTS

The outer layer of the player's right leg
field signature:
RIGHT_PANTS
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.CAPE_MODEL

The vanilla cape model
field signature:
CAPE_MODEL
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.FAKE_CAPE

A custom copy of the cape, an attempt at storing its transformations as vanilla cape math is… weird
field signature:
FAKE_CAPE
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.HELMET_ITEM

The item on the armor head slot
field signature:
HELMET_ITEM
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.HELMET_HEAD

The head of the helmet model
field signature:
HELMET_HEAD
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.HELMET_HAT

The hat of the helmet model
field signature:
HELMET_HAT
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.CHESTPLATE_BODY

The body of the chestplate model
field signature:
CHESTPLATE_BODY
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.CHESTPLATE_LEFT_ARM

The left arm of the chestplate model
field signature:
CHESTPLATE_LEFT_ARM
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.CHESTPLATE_RIGHT_ARM

The right arm of the chestplate model
field signature:
CHESTPLATE_RIGHT_ARM
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.LEGGINGS_BODY

The body of the leggings model
field signature:
LEGGINGS_BODY
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.LEGGINGS_LEFT_LEG

The left leg of the leggings model
field signature:
LEGGINGS_LEFT_LEG
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.LEGGINGS_RIGHT_LEG

The right leg of the leggings model
field signature:
LEGGINGS_RIGHT_LEG
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.BOOTS_LEFT_LEG

The left boot of the boots model
field signature:
BOOTS_LEFT_LEG
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.BOOTS_RIGHT_LEG

The right boot of the boots model
field signature:
BOOTS_RIGHT_LEG
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.LEFT_ELYTRA

The left wing of the elytra model
field signature:
LEFT_ELYTRA
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.RIGHT_ELYTRA

The right wing of the elytra model
field signature:
RIGHT_ELYTRA
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.LEFT_ITEM

The item in the player's left hand
field signature:
LEFT_ITEM
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.RIGHT_ITEM

The item in the player's right hand
field signature:
RIGHT_ITEM
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.LEFT_PARROT

The Parrot in the player's left shoulder
field signature:
LEFT_PARROT
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.RIGHT_PARROT

The Parrot in the player's right shoulder
field signature:
RIGHT_PARROT
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.ALL

Multi-part: The entirety of the vanilla model
field signature:
ALL
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.PLAYER

Multi-part: Both the outer and inner layers of the player's skin, as well as the cape
field signature:
PLAYER
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.OUTER_LAYER

Multi-part: The outer layer of the player
field signature:
OUTER_LAYER
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.INNER_LAYER

Multi-part: The main body of the player, everything except the outer layer
field signature:
INNER_LAYER
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.CAPE

Multi-part: The player's cape
field signature:
CAPE
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.ARMOR

Multi-part: All armor on the model
field signature:
ARMOR
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.HELMET

Multi-part: The helmet model
field signature:
HELMET
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.CHESTPLATE

Multi-part: The chestplate model
field signature:
CHESTPLATE
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.LEGGINGS

Multi-part: The leggings model
field signature:
LEGGINGS
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.BOOTS

Multi-part: The boots model
field signature:
BOOTS
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.ELYTRA

Multi-part: The elytra model
field signature:
ELYTRA
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.HELD_ITEMS

Multi-part: Items in the player's hands
field signature:
HELD_ITEMS
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.PARROTS

Multi-part: Parrots on the player's shoulders
field signature:
PARROTS
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

vec

An alias for "vectors.vec"
field signature:
vec
Method Property Fluent Description Representation
Field Type a function that takes a Number, a Number, either a Number or nil, either a Number or nil, either a Number or nil and either a Number or nil and will return anything, such that supplying a Number and a Number would return a Vector2, supplying a Number, a Number and a Number would return a Vector3, supplying a Number, a Number, a Number and a Number would return a Vector4, supplying a Number, a Number, a Number, a Number and a Number would return a Vector5, supplying a Number, a Number, a Number, a Number, a Number and a Number would return a Vector6

vectors

The global instance of the VectorsAPI and its subtypes
field signature:
vectors
Method Property Fluent Description Representation
Field Type a VectorsAPI

VectorsAPI.vec

Creates and returns a vector of the appropriate size to hold the arguments passed in
For example; if you call vec(3,
4, 0, 2), then the function will return a Vector4 containing those values
There is a global alias "vec" for this function,
meaning the "vectors." can be omitted
overload 1:
vectors.vec(x, y)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
Return Value a Vector2
overload 2:
vectors.vec(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Vector3
overload 3:
vectors.vec(x, y, z, w)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
Return Value a Vector4
overload 4:
vectors.vec(x, y, z, w, t)
typings.2002444082
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
Return Value
overload 5:
vectors.vec(x, y, z, w, t, h)
typings.2002444083
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
h accepts a Number
Return Value

VectorsAPI.intToRGB

Converts the given color from Integer format to RGB format
overload 1:
vectors.intToRGB(color)
Method Property Fluent Description Representation
color accepts an Integer
Return Value a Vector3

VectorsAPI.hsvToRGB

Converts the given color from HSV format to RGB format
overload 1:
vectors.hsvToRGB(hsv)
Method Property Fluent Description Representation
hsv accepts a Vector3
Return Value a Vector3
overload 2:
vectors.hsvToRGB(h, s, v)
Method Property Fluent Description Representation
h accepts a Number
s accepts a Number
v accepts a Number
Return Value a Vector3

VectorsAPI.rgbToInt

Converts the given color from RGB format to Integer format
overload 1:
vectors.rgbToInt(rgb)
Method Property Fluent Description Representation
rgb accepts a Vector3
Return Value an Integer
overload 2:
vectors.rgbToInt(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an Integer

VectorsAPI.rgbToHSV

Converts the given color from RGB format to HSV format
overload 1:
vectors.rgbToHSV(rgb)
Method Property Fluent Description Representation
rgb accepts a Vector3
Return Value a Vector3
overload 2:
vectors.rgbToHSV(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value a Vector3

VectorsAPI.rainbow

figura.docs.vectors.rainbow
overload 1:
vectors.rainbow(speed)
Method Property Fluent Description Representation
speed accepts a Number
Return Value a Vector3
overload 2:
vectors.rainbow(speed, offset)
Method Property Fluent Description Representation
speed accepts a Number
offset accepts a Number
Return Value a Vector3
overload 3:
vectors.rainbow(speed, offset, saturation, light)
Method Property Fluent Description Representation
speed accepts a Number
offset accepts a Number
saturation accepts a Number
light accepts a Number
Return Value a Vector3

VectorsAPI.rgbToHex

Converts the given color from RGB format to Hex format
The "#" is not included on the return value
overload 1:
vectors.rgbToHex(rgb)
Method Property Fluent Description Representation
rgb accepts a Vector3
Return Value a String
overload 2:
vectors.rgbToHex(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value a String

VectorsAPI.toCameraSpace

Converts a position in the world into a position relative to the viewer's camera
overload 1:
vectors.toCameraSpace(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Vector3
overload 2:
vectors.toCameraSpace(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Vector3

VectorsAPI.hexToRGB

Parses a Hex string color into an RGB format vector
The hex "#" is optional,
and it can have any length, however only the first 6 hex digits are evaluated, short hex (length 3) is also supported
For example,
"#42" is the same as "420000", and "F0B" is the same as "FF00BB"
overload 1:
vectors.hexToRGB(hex)
Method Property Fluent Description Representation
hex accepts a String
Return Value a Vector3

VectorsAPI.vec6

figura.docs.vectors.vec6
overload 1:
vectors.vec6(x, y, z, w, t, h)
typings.2002444083
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
h accepts a Number
Return Value

VectorsAPI.vec4

Creates and returns a Vector4 with the given values
Nil values become zero
overload 1:
vectors.vec4(x, y, z, w)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
Return Value a Vector4

VectorsAPI.vec5

figura.docs.vectors.vec5
overload 1:
vectors.vec5(x, y, z, w, t)
typings.2002444082
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
Return Value

VectorsAPI.rotateAroundAxis

Rotates a vector relative to a rotation vector
overload 1:
vectors.rotateAroundAxis(angle, vec, axis)
Method Property Fluent Description Representation
angle accepts a Number
vec accepts a Vector3
axis accepts a Vector3
Return Value a Vector3
overload 2:
vectors.rotateAroundAxis(angle, x, y, z, axis)
Method Property Fluent Description Representation
angle accepts a Number
x accepts a Number
y accepts a Number
z accepts a Number
axis accepts a Vector3
Return Value a Vector3
overload 3:
vectors.rotateAroundAxis(angle, vec, axisX, axisY, axisZ)
Method Property Fluent Description Representation
angle accepts a Number
vec accepts a Vector3
axisX accepts a Number
axisY accepts a Number
axisZ accepts a Number
Return Value a Vector3
overload 4:
vectors.rotateAroundAxis(angle, x, y, z, axisX, axisY, axisZ)
Method Property Fluent Description Representation
angle accepts a Number
x accepts a Number
y accepts a Number
z accepts a Number
axisX accepts a Number
axisY accepts a Number
axisZ accepts a Number
Return Value a Vector3

VectorsAPI.worldToScreenSpace

Converts a position in the world into a position relative to the viewer's screen
overload 1:
vectors.worldToScreenSpace(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Vector4
overload 2:
vectors.worldToScreenSpace(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Vector4

VectorsAPI.vec3

Creates and returns a Vector3 with the given values
Nil values become zero
overload 1:
vectors.vec3(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Vector3

VectorsAPI.vec2

Creates and returns a Vector2 with the given values
Nil values become zero
overload 1:
vectors.vec2(x, y)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
Return Value a Vector2

world

The global instance of the WorldAPI and its subtypes
field signature:
world
Method Property Fluent Description Representation
Field Type a WorldAPI

WorldAPI.exists

Checks whether or not a world currently exists
This will almost always be true,
but might be false on some occasions such as while traveling between dimensions
overload 1:
world.exists()
Method Property Fluent Description Representation
Return Value a Boolean

WorldAPI.getTime

Gets the current game time of the world
If delta is passed in,
then it adds delta to the time
The default value of delta is zero
overload 1:
world.getTime()
Method Property Fluent Description Representation
Return Value a Number
overload 2:
world.getTime(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Number

WorldAPI.getTimeOfDay

Gets the current day time of the world
If delta is passed in,
then it adds delta to the time
The default value of delta is zero
overload 1:
world.getTimeOfDay()
Method Property Fluent Description Representation
Return Value a Number
overload 2:
world.getTimeOfDay(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Number

WorldAPI.getEntity

Returns an EntityAPI object from this UUID's entity, or nil if no entity was found
overload 1:
world.getEntity(UUID)
Method Property Fluent Description Representation
UUID accepts a String
Return Value either an EntityAPI or nil

WorldAPI.getRedstonePower

Gets the redstone power level of the block at the given position
overload 1:
world.getRedstonePower(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value an Integer
overload 2:
world.getRedstonePower(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value an Integer

WorldAPI.getRainGradient

Gets the current rain gradient in the world, interpolated from the previous tick to the current one
The default value of delta is 1,
which is the current tick
overload 1:
world.getRainGradient()
Method Property Fluent Description Representation
Return Value a Number
overload 2:
world.getRainGradient(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Number

WorldAPI.isThundering

Gets whether or not there is currently thunder/lightning happening in the world
overload 1:
world.isThundering()
Method Property Fluent Description Representation
Return Value a Boolean

WorldAPI.getBlockState

figura.docs.world.get_blockstate
overload 1:
world.getBlockState(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value a BlockState
overload 2:
world.getBlockState(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a BlockState

WorldAPI.getMoonPhase

Gets the current moon phase of the world, stored as an integer
overload 1:
world.getMoonPhase()
Method Property Fluent Description Representation
Return Value an Integer

WorldAPI.getBlockLightLevel

Gets the block light level of the block at the given position
overload 1:
world.getBlockLightLevel(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value an Integer
overload 2:
world.getBlockLightLevel(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value an Integer

WorldAPI.getBiome

Gets the Biome located at the given position
overload 1:
world.getBiome(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value a Biome
overload 2:
world.getBiome(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Biome

WorldAPI.isOpenSky

Gets whether or not the sky is open at the given position
overload 1:
world.isOpenSky(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value a Boolean
overload 2:
world.isOpenSky(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Boolean

WorldAPI.getLightLevel

Gets the overall light level of the block at the given position
overload 1:
world.getLightLevel(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value an Integer
overload 2:
world.getLightLevel(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value an Integer

WorldAPI.getSkyLightLevel

Gets the skylight level of the block at the given position
overload 1:
world.getSkyLightLevel(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value an Integer
overload 2:
world.getSkyLightLevel(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value an Integer

WorldAPI.playerVars

figura.docs.world.player_vars
overload 1:
world.playerVars()
Method Property Fluent Description Representation
Return Value a table

WorldAPI.getPlayers

Returns a table containing instances of Player for all players in the world
The players are indexed by their names
overload 1:
world.getPlayers()
Method Property Fluent Description Representation
Return Value a table mapping a String to a PlayerAPI

WorldAPI.getStrongRedstonePower

Gets the direct redstone power level of the block at the given position
overload 1:
world.getStrongRedstonePower(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value an Integer
overload 2:
world.getStrongRedstonePower(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value an Integer

Action

An action in the Figura Action Wheel
Actions are either interacted by clicking and scrolling,
which also being able to be toggleable

Action.color

figura.docs.wheel_action.color
overload 1:
Action:color(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an Action
overload 2:
Action:color(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an Action

Action.item

figura.docs.wheel_action.item
overload 1:
Action:item(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value an Action
overload 2:
Action:item(item)
Method Property Fluent Description Representation
item accepts a String
Return Value an Action

Action.title

figura.docs.wheel_action.title
overload 1:
Action:title()
Method Property Fluent Description Representation
Return Value an Action
overload 2:
Action:title(title)
Method Property Fluent Description Representation
title accepts a String
Return Value an Action

Action.hoverItem

figura.docs.wheel_action.hover_item
overload 1:
Action:hoverItem(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value an Action
overload 2:
Action:hoverItem(item)
Method Property Fluent Description Representation
item accepts a String
Return Value an Action

Action.hoverColor

figura.docs.wheel_action.hover_color
overload 1:
Action:hoverColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an Action
overload 2:
Action:hoverColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an Action

Animation

A Blockbench animation

Animation.priority

figura.docs.animation.priority
overload 1:
Animation:priority(priority)
Method Property Fluent Description Representation
priority accepts an Integer
Return Value an Animation

Animation.length

figura.docs.animation.length
overload 1:
Animation:length(length)
Method Property Fluent Description Representation
length accepts a Number
Return Value an Animation

Animation.blend

figura.docs.animation.blend
overload 1:
Animation:blend(blend)
Method Property Fluent Description Representation
blend accepts a Number
Return Value an Animation

Animation.offset

figura.docs.animation.offset
overload 1:
Animation:offset(offset)
Method Property Fluent Description Representation
offset accepts a Number
Return Value an Animation

Animation.stop

Stop the animation
overload 1:
Animation:stop()
Method Property Fluent Description Representation
Return Value nil

Animation.override

figura.docs.animation.override
overload 1:
Animation:override(override)
Method Property Fluent Description Representation
override accepts a Boolean
Return Value an Animation

Animation.loop

figura.docs.animation.loop
overload 1:
Animation:loop(loop)
Method Property Fluent Description Representation
loop accepts a String
Return Value an Animation

Animation.getTime

Get the animation's playback current time
overload 1:
Animation:getTime()
Method Property Fluent Description Representation
Return Value a Number

Animation.setTime

Sets the animation's playback current time
overload 1:
Animation:setTime(time)
Method Property Fluent Description Representation
time accepts a Number
Return Value nil

Animation.speed

figura.docs.animation.speed
overload 1:
Animation:speed(speed)
Method Property Fluent Description Representation
speed accepts a Number
Return Value an Animation

Animation.startDelay

figura.docs.animation.start_delay
overload 1:
Animation:startDelay(delay)
Method Property Fluent Description Representation
delay accepts a Number
Return Value an Animation

Animation.loopDelay

figura.docs.animation.loop_delay
overload 1:
Animation:loopDelay(delay)
Method Property Fluent Description Representation
delay accepts a Number
Return Value an Animation

Animation.addCode

figura.docs.animation.add_code
overload 1:
Animation:addCode(time, code)
Method Property Fluent Description Representation
time accepts a Number
code accepts a String
Return Value an Animation

Animation.pause

Pause the animation's playback
overload 1:
Animation:pause()
Method Property Fluent Description Representation
Return Value nil

Animation.getPlayState

Get the animation's playback state
overload 1:
Animation:getPlayState()
Method Property Fluent Description Representation
Return Value a String

Animation.restart

Restarts the animation
Plays the animation if it was stopped
This behavior can also be reproduced by stopping then playing the animation
overload 1:
Animation:restart()
Method Property Fluent Description Representation
Return Value nil

Animation.play

Example by JimmyHelp:
animations.bbmodelName.animationName:play()
Initializes the animation
Resume the animation if it was paused
overload 1:
Animation:play()
Method Property Fluent Description Representation
Return Value nil

Animation.name

This animation's name
field signature:
name
Method Property Fluent Description Representation
Field Type a String

Biome

A proxy for a Minecraft biome
Instances are obtained through the WorldAPI
This proxy also contains a saved position for the Biome

Biome.getName

figura.docs.biome.get_name
overload 1:
Biome:getName()
Method Property Fluent Description Representation
Return Value a String

Biome.setPos

Sets the saved position for this Biome's proxy
The saved position is used in Biome functions that require a position
overload 1:
Biome:setPos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value nil
overload 2:
Biome:setPos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

Biome.getPos

Returns the saved position for this Biome's proxy
The saved position is used in Biome functions that require a position
overload 1:
Biome:getPos()
Method Property Fluent Description Representation
Return Value a Vector3

Biome.getPrecipitation

Gets the rain type of this biome
The type can be "NONE",
"RAIN" or "SNOW"
overload 1:
Biome:getPrecipitation()
Method Property Fluent Description Representation
Return Value a String

Biome.getWaterColor

Gets this biome's water color as an RGB vector
overload 1:
Biome:getWaterColor()
Method Property Fluent Description Representation
Return Value a Vector3

Biome.getWaterFogColor

Gets this biome's water fog color as an RGB vector
overload 1:
Biome:getWaterFogColor()
Method Property Fluent Description Representation
Return Value a Vector3

Biome.getSkyColor

Gets this biome's sky color as an RGB vector
overload 1:
Biome:getSkyColor()
Method Property Fluent Description Representation
Return Value a Vector3

Biome.getFoliageColor

Gets this biome's foliage color as an RGB vector
overload 1:
Biome:getFoliageColor()
Method Property Fluent Description Representation
Return Value a Vector3

Biome.getTemperature

Gets the temperature of this biome
overload 1:
Biome:getTemperature()
Method Property Fluent Description Representation
Return Value a Number

Biome.getGrassColor

Gets this biome's grass color as an RGB vector
overload 1:
Biome:getGrassColor()
Method Property Fluent Description Representation
Return Value a Vector3

Biome.getFogColor

Gets this biome's fog color as an RGB vector
overload 1:
Biome:getFogColor()
Method Property Fluent Description Representation
Return Value a Vector3

Biome.isCold

Checks if this biome is cold
overload 1:
Biome:isCold()
Method Property Fluent Description Representation
Return Value a Boolean

Biome.isHot

Checks if this biome is hot
overload 1:
Biome:isHot()
Method Property Fluent Description Representation
Return Value a Boolean

Biome.getDownfall

Gets this biome's humidity
overload 1:
Biome:getDownfall()
Method Property Fluent Description Representation
Return Value a Number

BlockState

A proxy for a block state from Minecraft
Instances are obtained through the WorldAPI
This proxy also contains a saved position for the BlockState

BlockState.isOpaque

Gets whether or not this BlockState is opaque
overload 1:
BlockState:isOpaque()
Method Property Fluent Description Representation
Return Value a Boolean

BlockState.getVelocityMultiplier

Gets the velocity multiplier of this BlockState
(Only Soul sand,
honey blocks in vanilla)
overload 1:
BlockState:getVelocityMultiplier()
Method Property Fluent Description Representation
Return Value a Number

BlockState.getJumpVelocityMultiplier

Gets the jump velocity multiplier of this BlockState
(Literally just honey blocks in vanilla)
overload 1:
BlockState:getJumpVelocityMultiplier()
Method Property Fluent Description Representation
Return Value a Number

BlockState.getEntityData

Returns the nbt of the Block Entity associated with this BlockState, at its position, as a table
Since the mod is only on client side,
this NBT might not actually contain the real nbt, which is stored server-side
overload 1:
BlockState:getEntityData()
Method Property Fluent Description Representation
Return Value a table

BlockState.getFluidTags

Returns a table containing all the fluid tags of this block, as strings
overload 1:
BlockState:getFluidTags()
Method Property Fluent Description Representation
Return Value a table

BlockState.toStateString

Converts this BlockState into a string, like you'd see in a Minecraft command
overload 1:
BlockState:toStateString()
Method Property Fluent Description Representation
Return Value a String

BlockState.setPos

Sets the saved position for this BlockState proxy
The saved position is used in BlockState functions that require a position
overload 1:
BlockState:setPos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value nil
overload 2:
BlockState:setPos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

BlockState.getPos

Returns the saved position for this BlockState proxy
The saved position is used in BlockState functions that require a position
overload 1:
BlockState:getPos()
Method Property Fluent Description Representation
Return Value a Vector3

BlockState.getMapColor

Gets the map color of this BlockState, as a Vector3 with R,G,B ranging 0 to 1
overload 1:
BlockState:getMapColor()
Method Property Fluent Description Representation
Return Value a Vector3

BlockState.hasBlockEntity

Gets whether or not this BlockState has an associated block entity
overload 1:
BlockState:hasBlockEntity()
Method Property Fluent Description Representation
Return Value a Boolean

BlockState.getOpacity

Gets the opacity of the BlockState, in terms of how much it affects light levels
overload 1:
BlockState:getOpacity()
Method Property Fluent Description Representation
Return Value an Integer

BlockState.isFullCube

Gets whether or not the BlockState has a full cube as its collision hitbox
overload 1:
BlockState:isFullCube()
Method Property Fluent Description Representation
Return Value a Boolean

BlockState.isSolidBlock

Gets whether or not the BlockState is considered a "solid" block by Minecraft
overload 1:
BlockState:isSolidBlock()
Method Property Fluent Description Representation
Return Value a Boolean

BlockState.isTranslucent

Gets whether or not the BlockState would propagate sky light downwards
overload 1:
BlockState:isTranslucent()
Method Property Fluent Description Representation
Return Value a Boolean

BlockState.getBlastResistance

Gets the blast resistance of this BlockState
overload 1:
BlockState:getBlastResistance()
Method Property Fluent Description Representation
Return Value a Number

BlockState.getCollisionShape

Returns a table representing the bounding boxes of the collision shape
The table a list of every shape,
containing two Vector3, where the first vector is one corner of the box and the other vector is the other corner
overload 1:
BlockState:getCollisionShape()
Method Property Fluent Description Representation
Return Value a table

BlockState.getSounds

Gets the names of all the sounds which can play from this BlockState, as well as their pitch and volume
Stored in a table
overload 1:
BlockState:getSounds()
Method Property Fluent Description Representation
Return Value a table

BlockState.getTags

Returns a table containing all the tags of this block, as strings
overload 1:
BlockState:getTags()
Method Property Fluent Description Representation
Return Value a table

BlockState.getOutlineShape

Returns a table representing the bounding boxes of the outline shape
The table a list of every shape,
containing two Vector3, where the first vector is one corner of the box and the other vector is the other corner
overload 1:
BlockState:getOutlineShape()
Method Property Fluent Description Representation
Return Value a table

BlockState.asItem

Returns an ItemStack representing this block in item form, whatever Minecraft deems that to be
If it cannot find an item for this block,
it will return nil
overload 1:
BlockState:asItem()
Method Property Fluent Description Representation
Return Value either an ItemStack or nil

BlockState.getFriction

Gets the friction of this BlockState
(Slime blocks and ice in vanilla)
overload 1:
BlockState:getFriction()
Method Property Fluent Description Representation
Return Value a Number

BlockState.emitsRedstonePower

Gets whether or not this BlockState emits redstone power
overload 1:
BlockState:emitsRedstonePower()
Method Property Fluent Description Representation
Return Value a Boolean

BlockState.hasCollision

figura.docs.blockstate.get_has_collision
overload 1:
BlockState:hasCollision()
Method Property Fluent Description Representation
Return Value a Boolean

BlockState.getMaterial

figura.docs.blockstate.get_material
overload 1:
BlockState:getMaterial()
Method Property Fluent Description Representation
Return Value a String

BlockState.getLuminance

Gets the emission light level of this BlockState
overload 1:
BlockState:getLuminance()
Method Property Fluent Description Representation
Return Value an Integer

BlockState.getHardness

Gets the hardness of the BlockState
overload 1:
BlockState:getHardness()
Method Property Fluent Description Representation
Return Value a Number

BlockState.hasEmissiveLighting

figura.docs.blockstate.has_emissive_lightning
overload 1:
BlockState:hasEmissiveLighting()
Method Property Fluent Description Representation
Return Value a Boolean

BlockState.getComparatorOutput

Gets the amount of signal strength a comparator would get from this BlockState
overload 1:
BlockState:getComparatorOutput()
Method Property Fluent Description Representation
Return Value an Integer

BlockState.id

The identifier of the block this BlockState comes from
field signature:
id
Method Property Fluent Description Representation
Field Type a String

BlockState.properties

A table containing the properties of this BlockState
If this BlockState has no properties,
it is nil
field signature:
properties
Method Property Fluent Description Representation
Field Type a table

BlockTask

subclasses RenderTask

A task for rendering a Block

BlockTask.block

figura.docs.block_task.block
overload 1:
BlockTask:block(block)
Method Property Fluent Description Representation
block accepts a String
Return Value a RenderTask
overload 2:
BlockTask:block(block)
Method Property Fluent Description Representation
block accepts a BlockState
Return Value a RenderTask

BlockTask.scale

Inherited from RenderTask

figura.docs.render_task.scale
overload 1:
BlockTask:scale(scale)
Method Property Fluent Description Representation
scale accepts a Vector3
Return Value a RenderTask
overload 2:
BlockTask:scale(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

BlockTask.enabled

Inherited from RenderTask

figura.docs.render_task.enabled
overload 1:
BlockTask:enabled(bool)
Method Property Fluent Description Representation
bool accepts a Boolean
Return Value a RenderTask

BlockTask.pos

Inherited from RenderTask

figura.docs.render_task.pos
overload 1:
BlockTask:pos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value a RenderTask
overload 2:
BlockTask:pos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

BlockTask.emissive

Inherited from RenderTask

figura.docs.render_task.emissive
overload 1:
BlockTask:emissive(bool)
Method Property Fluent Description Representation
bool accepts a Boolean
Return Value a RenderTask

BlockTask.rot

Inherited from RenderTask

figura.docs.render_task.rot
overload 1:
BlockTask:rot(rot)
Method Property Fluent Description Representation
rot accepts a Vector3
Return Value a RenderTask
overload 2:
BlockTask:rot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

ClickAction

subclasses Action

figura.docs.click_action

ClickAction.onRightClick

Example by applejuice:
local myAction = myPage:newAction()

myAction:onRightClick(function()
log("Heheh I got Right Clicked!")
end)
figura.docs.click_action.on_right_click
overload 1:
ClickAction:onRightClick(rightFunction)
Method Property Fluent Description Representation
rightFunction accepts a function
Return Value an Action

ClickAction.onLeftClick

Example by applejuice:
local myAction = myPage:newAction()

myAction:onLeftClick(function()
log("Heheh I got Left Clicked!")
end)
figura.docs.click_action.on_left_click
overload 1:
ClickAction:onLeftClick(leftFunction)
Method Property Fluent Description Representation
leftFunction accepts a function
Return Value an Action

ClickAction.color

Inherited from Action

figura.docs.wheel_action.color
overload 1:
ClickAction:color(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an Action
overload 2:
ClickAction:color(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an Action

ClickAction.item

Inherited from Action

figura.docs.wheel_action.item
overload 1:
ClickAction:item(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value an Action
overload 2:
ClickAction:item(item)
Method Property Fluent Description Representation
item accepts a String
Return Value an Action

ClickAction.title

Inherited from Action

figura.docs.wheel_action.title
overload 1:
ClickAction:title()
Method Property Fluent Description Representation
Return Value an Action
overload 2:
ClickAction:title(title)
Method Property Fluent Description Representation
title accepts a String
Return Value an Action

ClickAction.hoverItem

Inherited from Action

figura.docs.wheel_action.hover_item
overload 1:
ClickAction:hoverItem(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value an Action
overload 2:
ClickAction:hoverItem(item)
Method Property Fluent Description Representation
item accepts a String
Return Value an Action

ClickAction.hoverColor

Inherited from Action

figura.docs.wheel_action.hover_color
overload 1:
ClickAction:hoverColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an Action
overload 2:
ClickAction:hoverColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an Action

ClickAction.leftClick

figura.docs.click_action.left_click
field signature:
leftClick
Method Property Fluent Description Representation
Field Type a function

ClickAction.rightClick

figura.docs.click_action.right_click
field signature:
rightClick
Method Property Fluent Description Representation
Field Type a function

EntityNameplateCustomization

subclasses NameplateCustomization

A nameplate customization that is specialized for entities

EntityNameplateCustomization.setScale

Sets the scale factor of the nameplate
overload 1:
EntityNameplateCustomization:setScale(scale)
Method Property Fluent Description Representation
scale accepts a Vector3
Return Value nil
overload 2:
EntityNameplateCustomization:setScale(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

EntityNameplateCustomization.getScale

Gets scale factor of the nameplate
overload 1:
EntityNameplateCustomization:getScale()
Method Property Fluent Description Representation
Return Value a Vector3

EntityNameplateCustomization.setPos

Sets the position offset of the nameplate, in world coordinates
overload 1:
EntityNameplateCustomization:setPos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value nil
overload 2:
EntityNameplateCustomization:setPos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

EntityNameplateCustomization.getPos

Gets the position offset of the nameplate, in world coordinates
overload 1:
EntityNameplateCustomization:getPos()
Method Property Fluent Description Representation
Return Value a Vector3

EntityNameplateCustomization.getText

Inherited from NameplateCustomization

The text to use in this nameplate
overload 1:
EntityNameplateCustomization:getText()
Method Property Fluent Description Representation
Return Value a String

EntityNameplateCustomization.setText

Inherited from NameplateCustomization

The text to use in this nameplate
overload 1:
EntityNameplateCustomization:setText(text)
Method Property Fluent Description Representation
text accepts a String
Return Value nil

EntityNameplateCustomization.visible

figura.docs.nameplate_entity.visible
field signature:
visible
Method Property Fluent Description Representation
Field Type a Boolean

EntityNameplateCustomization.background

figura.docs.nameplate_entity.background
field signature:
background
Method Property Fluent Description Representation
Field Type a Boolean

EntityNameplateCustomization.shadow

figura.docs.nameplate_entity.shadow
field signature:
shadow
Method Property Fluent Description Representation
Field Type a Boolean

EntityNameplateCustomization.outline

figura.docs.nameplate_entity.outline
field signature:
outline
Method Property Fluent Description Representation
Field Type a Boolean

Event

A hook for a certain event in Minecraft
You may register functions to one,
and those functions will be called when the event occurs

Event.remove

Removes either a function from this event or when given a string, remove all functions registered under that name
Returns the number of functions that were removed
overload 1:
Event:remove(name)
Method Property Fluent Description Representation
name accepts a String
Return Value an Integer

Event.clear

Clears the given event of all its functions
overload 1:
Event:clear()
Method Property Fluent Description Representation
Return Value nil

Event.register

Register a function on this event
Functions are run in registration order
An optional string argument can be given,
grouping functions under that name, for an easier management later on
overload 1:
Event:register(func)
Method Property Fluent Description Representation
func accepts a function
Return Value nil
overload 2:
Event:register(func, name)
Method Property Fluent Description Representation
func accepts a function
name accepts a String
Return Value nil

Event.runOnce

figura.docs.event.run_once
overload 1:
Event:runOnce(predicate, toRun)
Method Property Fluent Description Representation
predicate accepts a function
toRun accepts a function
Return Value nil

ItemStack

A proxy for an item stack from Minecraft

ItemStack.getName

Gets the name of the item
overload 1:
ItemStack:getName()
Method Property Fluent Description Representation
Return Value a String

ItemStack.getCount

Gets the number of items in this stack
overload 1:
ItemStack:getCount()
Method Property Fluent Description Representation
Return Value an Integer

ItemStack.getRarity

Gets the rarity of this item stack
COMMON = white, UNCOMMON = yellow,
RARE = aqua, EPIC = light purple
overload 1:
ItemStack:getRarity()
Method Property Fluent Description Representation
Return Value a String

ItemStack.isEnchantable

Returns true if this item stack can be put in an enchanting table
overload 1:
ItemStack:isEnchantable()
Method Property Fluent Description Representation
Return Value a Boolean

ItemStack.getMaxDamage

Gets the maximum durability of this item stack
overload 1:
ItemStack:getMaxDamage()
Method Property Fluent Description Representation
Return Value an Integer

ItemStack.getCooldown

figura.docs.itemstack.get_cooldown
overload 1:
ItemStack:getCooldown()
Method Property Fluent Description Representation
Return Value an Integer

ItemStack.getDamage

Gets the damage value of the item in this stack
Works on things like tools,
or other things with a durability bar
overload 1:
ItemStack:getDamage()
Method Property Fluent Description Representation
Return Value an Integer

ItemStack.getUseAction

Returns the name of the animation that plays when using this item
overload 1:
ItemStack:getUseAction()
Method Property Fluent Description Representation
Return Value a String

ItemStack.hasGlint

Returns true if this item glows with enchantment glint
overload 1:
ItemStack:hasGlint()
Method Property Fluent Description Representation
Return Value a Boolean

ItemStack.isBlockItem

Returns true if this item represents a block
overload 1:
ItemStack:isBlockItem()
Method Property Fluent Description Representation
Return Value a Boolean

ItemStack.isFood

Returns true if this item is edible
overload 1:
ItemStack:isFood()
Method Property Fluent Description Representation
Return Value a Boolean

ItemStack.getMaxCount

Gets the maximum stack size of this item
overload 1:
ItemStack:getMaxCount()
Method Property Fluent Description Representation
Return Value an Integer

ItemStack.getRepairCost

Gets the repair cost modifier, in an anvil, for this item stack
overload 1:
ItemStack:getRepairCost()
Method Property Fluent Description Representation
Return Value an Integer

ItemStack.isStackable

Returns true if the item is stackable
overload 1:
ItemStack:isStackable()
Method Property Fluent Description Representation
Return Value a Boolean

ItemStack.getUseDuration

Gets the number of ticks needed to "use" this item
Currently only has a use for food items
Always 32 for food items except kelp,
which is 16
overload 1:
ItemStack:getUseDuration()
Method Property Fluent Description Representation
Return Value an Integer

ItemStack.isDamageable

Returns true if this item stack has durability
overload 1:
ItemStack:isDamageable()
Method Property Fluent Description Representation
Return Value a Boolean

ItemStack.toStackString

Converts this ItemStack to a string, as you'd see in a command
overload 1:
ItemStack:toStackString()
Method Property Fluent Description Representation
Return Value a String

ItemStack.getTags

Gets all the tags of this item as strings in a table
overload 1:
ItemStack:getTags()
Method Property Fluent Description Representation
Return Value a table

ItemStack.id

Contains the id of the item this ItemStack refers to
field signature:
id
Method Property Fluent Description Representation
Field Type a String

ItemStack.tag

A table containing the NBT tag of this ItemStack
If this ItemStack has nothing in its tag,
it is nil
field signature:
tag
Method Property Fluent Description Representation
Field Type a table

ItemTask

subclasses RenderTask

A task for rendering an Item

ItemTask.item

figura.docs.item_task.item
overload 1:
ItemTask:item(item)
Method Property Fluent Description Representation
item accepts a String
Return Value a RenderTask
overload 2:
ItemTask:item(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value a RenderTask

ItemTask.renderType

figura.docs.item_task.render_type
overload 1:
ItemTask:renderType(renderType)
Method Property Fluent Description Representation
renderType accepts a String
Return Value a RenderTask

ItemTask.scale

Inherited from RenderTask

figura.docs.render_task.scale
overload 1:
ItemTask:scale(scale)
Method Property Fluent Description Representation
scale accepts a Vector3
Return Value a RenderTask
overload 2:
ItemTask:scale(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

ItemTask.enabled

Inherited from RenderTask

figura.docs.render_task.enabled
overload 1:
ItemTask:enabled(bool)
Method Property Fluent Description Representation
bool accepts a Boolean
Return Value a RenderTask

ItemTask.pos

Inherited from RenderTask

figura.docs.render_task.pos
overload 1:
ItemTask:pos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value a RenderTask
overload 2:
ItemTask:pos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

ItemTask.emissive

Inherited from RenderTask

figura.docs.render_task.emissive
overload 1:
ItemTask:emissive(bool)
Method Property Fluent Description Representation
bool accepts a Boolean
Return Value a RenderTask

ItemTask.rot

Inherited from RenderTask

figura.docs.render_task.rot
overload 1:
ItemTask:rot(rot)
Method Property Fluent Description Representation
rot accepts a Vector3
Return Value a RenderTask
overload 2:
ItemTask:rot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

Keybind

Represents a key binding for your script
Instances are obtained using the KeybindAPI's create() function

Keybind.getName

Gets the name of the keybind, which you set when you created the keybind
overload 1:
Keybind:getName()
Method Property Fluent Description Representation
Return Value a String

Keybind.getKey

Gets the current key for this keybind
overload 1:
Keybind:getKey()
Method Property Fluent Description Representation
Return Value a String

Keybind.isDefault

Checks whether this key is currently set to its default state (not been changed using the keybind menu)
overload 1:
Keybind:isDefault()
Method Property Fluent Description Representation
Return Value a Boolean

Keybind.setKey

Sets the key for this keybind
overload 1:
Keybind:setKey(key)
Method Property Fluent Description Representation
key accepts a String
Return Value nil

Keybind.getKeyName

Gets the name of the current key for this keybind
overload 1:
Keybind:getKeyName()
Method Property Fluent Description Representation
Return Value a String

Keybind.isPressed

Gets whether this keybind is currently pressed down
overload 1:
Keybind:isPressed()
Method Property Fluent Description Representation
Return Value a Boolean

Keybind.onPress

figura.docs.keybind.on_press
field signature:
onPress
typings.1812163554
Method Property Fluent Description Representation
Field Type

Keybind.onRelease

figura.docs.keybind.on_release
field signature:
onRelease
typings.1812163554
Method Property Fluent Description Representation
Field Type

Keybind.enabled

figura.docs.keybind.enabled
field signature:
enabled
Method Property Fluent Description Representation
Field Type a Boolean

Keybind.gui

figura.docs.keybind.gui
field signature:
gui
Method Property Fluent Description Representation
Field Type a Boolean

Keybind.override

figura.docs.keybind.override
field signature:
override
Method Property Fluent Description Representation
Field Type a Boolean

LivingEntityAPI

subclasses EntityAPI

Acts as a proxy for a living entity in the Minecraft world

LivingEntityAPI.getActiveItem

Returns an ItemStack representing the item the entity is currently using
If they're not using any item,
returns air
overload 1:
LivingEntityAPI:getActiveItem()
Method Property Fluent Description Representation
Return Value an ItemStack

LivingEntityAPI.getMaxHealth

Returns the maximum amount of health this entity can have
overload 1:
LivingEntityAPI:getMaxHealth()
Method Property Fluent Description Representation
Return Value a Number

LivingEntityAPI.getArrowCount

Returns the number of arrows sticking out of this entity
overload 1:
LivingEntityAPI:getArrowCount()
Method Property Fluent Description Representation
Return Value an Integer

LivingEntityAPI.isLeftHanded

Returns true if the entity's main hand is its left
overload 1:
LivingEntityAPI:isLeftHanded()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntityAPI.isUsingItem

Returns true if the entity is currently using an item
overload 1:
LivingEntityAPI:isUsingItem()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntityAPI.getActiveHand

Returns "OFF_HAND" or "MAIN_HAND", depending on which hand this entity uses an item with
overload 1:
LivingEntityAPI:getActiveHand()
Method Property Fluent Description Representation
Return Value a String

LivingEntityAPI.getBodyYaw

Gets the yaw of this entity's body in degrees
If delta is passed in,
then it will be used to linearly interpolate the rotation of the body between the previous tick and the current tick
The default value of delta is 1
overload 1:
LivingEntityAPI:getBodyYaw()
Method Property Fluent Description Representation
Return Value a Number
overload 2:
LivingEntityAPI:getBodyYaw(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Number

LivingEntityAPI.getHealth

Returns the amount of health this entity has remaining
overload 1:
LivingEntityAPI:getHealth()
Method Property Fluent Description Representation
Return Value a Number

LivingEntityAPI.getDeathTime

Returns the number of ticks this entity has been dead for
overload 1:
LivingEntityAPI:getDeathTime()
Method Property Fluent Description Representation
Return Value a Number

LivingEntityAPI.getStatusEffects

figura.docs.living_entity.get_status_effects
overload 1:
LivingEntityAPI:getStatusEffects()
Method Property Fluent Description Representation
Return Value a table

LivingEntityAPI.getStingerCount

Returns the number of bee stingers sticking out of this entity
overload 1:
LivingEntityAPI:getStingerCount()
Method Property Fluent Description Representation
Return Value an Integer

LivingEntityAPI.getHeldItem

Returns an ItemStack representing the item in this entity's main hand
If true is passed in for "offhand",
then it will instead look at the item in the entity's offhand
If the entity isn't holding an item in that hand,
returns air
overload 1:
LivingEntityAPI:getHeldItem()
Method Property Fluent Description Representation
Return Value an ItemStack
overload 2:
LivingEntityAPI:getHeldItem(offhand)
Method Property Fluent Description Representation
offhand accepts a Boolean
Return Value an ItemStack

LivingEntityAPI.getArmor

Returns the amount of armor points this entity has
overload 1:
LivingEntityAPI:getArmor()
Method Property Fluent Description Representation
Return Value a Number

LivingEntityAPI.isClimbing

Returns true if the entity is currently using a climbable block, like a ladder or vine
overload 1:
LivingEntityAPI:isClimbing()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntityAPI.getName

Inherited from EntityAPI

Gets the name of this entity, if it has a custom name
If it doesn't,
returns a translated form of getType()
overload 1:
LivingEntityAPI:getName()
Method Property Fluent Description Representation
Return Value a String

LivingEntityAPI.getType

Inherited from EntityAPI

Gets the Minecraft identifier of this entity
For instance,
"minecraft:pig"
overload 1:
LivingEntityAPI:getType()
Method Property Fluent Description Representation
Return Value a String

LivingEntityAPI.isLoaded

Inherited from EntityAPI

Checks if this entity object is still being updated and loaded
A non-loaded entity would be someone or something which is in another dimension or out of the render distance for example
overload 1:
LivingEntityAPI:isLoaded()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntityAPI.getItem

Inherited from EntityAPI

Gets an ItemStack for the item in the given slot
For the player,
slots are indexed with 1 as the main hand, 2 as the off hand, and 3,4,5,6 as the 4 armor slots from the boots to the helmet
If an invalid slot number is given,
this will return nil
overload 1:
LivingEntityAPI:getItem(index)
Method Property Fluent Description Representation
index accepts an Integer
Return Value an ItemStack

LivingEntityAPI.getPos

Inherited from EntityAPI

Gets the position of the entity in the world
If delta is passed in,
then it will be used to linearly interpolate the position of the entity between the previous tick and the current tick
The default value of delta is 1
overload 1:
LivingEntityAPI:getPos()
Method Property Fluent Description Representation
Return Value a Vector3
overload 2:
LivingEntityAPI:getPos(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Vector3

LivingEntityAPI.getNbt

Inherited from EntityAPI

Gets a table containing the NBT of this entity
Please note that not all values in the entity's NBT may be synced,
as some are handled only on the server side
overload 1:
LivingEntityAPI:getNbt()
Method Property Fluent Description Representation
Return Value a table

LivingEntityAPI.getRot

Inherited from EntityAPI

Gets the rotation of the entity in degrees
If delta is passed in,
then it will be used to linearly interpolate the rotation of the entity between the previous tick and the current tick
The default value of delta is 1
overload 1:
LivingEntityAPI:getRot()
Method Property Fluent Description Representation
Return Value a Vector2
overload 2:
LivingEntityAPI:getRot(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Vector2

LivingEntityAPI.isOnGround

Inherited from EntityAPI

Returns whether or not this entity is currently on the ground
overload 1:
LivingEntityAPI:isOnGround()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntityAPI.getUUID

Inherited from EntityAPI

Gets the UUID of the proxied entity
overload 1:
LivingEntityAPI:getUUID()
Method Property Fluent Description Representation
Return Value a String

LivingEntityAPI.getEyeHeight

Inherited from EntityAPI

Returns the current eye height of this entity
overload 1:
LivingEntityAPI:getEyeHeight()
Method Property Fluent Description Representation
Return Value a Number

LivingEntityAPI.getPose

Inherited from EntityAPI

Returns the current pose of the player
This can be one of: "STANDING",
"FALL_FLYING", "SLEEPING", "SWIMMING", "SPIN_ATTACK", "CROUCHING", "LONG_JUMPING", or "DYING"
overload 1:
LivingEntityAPI:getPose()
Method Property Fluent Description Representation
Return Value a String

LivingEntityAPI.getBoundingBox

Inherited from EntityAPI

Returns the size of this entity's bounding box as a Vector3
{x,
y, z} are the width, height, and width
Minecraft entity hitboxes always have square bases
overload 1:
LivingEntityAPI:getBoundingBox()
Method Property Fluent Description Representation
Return Value a Vector3

LivingEntityAPI.isHamburger

Inherited from EntityAPI

figura.docs.entity.is_hamburger
overload 1:
LivingEntityAPI:isHamburger()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntityAPI.getLookDir

Inherited from EntityAPI

Returns a unit vector pointing in the direction that this entity is looking
See the blue line in the F3+B screen for an example
overload 1:
LivingEntityAPI:getLookDir()
Method Property Fluent Description Representation
Return Value a Vector3

LivingEntityAPI.getFrozenTicks

Inherited from EntityAPI

Gets the number of ticks this entity has been freezing in powder snow for
overload 1:
LivingEntityAPI:getFrozenTicks()
Method Property Fluent Description Representation
Return Value an Integer

LivingEntityAPI.getMaxAir

Inherited from EntityAPI

Gets the maximum amount of air this entity can have
overload 1:
LivingEntityAPI:getMaxAir()
Method Property Fluent Description Representation
Return Value an Integer

LivingEntityAPI.getFireTicks

Inherited from EntityAPI

figura.docs.entity.get_fire_ticks
overload 1:
LivingEntityAPI:getFireTicks()
Method Property Fluent Description Representation
Return Value an Integer

LivingEntityAPI.getDimensionName

Inherited from EntityAPI

Gets the Minecraft identifier of the dimension this entity is in
overload 1:
LivingEntityAPI:getDimensionName()
Method Property Fluent Description Representation
Return Value a String

LivingEntityAPI.getVehicle

Inherited from EntityAPI

Returns a proxy for the entity that this player is currently riding
If the player isn't riding anything,
returns nil
overload 1:
LivingEntityAPI:getVehicle()
Method Property Fluent Description Representation
Return Value an EntityAPI

LivingEntityAPI.getVelocity

Inherited from EntityAPI

Gets the current velocity of this entity in world coordinates, calculated as its position this tick minus its position last tick
overload 1:
LivingEntityAPI:getVelocity()
Method Property Fluent Description Representation
Return Value a Vector3

LivingEntityAPI.getAir

Inherited from EntityAPI

figura.docs.entity.get_air
overload 1:
LivingEntityAPI:getAir()
Method Property Fluent Description Representation
Return Value an Integer

LivingEntityAPI.getTargetedBlock

Inherited from EntityAPI

Returns a proxy for your currently targeted BlockState
This BlockState appears on the F3 screen
The maximum (and default) distance is 20,
minimum is -20
Returns the block, the hit position,
and the targeted block face as three separate values
overload 1:
LivingEntityAPI:getTargetedBlock()
Method Property Fluent Description Representation
Return Value a BlockState
overload 2:
LivingEntityAPI:getTargetedBlock(ignoreLiquids)
Method Property Fluent Description Representation
ignoreLiquids accepts a Boolean
Return Value a BlockState
overload 3:
LivingEntityAPI:getTargetedBlock(ignoreLiquids, distance)
Method Property Fluent Description Representation
ignoreLiquids accepts a Boolean
distance accepts a Number
Return Value a BlockState

LivingEntityAPI.isInWater

Inherited from EntityAPI

Returns true if this entity is currently in a water block, including waterlogging
overload 1:
LivingEntityAPI:isInWater()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntityAPI.isInRain

Inherited from EntityAPI

Returns true if this entity is currently standing in rain
overload 1:
LivingEntityAPI:isInRain()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntityAPI.isInvisible

Inherited from EntityAPI

Returns true if this entity is invisible, for one reason or another
overload 1:
LivingEntityAPI:isInvisible()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntityAPI.hasAvatar

Inherited from EntityAPI

Returns true if Figura has an avatar loaded for this entity
overload 1:
LivingEntityAPI:hasAvatar()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntityAPI.isGlowing

Inherited from EntityAPI

Returns true if this entity is currently glowing
overload 1:
LivingEntityAPI:isGlowing()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntityAPI.isUnderwater

Inherited from EntityAPI

Returns true if this entity's eyes are touching water
overload 1:
LivingEntityAPI:isUnderwater()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntityAPI.isWet

Inherited from EntityAPI

Returns true in any of three conditions: if the entity is in water, if the entity is in rain, or if the entity is in a bubble column
Otherwise,
returns false
overload 1:
LivingEntityAPI:isWet()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntityAPI.getEyeY

Inherited from EntityAPI

Returns the Y level of this entity's eyes
Not to be confused with getEyeHeight,
this function also takes the entity itself's Y position into account
overload 1:
LivingEntityAPI:getEyeY()
Method Property Fluent Description Representation
Return Value a Number

LivingEntityAPI.isSilent

Inherited from EntityAPI

Returns true if this entity is silent
overload 1:
LivingEntityAPI:isSilent()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntityAPI.isSneaking

Inherited from EntityAPI

Returns true if this entity is logically sneaking (can't fall from blocks edges, can't see nameplate behind walls, etc)
overload 1:
LivingEntityAPI:isSneaking()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntityAPI.isSprinting

Inherited from EntityAPI

Returns true if this entity is currently sprinting
overload 1:
LivingEntityAPI:isSprinting()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntityAPI.isOnFire

Inherited from EntityAPI

Returns true if this entity is currently on fire
overload 1:
LivingEntityAPI:isOnFire()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntityAPI.isInLava

Inherited from EntityAPI

Returns true if this entity is currently in lava
overload 1:
LivingEntityAPI:isInLava()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntityAPI.getVariable

Inherited from EntityAPI

Gets the value of a variable this entity stored in themselves using the Avatar API's store() function
overload 1:
LivingEntityAPI:getVariable(key)
Method Property Fluent Description Representation
key accepts a String
Return Value anything

Matrix2

A matrix with 2 rows and 2 columns
Meta name Allowed other parameters Meta execution method
__le
  • Matrix2
x <= y
__eq
  • Matrix2
x == y
__mul
  • Number
  • Matrix2
  • Vector2
x * y
__add
  • Matrix2
x + y
__sub
  • Matrix2
x - y
__len
#x

Matrix2.add

Adds the other matrix to this one
Returns self for chaining
overload 1:
Matrix2:add(other)
Method Property Fluent Description Representation
other accepts a Matrix2
Return Value a Matrix2

Matrix2.scale

Scales this matrix by the specified amount, changing the values inside
Returns self for chaining
overload 1:
Matrix2:scale(vec)
Method Property Fluent Description Representation
vec accepts a Vector2
Return Value a Matrix2
overload 2:
Matrix2:scale(x, y)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
Return Value a Matrix2

Matrix2.set

Sets this matrix to have the same values as the matrix passed in
Returns self for chaining
overload 1:
Matrix2:set(other)
Method Property Fluent Description Representation
other accepts a Matrix2
Return Value a Matrix2

Matrix2.copy

Creates and returns a new copy of this matrix
overload 1:
Matrix2:copy()
Method Property Fluent Description Representation
Return Value a Matrix2

Matrix2.reset

Resets this matrix back to the identity matrix
Returns self for chaining
overload 1:
Matrix2:reset()
Method Property Fluent Description Representation
Return Value a Matrix2

Matrix2.multiply

Multiplies this matrix by the other matrix, with the other matrix on the left
Returns self for chaining
overload 1:
Matrix2:multiply(other)
Method Property Fluent Description Representation
other accepts a Matrix2
Return Value a Matrix2

Matrix2.rotate

Rotates this matrix by the specified amount, changing the values inside
Angles are given in degrees
Returns self for chaining
overload 1:
Matrix2:rotate(degrees)
Method Property Fluent Description Representation
degrees accepts a Number
Return Value a Matrix2

Matrix2.sub

Subtracts the other matrix from this one
Returns self for chaining
overload 1:
Matrix2:sub(other)
Method Property Fluent Description Representation
other accepts a Matrix2
Return Value a Matrix2

Matrix2.getColumn

Gets the given column of this matrix, as a vector
Indexing starts at 1,
as usual
overload 1:
Matrix2:getColumn(col)
Method Property Fluent Description Representation
col accepts an Integer
Return Value a Vector2

Matrix2.inverted

Returns a copy of this matrix, but inverted
overload 1:
Matrix2:inverted()
Method Property Fluent Description Representation
Return Value a Matrix2

Matrix2.det

Calculates and returns the determinant of this matrix
overload 1:
Matrix2:det()
Method Property Fluent Description Representation
Return Value a Number

Matrix2.getRow

Gets the given row of this matrix, as a vector
Indexing starts at 1,
as usual
overload 1:
Matrix2:getRow(row)
Method Property Fluent Description Representation
row accepts an Integer
Return Value a Vector2

Matrix2.rightMultiply

Multiplies this matrix by the other matrix, with the other matrix on the right
Returns self for chaining
overload 1:
Matrix2:rightMultiply(other)
Method Property Fluent Description Representation
other accepts a Matrix2
Return Value a Matrix2

Matrix2.transposed

Returns a copy of this matrix, but transposed
Transposing means to swap the rows and the columns
overload 1:
Matrix2:transposed()
Method Property Fluent Description Representation
Return Value a Matrix2

Matrix2.invert

Inverts this matrix, changing the values inside
Returns self for chaining
overload 1:
Matrix2:invert()
Method Property Fluent Description Representation
Return Value a Matrix2

Matrix2.augmented

Augments this matrix, adding an additional row and column
Puts a 1 along the diagonal in the new spot,
and the rest are zero
overload 1:
Matrix2:augmented()
Method Property Fluent Description Representation
Return Value a Matrix3

Matrix2.transpose

Transposes this matrix, changing the values inside
Transposing means to swap the rows and the columns
Returns self for chaining
overload 1:
Matrix2:transpose()
Method Property Fluent Description Representation
Return Value a Matrix2

Matrix3

A matrix with 3 rows and 3 columns
Meta name Allowed other parameters Meta execution method
__le
  • Matrix3
x <= y
__eq
  • Matrix3
x == y
__mul
  • Number
  • Matrix3
  • Vector3
x * y
__add
  • Matrix3
x + y
__sub
  • Matrix3
x - y
__len
#x

Matrix3.add

Adds the other matrix to this one
Returns self for chaining
overload 1:
Matrix3:add(other)
Method Property Fluent Description Representation
other accepts a Matrix3
Return Value a Matrix3

Matrix3.scale

Scales this matrix by the specified amount, changing the values inside
Returns self for chaining
overload 1:
Matrix3:scale(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Matrix3
overload 2:
Matrix3:scale(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Matrix3

Matrix3.set

Sets this matrix to have the same values as the matrix passed in
Returns self for chaining
overload 1:
Matrix3:set(other)
Method Property Fluent Description Representation
other accepts a Matrix3
Return Value a Matrix3

Matrix3.copy

Creates and returns a new copy of this matrix
overload 1:
Matrix3:copy()
Method Property Fluent Description Representation
Return Value a Matrix3

Matrix3.reset

Resets this matrix back to the identity matrix
Returns self for chaining
overload 1:
Matrix3:reset()
Method Property Fluent Description Representation
Return Value a Matrix3

Matrix3.multiply

Multiplies this matrix by the other matrix, with the other matrix on the left
Returns self for chaining
overload 1:
Matrix3:multiply(other)
Method Property Fluent Description Representation
other accepts a Matrix3
Return Value a Matrix3

Matrix3.rotate

Rotates this matrix by the specified amount, changing the values inside
Angles are given in degrees
Returns self for chaining
overload 1:
Matrix3:rotate(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Matrix3
overload 2:
Matrix3:rotate(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Matrix3

Matrix3.sub

Subtracts the other matrix from this one
Returns self for chaining
overload 1:
Matrix3:sub(other)
Method Property Fluent Description Representation
other accepts a Matrix3
Return Value a Matrix3

Matrix3.getColumn

Gets the given column of this matrix, as a vector
Indexing starts at 1,
as usual
overload 1:
Matrix3:getColumn(col)
Method Property Fluent Description Representation
col accepts an Integer
Return Value a Vector3

Matrix3.inverted

Returns a copy of this matrix, but inverted
overload 1:
Matrix3:inverted()
Method Property Fluent Description Representation
Return Value a Matrix3

Matrix3.det

Calculates and returns the determinant of this matrix
overload 1:
Matrix3:det()
Method Property Fluent Description Representation
Return Value a Number

Matrix3.getRow

Gets the given row of this matrix, as a vector
Indexing starts at 1,
as usual
overload 1:
Matrix3:getRow(row)
Method Property Fluent Description Representation
row accepts an Integer
Return Value a Vector3

Matrix3.rightMultiply

Multiplies this matrix by the other matrix, with the other matrix on the right
Returns self for chaining
overload 1:
Matrix3:rightMultiply(other)
Method Property Fluent Description Representation
other accepts a Matrix3
Return Value a Matrix3

Matrix3.transposed

Returns a copy of this matrix, but transposed
Transposing means to swap the rows and the columns
overload 1:
Matrix3:transposed()
Method Property Fluent Description Representation
Return Value a Matrix3

Matrix3.invert

Inverts this matrix, changing the values inside
Returns self for chaining
overload 1:
Matrix3:invert()
Method Property Fluent Description Representation
Return Value a Matrix3

Matrix3.rotateY

Rotates this matrix around the Y axis by the specified number of degrees
Returns self for chaining
overload 1:
Matrix3:rotateY(degrees)
Method Property Fluent Description Representation
degrees accepts a Number
Return Value a Matrix3

Matrix3.translate

Translates this matrix by the specified amount, changing the values inside
Returns self for chaining
overload 1:
Matrix3:translate(vec)
Method Property Fluent Description Representation
vec accepts a Vector2
Return Value a Matrix3
overload 2:
Matrix3:translate(x, y)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
Return Value a Matrix3

Matrix3.augmented

Augments this matrix, adding an additional row and column
Puts a 1 along the diagonal in the new spot,
and the rest are zero
overload 1:
Matrix3:augmented()
Method Property Fluent Description Representation
Return Value a Matrix4

Matrix3.transpose

Transposes this matrix, changing the values inside
Transposing means to swap the rows and the columns
Returns self for chaining
overload 1:
Matrix3:transpose()
Method Property Fluent Description Representation
Return Value a Matrix3

Matrix3.rotateX

Rotates this matrix around the X axis by the specified number of degrees
Returns self for chaining
overload 1:
Matrix3:rotateX(degrees)
Method Property Fluent Description Representation
degrees accepts a Number
Return Value a Matrix3

Matrix3.rotateZ

Rotates this matrix around the Z axis by the specified number of degrees
Returns self for chaining
overload 1:
Matrix3:rotateZ(degrees)
Method Property Fluent Description Representation
degrees accepts a Number
Return Value a Matrix3

Matrix3.deaugmented

Deaugments this matrix, removing a row and column
overload 1:
Matrix3:deaugmented()
Method Property Fluent Description Representation
Return Value a Matrix2

Matrix4

A matrix with 4 rows and 4 columns
Meta name Allowed other parameters Meta execution method
__le
  • Matrix4
x <= y
__eq
  • Matrix4
x == y
__mul
  • Number
  • Matrix4
  • Vector4
x * y
__add
  • Matrix4
x + y
__sub
  • Matrix4
x - y
__len
#x

Matrix4.add

Adds the other matrix to this one
Returns self for chaining
overload 1:
Matrix4:add(other)
Method Property Fluent Description Representation
other accepts a Matrix4
Return Value a Matrix4

Matrix4.scale

Scales this matrix by the specified amount, changing the values inside
Returns self for chaining
overload 1:
Matrix4:scale(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Matrix4
overload 2:
Matrix4:scale(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Matrix4

Matrix4.set

Sets this matrix to have the same values as the matrix passed in
Returns self for chaining
overload 1:
Matrix4:set(other)
Method Property Fluent Description Representation
other accepts a Matrix4
Return Value a Matrix4

Matrix4.copy

Creates and returns a new copy of this matrix
overload 1:
Matrix4:copy()
Method Property Fluent Description Representation
Return Value a Matrix4

Matrix4.reset

Resets this matrix back to the identity matrix
Returns self for chaining
overload 1:
Matrix4:reset()
Method Property Fluent Description Representation
Return Value a Matrix4

Matrix4.multiply

Multiplies this matrix by the other matrix, with the other matrix on the left
Returns self for chaining
overload 1:
Matrix4:multiply(other)
Method Property Fluent Description Representation
other accepts a Matrix4
Return Value a Matrix4

Matrix4.rotate

Rotates this matrix by the specified amount, changing the values inside
Angles are given in degrees
Returns self for chaining
overload 1:
Matrix4:rotate(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Matrix4
overload 2:
Matrix4:rotate(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Matrix4

Matrix4.sub

Subtracts the other matrix from this one
Returns self for chaining
overload 1:
Matrix4:sub(other)
Method Property Fluent Description Representation
other accepts a Matrix4
Return Value a Matrix4

Matrix4.getColumn

Gets the given column of this matrix, as a vector
Indexing starts at 1,
as usual
overload 1:
Matrix4:getColumn(col)
Method Property Fluent Description Representation
col accepts an Integer
Return Value a Vector4

Matrix4.inverted

Returns a copy of this matrix, but inverted
overload 1:
Matrix4:inverted()
Method Property Fluent Description Representation
Return Value a Matrix4

Matrix4.det

Calculates and returns the determinant of this matrix
overload 1:
Matrix4:det()
Method Property Fluent Description Representation
Return Value a Number

Matrix4.getRow

Gets the given row of this matrix, as a vector
Indexing starts at 1,
as usual
overload 1:
Matrix4:getRow(row)
Method Property Fluent Description Representation
row accepts an Integer
Return Value a Vector4

Matrix4.rightMultiply

Multiplies this matrix by the other matrix, with the other matrix on the right
Returns self for chaining
overload 1:
Matrix4:rightMultiply(other)
Method Property Fluent Description Representation
other accepts a Matrix4
Return Value a Matrix4

Matrix4.transposed

Returns a copy of this matrix, but transposed
Transposing means to swap the rows and the columns
overload 1:
Matrix4:transposed()
Method Property Fluent Description Representation
Return Value a Matrix4

Matrix4.invert

Inverts this matrix, changing the values inside
Returns self for chaining
overload 1:
Matrix4:invert()
Method Property Fluent Description Representation
Return Value a Matrix4

Matrix4.rotateY

Rotates this matrix around the Y axis by the specified number of degrees
Returns self for chaining
overload 1:
Matrix4:rotateY(degrees)
Method Property Fluent Description Representation
degrees accepts a Number
Return Value a Matrix4

Matrix4.translate

Translates this matrix by the specified amount, changing the values inside
Returns self for chaining
overload 1:
Matrix4:translate(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Matrix4
overload 2:
Matrix4:translate(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Matrix4

Matrix4.transpose

Transposes this matrix, changing the values inside
Transposing means to swap the rows and the columns
Returns self for chaining
overload 1:
Matrix4:transpose()
Method Property Fluent Description Representation
Return Value a Matrix4

Matrix4.rotateX

Rotates this matrix around the X axis by the specified number of degrees
Returns self for chaining
overload 1:
Matrix4:rotateX(degrees)
Method Property Fluent Description Representation
degrees accepts a Number
Return Value a Matrix4

Matrix4.rotateZ

Rotates this matrix around the Z axis by the specified number of degrees
Returns self for chaining
overload 1:
Matrix4:rotateZ(degrees)
Method Property Fluent Description Representation
degrees accepts a Number
Return Value a Matrix4

Matrix4.deaugmented

Deaugments this matrix, removing a row and column
overload 1:
Matrix4:deaugmented()
Method Property Fluent Description Representation
Return Value a Matrix3

NameplateCustomization

A customization that can be applied to a nameplate

NameplateCustomization.getText

The text to use in this nameplate
overload 1:
NameplateCustomization:getText()
Method Property Fluent Description Representation
Return Value a String

NameplateCustomization.setText

The text to use in this nameplate
overload 1:
NameplateCustomization:setText(text)
Method Property Fluent Description Representation
text accepts a String
Return Value nil

NameplateCustomizationGroup

A customization that holds another nameplate customizations

NameplateCustomizationGroup.setText

Sets the text for all its children customizations
overload 1:
NameplateCustomizationGroup:setText(text)
Method Property Fluent Description Representation
text accepts a String
Return Value nil

Page

An Action Wheel container which is used to store up to 8 actions

Page.newAction

Adds a new Action on the selected Page's index
If no index is given it is added in the first available index
overload 1:
Page:newAction()
Method Property Fluent Description Representation
Return Value an Action
overload 2:
Page:newAction(index)
Method Property Fluent Description Representation
index accepts an Integer
Return Value an Action

Page.getAction

Example by applejuice:
local action = myPage:getAction(1)
Gets an Action from the Page's given index
overload 1:
Page:getAction(index)
Method Property Fluent Description Representation
index accepts an Integer
Return Value an Action

Page.newScroll

figura.docs.wheel_page.new_scroll
overload 1:
Page:newScroll()
Method Property Fluent Description Representation
Return Value an Action
overload 2:
Page:newScroll(index)
Method Property Fluent Description Representation
index accepts an Integer
Return Value an Action

Page.newToggle

figura.docs.wheel_page.new_toggle
overload 1:
Page:newToggle()
Method Property Fluent Description Representation
Return Value an Action
overload 2:
Page:newToggle(index)
Method Property Fluent Description Representation
index accepts an Integer
Return Value an Action

PingFunction

A custom function wrapped with networking data

RenderTask

Represents a rendering task for Figura to complete each frame
An abstract superclass of ItemTask,
BlockTask, and TextTask

RenderTask.scale

figura.docs.render_task.scale
overload 1:
RenderTask:scale(scale)
Method Property Fluent Description Representation
scale accepts a Vector3
Return Value a RenderTask
overload 2:
RenderTask:scale(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

RenderTask.enabled

figura.docs.render_task.enabled
overload 1:
RenderTask:enabled(bool)
Method Property Fluent Description Representation
bool accepts a Boolean
Return Value a RenderTask

RenderTask.pos

figura.docs.render_task.pos
overload 1:
RenderTask:pos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value a RenderTask
overload 2:
RenderTask:pos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

RenderTask.emissive

figura.docs.render_task.emissive
overload 1:
RenderTask:emissive(bool)
Method Property Fluent Description Representation
bool accepts a Boolean
Return Value a RenderTask

RenderTask.rot

figura.docs.render_task.rot
overload 1:
RenderTask:rot(rot)
Method Property Fluent Description Representation
rot accepts a Vector3
Return Value a RenderTask
overload 2:
RenderTask:rot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

ScrollAction

subclasses Action

figura.docs.scroll_action

ScrollAction.onScroll

figura.docs.scroll_action.on_scroll
overload 1:
ScrollAction:onScroll(scrollFunction)
Method Property Fluent Description Representation
scrollFunction accepts a function
Return Value an Action

ScrollAction.color

Inherited from Action

figura.docs.wheel_action.color
overload 1:
ScrollAction:color(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an Action
overload 2:
ScrollAction:color(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an Action

ScrollAction.item

Inherited from Action

figura.docs.wheel_action.item
overload 1:
ScrollAction:item(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value an Action
overload 2:
ScrollAction:item(item)
Method Property Fluent Description Representation
item accepts a String
Return Value an Action

ScrollAction.title

Inherited from Action

figura.docs.wheel_action.title
overload 1:
ScrollAction:title()
Method Property Fluent Description Representation
Return Value an Action
overload 2:
ScrollAction:title(title)
Method Property Fluent Description Representation
title accepts a String
Return Value an Action

ScrollAction.hoverItem

Inherited from Action

figura.docs.wheel_action.hover_item
overload 1:
ScrollAction:hoverItem(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value an Action
overload 2:
ScrollAction:hoverItem(item)
Method Property Fluent Description Representation
item accepts a String
Return Value an Action

ScrollAction.hoverColor

Inherited from Action

figura.docs.wheel_action.hover_color
overload 1:
ScrollAction:hoverColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an Action
overload 2:
ScrollAction:hoverColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an Action

ScrollAction.scroll

figura.docs.scroll_action.scroll
field signature:
scroll
Method Property Fluent Description Representation
Field Type a function

Sound

Represents a sound that can be played
Obtained by indexing the SoundAPI
Exists as an object-oriented alternative to sounds:playSound()

Sound.play

Plays this sound, or resume a paused sound
overload 1:
Sound:play(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value nil
overload 2:
Sound:play(posX, posY, posZ)
Method Property Fluent Description Representation
posX accepts a Number
posY accepts a Number
posZ accepts a Number
Return Value nil
overload 3:
Sound:play(pos, volume, pitch, loop)
Method Property Fluent Description Representation
pos accepts a Vector3
volume accepts a Number
pitch accepts a Number
loop accepts a Boolean
Return Value nil
overload 4:
Sound:play(posX, posY, posZ, volume, pitch, loop)
Method Property Fluent Description Representation
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 nil

TextTask

subclasses RenderTask

A task for rendering some Text

TextTask.text

figura.docs.text_task.text
overload 1:
TextTask:text(text)
Method Property Fluent Description Representation
text accepts a String
Return Value a RenderTask

TextTask.shadow

figura.docs.text_task.shadow
overload 1:
TextTask:shadow(shadow)
Method Property Fluent Description Representation
shadow accepts a Boolean
Return Value a RenderTask

TextTask.outline

figura.docs.text_task.outline
overload 1:
TextTask:outline(outline)
Method Property Fluent Description Representation
outline accepts a Boolean
Return Value a RenderTask

TextTask.centered

figura.docs.text_task.centered
overload 1:
TextTask:centered(centered)
Method Property Fluent Description Representation
centered accepts a Boolean
Return Value a RenderTask

TextTask.outlineColor

figura.docs.text_task.outline_color
overload 1:
TextTask:outlineColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value a TextTask
overload 2:
TextTask:outlineColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value a TextTask

TextTask.scale

Inherited from RenderTask

figura.docs.render_task.scale
overload 1:
TextTask:scale(scale)
Method Property Fluent Description Representation
scale accepts a Vector3
Return Value a RenderTask
overload 2:
TextTask:scale(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

TextTask.enabled

Inherited from RenderTask

figura.docs.render_task.enabled
overload 1:
TextTask:enabled(bool)
Method Property Fluent Description Representation
bool accepts a Boolean
Return Value a RenderTask

TextTask.pos

Inherited from RenderTask

figura.docs.render_task.pos
overload 1:
TextTask:pos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value a RenderTask
overload 2:
TextTask:pos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

TextTask.emissive

Inherited from RenderTask

figura.docs.render_task.emissive
overload 1:
TextTask:emissive(bool)
Method Property Fluent Description Representation
bool accepts a Boolean
Return Value a RenderTask

TextTask.rot

Inherited from RenderTask

figura.docs.render_task.rot
overload 1:
TextTask:rot(rot)
Method Property Fluent Description Representation
rot accepts a Vector3
Return Value a RenderTask
overload 2:
TextTask:rot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

ToggleAction

subclasses Action

figura.docs.toggle_action

ToggleAction.toggleColor

figura.docs.toggle_action.toggle_color
overload 1:
ToggleAction:toggleColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an Action
overload 2:
ToggleAction:toggleColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an Action

ToggleAction.isToggled

figura.docs.toggle_action.is_toggled
overload 1:
ToggleAction:isToggled()
Method Property Fluent Description Representation
Return Value a Boolean

ToggleAction.toggled

figura.docs.toggle_action.toggled
overload 1:
ToggleAction:toggled(bool)
Method Property Fluent Description Representation
bool accepts a Boolean
Return Value an Action

ToggleAction.onToggle

figura.docs.toggle_action.on_toggle
overload 1:
ToggleAction:onToggle(leftFunction)
Method Property Fluent Description Representation
leftFunction accepts a function
Return Value an Action

ToggleAction.toggleItem

figura.docs.toggle_action.toggle_item
overload 1:
ToggleAction:toggleItem(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value an Action
overload 2:
ToggleAction:toggleItem(item)
Method Property Fluent Description Representation
item accepts a String
Return Value an Action

ToggleAction.toggleTitle

figura.docs.toggle_action.toggle_title
overload 1:
ToggleAction:toggleTitle(title)
Method Property Fluent Description Representation
title accepts a String
Return Value an Action

ToggleAction.onUntoggle

figura.docs.toggle_action.on_untoggle
overload 1:
ToggleAction:onUntoggle(rightFunction)
Method Property Fluent Description Representation
rightFunction accepts a function
Return Value an Action

ToggleAction.color

Inherited from Action

figura.docs.wheel_action.color
overload 1:
ToggleAction:color(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an Action
overload 2:
ToggleAction:color(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an Action

ToggleAction.item

Inherited from Action

figura.docs.wheel_action.item
overload 1:
ToggleAction:item(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value an Action
overload 2:
ToggleAction:item(item)
Method Property Fluent Description Representation
item accepts a String
Return Value an Action

ToggleAction.title

Inherited from Action

figura.docs.wheel_action.title
overload 1:
ToggleAction:title()
Method Property Fluent Description Representation
Return Value an Action
overload 2:
ToggleAction:title(title)
Method Property Fluent Description Representation
title accepts a String
Return Value an Action

ToggleAction.hoverItem

Inherited from Action

figura.docs.wheel_action.hover_item
overload 1:
ToggleAction:hoverItem(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value an Action
overload 2:
ToggleAction:hoverItem(item)
Method Property Fluent Description Representation
item accepts a String
Return Value an Action

ToggleAction.hoverColor

Inherited from Action

figura.docs.wheel_action.hover_color
overload 1:
ToggleAction:hoverColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an Action
overload 2:
ToggleAction:hoverColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an Action

ToggleAction.toggle

figura.docs.toggle_action.toggle
field signature:
toggle
Method Property Fluent Description Representation
Field Type a function

ToggleAction.untoggle

figura.docs.toggle_action.untoggle
field signature:
untoggle
Method Property Fluent Description Representation
Field Type a function

VanillaModelGroup

figura.docs.vanilla_group

VanillaModelGroup.setVisible

figura.docs.vanilla_group.set_visible
overload 1:
VanillaModelGroup:setVisible(vanillaGroup, visible)
Method Property Fluent Description Representation
vanillaGroup accepts a VanillaModelGroup
visible accepts a Boolean
Return Value nil

VanillaModelGroup.getVisible

figura.docs.vanilla_group.get_visible
overload 1:
VanillaModelGroup:getVisible()
Method Property Fluent Description Representation
Return Value a Boolean

VanillaModelPart

An abstract superclass for vanilla model parts and groups
This part can be transformed similar to custom model parts,
however not with the same extent

VanillaModelPart.getOriginRot

figura.docs.vanilla_part.get_origin_rot
overload 1:
VanillaModelPart:getOriginRot()
Method Property Fluent Description Representation
Return Value a Vector3

VanillaModelPart.getOriginPos

figura.docs.vanilla_part.get_origin_pos
overload 1:
VanillaModelPart:getOriginPos()
Method Property Fluent Description Representation
Return Value a Vector3

VanillaModelPart.setVisible

Sets this part to be visible or invisible
overload 1:
VanillaModelPart:setVisible(visible)
Method Property Fluent Description Representation
visible accepts a Boolean
Return Value nil

VanillaModelPart.getVisible

Gets whether you have set this part to be visible or invisible
overload 1:
VanillaModelPart:getVisible()
Method Property Fluent Description Representation
Return Value a Boolean

Vector2

A vector that holds 2 numbers
Can be created using functions in the "vectors" api
Meta name Allowed other parameters Meta execution method
__le
  • Vector2
x <= y
__lt
  • Vector2
x < y
__len
#x
__unm
-x
__eq
  • Vector2
x == y
__mod
  • Number
  • Vector2
x % y
__div
  • Number
  • Vector2
x / y
__mul
  • Number
  • Vector2
  • Matrix2
x * y
__add
  • Vector2
x + y
__sub
  • Vector2
x - y

Vector2.add

Adds the given vector or values to this one, and returns self for chaining
overload 1:
Vector2:add(vec)
Method Property Fluent Description Representation
vec accepts a Vector2
Return Value a Vector2
overload 2:
Vector2:add(x, y)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
Return Value a Vector2

Vector2.length

Returns the length of this vector
overload 1:
Vector2:length()
Method Property Fluent Description Representation
Return Value a Number

Vector2.floor

Returns a copy of this vector with its values rounded down
overload 1:
Vector2:floor()
Method Property Fluent Description Representation
Return Value a Vector2

Vector2.ceil

Returns a copy of this vector with its values rounded up
overload 1:
Vector2:ceil()
Method Property Fluent Description Representation
Return Value a Vector2

Vector2.scale

Scales this vector by the given factor, and returns self for chaining
overload 1:
Vector2:scale(factor)
Method Property Fluent Description Representation
factor accepts a Number
Return Value a Vector2

Vector2.transform

Transforms this vector by the given matrix, and returns self for chaining
overload 1:
Vector2:transform(mat)
Method Property Fluent Description Representation
mat accepts a Matrix2
Return Value a Vector2

Vector2.dot

Returns the dot product of this vector with the other
overload 1:
Vector2:dot(vec)
Method Property Fluent Description Representation
vec accepts a Vector2
Return Value a Number

Vector2.set

Sets this vector to have the given values
Nil values are treated as zero
Returns self for chaining
overload 1:
Vector2:set(vec)
Method Property Fluent Description Representation
vec accepts a Vector2
Return Value a Vector2
overload 2:
Vector2:set(x, y)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
Return Value a Vector2

Vector2.copy

Creates and returns a copy of this vector
overload 1:
Vector2:copy()
Method Property Fluent Description Representation
Return Value a Vector2

Vector2.normalize

Modifies this vector so that its length is 1 unless its length was originally 0
Returns self for chaining
overload 1:
Vector2:normalize()
Method Property Fluent Description Representation
Return Value a Vector2

Vector2.reset

Resets this vector back to being all zeroes, and returns itself for chaining
overload 1:
Vector2:reset()
Method Property Fluent Description Representation
Return Value a Vector2

Vector2.reduce

Reduces this vector modulo the given vector or values, and returns self for chaining
overload 1:
Vector2:reduce(vec)
Method Property Fluent Description Representation
vec accepts a Vector2
Return Value a Vector2
overload 2:
Vector2:reduce(x, y)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
Return Value a Vector2

Vector2.normalized

Returns a copy of this vector with length 1 unless its length was originally 0
overload 1:
Vector2:normalized()
Method Property Fluent Description Representation
Return Value a Vector2

Vector2.sub

Subtracts the given vector or values from this one, and returns self for chaining
overload 1:
Vector2:sub(vec)
Method Property Fluent Description Representation
vec accepts a Vector2
Return Value a Vector2
overload 2:
Vector2:sub(x, y)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
Return Value a Vector2

Vector2.mul

Multiplies the given vector or values into this one, and returns self for chaining
overload 1:
Vector2:mul(vec)
Method Property Fluent Description Representation
vec accepts a Vector2
Return Value a Vector2
overload 2:
Vector2:mul(x, y)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
Return Value a Vector2

Vector2.div

Divides this vector by the given vector or values, and returns self for chaining
overload 1:
Vector2:div(vec)
Method Property Fluent Description Representation
vec accepts a Vector2
Return Value a Vector2
overload 2:
Vector2:div(x, y)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
Return Value a Vector2

Vector2.clamped

Returns a modified copy of this vector, with its length clamped from minLength to maxLength
If the vector has length zero,
then the copy does too
overload 1:
Vector2:clamped(minLength, maxLength)
Method Property Fluent Description Representation
minLength accepts a Number
maxLength accepts a Number
Return Value a Vector2

Vector2.lengthSquared

Returns the length of this vector squared
Suitable when you only care about relative lengths,
because it avoids a square root
overload 1:
Vector2:lengthSquared()
Method Property Fluent Description Representation
Return Value a Number

Vector2.toDeg

Returns a copy of this vector, in degrees
overload 1:
Vector2:toDeg()
Method Property Fluent Description Representation
Return Value a Vector2

Vector2.toRad

Returns a copy of this vector, in radians
overload 1:
Vector2:toRad()
Method Property Fluent Description Representation
Return Value a Vector2

Vector2.applyFunc

Calls the given function on each element of this vector, and sets the values of the vector to the returns
The current index and its value is given as arguments of the function
Returns self for chaining
overload 1:
Vector2:applyFunc(func)
Method Property Fluent Description Representation
func accepts a function that takes a Number and an Integer and will return a Number
Return Value a Vector2

Vector2.clampLength

Modifies this vector so that its length is between minLength and maxLength
If the vector has length zero,
it is unmodified
Returns self for chaining
overload 1:
Vector2:clampLength(minLength, maxLength)
Method Property Fluent Description Representation
minLength accepts a Number
maxLength accepts a Number
Return Value a Vector2

Vector2.x

The first coordinate of this vector
Can also be gotten with the indices "r" and [1]
field signature:
x
Method Property Fluent Description Representation
Field Type a Number

Vector2.y

The second coordinate of this vector
Can also be gotten with the indices "g" and [2]
field signature:
y
Method Property Fluent Description Representation
Field Type a Number

Vector3

A vector that holds 3 numbers
Can be created using functions in the "vectors" api
Meta name Allowed other parameters Meta execution method
__le
  • Vector3
x <= y
__lt
  • Vector3
x < y
__len
#x
__unm
-x
__eq
  • Vector3
x == y
__mod
  • Number
  • Vector3
x % y
__div
  • Number
  • Vector3
x / y
__mul
  • Number
  • Vector3
  • Matrix3
x * y
__add
  • Vector3
x + y
__sub
  • Vector3
x - y

Vector3.add

Adds the given vector or values to this one, and returns self for chaining
overload 1:
Vector3:add(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Vector3
overload 2:
Vector3:add(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Vector3

Vector3.length

Returns the length of this vector
overload 1:
Vector3:length()
Method Property Fluent Description Representation
Return Value a Number

Vector3.floor

Returns a copy of this vector with its values rounded down
overload 1:
Vector3:floor()
Method Property Fluent Description Representation
Return Value a Vector3

Vector3.ceil

Returns a copy of this vector with its values rounded up
overload 1:
Vector3:ceil()
Method Property Fluent Description Representation
Return Value a Vector3

Vector3.scale

Scales this vector by the given factor, and returns self for chaining
overload 1:
Vector3:scale(factor)
Method Property Fluent Description Representation
factor accepts a Number
Return Value a Vector3

Vector3.transform

Transforms this vector by the given matrix, and returns self for chaining
overload 1:
Vector3:transform(mat)
Method Property Fluent Description Representation
mat accepts a Matrix3
Return Value a Vector3

Vector3.dot

Returns the dot product of this vector with the other
overload 1:
Vector3:dot(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Number

Vector3.set

Sets this vector to have the given values
Nil values are treated as zero
Returns self for chaining
overload 1:
Vector3:set(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Vector3
overload 2:
Vector3:set(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Vector3

Vector3.copy

Creates and returns a copy of this vector
overload 1:
Vector3:copy()
Method Property Fluent Description Representation
Return Value a Vector3

Vector3.normalize

Modifies this vector so that its length is 1 unless its length was originally 0
Returns self for chaining
overload 1:
Vector3:normalize()
Method Property Fluent Description Representation
Return Value a Vector3

Vector3.reset

Resets this vector back to being all zeroes, and returns itself for chaining
overload 1:
Vector3:reset()
Method Property Fluent Description Representation
Return Value a Vector3

Vector3.reduce

Reduces this vector modulo the given vector or values, and returns self for chaining
overload 1:
Vector3:reduce(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Vector3
overload 2:
Vector3:reduce(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Vector3

Vector3.normalized

Returns a copy of this vector with length 1 unless its length was originally 0
overload 1:
Vector3:normalized()
Method Property Fluent Description Representation
Return Value a Vector3

Vector3.sub

Subtracts the given vector or values from this one, and returns self for chaining
overload 1:
Vector3:sub(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Vector3
overload 2:
Vector3:sub(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Vector3

Vector3.mul

Multiplies the given vector or values into this one, and returns self for chaining
overload 1:
Vector3:mul(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Vector3
overload 2:
Vector3:mul(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Vector3

Vector3.div

Divides this vector by the given vector or values, and returns self for chaining
overload 1:
Vector3:div(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Vector3
overload 2:
Vector3:div(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Vector3

Vector3.clamped

Returns a modified copy of this vector, with its length clamped from minLength to maxLength
If the vector has length zero,
then the copy does too
overload 1:
Vector3:clamped(minLength, maxLength)
Method Property Fluent Description Representation
minLength accepts a Number
maxLength accepts a Number
Return Value a Vector3

Vector3.lengthSquared

Returns the length of this vector squared
Suitable when you only care about relative lengths,
because it avoids a square root
overload 1:
Vector3:lengthSquared()
Method Property Fluent Description Representation
Return Value a Number

Vector3.augmented

figura.docs.vector3.augmented
overload 1:
Vector3:augmented()
Method Property Fluent Description Representation
Return Value a Vector4

Vector3.crossed

Returns a new vector which is the cross product of this and the other one
overload 1:
Vector3:crossed(other)
Method Property Fluent Description Representation
other accepts a Vector3
Return Value a Vector3

Vector3.toDeg

Returns a copy of this vector, in degrees
overload 1:
Vector3:toDeg()
Method Property Fluent Description Representation
Return Value a Vector3

Vector3.toRad

Returns a copy of this vector, in radians
overload 1:
Vector3:toRad()
Method Property Fluent Description Representation
Return Value a Vector3

Vector3.applyFunc

Calls the given function on each element of this vector, and sets the values of the vector to the returns
The current index and its value is given as arguments of the function
Returns self for chaining
overload 1:
Vector3:applyFunc(func)
Method Property Fluent Description Representation
func accepts a function that takes a Number and an Integer and will return a Number
Return Value a Vector3

Vector3.clampLength

Modifies this vector so that its length is between minLength and maxLength
If the vector has length zero,
it is unmodified
Returns self for chaining
overload 1:
Vector3:clampLength(minLength, maxLength)
Method Property Fluent Description Representation
minLength accepts a Number
maxLength accepts a Number
Return Value a Vector3

Vector3.cross

Sets this vector to the cross product of itself and the other vector
Returns self for chaining
overload 1:
Vector3:cross(other)
Method Property Fluent Description Representation
other accepts a Vector3
Return Value a Vector3

Vector3.x

The first coordinate of this vector
Can also be gotten with the indices "r" and [1]
field signature:
x
Method Property Fluent Description Representation
Field Type a Number

Vector3.y

The second coordinate of this vector
Can also be gotten with the indices "g" and [2]
field signature:
y
Method Property Fluent Description Representation
Field Type a Number

Vector3.z

The third coordinate of this vector
Can also be gotten with the indices "b" and [3]
field signature:
z
Method Property Fluent Description Representation
Field Type a Number

Vector4

A vector that holds 4 numbers
Can be created using functions in the "vectors" api
Meta name Allowed other parameters Meta execution method
__le
  • Vector4
x <= y
__lt
  • Vector4
x < y
__len
#x
__unm
-x
__eq
  • Vector4
x == y
__mod
  • Number
  • Vector4
x % y
__div
  • Number
  • Vector4
x / y
__mul
  • Number
  • Vector4
  • Matrix4
x * y
__add
  • Vector4
x + y
__sub
  • Vector4
x - y

Vector4.add

Adds the given vector or values to this one, and returns self for chaining
overload 1:
Vector4:add(vec)
Method Property Fluent Description Representation
vec accepts a Vector4
Return Value a Vector4
overload 2:
Vector4:add(x, y, z, w)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
Return Value a Vector4

Vector4.length

Returns the length of this vector
overload 1:
Vector4:length()
Method Property Fluent Description Representation
Return Value a Number

Vector4.floor

Returns a copy of this vector with its values rounded down
overload 1:
Vector4:floor()
Method Property Fluent Description Representation
Return Value a Vector4

Vector4.ceil

Returns a copy of this vector with its values rounded up
overload 1:
Vector4:ceil()
Method Property Fluent Description Representation
Return Value a Vector4

Vector4.scale

Scales this vector by the given factor, and returns self for chaining
overload 1:
Vector4:scale(factor)
Method Property Fluent Description Representation
factor accepts a Number
Return Value a Vector4

Vector4.transform

Transforms this vector by the given matrix, and returns self for chaining
overload 1:
Vector4:transform(mat)
Method Property Fluent Description Representation
mat accepts a Matrix4
Return Value a Vector4

Vector4.dot

Returns the dot product of this vector with the other
overload 1:
Vector4:dot(vec)
Method Property Fluent Description Representation
vec accepts a Vector4
Return Value a Number

Vector4.set

Sets this vector to have the given values
Nil values are treated as zero
Returns self for chaining
overload 1:
Vector4:set(vec)
Method Property Fluent Description Representation
vec accepts a Vector4
Return Value a Vector4
overload 2:
Vector4:set(x, y, z, w)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
Return Value a Vector4

Vector4.copy

Creates and returns a copy of this vector
overload 1:
Vector4:copy()
Method Property Fluent Description Representation
Return Value a Vector4

Vector4.normalize

Modifies this vector so that its length is 1 unless its length was originally 0
Returns self for chaining
overload 1:
Vector4:normalize()
Method Property Fluent Description Representation
Return Value a Vector4

Vector4.reset

Resets this vector back to being all zeroes, and returns itself for chaining
overload 1:
Vector4:reset()
Method Property Fluent Description Representation
Return Value a Vector4

Vector4.reduce

Reduces this vector modulo the given vector or values, and returns self for chaining
overload 1:
Vector4:reduce(vec)
Method Property Fluent Description Representation
vec accepts a Vector4
Return Value a Vector4
overload 2:
Vector4:reduce(x, y, z, w)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
Return Value a Vector4

Vector4.normalized

Returns a copy of this vector with length 1 unless its length was originally 0
overload 1:
Vector4:normalized()
Method Property Fluent Description Representation
Return Value a Vector4

Vector4.sub

Subtracts the given vector or values from this one, and returns self for chaining
overload 1:
Vector4:sub(vec)
Method Property Fluent Description Representation
vec accepts a Vector4
Return Value a Vector4
overload 2:
Vector4:sub(x, y, z, w)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
Return Value a Vector4

Vector4.mul

Multiplies the given vector or values into this one, and returns self for chaining
overload 1:
Vector4:mul(vec)
Method Property Fluent Description Representation
vec accepts a Vector4
Return Value a Vector4
overload 2:
Vector4:mul(x, y, z, w)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
Return Value a Vector4

Vector4.div

Divides this vector by the given vector or values, and returns self for chaining
overload 1:
Vector4:div(vec)
Method Property Fluent Description Representation
vec accepts a Vector4
Return Value a Vector4
overload 2:
Vector4:div(x, y, z, w)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
Return Value a Vector4

Vector4.clamped

Returns a modified copy of this vector, with its length clamped from minLength to maxLength
If the vector has length zero,
then the copy does too
overload 1:
Vector4:clamped(minLength, maxLength)
Method Property Fluent Description Representation
minLength accepts a Number
maxLength accepts a Number
Return Value a Vector4

Vector4.lengthSquared

Returns the length of this vector squared
Suitable when you only care about relative lengths,
because it avoids a square root
overload 1:
Vector4:lengthSquared()
Method Property Fluent Description Representation
Return Value a Number

Vector4.toDeg

Returns a copy of this vector, in degrees
overload 1:
Vector4:toDeg()
Method Property Fluent Description Representation
Return Value a Vector4

Vector4.toRad

Returns a copy of this vector, in radians
overload 1:
Vector4:toRad()
Method Property Fluent Description Representation
Return Value a Vector4

Vector4.applyFunc

Calls the given function on each element of this vector, and sets the values of the vector to the returns
The current index and its value is given as arguments of the function
Returns self for chaining
overload 1:
Vector4:applyFunc(func)
Method Property Fluent Description Representation
func accepts a function that takes a Number and an Integer and will return a Number
Return Value a Vector4

Vector4.clampLength

Modifies this vector so that its length is between minLength and maxLength
If the vector has length zero,
it is unmodified
Returns self for chaining
overload 1:
Vector4:clampLength(minLength, maxLength)
Method Property Fluent Description Representation
minLength accepts a Number
maxLength accepts a Number
Return Value a Vector4

Vector4.x

The first coordinate of this vector
Can also be gotten with the indices "r" and [1]
field signature:
x
Method Property Fluent Description Representation
Field Type a Number

Vector4.y

The second coordinate of this vector
Can also be gotten with the indices "g" and [2]
field signature:
y
Method Property Fluent Description Representation
Field Type a Number

Vector4.z

The third coordinate of this vector
Can also be gotten with the indices "b" and [3]
field signature:
z
Method Property Fluent Description Representation
Field Type a Number

Vector4.w

The fourth coordinate of this vector
Can also be gotten with the indices "a" and [4]
field signature:
w
Method Property Fluent Description Representation
Field Type a Number

Vector5

figura.docs.vector5
Meta name Allowed other parameters Meta execution method
__le
  • Vector5
x <= y
__lt
  • Vector5
x < y
__len
#x
__unm
-x
__eq
  • Vector5
x == y
__mod
  • Number
  • Vector5
x % y
__div
  • Number
  • Vector5
x / y
__mul
  • Number
  • Vector5
x * y
__add
  • Vector5
x + y
__sub
  • Vector5
x - y

Vector5.add

Adds the given vector or values to this one, and returns self for chaining
overload 1:
Vector5:add(vec)
typings.2002444082typings.2002444082
Method Property Fluent Description Representation
vec accepts
Return Value
overload 2:
Vector5:add(x, y, z, w, t)
typings.2002444082
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
Return Value

Vector5.length

Returns the length of this vector
overload 1:
Vector5:length()
Method Property Fluent Description Representation
Return Value a Number

Vector5.floor

Returns a copy of this vector with its values rounded down
overload 1:
Vector5:floor()
typings.2002444082
Method Property Fluent Description Representation
Return Value

Vector5.ceil

Returns a copy of this vector with its values rounded up
overload 1:
Vector5:ceil()
typings.2002444082
Method Property Fluent Description Representation
Return Value

Vector5.scale

Scales this vector by the given factor, and returns self for chaining
overload 1:
Vector5:scale(factor)
typings.2002444082
Method Property Fluent Description Representation
factor accepts a Number
Return Value

Vector5.dot

Returns the dot product of this vector with the other
overload 1:
Vector5:dot(vec)
typings.2002444082
Method Property Fluent Description Representation
vec accepts
Return Value a Number

Vector5.set

Sets this vector to have the given values
Nil values are treated as zero
Returns self for chaining
overload 1:
Vector5:set(vec)
typings.2002444082typings.2002444082
Method Property Fluent Description Representation
vec accepts
Return Value
overload 2:
Vector5:set(x, y, z, w, t)
typings.2002444082
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
Return Value

Vector5.copy

Creates and returns a copy of this vector
overload 1:
Vector5:copy()
typings.2002444082
Method Property Fluent Description Representation
Return Value

Vector5.normalize

Modifies this vector so that its length is 1 unless its length was originally 0
Returns self for chaining
overload 1:
Vector5:normalize()
typings.2002444082
Method Property Fluent Description Representation
Return Value

Vector5.reset

Resets this vector back to being all zeroes, and returns itself for chaining
overload 1:
Vector5:reset()
typings.2002444082
Method Property Fluent Description Representation
Return Value

Vector5.reduce

Reduces this vector modulo the given vector or values, and returns self for chaining
overload 1:
Vector5:reduce(vec)
typings.2002444082typings.2002444082
Method Property Fluent Description Representation
vec accepts
Return Value
overload 2:
Vector5:reduce(x, y, z, w, t)
typings.2002444082
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
Return Value

Vector5.normalized

Returns a copy of this vector with length 1 unless its length was originally 0
overload 1:
Vector5:normalized()
typings.2002444082
Method Property Fluent Description Representation
Return Value

Vector5.sub

Subtracts the given vector or values from this one, and returns self for chaining
overload 1:
Vector5:sub(vec)
typings.2002444082typings.2002444082
Method Property Fluent Description Representation
vec accepts
Return Value
overload 2:
Vector5:sub(x, y, z, w, t)
typings.2002444082
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
Return Value

Vector5.mul

Multiplies the given vector or values into this one, and returns self for chaining
overload 1:
Vector5:mul(vec)
typings.2002444082typings.2002444082
Method Property Fluent Description Representation
vec accepts
Return Value
overload 2:
Vector5:mul(x, y, z, w, t)
typings.2002444082
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
Return Value

Vector5.div

Divides this vector by the given vector or values, and returns self for chaining
overload 1:
Vector5:div(vec)
typings.2002444082typings.2002444082
Method Property Fluent Description Representation
vec accepts
Return Value
overload 2:
Vector5:div(x, y, z, w, t)
typings.2002444082
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
Return Value

Vector5.clamped

Returns a modified copy of this vector, with its length clamped from minLength to maxLength
If the vector has length zero,
then the copy does too
overload 1:
Vector5:clamped(minLength, maxLength)
typings.2002444082
Method Property Fluent Description Representation
minLength accepts a Number
maxLength accepts a Number
Return Value

Vector5.lengthSquared

Returns the length of this vector squared
Suitable when you only care about relative lengths,
because it avoids a square root
overload 1:
Vector5:lengthSquared()
Method Property Fluent Description Representation
Return Value a Number

Vector5.toDeg

Returns a copy of this vector, in degrees
overload 1:
Vector5:toDeg()
typings.2002444082
Method Property Fluent Description Representation
Return Value

Vector5.toRad

Returns a copy of this vector, in radians
overload 1:
Vector5:toRad()
typings.2002444082
Method Property Fluent Description Representation
Return Value

Vector5.applyFunc

Calls the given function on each element of this vector, and sets the values of the vector to the returns
The current index and its value is given as arguments of the function
Returns self for chaining
overload 1:
Vector5:applyFunc(func)
typings.2002444082
Method Property Fluent Description Representation
func accepts a function that takes a Number and an Integer and will return a Number
Return Value

Vector5.clampLength

Modifies this vector so that its length is between minLength and maxLength
If the vector has length zero,
it is unmodified
Returns self for chaining
overload 1:
Vector5:clampLength(minLength, maxLength)
typings.2002444082
Method Property Fluent Description Representation
minLength accepts a Number
maxLength accepts a Number
Return Value

Vector5.x

The first coordinate of this vector
Can also be gotten with the indices "r" and [1]
field signature:
x
Method Property Fluent Description Representation
Field Type a Number

Vector5.y

The second coordinate of this vector
Can also be gotten with the indices "g" and [2]
field signature:
y
Method Property Fluent Description Representation
Field Type a Number

Vector5.z

The third coordinate of this vector
Can also be gotten with the indices "b" and [3]
field signature:
z
Method Property Fluent Description Representation
Field Type a Number

Vector5.w

The fourth coordinate of this vector
Can also be gotten with the indices "a" and [4]
field signature:
w
Method Property Fluent Description Representation
Field Type a Number

Vector5.t

figura.docs.vector_n.t
field signature:
t
Method Property Fluent Description Representation
Field Type a Number

Vector6

figura.docs.vector6
Meta name Allowed other parameters Meta execution method
__le
  • Vector6
x <= y
__lt
  • Vector6
x < y
__len
#x
__unm
-x
__eq
  • Vector6
x == y
__mod
  • Number
  • Vector6
x % y
__div
  • Number
  • Vector6
x / y
__mul
  • Number
  • Vector6
x * y
__add
  • Vector6
x + y
__sub
  • Vector6
x - y

Vector6.add

Adds the given vector or values to this one, and returns self for chaining
overload 1:
Vector6:add(vec)
typings.2002444083typings.2002444083
Method Property Fluent Description Representation
vec accepts
Return Value
overload 2:
Vector6:add(x, y, z, w, t, h)
typings.2002444083
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
h accepts a Number
Return Value

Vector6.length

Returns the length of this vector
overload 1:
Vector6:length()
Method Property Fluent Description Representation
Return Value a Number

Vector6.floor

Returns a copy of this vector with its values rounded down
overload 1:
Vector6:floor()
typings.2002444083
Method Property Fluent Description Representation
Return Value

Vector6.ceil

Returns a copy of this vector with its values rounded up
overload 1:
Vector6:ceil()
typings.2002444083
Method Property Fluent Description Representation
Return Value

Vector6.scale

Scales this vector by the given factor, and returns self for chaining
overload 1:
Vector6:scale(factor)
typings.2002444083
Method Property Fluent Description Representation
factor accepts a Number
Return Value

Vector6.dot

Returns the dot product of this vector with the other
overload 1:
Vector6:dot(vec)
typings.2002444083
Method Property Fluent Description Representation
vec accepts
Return Value a Number

Vector6.set

Sets this vector to have the given values
Nil values are treated as zero
Returns self for chaining
overload 1:
Vector6:set(vec)
typings.2002444083typings.2002444083
Method Property Fluent Description Representation
vec accepts
Return Value
overload 2:
Vector6:set(x, y, z, w, t, h)
typings.2002444083
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
h accepts a Number
Return Value

Vector6.copy

Creates and returns a copy of this vector
overload 1:
Vector6:copy()
typings.2002444083
Method Property Fluent Description Representation
Return Value

Vector6.normalize

Modifies this vector so that its length is 1 unless its length was originally 0
Returns self for chaining
overload 1:
Vector6:normalize()
typings.2002444083
Method Property Fluent Description Representation
Return Value

Vector6.reset

Resets this vector back to being all zeroes, and returns itself for chaining
overload 1:
Vector6:reset()
typings.2002444083
Method Property Fluent Description Representation
Return Value

Vector6.reduce

Reduces this vector modulo the given vector or values, and returns self for chaining
overload 1:
Vector6:reduce(vec)
typings.2002444083typings.2002444083
Method Property Fluent Description Representation
vec accepts
Return Value
overload 2:
Vector6:reduce(x, y, z, w, t, h)
typings.2002444083
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
h accepts a Number
Return Value

Vector6.normalized

Returns a copy of this vector with length 1 unless its length was originally 0
overload 1:
Vector6:normalized()
typings.2002444083
Method Property Fluent Description Representation
Return Value

Vector6.sub

Subtracts the given vector or values from this one, and returns self for chaining
overload 1:
Vector6:sub(vec)
typings.2002444083typings.2002444083
Method Property Fluent Description Representation
vec accepts
Return Value
overload 2:
Vector6:sub(x, y, z, w, t, h)
typings.2002444083
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
h accepts a Number
Return Value

Vector6.mul

Multiplies the given vector or values into this one, and returns self for chaining
overload 1:
Vector6:mul(vec)
typings.2002444083typings.2002444083
Method Property Fluent Description Representation
vec accepts
Return Value
overload 2:
Vector6:mul(x, y, z, w, t, h)
typings.2002444083
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
h accepts a Number
Return Value

Vector6.div

Divides this vector by the given vector or values, and returns self for chaining
overload 1:
Vector6:div(vec)
typings.2002444083typings.2002444083
Method Property Fluent Description Representation
vec accepts
Return Value
overload 2:
Vector6:div(x, y, z, w, t, h)
typings.2002444083
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
h accepts a Number
Return Value

Vector6.clamped

Returns a modified copy of this vector, with its length clamped from minLength to maxLength
If the vector has length zero,
then the copy does too
overload 1:
Vector6:clamped(minLength, maxLength)
typings.2002444083
Method Property Fluent Description Representation
minLength accepts a Number
maxLength accepts a Number
Return Value

Vector6.lengthSquared

Returns the length of this vector squared
Suitable when you only care about relative lengths,
because it avoids a square root
overload 1:
Vector6:lengthSquared()
Method Property Fluent Description Representation
Return Value a Number

Vector6.toDeg

Returns a copy of this vector, in degrees
overload 1:
Vector6:toDeg()
typings.2002444083
Method Property Fluent Description Representation
Return Value

Vector6.toRad

Returns a copy of this vector, in radians
overload 1:
Vector6:toRad()
typings.2002444083
Method Property Fluent Description Representation
Return Value

Vector6.applyFunc

Calls the given function on each element of this vector, and sets the values of the vector to the returns
The current index and its value is given as arguments of the function
Returns self for chaining
overload 1:
Vector6:applyFunc(func)
typings.2002444083
Method Property Fluent Description Representation
func accepts a function that takes a Number and an Integer and will return a Number
Return Value

Vector6.clampLength

Modifies this vector so that its length is between minLength and maxLength
If the vector has length zero,
it is unmodified
Returns self for chaining
overload 1:
Vector6:clampLength(minLength, maxLength)
typings.2002444083
Method Property Fluent Description Representation
minLength accepts a Number
maxLength accepts a Number
Return Value

Vector6.x

The first coordinate of this vector
Can also be gotten with the indices "r" and [1]
field signature:
x
Method Property Fluent Description Representation
Field Type a Number

Vector6.y

The second coordinate of this vector
Can also be gotten with the indices "g" and [2]
field signature:
y
Method Property Fluent Description Representation
Field Type a Number

Vector6.z

The third coordinate of this vector
Can also be gotten with the indices "b" and [3]
field signature:
z
Method Property Fluent Description Representation
Field Type a Number

Vector6.w

The fourth coordinate of this vector
Can also be gotten with the indices "a" and [4]
field signature:
w
Method Property Fluent Description Representation
Field Type a Number

Vector6.t

figura.docs.vector_n.t
field signature:
t
Method Property Fluent Description Representation
Field Type a Number

Vector6.h

figura.docs.vector_n.h
field signature:
h
Method Property Fluent Description Representation
Field Type a Number

math

Contains functions which Figura adds to the default Lua "math" library table

math.map

Maps the given value from one range to another
For example,
if you have a value of 20 in the range 0-200, and you want to map it to the range 100-200, the result will be 110
overload 1:
math.map(value, oldMin, oldMax, newMin, newMax)
Method Property Fluent Description Representation
value accepts a Number
oldMin accepts a Number
oldMax accepts a Number
newMin accepts a Number
newMax accepts a Number
Return Value a Number

math.round

Rounds the given number to the nearest whole integer
overload 1:
math.round(value)
Method Property Fluent Description Representation
value accepts a Number
Return Value a Number

math.sign

Returns the sign of the given number
Returns 1 if the number is positive,
-1 if it's negative, and 0 if it's 0
overload 1:
math.sign(value)
Method Property Fluent Description Representation
value accepts a Number
Return Value a Number

math.clamp

Clamps the given value between min and max
overload 1:
math.clamp(value, min, max)
Method Property Fluent Description Representation
value accepts a Number
min accepts a Number
max accepts a Number
Return Value a Number

math.shortAngle

Returns the shortest angle between two angles
For example,
if you have an angle of 350 degrees and you want to get the shortest angle between it and 0 degrees, the result will be 10 degrees
overload 1:
math.shortAngle(from, to)
Method Property Fluent Description Representation
from accepts a Number
to accepts a Number
Return Value a Number

math.lerp

Linearly interpolates from its first argument to its second argument, with the third argument as the parameter
Works on both regular numbers,
vectors of the same type, and matrices of the same type
overload 1:
math.lerp(a, b, t)
Method Property Fluent Description Representation
a accepts a Number
b accepts a Number
t accepts a Number
Return Value a Number
overload 2:
math.lerp(a, b, t)
Method Property Fluent Description Representation
a accepts a Vector2
b accepts a Vector2
t accepts a Number
Return Value a Vector2
overload 3:
math.lerp(a, b, t)
Method Property Fluent Description Representation
a accepts a Vector3
b accepts a Vector3
t accepts a Number
Return Value a Vector3
overload 4:
math.lerp(a, b, t)
Method Property Fluent Description Representation
a accepts a Vector4
b accepts a Vector4
t accepts a Number
Return Value a Vector4
overload 5:
math.lerp(a, b, t)
typings.2002444082typings.2002444082typings.2002444082
Method Property Fluent Description Representation
a accepts
b accepts
t accepts a Number
Return Value
overload 6:
math.lerp(a, b, t)
typings.2002444083typings.2002444083typings.2002444083
Method Property Fluent Description Representation
a accepts
b accepts
t accepts a Number
Return Value

math.lerpAngle

Similar to the default lerp function, but numbers are limited to the range of 0-360
Lerp is done towards the shortest angle
For example,
a lerp of 340 and 20, with a factor of 0.75, will return 10
overload 1:
math.lerpAngle(a, b, t)
Method Property Fluent Description Representation
a accepts a Number
b accepts a Number
t accepts a Number
Return Value a Number

EntityPoses

List of valid EntityPoses
Used within the EntityAPI
STANDING
FALL_FLYING
SLEEPING
SWIMMING
SPIN_ATTACK
CROUCHING
LONG_JUMPING
DYING
CROAKING
USING_TONGUE
ROARING
SNIFFING
EMERGING
DIGGING

ItemRenderTypes

figura.docs.enum.item_render_types
NONE
THIRD_PERSON_LEFT_HAND
THIRD_PERSON_RIGHT_HAND
FIRST_PERSON_LEFT_HAND
FIRST_PERSON_RIGHT_HAND
HEAD
GUI
GROUND
FIXED

KeyIDs

List of valid KeyIDs
Used within the KeybindAPI
key.playerlist
figura.config.action_wheel_button
key.sneak
key.hotbar.8
key.hotbar.7
key.sprint
key.hotbar.6
key.hotbar.5
key.hotbar.4
key.hotbar.3
key.hotbar.2
key.togglePerspective
key.hotbar.1
key.spectatorOutlines
key.left
key.chat
key.pickItem
key.socialInteractions
key.fullscreen
key.attack
key.smoothCamera
key.advancements
figura.config.popup_button
key.use
figura.config.panic_button
key.loadToolbarActivator
figura.config.reload_button
key.hotbar.9
key.forward
key.right
key.screenshot
key.back
key.swapOffhand
key.command
key.saveToolbarActivator
key.inventory
key.jump
key.drop

Keybinds

List of valid keybind keys
Used within the KeybindAPI
key.keyboard.unknown
key.mouse.left
key.mouse.right
key.mouse.middle
key.mouse.4
key.mouse.5
key.mouse.6
key.mouse.7
key.mouse.8
key.keyboard.0
key.keyboard.1
key.keyboard.2
key.keyboard.3
key.keyboard.4
key.keyboard.5
key.keyboard.6
key.keyboard.7
key.keyboard.8
key.keyboard.9
key.keyboard.a
key.keyboard.b
key.keyboard.c
key.keyboard.d
key.keyboard.e
key.keyboard.f
key.keyboard.g
key.keyboard.h
key.keyboard.i
key.keyboard.j
key.keyboard.k
key.keyboard.l
key.keyboard.m
key.keyboard.n
key.keyboard.o
key.keyboard.p
key.keyboard.q
key.keyboard.r
key.keyboard.s
key.keyboard.t
key.keyboard.u
key.keyboard.v
key.keyboard.w
key.keyboard.x
key.keyboard.y
key.keyboard.z
key.keyboard.f1
key.keyboard.f2
key.keyboard.f3
key.keyboard.f4
key.keyboard.f5
key.keyboard.f6
key.keyboard.f7
key.keyboard.f8
key.keyboard.f9
key.keyboard.f10
key.keyboard.f11
key.keyboard.f12
key.keyboard.f13
key.keyboard.f14
key.keyboard.f15
key.keyboard.f16
key.keyboard.f17
key.keyboard.f18
key.keyboard.f19
key.keyboard.f20
key.keyboard.f21
key.keyboard.f22
key.keyboard.f23
key.keyboard.f24
key.keyboard.f25
key.keyboard.num.lock
key.keyboard.keypad.0
key.keyboard.keypad.1
key.keyboard.keypad.2
key.keyboard.keypad.3
key.keyboard.keypad.4
key.keyboard.keypad.5
key.keyboard.keypad.6
key.keyboard.keypad.7
key.keyboard.keypad.8
key.keyboard.keypad.9
key.keyboard.keypad.add
key.keyboard.keypad.decimal
key.keyboard.keypad.enter
key.keyboard.keypad.equal
key.keyboard.keypad.multiply
key.keyboard.keypad.divide
key.keyboard.keypad.subtract
key.keyboard.down
key.keyboard.left
key.keyboard.right
key.keyboard.up
key.keyboard.apostrophe
key.keyboard.backslash
key.keyboard.comma
key.keyboard.equal
key.keyboard.grave.accent
key.keyboard.left.bracket
key.keyboard.minus
key.keyboard.period
key.keyboard.right.bracket
key.keyboard.semicolon
key.keyboard.slash
key.keyboard.space
key.keyboard.tab
key.keyboard.left.alt
key.keyboard.left.control
key.keyboard.left.shift
key.keyboard.left.win
key.keyboard.right.alt
key.keyboard.right.control
key.keyboard.right.shift
key.keyboard.right.win
key.keyboard.enter
key.keyboard.escape
key.keyboard.backspace
key.keyboard.delete
key.keyboard.end
key.keyboard.home
key.keyboard.insert
key.keyboard.page.down
key.keyboard.page.up
key.keyboard.caps.lock
key.keyboard.pause
key.keyboard.scroll.lock
key.keyboard.menu
key.keyboard.print.screen
key.keyboard.world.1
key.keyboard.world.2

LoopModes

List of valid LoopModes
Used within Blockbench animations
LOOP
ONCE
HOLD

ParentTypes

List of valid ParentTypes
Used within ModelParts
None
NONE
Head
HEAD
Body
BODY
LeftArm
LEFT_ARM
RightArm
RIGHT_ARM
LeftLeg
LEFT_LEG
RightLeg
RIGHT_LEG
LeftElytra
LEFT_ELYTRA
LeftElytron
LEFT_ELYTRON
RightElytra
RIGHT_ELYTRA
RightElytron
RIGHT_ELYTRON
Cape
CAPE
World
WORLD
Hud
HUD
Gui
GUI
Camera
CAMERA
Skull
SKULL
?
LeftItemPivot
LEFT_ITEM_PIVOT
RightItemPivot
RIGHT_ITEM_PIVOT
LeftSpyglassPivot
LEFT_SPYGLASS_PIVOT
RightSpyglassPivot
RIGHT_SPYGLASS_PIVOT
HelmetItemPivot
HELMET_ITEM_PIVOT
LeftParrotPivot
LEFT_PARROT_PIVOT
RightParrotPivot
RIGHT_PARROT_PIVOT

PlayStates

List of valid PlayStates
Used within Blockbench animations
STOPPED
PAUSED
PLAYING

PostEffects

List of valid PostEffects
Used within the RendererAPI
notch
fxaa
art
bumpy
blobs2
pencil
color_convolve
deconverge
flip
invert
ntsc
outline
phosphor
scan_pincushion
sobel
bits
desaturate
green
blur
wobble
blobs
antialias
creeper
spider

RenderTypes

List of valid RenderTypes
Used within ModelParts
CUTOUT
CUTOUT_CULL
TRANSLUCENT
TRANSLUCENT_CULL
EMISSIVE
EMISSIVE_SOLID
END_PORTAL
END_GATEWAY
GLINT
GLINT2
LINES
LINES_STRIP

TextureTypes

List of valid TextureTypes
Used within ModelParts
skin
cape
elytra
resource
texture
a a