Show not everything 
log 
action_wheel Miscellaneous Types
Miscellaneous Enums
Colors EntityPoses ItemRenderTypes KeyIDs Keybinds LoopModes ParentTypes PlayStates PlayerModelParts PostEffects RenderTypes TextureTypeslogTable
figura.docs.globals.log_table
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
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
printJson
Example by ChloeSpacedOut:
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
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
printTable
Example by ChloeSpacedOut:
local table = {'string',{'tableception'}}
printTable(table,2) 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
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
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 `../`
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 `../`
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
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
ActionWheelAPI.isEnabled
Example by ChloeSpacedOut:
examplePage = action_wheel:createPage()
action_wheel:setPage(examplePage)
events.TICK:register(function()
if action_wheel:isEnabled() then
log("action wheel's is open!")
end
end) ActionWheelAPI.getSelected
Example by ChloeSpacedOut:
examplePage = action_wheel:createPage()
action_wheel:setPage(examplePage)
for slot = 1,8 do
examplePage:newAction(slot)
end
events.TICK:register(function()
log(action_wheel:getSelected())
end)
-- returns even if the action wheel is closed 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
ActionWheelAPI.createPage
Example by ChloeSpacedOut:
ActionWheelAPI.getPage
Example by ChloeSpacedOut:
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 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 ActionWheelAPI.scroll
Example by ChloeSpacedOut:
examplePage = action_wheel:createPage('pageName')
action_wheel:setPage(examplePage)
function action_wheel.scroll(direction)
log(direction)
end avatar
The global instance of AvatarAPI
field signature:
avatar 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
Someone else can get this information from a different script with the avatarVars() function in World
The key must be 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.
client
The global instance of ClientAPI
field signature:
client ClientAPI.getVersion
Example by ChloeSpacedOut:
log(client.getVersion()) ClientAPI.getEntityStatistics
Example by ChloeSpacedOut:
ClientAPI.getSoundStatistics
Example by ChloeSpacedOut:
ClientAPI.getVersionType
Example by ChloeSpacedOut:
ClientAPI.getChunkStatistics
Example by ChloeSpacedOut:
ClientAPI.getJavaVersion
Example by ChloeSpacedOut:
ClientAPI.getMaxMemory
Example by ChloeSpacedOut:
ClientAPI.getAllocatedMemory
Example by ChloeSpacedOut:
ClientAPI.getServerBrand
Example by ChloeSpacedOut:
ClientAPI.getUsedMemory
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getUsedMemory())
end)
-- returns memory in bytes ClientAPI.getTextWidth
Example by ChloeSpacedOut:
ClientAPI.getGuiScale
Example by ChloeSpacedOut:
log(client.getGuiScale()) ClientAPI.getTextHeight
Example by ChloeSpacedOut:
ClientAPI.getActiveLang
Example by ChloeSpacedOut:
events
The global instance of the EventsAPI and its subtypes
field signature:
events 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
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
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
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
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
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
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
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
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)
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)
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
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
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
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
host
The global instance of 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
The slot is either their numerical id (0 indexed) or the slot string, as used in the /item command
HostAPI.setTitleTimes
Sets the duration of the title on the screen, also its fade-in and fade-out durations
HostAPI.setActionbar
Sets the action bar message to the given text
The boolean parameter defaults to false
The boolean parameter defaults to false
HostAPI.swingArm
Animates swinging the player's arm
If the boolean is true, then the offhand is the one that swings
If the boolean is true, then the offhand is the one that swings
HostAPI.setChatColor
Sets the color of the text that is currently being typed into the chat window
keybind
figura.docs.globals.keybind
KeybindAPI.create
figura.docs.keybind_api.create
matrices
The global instance of the MatricesAPI and its subtypes
MatricesAPI.scale2
Creates a new Matrix2 that scales by the specified factors
MatricesAPI.mat2
Creates a Matrix2 using the given parameters as columns
If you call the function with no parameters, returns the 2x2 identity matrix
If you call the function with no parameters, returns the 2x2 identity matrix
MatricesAPI.mat4
Creates a Matrix4 using the given parameters as columns
If you call the function with no parameters, returns the 4x4 identity matrix
If you call the function with no parameters, returns the 4x4 identity matrix
MatricesAPI.mat3
Creates a Matrix3 using the given parameters as columns
If you call the function with no parameters, returns the 3x3 identity matrix
If you call the function with no parameters, returns the 3x3 identity matrix
MatricesAPI.translate4
Creates a new Matrix4 that translates by the specified offset
MatricesAPI.rotation4
Creates a new Matrix4 that rotates by the specified angles
Angles are given in degrees, and the rotation order is ZYX
Angles are given in degrees, and the rotation order is ZYX
MatricesAPI.scale3
Creates a new Matrix3 that scales by the specified factors
MatricesAPI.translate3
Creates a new Matrix3 that translates by the specified offset
MatricesAPI.rotation3
Creates a new Matrix3 that rotates by the specified angles
Angles are given in degrees, and the rotation order is ZYX
Angles are given in degrees, and the rotation order is ZYX
MatricesAPI.scale4
Creates a new Matrix4 that scales by the specified factors
models
The global instance of the Avatar Models and its subtypes
field signature:
models 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
Values are RGB from 0 to 1
ModelPart.setScale
Sets the scale factor for this part
Nil values for scale are assumed to be 1
Nil values for scale are assumed to be 1
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
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.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
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
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
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.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
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
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
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
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
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.offsetPivot
figura.docs.model_part.offset_pivot
ModelPart.offsetRot
figura.docs.model_part.offset_rot
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
Nil values for rotation are assumed to be 0
Angles are given in degrees
For relative rotation values, check out the "offset" rot functions
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
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
ModelPart.setPos
Sets the position offset for this part from its Blockbench position
Nil values for position are assumed to be 0
Nil values for position are assumed to be 0
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
Nil values are assumed to be 0
For relative pivot offsets, check out the "offset" pivot functions
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
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
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
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
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
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
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
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
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
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
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
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
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.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
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
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
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
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 |
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 7:
particles:addParticle(name, posX, posY, posZ, velX, velY, velZ) player
The global instance of the EntityAPI and its subtypes
field signature:
player PlayerAPI.getExperienceProgress
Example by JimmyHelp:
if player:getExperienceProgress() > .5 then
log("You're over halfway to the next level")
end PlayerAPI.getSaturation
Example by JimmyHelp:
if player:getSaturation() == 20 then
log("Your saturation is 20")
end PlayerAPI.getFood
Example by JimmyHelp:
if player:getFood() == 0 then
log("You're starving")
end PlayerAPI.getExperienceLevel
Example by JimmyHelp:
if player:getExperienceLevel() == 30 then
log("You have 30 levels")
end PlayerAPI.isFlying
Example by JimmyHelp:
if player:isFlying() then
log("You're flying")
end PlayerAPI.getModelType
Example by JimmyHelp:
if player:getModelType() == "DEFAULT" then
log("You're Steve")
end PlayerAPI.isSkinLayerVisible
Example by JimmyHelp:
if player:isSkinLayerVisible("HAT") then
log("Your hat's on")
end PlayerAPI.getGamemode
Example by JimmyHelp:
if player:getGamemode() and player:getGamemode() == "SURVIVAL" then
log("You're in survival mode")
end 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
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
PlayerAPI.getActiveItem
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getActiveItem().id == "minecraft:bow" then
log("You're drawing back a bow")
end PlayerAPI.getHealth
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getHealth() == 20 then
log("You're at full health")
end PlayerAPI.getHeldItem
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getHeldItem(false).id == "minecraft:diamond_sword" then
log("You're holding a diamond sword")
end 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
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
PlayerAPI.isLeftHanded
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isLeftHanded() then
log("You're left handed")
end PlayerAPI.getActiveHand
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getActiveHand() == "MAIN_HAND" then
log("You're using your main hand")
end PlayerAPI.getArmor
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getArmor() == 20 then
log("You have max armor points")
end PlayerAPI.getArrowCount
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getArrowCount() > 0 then
log("You've been shot")
end PlayerAPI.isClimbing
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isClimbing() then
log("You're climbing")
end PlayerAPI.isUsingItem
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isUsingItem() then
log("You're using an item")
end PlayerAPI.getDeathTime
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getDeathTime() > 0 then
log("You're dead")
end PlayerAPI.getStingerCount
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getStingerCount() > 0 then
log("You've been stung")
end PlayerAPI.getMaxHealth
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getMaxHealth() == 20 then
log("You're healthy")
end PlayerAPI.getStatusEffects
Inherited from LivingEntityAPI
Example by JimmyHelp:
for i, effect in ipairs(player:getStatusEffects()) do
if effect.name == "effect.minecraft.night_vision" then
log("Night vision")
end
end PlayerAPI.getName
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getName() == "JimmyHelp" then
log("You're... me?")
end PlayerAPI.getType
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getType() == "minecraft:player" then
log("You're a player")
end PlayerAPI.isLoaded
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isLoaded() then
log("You're being loaded")
end PlayerAPI.getItem
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getItem(5).id == "minecraft:elytra" then
log("You're wearing an elytra")
end 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
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
PlayerAPI.getNbt
Inherited from LivingEntityAPI
PlayerAPI.getRot
Inherited from LivingEntityAPI
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
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
PlayerAPI.getFrozenTicks
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getFrozenTicks() == 140 then
log("You're being frozen solid")
end PlayerAPI.getPos
Inherited from LivingEntityAPI
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
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
PlayerAPI.getMaxAir
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getMaxAir() == 300 then
log("You've got healthy lungs")
end PlayerAPI.isHamburger
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isHamburger() then
log("You're hamburger")
end PlayerAPI.getDimensionName
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getDimensionName() == "minecraft:overworld" then
log("You're in the Overworld")
end PlayerAPI.getAir
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getAir() < 0 then
log("You're drowning")
end PlayerAPI.getVelocity
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getVelocity():length() > 0 then
log("You're moving in any direction")
end PlayerAPI.getUUID
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getUUID() == "5003b2ce-7a8d-4c56-8b91-ec705985fe08" then
log("You're... me?")
end PlayerAPI.hasAvatar
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:hasAvatar() then
log("You have an avatar")
end PlayerAPI.isGlowing
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isGlowing() then
log("You're glowing")
end PlayerAPI.getEyeY
Inherited from LivingEntityAPI
PlayerAPI.getVehicle
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getVehicle() and player:getVehicle():getType() == "minecraft:pig" then
log("You're riding a pig")
end PlayerAPI.isOnGround
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isOnGround() then
log("You're on the ground")
end PlayerAPI.isInvisible
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isInvisible() then
log("You're invisible")
end PlayerAPI.getPose
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getPose() == "CROUCHING" then
log("You're crouching")
end PlayerAPI.isSprinting
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isSprinting() then
log("You're sprinting")
end PlayerAPI.isSilent
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isSilent() then
log("You're silent")
end PlayerAPI.isSneaking
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isSneaking() then
log("You're sneaking")
end PlayerAPI.isInLava
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isInLava() then
log("You're in lava")
end PlayerAPI.isInWater
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isInWater() then
log("You're in water")
end PlayerAPI.isUnderwater
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isUnderwater() then
log("You're underwater")
end PlayerAPI.isInRain
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isInRain() then
log("You're in rain")
end PlayerAPI.isWet
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isWet() then
log("You're touching water")
end PlayerAPI.getVariable
Inherited from LivingEntityAPI
PlayerAPI.getTargetedBlock
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getTargetedBlock(true,4.5).id == "minecraft:grass_block" then
log("You're looking at grass")
end 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
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.isOnFire
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isOnFire() then
log("You're on fire")
end renderer
The global instance of RendererAPI
RendererAPI.offsetCameraRot
figura.docs.renderer.offset_camera_rot
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
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
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
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
RendererAPI.offsetCameraPivot
figura.docs.renderer.offset_camera_pivot
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
The default value is nil, which means to use the vanilla default of 0.5 for players
The maximum value is 12
RendererAPI.setCameraPos
Sets the position offset for the camera
Nil values for position are assumed to be 0
Nil values for position are assumed to be 0
sounds
The global instance of SoundAPI
field signature:
sounds SoundAPI.stopSound
Stops the playing sounds from this avatar
If an id is specified, it only stops the sounds from that id
If an id is specified, it only stops the sounds from that id
SoundAPI.addSound
figura.docs.sounds.add_sound
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
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 4:
sounds:playSound(sound, posX, posY, posZ, volume, pitch, loop) 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
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
user
An alias for player, just in case the user of your avatar isn't a player
(Foreshadowing?)
(Foreshadowing?)
field signature:
user 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
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
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
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
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
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
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
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 |
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
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 | (Number, Number, Number | nil, Number | nil, Number | nil, Number | nil) -> AnyType where (Number, Number) -> Vector2 and (Number, Number, Number) -> Vector3 and (Number, Number, Number, Number) -> Vector4 and (Number, Number, Number, Number, Number) -> Vector5 and (Number, Number, Number, Number, Number, Number) -> Vector6 |
vectors
The global instance of the VectorsAPI and its subtypes
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
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
VectorsAPI.vec6
figura.docs.vectors.vec6
VectorsAPI.worldToScreenSpace
Converts a position in the world into a position relative to the viewer's screen
VectorsAPI.rotateAroundAxis
Rotates a vector relative to a rotation vector
overload 3:
vectors.rotateAroundAxis(angle, vec, axisX, axisY, axisZ) overload 4:
vectors.rotateAroundAxis(angle, x, y, z, axisX, axisY, axisZ) 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"
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"
VectorsAPI.toCameraSpace
Converts a position in the world into a position relative to the viewer's camera
VectorsAPI.rgbToHSV
Converts the given color from RGB format to HSV format
VectorsAPI.hsvToRGB
Converts the given color from HSV format to RGB format
VectorsAPI.rgbToInt
Converts the given color from RGB format to Integer format
VectorsAPI.rgbToHex
Converts the given color from RGB format to Hex format
The "#" is not included on the return value
The "#" is not included on the return value
VectorsAPI.rainbow
figura.docs.vectors.rainbow
world
The global instance of the WorldAPI and its subtypes
field signature:
world 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
If delta is passed in, then it adds delta to the time
The default value of delta is zero
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
If delta is passed in, then it adds delta to the time
The default value of delta is zero
WorldAPI.getStrongRedstonePower
Gets the direct redstone power level of the block at the given position
WorldAPI.getBiome
Gets the Biome located at the given position
WorldAPI.getSkyLightLevel
Gets the skylight level of the block at the given position
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
The default value of delta is 1, which is the current tick
WorldAPI.isOpenSky
Gets whether or not the sky is open at the given position
WorldAPI.getRedstonePower
Gets the redstone power level of the block at the given position
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.getLightLevel
Gets the overall light level of the block at the given position
WorldAPI.newBlock
Parses and creates a new BlockState from the given string
A world position can be optionally given for the blockstate functions that rely on its position
A world position can be optionally given for the blockstate functions that rely on its position
overload 1:
world.newBlock(block) | Method Property | Fluent Description | Representation |
|---|---|---|
| block accepts | a String | |
| Return Value | a BlockState |
overload 2:
world.newBlock(block, pos) | Method Property | Fluent Description | Representation |
|---|---|---|
| block accepts | a String | |
| pos accepts | a Vector3 | |
| Return Value | a BlockState |
overload 3:
world.newBlock(block, x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| block accepts | a String | |
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a BlockState |
WorldAPI.getBlockLightLevel
Gets the block light level of the block at the given position
WorldAPI.newItem
Parses and creates a new ItemStack from the given string
A count and damage can be given, to be applied on this itemstack
A count and damage can be given, to be applied on this itemstack
Action
An action in the Figura Action Wheel
Actions are either interacted by clicking and scrolling, which also being able to be toggleable
Actions are either interacted by clicking and scrolling, which also being able to be toggleable
Action.color
figura.docs.wheel_action.color
Action.item
figura.docs.wheel_action.item
Action.hoverItem
figura.docs.wheel_action.hover_item
Action.hoverColor
figura.docs.wheel_action.hover_color
Animation
A Blockbench animation
Animation.play
Example by JimmyHelp:
animations.bbmodelName.animationName:play() Biome
A proxy for a Minecraft biome
Instances are obtained through the WorldAPI
This proxy also contains a saved position for the Biome
Instances are obtained through the WorldAPI
This proxy also contains a saved position for the Biome
Biome.setPos
Sets the saved position for this Biome's proxy
The saved position is used in Biome functions that require a position
The saved position is used in Biome functions that require a position
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
Instances are obtained through the WorldAPI
This proxy also contains a saved position for the BlockState
BlockState.setPos
Sets the saved position for this BlockState proxy
The saved position is used in BlockState functions that require a position
The saved position is used in BlockState functions that require a position
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
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
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
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
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
Since the mod is only on client side, this NBT might not actually contain the real nbt, which is stored server-side
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.isEnabled
Inherited from RenderTask
BlockTask.isEmissive
Inherited from 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 |
BlockTask.getScale
Inherited from RenderTask
BlockTask.getRot
Inherited from RenderTask
BlockTask.getPos
Inherited from RenderTask
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.getTitle
Inherited from Action
ClickAction.title
Inherited from Action
ClickAction.getHoverColor
Inherited from Action
ClickAction.getColor
Inherited from Action
ClickAction.leftClick
figura.docs.click_action.left_click
ClickAction.rightClick
figura.docs.click_action.right_click
EntityNameplateCustomization
subclasses NameplateCustomization
A nameplate customization that is specialized for entities
EntityNameplateCustomization.setScale
Sets the scale factor of the nameplate
EntityNameplateCustomization.setPos
Sets the position offset of the nameplate, in world coordinates
EntityNameplateCustomization.setBackgroundColor
Sets the color of the nameplate background
If the alpha value is not given, it will use the vanilla value (as in the accessibility settings)
If the alpha value is not given, it will use the vanilla value (as in the accessibility settings)
EntityNameplateCustomization.getText
Inherited from NameplateCustomization
EntityNameplateCustomization.setText
Inherited from NameplateCustomization
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
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
Returns the number of functions that were removed
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
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 |
ItemStack
A proxy for an item stack from Minecraft
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.isEnabled
Inherited from RenderTask
ItemTask.isEmissive
Inherited from 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 |
ItemTask.getScale
Inherited from RenderTask
ItemTask.getRot
Inherited from RenderTask
ItemTask.getPos
Inherited from RenderTask
Keybind
Represents a key binding for your script
Instances are obtained using the KeybindAPI's create() function
Instances are obtained using the KeybindAPI's create() function
Keybind.onPress
figura.docs.keybind.on_press
field signature:
onPress | Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | typings.1812163554
Keybind.onRelease
figura.docs.keybind.on_release
field signature:
onRelease | Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | typings.1812163554
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
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
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
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
LivingEntityAPI.getName
Inherited from EntityAPI
LivingEntityAPI.getType
Inherited from EntityAPI
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
A non-loaded entity would be someone or something which is in another dimension or out of the render distance for example
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
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
LivingEntityAPI.getNbt
Inherited from EntityAPI
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
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
LivingEntityAPI.getFireTicks
Inherited from EntityAPI
LivingEntityAPI.getFrozenTicks
Inherited from EntityAPI
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
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
LivingEntityAPI.getLookDir
Inherited from EntityAPI
LivingEntityAPI.getMaxAir
Inherited from EntityAPI
LivingEntityAPI.isHamburger
Inherited from EntityAPI
LivingEntityAPI.getDimensionName
Inherited from EntityAPI
LivingEntityAPI.getAir
Inherited from EntityAPI
LivingEntityAPI.getVelocity
Inherited from EntityAPI
LivingEntityAPI.getUUID
Inherited from EntityAPI
LivingEntityAPI.hasAvatar
Inherited from EntityAPI
LivingEntityAPI.getBoundingBox
Inherited from EntityAPI
LivingEntityAPI.isGlowing
Inherited from EntityAPI
LivingEntityAPI.getEyeY
Inherited from EntityAPI
LivingEntityAPI.getEyeHeight
Inherited from EntityAPI
LivingEntityAPI.getVehicle
Inherited from EntityAPI
LivingEntityAPI.isOnGround
Inherited from EntityAPI
LivingEntityAPI.isInvisible
Inherited from EntityAPI
LivingEntityAPI.getPose
Inherited from EntityAPI
LivingEntityAPI.isSprinting
Inherited from EntityAPI
LivingEntityAPI.isSilent
Inherited from EntityAPI
LivingEntityAPI.isSneaking
Inherited from EntityAPI
LivingEntityAPI.isInLava
Inherited from EntityAPI
LivingEntityAPI.isInWater
Inherited from EntityAPI
LivingEntityAPI.isUnderwater
Inherited from EntityAPI
LivingEntityAPI.isInRain
Inherited from EntityAPI
LivingEntityAPI.isWet
Inherited from EntityAPI
LivingEntityAPI.getVariable
Inherited from EntityAPI
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
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.isOnFire
Inherited from EntityAPI
Matrix2
A matrix with 2 rows and 2 columns
| Meta name | Allowed other parameters | Meta execution method |
|---|---|---|
__le |
| x <= y |
__eq |
| x == y |
__mul |
| x * y |
__add |
| x + y |
__sub |
| x - y |
__len | #x |
Matrix2.scale
Scales this matrix by the specified amount, changing the values inside
Returns self for chaining
Returns self for chaining
Matrix3
A matrix with 3 rows and 3 columns
| Meta name | Allowed other parameters | Meta execution method |
|---|---|---|
__le |
| x <= y |
__eq |
| x == y |
__mul |
| x * y |
__add |
| x + y |
__sub |
| x - y |
__len | #x |
Matrix3.scale
Scales this matrix by the specified amount, changing the values inside
Returns self for chaining
Returns self for chaining
Matrix3.apply
Treats the given values as a vector, augments this vector with a 1, multiplies it against the matrix, and returns a deaugmented vector of the first values
Matrix3.rotate
Rotates this matrix by the specified amount, changing the values inside
Angles are given in degrees
Returns self for chaining
Angles are given in degrees
Returns self for chaining
Matrix3.translate
Translates this matrix by the specified amount, changing the values inside
Returns self for chaining
Returns self for chaining
Matrix3.applyDir
Treats the given values as a vector, augments this vector with a 0, multiplies it against the matrix, and returns a deaugmented vector of the first values
Matrix4
A matrix with 4 rows and 4 columns
| Meta name | Allowed other parameters | Meta execution method |
|---|---|---|
__le |
| x <= y |
__eq |
| x == y |
__mul |
| x * y |
__add |
| x + y |
__sub |
| x - y |
__len | #x |
Matrix4.scale
Scales this matrix by the specified amount, changing the values inside
Returns self for chaining
Returns self for chaining
Matrix4.apply
Treats the given values as a vector, augments this vector with a 1, multiplies it against the matrix, and returns a deaugmented vector of the first values
Matrix4.rotate
Rotates this matrix by the specified amount, changing the values inside
Angles are given in degrees
Returns self for chaining
Angles are given in degrees
Returns self for chaining
Matrix4.translate
Translates this matrix by the specified amount, changing the values inside
Returns self for chaining
Returns self for chaining
Matrix4.applyDir
Treats the given values as a vector, augments this vector with a 0, multiplies it against the matrix, and returns a deaugmented vector of the first values
NameplateCustomization
A customization that can be applied to a nameplate
NameplateCustomizationGroup
A customization that holds another nameplate customizations
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
If no index is given it is added in the first available index
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
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.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.getTitle
Inherited from Action
ScrollAction.title
Inherited from Action
ScrollAction.getHoverColor
Inherited from Action
ScrollAction.getColor
Inherited from Action
ScrollAction.scroll
figura.docs.scroll_action.scroll
Sound
Represents a sound that can be played
Obtained by indexing the SoundAPI
Exists as an object-oriented alternative to sounds:playSound()
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 4:
Sound:play(posX, posY, posZ, volume, pitch, loop) 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
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.isEnabled
Inherited from RenderTask
TextTask.isEmissive
Inherited from 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 |
TextTask.getScale
Inherited from RenderTask
TextTask.getRot
Inherited from RenderTask
TextTask.getPos
Inherited from RenderTask
ToggleAction.toggleColor
figura.docs.toggle_action.toggle_color
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.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.toggleItem
figura.docs.toggle_action.toggle_item
ToggleAction.title
Inherited from Action
ToggleAction.getHoverColor
Inherited from Action
ToggleAction.getColor
Inherited from Action
ToggleAction.toggle
figura.docs.toggle_action.toggle
ToggleAction.untoggle
figura.docs.toggle_action.untoggle
VanillaModelGroup
figura.docs.vanilla_group
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
This part can be transformed similar to custom model parts, however not with the same extent
Vector2
A vector that holds 2 numbers
Can be created using functions in the "vectors" api
Can be created using functions in the "vectors" api
| Meta name | Allowed other parameters | Meta execution method |
|---|---|---|
__le |
| x <= y |
__lt |
| x < y |
__len | #x | |
__unm | -x | |
__eq |
| x == y |
__mod |
| x % y |
__div |
| x / y |
__mul |
| x * y |
__add |
| x + y |
__sub |
| x - y |
Vector2.add
Adds the given vector or values to this one, and returns self for chaining
Vector2.set
Sets this vector to have the given values
Nil values are treated as zero
Returns self for chaining
Nil values are treated as zero
Returns self for chaining
Vector2.reduce
Reduces this vector modulo the given vector or values, and returns self for chaining
Vector2.sub
Subtracts the given vector or values from this one, and returns self for chaining
Vector2.mul
Multiplies the given vector or values into this one, and returns self for chaining
Vector2.div
Divides this vector by the given vector or values, and returns self for chaining
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
If the vector has length zero, then the copy does too
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
If the vector has length zero, it is unmodified
Returns self for chaining
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
The current index and its value is given as arguments of the function
Returns self for chaining
Vector3
A vector that holds 3 numbers
Can be created using functions in the "vectors" api
Can be created using functions in the "vectors" api
| Meta name | Allowed other parameters | Meta execution method |
|---|---|---|
__le |
| x <= y |
__lt |
| x < y |
__len | #x | |
__unm | -x | |
__eq |
| x == y |
__mod |
| x % y |
__div |
| x / y |
__mul |
| x * y |
__add |
| x + y |
__sub |
| x - y |
Vector3.add
Adds the given vector or values to this one, and returns self for chaining
Vector3.set
Sets this vector to have the given values
Nil values are treated as zero
Returns self for chaining
Nil values are treated as zero
Returns self for chaining
Vector3.reduce
Reduces this vector modulo the given vector or values, and returns self for chaining
Vector3.sub
Subtracts the given vector or values from this one, and returns self for chaining
Vector3.mul
Multiplies the given vector or values into this one, and returns self for chaining
Vector3.div
Divides this vector by the given vector or values, and returns self for chaining
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
If the vector has length zero, then the copy does too
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
If the vector has length zero, it is unmodified
Returns self for chaining
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
The current index and its value is given as arguments of the function
Returns self for chaining
Vector4
A vector that holds 4 numbers
Can be created using functions in the "vectors" api
Can be created using functions in the "vectors" api
| Meta name | Allowed other parameters | Meta execution method |
|---|---|---|
__le |
| x <= y |
__lt |
| x < y |
__len | #x | |
__unm | -x | |
__eq |
| x == y |
__mod |
| x % y |
__div |
| x / y |
__mul |
| x * y |
__add |
| x + y |
__sub |
| x - y |
Vector4.add
Adds the given vector or values to this one, and returns self for chaining
Vector4.set
Sets this vector to have the given values
Nil values are treated as zero
Returns self for chaining
Nil values are treated as zero
Returns self for chaining
Vector4.reduce
Reduces this vector modulo the given vector or values, and returns self for chaining
Vector4.sub
Subtracts the given vector or values from this one, and returns self for chaining
Vector4.mul
Multiplies the given vector or values into this one, and returns self for chaining
Vector4.div
Divides this vector by the given vector or values, and returns self for chaining
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
If the vector has length zero, then the copy does too
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
If the vector has length zero, it is unmodified
Returns self for chaining
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
The current index and its value is given as arguments of the function
Returns self for chaining
Vector5
figura.docs.vector5
| Meta name | Allowed other parameters | Meta execution method |
|---|---|---|
__le |
| x <= y |
__lt |
| x < y |
__len | #x | |
__unm | -x | |
__eq |
| x == y |
__mod |
| x % y |
__div |
| x / y |
__mul |
| x * y |
__add |
| x + y |
__sub |
| x - y |
Vector5.add
Adds the given vector or values to this one, and returns self for chaining
overload 1:
Vector5:add(vec) | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444082||
| Return Value | typings.2002444082
Vector5.floor
Returns a copy of this vector with its values rounded down
overload 1:
Vector5:floor() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444082
Vector5.ceil
Returns a copy of this vector with its values rounded up
overload 1:
Vector5:ceil() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444082
Vector5.set
Sets this vector to have the given values
Nil values are treated as zero
Returns self for chaining
Nil values are treated as zero
Returns self for chaining
overload 1:
Vector5:set(vec) | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444082||
| Return Value | typings.2002444082
Vector5.copy
Creates and returns a copy of this vector
overload 1:
Vector5:copy() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444082
Vector5.normalize
Modifies this vector so that its length is 1 unless its length was originally 0
Returns self for chaining
Returns self for chaining
overload 1:
Vector5:normalize() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444082
Vector5.reset
Resets this vector back to being all zeroes, and returns itself for chaining
overload 1:
Vector5:reset() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444082
Vector5.reduce
Reduces this vector modulo the given vector or values, and returns self for chaining
overload 1:
Vector5:reduce(vec) | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444082||
| Return Value | typings.2002444082
Vector5.normalized
Returns a copy of this vector with length 1 unless its length was originally 0
overload 1:
Vector5:normalized() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444082
Vector5.sub
Subtracts the given vector or values from this one, and returns self for chaining
overload 1:
Vector5:sub(vec) | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444082||
| Return Value | typings.2002444082
Vector5.mul
Multiplies the given vector or values into this one, and returns self for chaining
overload 1:
Vector5:mul(vec) | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444082||
| Return Value | typings.2002444082
Vector5.div
Divides this vector by the given vector or values, and returns self for chaining
overload 1:
Vector5:div(vec) | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444082||
| Return Value | typings.2002444082
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
If the vector has length zero, then the copy does too
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
If the vector has length zero, it is unmodified
Returns self for chaining
Vector5.toRad
Returns a copy of this vector, in radians
overload 1:
Vector5:toRad() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444082
Vector5.toDeg
Returns a copy of this vector, in degrees
overload 1:
Vector5:toDeg() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444082
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
The current index and its value is given as arguments of the function
Returns self for chaining
Vector6
figura.docs.vector6
| Meta name | Allowed other parameters | Meta execution method |
|---|---|---|
__le |
| x <= y |
__lt |
| x < y |
__len | #x | |
__unm | -x | |
__eq |
| x == y |
__mod |
| x % y |
__div |
| x / y |
__mul |
| x * y |
__add |
| x + y |
__sub |
| x - y |
Vector6.add
Adds the given vector or values to this one, and returns self for chaining
overload 1:
Vector6:add(vec) | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444083||
| Return Value | typings.2002444083
Vector6.floor
Returns a copy of this vector with its values rounded down
overload 1:
Vector6:floor() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444083
Vector6.ceil
Returns a copy of this vector with its values rounded up
overload 1:
Vector6:ceil() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444083
Vector6.set
Sets this vector to have the given values
Nil values are treated as zero
Returns self for chaining
Nil values are treated as zero
Returns self for chaining
overload 1:
Vector6:set(vec) | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444083||
| Return Value | typings.2002444083
Vector6.copy
Creates and returns a copy of this vector
overload 1:
Vector6:copy() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444083
Vector6.normalize
Modifies this vector so that its length is 1 unless its length was originally 0
Returns self for chaining
Returns self for chaining
overload 1:
Vector6:normalize() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444083
Vector6.reset
Resets this vector back to being all zeroes, and returns itself for chaining
overload 1:
Vector6:reset() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444083
Vector6.reduce
Reduces this vector modulo the given vector or values, and returns self for chaining
overload 1:
Vector6:reduce(vec) | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444083||
| Return Value | typings.2002444083
Vector6.normalized
Returns a copy of this vector with length 1 unless its length was originally 0
overload 1:
Vector6:normalized() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444083
Vector6.sub
Subtracts the given vector or values from this one, and returns self for chaining
overload 1:
Vector6:sub(vec) | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444083||
| Return Value | typings.2002444083
Vector6.mul
Multiplies the given vector or values into this one, and returns self for chaining
overload 1:
Vector6:mul(vec) | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444083||
| Return Value | typings.2002444083
Vector6.div
Divides this vector by the given vector or values, and returns self for chaining
overload 1:
Vector6:div(vec) | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444083||
| Return Value | typings.2002444083
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
If the vector has length zero, then the copy does too
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
If the vector has length zero, it is unmodified
Returns self for chaining
Vector6.toRad
Returns a copy of this vector, in radians
overload 1:
Vector6:toRad() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444083
Vector6.toDeg
Returns a copy of this vector, in degrees
overload 1:
Vector6:toDeg() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444083
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
The current index and its value is given as arguments of the function
Returns self for chaining
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
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
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
Works on both regular numbers, vectors of the same type, and matrices of the same type
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
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
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
Lerp is done towards the shortest angle
For example, a lerp of 340 and 20, with a factor of 0.75, will return 10
Colors
List of custom colors
Used anywhere you can input a hex color
Used anywhere you can input a hex color
FRAN_PINK fran francielly bunny CHLOE_PURPLE chloe space MAYA_BLUE maya devnull SKYE_BLUE sky skye skylar LILY_RED lily foxes fox CHEESE largecheese large cheese LUA_LOG LUA_ERROR LUA_PING luna moff moth DEFAULT DISCORD EntityPoses
List of valid EntityPoses
Used within the EntityAPI
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
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
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
Used within Blockbench animations
LOOP ONCE HOLD ParentTypes
List of valid ParentTypes
Used within ModelParts
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
Used within Blockbench animations
STOPPED PAUSED PLAYING PlayerModelParts
List of valid PlayerModelParts
Used within the PlayerAPI
Used within the PlayerAPI
CAPE JACKET LEFT_SLEEVE RIGHT_SLEEVE LEFT_PANTS RIGHT_PANTS HAT PostEffects
List of valid PostEffects
Used within the RendererAPI
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
Used within ModelParts
NONE 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
Used within ModelParts
SKIN CAPE ELYTRA RESOURCE PRIMARY SECONDARY