Show not everything 
listFiles 
action_wheel Miscellaneous Types
Miscellaneous Enums
Colors EntityPoses ItemDisplayModes KeyIDs Keybinds LoopModes ParentTypes PlayStates PlayerModelParts PostEffects RenderModes RenderTypes TextureTypes UseActionslistFiles
A function that returns a table with all script file names from the specified path
If no path is specified, it will fetch from the root folder
A second argument, boolean, can be given to also list files inside subfolders
Folders can be accessed relative to the executing script using `./` and `../`
If no path is specified, it will fetch from the root folder
A second argument, boolean, can be given to also list files inside subfolders
Folders can be accessed relative to the executing script using `./` and `../`
log
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
logJson
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
logTable
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
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
overload 1:
action_wheel:execute() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an ActionWheelAPI |
overload 2:
action_wheel:execute(index) | Method Property | Fluent Description | Representation |
|---|---|---|
| index accepts | an Integer | |
| Return Value | an ActionWheelAPI |
overload 3:
action_wheel:execute(index, rightClick) | Method Property | Fluent Description | Representation |
|---|---|---|
| index accepts | an Integer | |
| rightClick accepts | a Boolean | |
| Return Value | an ActionWheelAPI |
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.newPage
Creates a new Page for the action wheel
A Title can be given to store this page internally
If no Title is given, the Page will just be returned from this function
A Title can be given to store this page internally
If no Title is given, the Page will just be returned from this function
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
overload 1:
action_wheel:setPage(pageTitle) | Method Property | Fluent Description | Representation |
|---|---|---|
| pageTitle accepts | a String | |
| Return Value | an ActionWheelAPI |
overload 2:
action_wheel:setPage(page) | Method Property | Fluent Description | Representation |
|---|---|---|
| page accepts | a Page | |
| Return Value | an ActionWheelAPI |
ActionWheelAPI.getPage
Example by ChloeSpacedOut:
action_wheel:createPage('examplePage')
log(action_wheel:getPage('examplePage')) Returns a stored Page by the given title
If no title is given, returns a table with all registered Pages
If no title is given, returns a table with all registered Pages
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 animations
The global instance of the AnimationsAPI and its subtypes
field signature:
animations | Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | an AnimationAPI |
AnimationAPI.stopAll
Stops all playing (and paused) animations
overload 1:
animations:stopAll() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an AnimationAPI |
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.
AvatarAPI.color
Sets the current color string of your avatar, used as your avatar theme, if the user has a special badge, they can pass in the badge's name to set the color for it.
client
The global instance of ClientAPI
field signature:
client ClientAPI.getVersion
Example by ChloeSpacedOut:
log(client.getVersion()) ClientAPI.getAtlas
Returns a TextureAtlasAPI object with information about the given atlas
Returns nil if the atlas was not found
Returns nil if the atlas was not found
overload 1:
client.getAtlas(path) | Method Property | Fluent Description | Representation |
|---|---|---|
| path accepts | a String | |
| Return Value | a TextureAtlas |
ClientAPI.getChunkStatistics
Example by ChloeSpacedOut:
ClientAPI.getUsedMemory
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getUsedMemory())
end)
-- returns memory in bytes ClientAPI.getJavaVersion
Example by ChloeSpacedOut:
ClientAPI.getSoundStatistics
Example by ChloeSpacedOut:
ClientAPI.getMaxMemory
Example by ChloeSpacedOut:
ClientAPI.getAllocatedMemory
Example by ChloeSpacedOut:
ClientAPI.getActiveLang
Example by ChloeSpacedOut:
ClientAPI.getTextWidth
Example by ChloeSpacedOut:
ClientAPI.getTextHeight
Example by ChloeSpacedOut:
ClientAPI.getTextDimensions
Returns the width and height of the given text, wrapping lines and trimming to a max width
ClientAPI.intUUIDToString
Converts an int array UUID (as 4 separated arguments) into its hexadecimal string representation
ClientAPI.getEntityStatistics
Example by ChloeSpacedOut:
ClientAPI.getServerBrand
Example by ChloeSpacedOut:
ClientAPI.getGuiScale
Example by ChloeSpacedOut:
log(client.getGuiScale()) config
The global instance of the ConfigAPI
field signature:
config ConfigAPI.load
Loads a saved variable under the specific key
If no key is given, it will return a table with all saved variables
If no key is given, it will return a table with all saved variables
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
EventsAPI.MOUSE_MOVE
The MOUSE_MOVE event runs every time the mouse is moved around
Takes two parameters, x and y, which is the difference from the mouse position based on the latest saved position
If returned true, the event cancels its vanilla function
Note that canceling the vanilla function also cancels saving the last mouse position
Takes two parameters, x and y, which is the difference from the mouse position based on the latest saved position
If returned true, the event cancels its vanilla function
Note that canceling the vanilla function also cancels saving the last mouse position
EventsAPI.MOUSE_PRESS
The MOUSE_PRESS event runs every time a mouse button is pressed
Takes three number parameters, a "button", which is the number id of the button that was been pressed, the "action", which is the status of the press event (0 for release, 1 for press, 2 for hold), and the "modifier", which is a bitmask number detecting if you have any modifier keys being pressed (like shift or alt, for example)
If returned true, the event cancels its vanilla function
Takes three number parameters, a "button", which is the number id of the button that was been pressed, the "action", which is the status of the press event (0 for release, 1 for press, 2 for hold), and the "modifier", which is a bitmask number detecting if you have any modifier keys being pressed (like shift or alt, for example)
If returned true, the event cancels its vanilla function
EventsAPI.KEY_PRESS
The KEY_PRESS event runs every time a keyboard key is pressed
Takes three number parameters, a "key", which is the number id of the key that was been pressed, the "action", which is the status of the press event (0 for release, 1 for press, 2 for hold), and the "modifier", which is a bitmask number detecting if you have any modifier keys being pressed (like shift or alt, for example)
If returned true, the event cancels its vanilla function
Takes three number parameters, a "key", which is the number id of the key that was been pressed, the "action", which is the status of the press event (0 for release, 1 for press, 2 for hold), and the "modifier", which is a bitmask number detecting if you have any modifier keys being pressed (like shift or alt, for example)
If returned true, the event cancels its vanilla function
EventsAPI.CHAR_TYPED
The CHAR_TYPED event runs every time a character is inputted
Takes three parameters, the resulting "string" after converting the code point, the "modifier", which is a bitmask number detecting if you have any modifier keys being pressed (like shift or alt, for example), and the "codepoint" of the inputted char
Takes three parameters, the resulting "string" after converting the code point, the "modifier", which is a bitmask number detecting if you have any modifier keys being pressed (like shift or alt, for example), and the "codepoint" of the inputted char
EventsAPI.USE_ITEM
The USE_ITEM event is run every time the entity uses an item
The item, action and amount of particles this item would produce is given as argument
If returned true, the event cancels its vanilla function
The item, action and amount of particles this item would produce is given as argument
If returned true, the event cancels its vanilla function
EventsAPI.ARROW_RENDER
The ARROW_RENDER event is run for every arrow entity shot by the Avatar owner
It takes two arguments, the tick delta, and the arrow entity
Returning "true" stops this arrow from rendering, including the Arrow parent parts
Requires the "Vanilla Model Change" permission
It takes two arguments, the tick delta, and the arrow entity
Returning "true" stops this arrow from rendering, including the Arrow parent parts
Requires the "Vanilla Model Change" permission
EventsAPI.ITEM_RENDER
Called on every one of your items that is being rendered
It takes six arguments: the item being rendered, the rendering mode, the position, rotation, and scale that would be applied to the item, and if it's being rendered in the left hand
Returning a ModelPart parented to Item stops the rendering of this item and will render the returned part instead
It takes six arguments: the item being rendered, the rendering mode, the position, rotation, and scale that would be applied to the item, and if it's being rendered in the left hand
Returning a ModelPart parented to Item stops the rendering of this item and will render the returned part instead
EventsAPI.ON_PLAY_SOUND
Called every time a new sound is played
Takes the following as arguments: the sound's ID, its world position, volume, pitch, if the sound should loop, the sound's category, and the sound's file path
Return true to prevent this sound from playing
Takes the following as arguments: the sound's ID, its world position, volume, pitch, if the sound should loop, the sound's category, and the sound's file path
Return true to prevent this sound from playing
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.setChatColor
Sets the color of the text that is currently being typed into the chat window
HostAPI.setChatMessage
Modifies a chat message with the given text
Takes an index, were 1 means the last message on chat
Setting the message to nil will effectively remove it from the chat
Takes an index, were 1 means the last message on chat
Setting the message to nil will effectively remove it from the chat
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.titleTimes
Sets the duration of the title on the screen, also its fade-in and fade-out durations
HostAPI.actionbar
Sets the action bar message to the given text
The boolean parameter defaults to false
The boolean parameter defaults to false
HostAPI.chatColor
Sets the color of the text that is currently being typed into the chat window
keybinds
The global instance of the KeybindAPI and its subtypes
KeybindAPI.newKeybind
Creates and returns a new Keybind
The name is used in the keybind menu
The key parameter is an identifier for a key, such as "key.keyboard.r"
The boolean gui indicates whether the keybind should always work, or if it should only work when you don't have a screen open
Check the docs enum command for all key names
The name is used in the keybind menu
The key parameter is an identifier for a key, such as "key.keyboard.r"
The boolean gui indicates whether the keybind should always work, or if it should only work when you don't have a screen open
Check the docs enum command for all key names
KeybindAPI.of
Creates and returns a new Keybind
The name is used in the keybind menu
The key parameter is an identifier for a key, such as "key.keyboard.r"
The boolean gui indicates whether the keybind should always work, or if it should only work when you don't have a screen open
Check the docs enum command for all key names
The name is used in the keybind menu
The key parameter is an identifier for a key, such as "key.keyboard.r"
The boolean gui indicates whether the keybind should always work, or if it should only work when you don't have a screen open
Check the docs enum command for all key names
matrices
The global instance of the MatricesAPI and its subtypes
MatricesAPI.scale2
Creates a new Matrix2 that scales by the specified factors
MatricesAPI.scale4
Creates a new Matrix4 that scales by the specified factors
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.translate4
Creates a new Matrix4 that translates by the specified offset
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.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.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.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
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.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.removeTask
Removes the Task with the given name from this part
Removes ALL tasks if a name is not given
Removes ALL tasks if a name is not given
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.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.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.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.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.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.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.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.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.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.setSecondaryColor
Sets the secondary color multiplier for this part
Values are RGB from 0 to 1
Values are RGB from 0 to 1
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.setOffsetPivot
Sets the pivot offset point for this part (multiplicative)
Nil values are assumed to be 0
For absolute pivot point values, check out the non-offset pivot functions
Nil values are assumed to be 0
For absolute pivot point values, check out the non-offset pivot functions
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.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.setPrimaryColor
Sets the primary color multiplier for this part
Values are RGB from 0 to 1
Values are RGB from 0 to 1
ModelPart.setOffsetScale
Sets the scale offset for this part
Nil values are assumed to be 1
For absolute scale values, check out the non-offset rot functions
Nil values are assumed to be 1
For absolute scale values, check out the non-offset rot functions
ModelPart.setOffsetRot
Sets the rotation offset for this part
Nil values for rotation are assumed to be 0
Angles are given in degrees
For absolute rotation values, check out the non-offset rot functions
Nil values for rotation are assumed to be 0
Angles are given in degrees
For absolute rotation values, check out the non-offset rot functions
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.setMidRender
Sets a function to run during the middle of this part's rendering, after its matrices are calculated
overload 1:
models:setMidRender(function) | Method Property | Fluent Description | Representation |
|---|---|---|
| function accepts | a function | |
| Return Value | a ModelPart |
ModelPart.setPostRender
Sets a function to run after this part and its children are rendered
overload 1:
models:setPostRender(function) | Method Property | Fluent Description | Representation |
|---|---|---|
| function accepts | a function | |
| Return Value | a ModelPart |
ModelPart.setPreRender
Sets a function to run before this part starts being rendered
overload 1:
models:setPreRender(function) | Method Property | Fluent Description | Representation |
|---|---|---|
| function accepts | a function | |
| Return Value | a ModelPart |
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.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.newSprite
Adds a new Sprite Render Task on this part
overload 1:
models:newSprite(taskName) | Method Property | Fluent Description | Representation |
|---|---|---|
| taskName accepts | a String | |
| Return Value | a SpriteTask |
ModelPart.newPart
Creates a new, empty, group model part as a child of this part, at the same pivot point
Takes two arguments, the new part's name, and optionally its parent type
Takes two arguments, the new part's name, and optionally its parent type
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.setOverlay
Sets the overlay color to be used when rendering this part
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this part
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this part
ModelPart.color
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.scale
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.rot
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.light
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.secondaryRenderType
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.secondaryTexture
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.primaryRenderType
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.uv
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.matrix
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.opacity
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.secondaryColor
Sets the secondary color multiplier for this part
Values are RGB from 0 to 1
Values are RGB from 0 to 1
ModelPart.pivot
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.offsetPivot
Sets the pivot offset point for this part (multiplicative)
Nil values are assumed to be 0
For absolute pivot point values, check out the non-offset pivot functions
Nil values are assumed to be 0
For absolute pivot point values, check out the non-offset pivot functions
ModelPart.uvMatrix
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.primaryTexture
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.primaryColor
Sets the primary color multiplier for this part
Values are RGB from 0 to 1
Values are RGB from 0 to 1
ModelPart.offsetScale
Sets the scale offset for this part
Nil values are assumed to be 1
For absolute scale values, check out the non-offset rot functions
Nil values are assumed to be 1
For absolute scale values, check out the non-offset rot functions
ModelPart.offsetRot
Sets the rotation offset for this part
Nil values for rotation are assumed to be 0
Angles are given in degrees
For absolute rotation values, check out the non-offset rot functions
Nil values for rotation are assumed to be 0
Angles are given in degrees
For absolute rotation values, check out the non-offset rot functions
ModelPart.uvPixels
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.pos
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.overlay
Sets the overlay color to be used when rendering this part
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this part
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this part
ModelPart.preRender
Function to run before this part starts being rendered
ModelPart.midRender
Function to run during the middle of this part's rendering, after its matrices are calculated
ModelPart.postRender
Function to run after this part and its children are rendered
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.removeParticles
Removes all particles spawned from this avatar
overload 1:
particles:removeParticles() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a ParticleAPI |
ParticleAPI.newParticle
Creates a particle with the given name at the specified position, with the given velocity
Some particles have special properties, like the "dust" particle
For these particles, the special properties can be put into the "name" parameter, the same way as it works for commands
Some particles have special properties, like the "dust" particle
For these particles, the special properties can be put into the "name" parameter, the same way as it works for commands
overload 6:
particles:newParticle(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.getShoulderEntity
Returns a table of the nbt of this entity left or right shoulder entity
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.getModelType
Example by JimmyHelp:
if player:getModelType() == "DEFAULT" then
log("You're Steve")
end PlayerAPI.getSaturation
Example by JimmyHelp:
if player:getSaturation() == 20 then
log("Your saturation is 20")
end PlayerAPI.getExperienceLevel
Example by JimmyHelp:
if player:getExperienceLevel() == 30 then
log("You have 30 levels")
end PlayerAPI.getFood
Example by JimmyHelp:
if player:getFood() == 0 then
log("You're starving")
end PlayerAPI.isBlocking
Inherited from LivingEntityAPI
PlayerAPI.isVisuallySwimming
Inherited from LivingEntityAPI
PlayerAPI.isLeftHanded
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isLeftHanded() then
log("You're left handed")
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.isGliding
Inherited from LivingEntityAPI
PlayerAPI.riptideSpinning
Inherited from LivingEntityAPI
PlayerAPI.getActiveItem
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getActiveItem().id == "minecraft:bow" then
log("You're drawing back a bow")
end PlayerAPI.getSwingArm
Inherited from LivingEntityAPI
PlayerAPI.getActiveHand
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getActiveHand() == "MAIN_HAND" then
log("You're using your main hand")
end PlayerAPI.getActiveItemTime
Inherited from LivingEntityAPI
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.getDeathTime
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getDeathTime() > 0 then
log("You're dead")
end PlayerAPI.getEntityCategory
Inherited from LivingEntityAPI
PlayerAPI.getSwingTime
Inherited from LivingEntityAPI
PlayerAPI.isSwingingArm
Inherited from LivingEntityAPI
PlayerAPI.isClimbing
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isClimbing() then
log("You're climbing")
end PlayerAPI.getAbsorptionAmount
Inherited from LivingEntityAPI
PlayerAPI.isUsingItem
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isUsingItem() then
log("You're using an item")
end PlayerAPI.getArrowCount
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getArrowCount() > 0 then
log("You've been shot")
end PlayerAPI.getStingerCount
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getStingerCount() > 0 then
log("You've been stung")
end PlayerAPI.isSensitiveToWater
Inherited from LivingEntityAPI
PlayerAPI.getSwingDuration
Inherited from LivingEntityAPI
PlayerAPI.getMaxHealth
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getMaxHealth() == 20 then
log("You're healthy")
end PlayerAPI.getHealth
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getHealth() == 20 then
log("You're at full health")
end PlayerAPI.getArmor
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getArmor() == 20 then
log("You have max armor points")
end PlayerAPI.getName
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getName() == "JimmyHelp" then
log("You're... me?")
end PlayerAPI.isAlive
Inherited from LivingEntityAPI
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.isSneaking
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isSneaking() then
log("You're sneaking")
end PlayerAPI.isWet
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isWet() then
log("You're touching water")
end PlayerAPI.isCute
Inherited from LivingEntityAPI
PlayerAPI.getVelocity
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getVelocity():length() > 0 then
log("You're moving in any direction")
end PlayerAPI.isHamburger
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isHamburger() then
log("You're hamburger")
end PlayerAPI.hasAvatar
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:hasAvatar() then
log("You have an avatar")
end PlayerAPI.getMaxAir
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getMaxAir() == 300 then
log("You've got healthy lungs")
end PlayerAPI.getDimensionName
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getDimensionName() == "minecraft:overworld" then
log("You're in the Overworld")
end 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.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.getNbt
Inherited from LivingEntityAPI
PlayerAPI.getPose
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getPose() == "CROUCHING" then
log("You're crouching")
end PlayerAPI.isInLava
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isInLava() then
log("You're in lava")
end PlayerAPI.isOnFire
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isOnFire() then
log("You're on fire")
end PlayerAPI.isCrouching
Inherited from LivingEntityAPI
PlayerAPI.isInWater
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isInWater() then
log("You're in water")
end PlayerAPI.isSilent
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isSilent() then
log("You're silent")
end PlayerAPI.isInRain
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isInRain() then
log("You're in rain")
end PlayerAPI.isSprinting
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isSprinting() then
log("You're sprinting")
end PlayerAPI.getEyeY
Inherited from LivingEntityAPI
PlayerAPI.isInvisible
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isInvisible() then
log("You're invisible")
end PlayerAPI.getPermissionLevel
Inherited from LivingEntityAPI
PlayerAPI.isOnGround
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isOnGround() then
log("You're on the ground")
end 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
PlayerAPI.hasInventory
Inherited from LivingEntityAPI
PlayerAPI.getTargetedEntity
Inherited from LivingEntityAPI
Returns a proxy for your currently targeted Entity
This Entity appears on the F3 screen
Maximum and Default distance is 20, Minimum is 0
This Entity appears on the F3 screen
Maximum and Default distance is 20, Minimum is 0
PlayerAPI.hasContainer
Inherited from LivingEntityAPI
PlayerAPI.getVariable
Inherited from LivingEntityAPI
Gets the value of a variable this entity stored in themselves using the Avatar API's store() function
PlayerAPI.isGlowing
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isGlowing() then
log("You're glowing")
end PlayerAPI.isUnderwater
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isUnderwater() then
log("You're underwater")
end PlayerAPI.getUUID
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getUUID() == "5003b2ce-7a8d-4c56-8b91-ec705985fe08" then
log("You're... me?")
end 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.getPassengers
Inherited from LivingEntityAPI
PlayerAPI.getControllingPassenger
Inherited from LivingEntityAPI
PlayerAPI.getControlledVehicle
Inherited from LivingEntityAPI
renderer
The global instance of RendererAPI
RendererAPI.setOutlineColor
Sets the custom glowing effect's outline color
overload 1:
renderer:setOutlineColor(rgb) | Method Property | Fluent Description | Representation |
|---|---|---|
| rgb accepts | a Vector3 | |
| Return Value | a RendererAPI |
overload 2:
renderer:setOutlineColor(r, g, b) | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | a Number | |
| g accepts | a Number | |
| b accepts | a Number | |
| Return Value | a RendererAPI |
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
overload 1:
renderer:setShadowRadius() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a RendererAPI |
overload 2:
renderer:setShadowRadius(radius) | Method Property | Fluent Description | Representation |
|---|---|---|
| radius accepts | a Number | |
| Return Value | a RendererAPI |
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
overload 1:
renderer:setCameraPos(pos) | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | |
| Return Value | a RendererAPI |
overload 2:
renderer:setCameraPos(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a RendererAPI |
RendererAPI.setPostEffect
Sets the current rendering effect
Same as the discontinued Super Secret Settings
Same as the discontinued Super Secret Settings
overload 1:
renderer:setPostEffect(effect) | Method Property | Fluent Description | Representation |
|---|---|---|
| effect accepts | a String | |
| Return Value | a RendererAPI |
RendererAPI.setCrosshairOffset
Sets the offset of your crosshair
overload 1:
renderer:setCrosshairOffset(vec) | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | a Vector2 | |
| Return Value | a RendererAPI |
overload 2:
renderer:setCrosshairOffset(x, y) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | an Integer | |
| y accepts | an Integer | |
| Return Value | a RendererAPI |
RendererAPI.setRenderLeftArm
Toggle if the left arm should be rendered in first person, regardless if you are holding an item or not
overload 1:
renderer:setRenderLeftArm(bool) | Method Property | Fluent Description | Representation |
|---|---|---|
| bool accepts | a Boolean | |
| Return Value | a RendererAPI |
RendererAPI.setOffsetCameraRot
Sets the offset rotation for the camera
Nil values for rotation are assumed to be 0
Angles are given in degrees
For absolute rotation values, check out the non-offset rot function
Nil values for rotation are assumed to be 0
Angles are given in degrees
For absolute rotation values, check out the non-offset rot function
overload 1:
renderer:setOffsetCameraRot(rot) | Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | a Vector3 | |
| Return Value | a RendererAPI |
overload 2:
renderer:setOffsetCameraRot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a RendererAPI |
RendererAPI.setEyeOffset
Sets an offset for the entity eye position, altering the targeted block and entity
overload 1:
renderer:setEyeOffset(pos) | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | |
| Return Value | a RendererAPI |
overload 2:
renderer:setEyeOffset(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a RendererAPI |
RendererAPI.setRenderRightArm
Toggle if the right arm should be rendered in first person, regardless if you are holding an item or not
overload 1:
renderer:setRenderRightArm(bool) | Method Property | Fluent Description | Representation |
|---|---|---|
| bool accepts | a Boolean | |
| Return Value | a RendererAPI |
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
overload 1:
renderer:setCameraRot(rot) | Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | a Vector3 | |
| Return Value | a RendererAPI |
overload 2:
renderer:setCameraRot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a RendererAPI |
RendererAPI.setFOV
Sets the multiplier of your fov
The default value is nil, which means no changes will be applied to your fov
The default value is nil, which means no changes will be applied to your fov
overload 1:
renderer:setFOV() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a RendererAPI |
overload 2:
renderer:setFOV(fov) | Method Property | Fluent Description | Representation |
|---|---|---|
| fov accepts | a Number | |
| Return Value | a RendererAPI |
RendererAPI.setCameraPivot
Sets the absolute pivot for the camera
The pivot will also move the camera
Its values are relative to the World
Nil values for pivot are assumed to be 0
For relative rotation values, check out the "offset" pivot function
The pivot will also move the camera
Its values are relative to the World
Nil values for pivot are assumed to be 0
For relative rotation values, check out the "offset" pivot function
overload 1:
renderer:setCameraPivot(pivot) | Method Property | Fluent Description | Representation |
|---|---|---|
| pivot accepts | a Vector3 | |
| Return Value | a RendererAPI |
overload 2:
renderer:setCameraPivot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a RendererAPI |
RendererAPI.setRenderCrosshair
Sets if your crosshair should be rendered
overload 1:
renderer:setRenderCrosshair(renderCrosshair) | Method Property | Fluent Description | Representation |
|---|---|---|
| renderCrosshair accepts | a Boolean | |
| Return Value | a RendererAPI |
RendererAPI.setRenderFire
Sets if the fire effect should be rendered
overload 1:
renderer:setRenderFire(renderFire) | Method Property | Fluent Description | Representation |
|---|---|---|
| renderFire accepts | a Boolean | |
| Return Value | a RendererAPI |
RendererAPI.setForcePaperdoll
Sets if the paperdoll should forcefully be rendered
overload 1:
renderer:setForcePaperdoll(forcePaperdoll) | Method Property | Fluent Description | Representation |
|---|---|---|
| forcePaperdoll accepts | a Boolean | |
| Return Value | a RendererAPI |
RendererAPI.setRenderHUD
Sets if the vanilla HUD should be rendered
overload 1:
renderer:setRenderHUD(renderHUD) | Method Property | Fluent Description | Representation |
|---|---|---|
| renderHUD accepts | a Boolean | |
| Return Value | a RendererAPI |
RendererAPI.setRenderVehicle
Sets if your vehicle should be rendered
overload 1:
renderer:setRenderVehicle(renderVehicle) | Method Property | Fluent Description | Representation |
|---|---|---|
| renderVehicle accepts | a Boolean | |
| Return Value | a RendererAPI |
RendererAPI.setOffsetCameraPivot
Sets the offset 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 non-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 non-offset pivot function
overload 1:
renderer:setOffsetCameraPivot(pivot) | Method Property | Fluent Description | Representation |
|---|---|---|
| pivot accepts | a Vector3 | |
| Return Value | a RendererAPI |
overload 2:
renderer:setOffsetCameraPivot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a RendererAPI |
RendererAPI.setSecondaryFireTexture
Sets a custom secondary fire texture, to render while the entity is on fire
The effect is compound by two layers
The secondary layer is what renders in first person
The absence of a secondary layer uses the primary layer as fallback
The effect is compound by two layers
The secondary layer is what renders in first person
The absence of a secondary layer uses the primary layer as fallback
overload 1:
renderer:setSecondaryFireTexture(id) | Method Property | Fluent Description | Representation |
|---|---|---|
| id accepts | a String | |
| Return Value | a RendererAPI |
RendererAPI.setBlockOutlineColor
Sets the color of the selected block outline
Default alpha is 0.4
Might not be compatible with shaders
Default alpha is 0.4
Might not be compatible with shaders
overload 1:
renderer:setBlockOutlineColor(rgb) | Method Property | Fluent Description | Representation |
|---|---|---|
| rgb accepts | a Vector3 | |
| Return Value | a RendererAPI |
overload 2:
renderer:setBlockOutlineColor(rgba) | Method Property | Fluent Description | Representation |
|---|---|---|
| rgba accepts | a Vector4 | |
| Return Value | a RendererAPI |
overload 3:
renderer:setBlockOutlineColor(r, g, b, a) | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | a Number | |
| g accepts | a Number | |
| b accepts | a Number | |
| a accepts | a Number | |
| Return Value | a RendererAPI |
RendererAPI.setPrimaryFireTexture
Sets a custom primary fire texture, to render while the entity is on fire
The effect is compound by two layers
The secondary layer is what renders in first person
The absence of a secondary layer uses the primary layer as fallback
The effect is compound by two layers
The secondary layer is what renders in first person
The absence of a secondary layer uses the primary layer as fallback
overload 1:
renderer:setPrimaryFireTexture(id) | Method Property | Fluent Description | Representation |
|---|---|---|
| id accepts | a String | |
| Return Value | a RendererAPI |
RendererAPI.outlineColor
Sets the custom glowing effect's outline color
overload 1:
renderer:outlineColor(rgb) | Method Property | Fluent Description | Representation |
|---|---|---|
| rgb accepts | a Vector3 | |
| Return Value | a RendererAPI |
overload 2:
renderer:outlineColor(r, g, b) | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | a Number | |
| g accepts | a Number | |
| b accepts | a Number | |
| Return Value | a RendererAPI |
RendererAPI.shadowRadius
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
overload 1:
renderer:shadowRadius() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a RendererAPI |
overload 2:
renderer:shadowRadius(radius) | Method Property | Fluent Description | Representation |
|---|---|---|
| radius accepts | a Number | |
| Return Value | a RendererAPI |
RendererAPI.cameraPos
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
overload 1:
renderer:cameraPos(pos) | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | |
| Return Value | a RendererAPI |
overload 2:
renderer:cameraPos(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a RendererAPI |
RendererAPI.postEffect
Sets the current rendering effect
Same as the discontinued Super Secret Settings
Same as the discontinued Super Secret Settings
overload 1:
renderer:postEffect(effect) | Method Property | Fluent Description | Representation |
|---|---|---|
| effect accepts | a String | |
| Return Value | a RendererAPI |
RendererAPI.crosshairOffset
Sets the offset of your crosshair
overload 1:
renderer:crosshairOffset(vec) | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | a Vector2 | |
| Return Value | a RendererAPI |
overload 2:
renderer:crosshairOffset(x, y) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | an Integer | |
| y accepts | an Integer | |
| Return Value | a RendererAPI |
RendererAPI.renderLeftArm
Toggle if the left arm should be rendered in first person, regardless if you are holding an item or not
overload 1:
renderer:renderLeftArm(bool) | Method Property | Fluent Description | Representation |
|---|---|---|
| bool accepts | a Boolean | |
| Return Value | a RendererAPI |
RendererAPI.offsetCameraRot
Sets the offset rotation for the camera
Nil values for rotation are assumed to be 0
Angles are given in degrees
For absolute rotation values, check out the non-offset rot function
Nil values for rotation are assumed to be 0
Angles are given in degrees
For absolute rotation values, check out the non-offset rot function
overload 1:
renderer:offsetCameraRot(rot) | Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | a Vector3 | |
| Return Value | a RendererAPI |
overload 2:
renderer:offsetCameraRot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a RendererAPI |
RendererAPI.eyeOffset
Sets an offset for the entity eye position, altering the targeted block and entity
overload 1:
renderer:eyeOffset(pos) | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | |
| Return Value | a RendererAPI |
overload 2:
renderer:eyeOffset(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a RendererAPI |
RendererAPI.renderRightArm
Toggle if the right arm should be rendered in first person, regardless if you are holding an item or not
overload 1:
renderer:renderRightArm(bool) | Method Property | Fluent Description | Representation |
|---|---|---|
| bool accepts | a Boolean | |
| Return Value | a RendererAPI |
RendererAPI.cameraRot
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
overload 1:
renderer:cameraRot(rot) | Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | a Vector3 | |
| Return Value | a RendererAPI |
overload 2:
renderer:cameraRot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a RendererAPI |
RendererAPI.fov
Sets the multiplier of your fov
The default value is nil, which means no changes will be applied to your fov
The default value is nil, which means no changes will be applied to your fov
overload 1:
renderer:fov() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a RendererAPI |
overload 2:
renderer:fov(fov) | Method Property | Fluent Description | Representation |
|---|---|---|
| fov accepts | a Number | |
| Return Value | a RendererAPI |
RendererAPI.cameraPivot
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
overload 1:
renderer:cameraPivot(pivot) | Method Property | Fluent Description | Representation |
|---|---|---|
| pivot accepts | a Vector3 | |
| Return Value | a RendererAPI |
overload 2:
renderer:cameraPivot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a RendererAPI |
RendererAPI.offsetCameraPivot
Sets the offset 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 non-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 non-offset pivot function
overload 1:
renderer:offsetCameraPivot(pivot) | Method Property | Fluent Description | Representation |
|---|---|---|
| pivot accepts | a Vector3 | |
| Return Value | a RendererAPI |
overload 2:
renderer:offsetCameraPivot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a RendererAPI |
RendererAPI.secondaryFireTexture
Sets a custom secondary fire texture, to render while the entity is on fire
The effect is compound by two layers
The secondary layer is what renders in first person
The absence of a secondary layer uses the primary layer as fallback
The effect is compound by two layers
The secondary layer is what renders in first person
The absence of a secondary layer uses the primary layer as fallback
overload 1:
renderer:secondaryFireTexture(id) | Method Property | Fluent Description | Representation |
|---|---|---|
| id accepts | a String | |
| Return Value | a RendererAPI |
RendererAPI.blockOutlineColor
Sets the color of the selected block outline
Default alpha is 0.4
Might not be compatible with shaders
Default alpha is 0.4
Might not be compatible with shaders
overload 1:
renderer:blockOutlineColor(rgb) | Method Property | Fluent Description | Representation |
|---|---|---|
| rgb accepts | a Vector3 | |
| Return Value | a RendererAPI |
overload 2:
renderer:blockOutlineColor(rgba) | Method Property | Fluent Description | Representation |
|---|---|---|
| rgba accepts | a Vector4 | |
| Return Value | a RendererAPI |
overload 3:
renderer:blockOutlineColor(r, g, b, a) | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | a Number | |
| g accepts | a Number | |
| b accepts | a Number | |
| a accepts | a Number | |
| Return Value | a RendererAPI |
RendererAPI.primaryFireTexture
Sets a custom primary fire texture, to render while the entity is on fire
The effect is compound by two layers
The secondary layer is what renders in first person
The absence of a secondary layer uses the primary layer as fallback
The effect is compound by two layers
The secondary layer is what renders in first person
The absence of a secondary layer uses the primary layer as fallback
overload 1:
renderer:primaryFireTexture(id) | Method Property | Fluent Description | Representation |
|---|---|---|
| id accepts | a String | |
| Return Value | a RendererAPI |
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.newSound
Registers a new custom sound for this avatar
The first argument is the sound id while the second argument is either a byte array of the sound data or a base64 string representation of the same
The first argument is the sound id while the second argument is either a byte array of the sound data or a base64 string representation of the same
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) textures
The global instance of the TextureAPI
TextureAPI.read
Reads a texture from a base64 string or a byte array
TextureAPI.newTexture
Creates a new texture with the given name, width and height
The texture is filled with a solid color
The texture is filled with a solid color
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.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.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.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
EntityAPI.getTargetedEntity
Returns a proxy for your currently targeted Entity
This Entity appears on the F3 screen
Maximum and Default distance is 20, Minimum is 0
This Entity appears on the F3 screen
Maximum and Default distance is 20, Minimum is 0
EntityAPI.getVariable
Gets the value of a variable this entity stored in themselves using the Avatar API's store() function
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.toCameraSpace
Converts a position in the world into a position relative to the viewer's camera
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.worldToScreenSpace
Converts a position in the world into a position relative to the viewer's screen
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.rgbToHSV
Converts the given color from RGB format to HSV format
VectorsAPI.hsvToRGB
Converts the given color from HSV format to RGB 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.rgbToInt
Converts the given color from RGB format to Integer format
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.getBlocks
Gets a list of all BlockStates in the specified area
The maximum area size is 8 x 8 x 8
The maximum area size is 8 x 8 x 8
overload 4:
world.getBlocks(minX, minY, minZ, maxX, maxY, maxZ) WorldAPI.getLightLevel
Gets the overall light 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.getBlockLightLevel
Gets the block light level of the block at the given position
WorldAPI.getSkyLightLevel
Gets the skylight level of the block at the given position
WorldAPI.getRedstonePower
Gets the redstone power 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
WorldAPI.getBlockState
Gets the BlockState of the block at the given position
If it is not loaded, returns void_air
If it is not loaded, returns void_air
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.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.getBiome
Gets the Biome located at the given position
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.setColor
Sets the color of the Action
Action.setItem
Sets the item of the Action
Action.setTexture
Sets a Custom Texture to render in this Action
All values are measured in pixels
Default UV is 0, 0, the default dimensions are the texture dimensions and the default scale of 1
All values are measured in pixels
Default UV is 0, 0, the default dimensions are the texture dimensions and the default scale of 1
overload 4:
Action:setTexture(texture, u, v, width, height, scale) Action.setHoverColor
Sets the color of the Action when it is being hovered
Action.setHoverItem
Sets the item of the Action when it is being hovered
Action.setOnRightClick
Sets the function that is executed when the right mouse button is clicked
The function has one argument
The first argument is this action itself
The function has one argument
The first argument is this action itself
overload 1:
Action:setOnRightClick(rightFunction) | Method Property | Fluent Description | Representation |
|---|---|---|
| rightFunction accepts | a function | |
| Return Value | an Action |
Action.setToggleColor
Sets the color of the Action when it is toggled
Action.setHoverTexture
Sets a Custom Texture to render while this Action is being hovered
All values are measured in pixels
Default UV is 0, 0, the default dimensions are the texture dimensions and the default scale of 1
All values are measured in pixels
Default UV is 0, 0, the default dimensions are the texture dimensions and the default scale of 1
overload 4:
Action:setHoverTexture(texture, u, v, width, height, scale) Action.setOnScroll
Sets the function that is executed when the mouse is scrolled
The function has two arguments
The first argument is mouse wheel direction
The second argument is this action itself
The function has two arguments
The first argument is mouse wheel direction
The second argument is this action itself
overload 1:
Action:setOnScroll(scrollFunction) | Method Property | Fluent Description | Representation |
|---|---|---|
| scrollFunction accepts | a function | |
| Return Value | an Action |
Action.setToggleItem
Sets the item of the Action when it is toggled
Action.setOnLeftClick
Sets the function that is executed when the left mouse button is clicked
The function has one argument
The first argument is this action itself
The function has one argument
The first argument is this action itself
overload 1:
Action:setOnLeftClick(leftFunction) | Method Property | Fluent Description | Representation |
|---|---|---|
| leftFunction accepts | a function | |
| Return Value | an Action |
Action.setToggleTexture
Sets a Custom Texture to render in this Action when it is toggled
All values are measured in pixels
Default UV is 0, 0, the default dimensions are the texture dimensions and the default scale of 1
All values are measured in pixels
Default UV is 0, 0, the default dimensions are the texture dimensions and the default scale of 1
overload 4:
Action:setToggleTexture(texture, u, v, width, height, scale) Action.setOnToggle
Sets the function that is executed when the Action is toggled
The function has two arguments
The first argument is toggle state of this action
The second argument is this action itself
The function has two arguments
The first argument is toggle state of this action
The second argument is this action itself
overload 1:
Action:setOnToggle(leftFunction) | Method Property | Fluent Description | Representation |
|---|---|---|
| leftFunction accepts | a function | |
| Return Value | an Action |
Action.setOnUntoggle
Sets the function that is executed when the Action is untoggled
The function has two arguments
The first argument is toggle state of this action
The second argument is this action itself
The function has two arguments
The first argument is toggle state of this action
The second argument is this action itself
overload 1:
Action:setOnUntoggle(rightFunction) | Method Property | Fluent Description | Representation |
|---|---|---|
| rightFunction accepts | a function | |
| Return Value | an Action |
Action.color
Sets the color of the Action
Action.item
Sets the item of the Action
Action.texture
Sets a Custom Texture to render in this Action
All values are measured in pixels
Default UV is 0, 0, the default dimensions are the texture dimensions and the default scale of 1
All values are measured in pixels
Default UV is 0, 0, the default dimensions are the texture dimensions and the default scale of 1
overload 4:
Action:texture(texture, u, v, width, height, scale) Action.hoverColor
Sets the color of the Action when it is being hovered
Action.hoverItem
Sets the item of the Action when it is being hovered
Action.onRightClick
Sets the function that is executed when the right mouse button is clicked
The function has one argument
The first argument is this action itself
The function has one argument
The first argument is this action itself
Action.toggleColor
Sets the color of the Action when it is toggled
Action.hoverTexture
Sets a Custom Texture to render while this Action is being hovered
All values are measured in pixels
Default UV is 0, 0, the default dimensions are the texture dimensions and the default scale of 1
All values are measured in pixels
Default UV is 0, 0, the default dimensions are the texture dimensions and the default scale of 1
overload 4:
Action:hoverTexture(texture, u, v, width, height, scale) Action.onScroll
Sets the function that is executed when the mouse is scrolled
The function has two arguments
The first argument is mouse wheel direction
The second argument is this action itself
The function has two arguments
The first argument is mouse wheel direction
The second argument is this action itself
Action.toggleItem
Sets the item of the Action when it is toggled
Action.onLeftClick
Sets the function that is executed when the left mouse button is clicked
The function has one argument
The first argument is this action itself
The function has one argument
The first argument is this action itself
Action.toggleTexture
Sets a Custom Texture to render in this Action when it is toggled
All values are measured in pixels
Default UV is 0, 0, the default dimensions are the texture dimensions and the default scale of 1
All values are measured in pixels
Default UV is 0, 0, the default dimensions are the texture dimensions and the default scale of 1
overload 4:
Action:toggleTexture(texture, u, v, width, height, scale) Action.onToggle
Sets the function that is executed when the Action is toggled
The function has two arguments
The first argument is toggle state of this action
The second argument is this action itself
The function has two arguments
The first argument is toggle state of this action
The second argument is this action itself
Action.onUntoggle
Sets the function that is executed when the Action is untoggled
The function has two arguments
The first argument is toggle state of this action
The second argument is this action itself
The function has two arguments
The first argument is toggle state of this action
The second argument is this action itself
Action.toggle
Function that is executed when the Action is toggled
The function has two arguments
The first argument is toggle state of this action
The second argument is this action itself
The function has two arguments
The first argument is toggle state of this action
The second argument is this action itself
Action.untoggle
Function that is executed when the Action is untoggled
The function has two arguments
The first argument is toggle state of this action
The second argument is this action itself
The function has two arguments
The first argument is toggle state of this action
The second argument is this action itself
Action.scroll
Function that is executed when the mouse is scrolled
The function has two arguments
The first argument is mouse wheel direction
The second argument is this action itself
The function has two arguments
The first argument is mouse wheel direction
The second argument is this action itself
Animation
A Blockbench animation
Animation.play
Example by JimmyHelp:
animations.bbmodelName.animationName:play() Animation.setPlaying
A function that merges "play" and "stop" together
Takes a boolean parameter, where if true, the animation will play, and when false, the animation will stop
Takes a boolean parameter, where if true, the animation will play, and when false, the animation will stop
Animation.setOverride
Set if this animation should override all of its parts vanilla transforms
Equivalent of calling "overrideRot", "overridePos" and "overrideScale" altogether
Equivalent of calling "overrideRot", "overridePos" and "overrideScale" altogether
Animation.playing
A function that merges "play" and "stop" together
Takes a boolean parameter, where if true, the animation will play, and when false, the animation will stop
Takes a boolean parameter, where if true, the animation will play, and when false, the animation will stop
Animation.override
Set if this animation should override all of its parts vanilla transforms
Equivalent of calling "overrideRot", "overridePos" and "overrideScale" altogether
Equivalent of calling "overrideRot", "overridePos" and "overrideScale" altogether
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
Biome.pos
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.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
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
overload 1:
BlockState:setPos(pos) | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | |
| Return Value | a BlockState |
overload 2:
BlockState:setPos(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a BlockState |
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.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.getTextures
Returns a List of this BlockState's textures
The keys represents the Culling Direction, while the values is another table with all texture paths (string)
Note this only works for normal blocks, special blocks (water, beds, …) will return an empty table
The keys represents the Culling Direction, while the values is another table with all texture paths (string)
Note this only works for normal blocks, special blocks (water, beds, …) will return an empty table
BlockState.pos
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
overload 1:
BlockState:pos(pos) | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | |
| Return Value | a BlockState |
overload 2:
BlockState:pos(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a BlockState |
BlockTask.setBlock
Sets the Block for this task render
overload 2:
BlockTask:setBlock(block) | Method Property | Fluent Description | Representation |
|---|---|---|
| block accepts | a BlockState | |
| Return Value | a BlockTask |
BlockTask.getName
Inherited from RenderTask
BlockTask.setScale
Inherited from RenderTask
Sets the scale of the task, relative to its attached part
overload 1:
BlockTask:setScale(scale) | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | a Vector3 | |
| Return Value | a RenderTask |
overload 2:
BlockTask:setScale(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.setVisible
Inherited from RenderTask
Sets whether or not this task should be rendered
overload 1:
BlockTask:setVisible(visible) | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | a Boolean | |
| Return Value | a RenderTask |
BlockTask.getOverlay
Inherited from RenderTask
BlockTask.getPos
Inherited from RenderTask
BlockTask.getRot
Inherited from RenderTask
BlockTask.setRot
Inherited from RenderTask
Sets the rotation of the task, relative to its attached part
overload 1:
BlockTask:setRot(rot) | Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | a Vector3 | |
| Return Value | a RenderTask |
overload 2:
BlockTask:setRot(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.getLight
Inherited from RenderTask
BlockTask.setLight
Inherited from RenderTask
Sets the light override value of this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
overload 1:
BlockTask:setLight(light) | Method Property | Fluent Description | Representation |
|---|---|---|
| light accepts | a Vector2 | |
| Return Value | a RenderTask |
overload 2:
BlockTask:setLight(blockLight, skyLight) | Method Property | Fluent Description | Representation |
|---|---|---|
| blockLight accepts | an Integer | |
| skyLight accepts | an Integer | |
| Return Value | a RenderTask |
BlockTask.getPositionMatrixRaw
Inherited from RenderTask
BlockTask.setMatrix
Inherited from RenderTask
Sets the given matrix as the position matrix for this render task
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 render task
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 render task
If you call setPos() or a similar function, the effects of setMatrix() will be overwritten
overload 1:
BlockTask:setMatrix(matrix) | Method Property | Fluent Description | Representation |
|---|---|---|
| matrix accepts | a Matrix4 | |
| Return Value | a RenderTask |
BlockTask.getNormalMatrix
Inherited from RenderTask
BlockTask.getPositionMatrix
Inherited from RenderTask
BlockTask.getNormalMatrixRaw
Inherited from RenderTask
BlockTask.getScale
Inherited from RenderTask
BlockTask.setPos
Inherited from RenderTask
Sets the position of the task, relative to its attached part
Uses model coordinates
Uses model coordinates
overload 1:
BlockTask:setPos(pos) | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | |
| Return Value | a RenderTask |
overload 2:
BlockTask:setPos(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.setOverlay
Inherited from RenderTask
Sets the overlay override value of this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
overload 1:
BlockTask:setOverlay(overlay) | Method Property | Fluent Description | Representation |
|---|---|---|
| overlay accepts | a Vector2 | |
| Return Value | a RenderTask |
overload 2:
BlockTask:setOverlay(whiteOverlay, hurtOverlay) | Method Property | Fluent Description | Representation |
|---|---|---|
| whiteOverlay accepts | an Integer | |
| hurtOverlay accepts | an Integer | |
| Return Value | a RenderTask |
BlockTask.isVisible
Inherited from RenderTask
BlockTask.block
Sets the Block for this task render
overload 2:
BlockTask:block(block) | Method Property | Fluent Description | Representation |
|---|---|---|
| block accepts | a BlockState | |
| Return Value | a BlockTask |
BlockTask.scale
Inherited from RenderTask
Sets the scale of the task, relative to its attached part
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.visible
Inherited from RenderTask
Sets whether or not this task should be rendered
overload 1:
BlockTask:visible(visible) | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | a Boolean | |
| Return Value | a RenderTask |
BlockTask.rot
Inherited from RenderTask
Sets the rotation of the task, relative to its attached part
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.light
Inherited from RenderTask
Sets the light override value of this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
overload 1:
BlockTask:light(light) | Method Property | Fluent Description | Representation |
|---|---|---|
| light accepts | a Vector2 | |
| Return Value | a RenderTask |
overload 2:
BlockTask:light(blockLight, skyLight) | Method Property | Fluent Description | Representation |
|---|---|---|
| blockLight accepts | an Integer | |
| skyLight accepts | an Integer | |
| Return Value | a RenderTask |
BlockTask.matrix
Inherited from RenderTask
Sets the given matrix as the position matrix for this render task
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 render task
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 render task
If you call setPos() or a similar function, the effects of setMatrix() will be overwritten
overload 1:
BlockTask:matrix(matrix) | Method Property | Fluent Description | Representation |
|---|---|---|
| matrix accepts | a Matrix4 | |
| Return Value | a RenderTask |
BlockTask.pos
Inherited from RenderTask
Sets the position of the task, relative to its attached part
Uses model coordinates
Uses model coordinates
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.overlay
Inherited from RenderTask
Sets the overlay override value of this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
overload 1:
BlockTask:overlay(overlay) | Method Property | Fluent Description | Representation |
|---|---|---|
| overlay accepts | a Vector2 | |
| Return Value | a RenderTask |
overload 2:
BlockTask:overlay(whiteOverlay, hurtOverlay) | Method Property | Fluent Description | Representation |
|---|---|---|
| whiteOverlay accepts | an Integer | |
| hurtOverlay accepts | an Integer | |
| Return Value | a RenderTask |
EntityNameplateCustomization
subclasses NameplateCustomization
A nameplate customization that is specialized for entities
EntityNameplateCustomization.setScale
Sets the scale factor of the nameplate
overload 1:
EntityNameplateCustomization:setScale(scale) | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | a Vector3 | |
| Return Value | an EntityNameplateCustomization |
overload 2:
EntityNameplateCustomization:setScale(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | an EntityNameplateCustomization |
EntityNameplateCustomization.setShadow
Sets whether or not the nameplate should have shadow
Incompatible with "outline"
Incompatible with "outline"
overload 1:
EntityNameplateCustomization:setShadow(shadow) | Method Property | Fluent Description | Representation |
|---|---|---|
| shadow accepts | a Boolean | |
| Return Value | an EntityNameplateCustomization |
EntityNameplateCustomization.setVisible
Sets whether or not the nameplate should be rendered
overload 1:
EntityNameplateCustomization:setVisible(visible) | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | a Boolean | |
| Return Value | an EntityNameplateCustomization |
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)
overload 1:
EntityNameplateCustomization:setBackgroundColor(rgba) | Method Property | Fluent Description | Representation |
|---|---|---|
| rgba accepts | a Vector4 | |
| Return Value | an EntityNameplateCustomization |
overload 2:
EntityNameplateCustomization:setBackgroundColor(r, g, b, a) | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | a Number | |
| g accepts | a Number | |
| b accepts | a Number | |
| a accepts | a Number | |
| Return Value | an EntityNameplateCustomization |
EntityNameplateCustomization.setLight
Sets the light override value
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override
overload 1:
EntityNameplateCustomization:setLight(light) | Method Property | Fluent Description | Representation |
|---|---|---|
| light accepts | a Vector2 | |
| Return Value | an EntityNameplateCustomization |
overload 2:
EntityNameplateCustomization:setLight(blockLight, skyLight) | Method Property | Fluent Description | Representation |
|---|---|---|
| blockLight accepts | an Integer | |
| skyLight accepts | an Integer | |
| Return Value | an EntityNameplateCustomization |
EntityNameplateCustomization.setPivot
Sets the pivot of the nameplate, in world coordinates
overload 1:
EntityNameplateCustomization:setPivot(pivot) | Method Property | Fluent Description | Representation |
|---|---|---|
| pivot accepts | a Vector3 | |
| Return Value | an EntityNameplateCustomization |
overload 2:
EntityNameplateCustomization:setPivot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | an EntityNameplateCustomization |
EntityNameplateCustomization.setOutlineColor
Sets the color used for the outline in the outline mode
overload 1:
EntityNameplateCustomization:setOutlineColor(color) | Method Property | Fluent Description | Representation |
|---|---|---|
| color accepts | a Vector3 | |
| Return Value | an EntityNameplateCustomization |
overload 2:
EntityNameplateCustomization:setOutlineColor(r, g, b) | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | a Number | |
| g accepts | a Number | |
| b accepts | a Number | |
| Return Value | an EntityNameplateCustomization |
EntityNameplateCustomization.setOutline
Sets whether or not the nameplate should have outline
Incompatible with "shadow"
Incompatible with "shadow"
overload 1:
EntityNameplateCustomization:setOutline(outline) | Method Property | Fluent Description | Representation |
|---|---|---|
| outline accepts | a Boolean | |
| Return Value | an EntityNameplateCustomization |
EntityNameplateCustomization.setPos
Sets the position offset of the nameplate, in world coordinates
overload 1:
EntityNameplateCustomization:setPos(pos) | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | |
| Return Value | an EntityNameplateCustomization |
overload 2:
EntityNameplateCustomization:setPos(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | an EntityNameplateCustomization |
EntityNameplateCustomization.getText
Inherited from NameplateCustomization
EntityNameplateCustomization.setText
Inherited from NameplateCustomization
The text to use in this nameplate
overload 1:
EntityNameplateCustomization:setText(text) | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | a String | |
| Return Value | a NameplateCustomization |
EntityNameplateCustomization.scale
Sets the scale factor of the nameplate
overload 1:
EntityNameplateCustomization:scale(scale) | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | a Vector3 | |
| Return Value | an EntityNameplateCustomization |
overload 2:
EntityNameplateCustomization:scale(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | an EntityNameplateCustomization |
EntityNameplateCustomization.shadow
Sets whether or not the nameplate should have shadow
Incompatible with "outline"
Incompatible with "outline"
overload 1:
EntityNameplateCustomization:shadow(shadow) | Method Property | Fluent Description | Representation |
|---|---|---|
| shadow accepts | a Boolean | |
| Return Value | an EntityNameplateCustomization |
EntityNameplateCustomization.visible
Sets whether or not the nameplate should be rendered
overload 1:
EntityNameplateCustomization:visible(visible) | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | a Boolean | |
| Return Value | an EntityNameplateCustomization |
EntityNameplateCustomization.backgroundColor
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)
overload 1:
EntityNameplateCustomization:backgroundColor(rgba) | Method Property | Fluent Description | Representation |
|---|---|---|
| rgba accepts | a Vector4 | |
| Return Value | an EntityNameplateCustomization |
overload 2:
EntityNameplateCustomization:backgroundColor(r, g, b, a) | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | a Number | |
| g accepts | a Number | |
| b accepts | a Number | |
| a accepts | a Number | |
| Return Value | an EntityNameplateCustomization |
EntityNameplateCustomization.light
Sets the light override value
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override
overload 1:
EntityNameplateCustomization:light(light) | Method Property | Fluent Description | Representation |
|---|---|---|
| light accepts | a Vector2 | |
| Return Value | an EntityNameplateCustomization |
overload 2:
EntityNameplateCustomization:light(blockLight, skyLight) | Method Property | Fluent Description | Representation |
|---|---|---|
| blockLight accepts | an Integer | |
| skyLight accepts | an Integer | |
| Return Value | an EntityNameplateCustomization |
EntityNameplateCustomization.pivot
Sets the pivot of the nameplate, in world coordinates
overload 1:
EntityNameplateCustomization:pivot(pivot) | Method Property | Fluent Description | Representation |
|---|---|---|
| pivot accepts | a Vector3 | |
| Return Value | an EntityNameplateCustomization |
overload 2:
EntityNameplateCustomization:pivot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | an EntityNameplateCustomization |
EntityNameplateCustomization.outlineColor
Sets the color used for the outline in the outline mode
overload 1:
EntityNameplateCustomization:outlineColor(color) | Method Property | Fluent Description | Representation |
|---|---|---|
| color accepts | a Vector3 | |
| Return Value | an EntityNameplateCustomization |
overload 2:
EntityNameplateCustomization:outlineColor(r, g, b) | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | a Number | |
| g accepts | a Number | |
| b accepts | a Number | |
| Return Value | an EntityNameplateCustomization |
EntityNameplateCustomization.outline
Sets whether or not the nameplate should have outline
Incompatible with "shadow"
Incompatible with "shadow"
overload 1:
EntityNameplateCustomization:outline(outline) | Method Property | Fluent Description | Representation |
|---|---|---|
| outline accepts | a Boolean | |
| Return Value | an EntityNameplateCustomization |
EntityNameplateCustomization.pos
Sets the position offset of the nameplate, in world coordinates
overload 1:
EntityNameplateCustomization:pos(pos) | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | |
| Return Value | an EntityNameplateCustomization |
overload 2:
EntityNameplateCustomization:pos(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | an EntityNameplateCustomization |
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 | an Event |
ItemStack
A proxy for an item stack from Minecraft
ItemStack.getBlockstate
Returns the blockstate representation of this item stack
If this item has no block representation, returns nil
If this item has no block representation, returns nil
overload 1:
ItemStack:getBlockstate() | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a BlockState |
ItemTask.setItem
Sets the Item for this task render
ItemTask.getName
Inherited from RenderTask
ItemTask.setScale
Inherited from RenderTask
Sets the scale of the task, relative to its attached part
overload 1:
ItemTask:setScale(scale) | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | a Vector3 | |
| Return Value | a RenderTask |
overload 2:
ItemTask:setScale(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.setVisible
Inherited from RenderTask
Sets whether or not this task should be rendered
overload 1:
ItemTask:setVisible(visible) | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | a Boolean | |
| Return Value | a RenderTask |
ItemTask.getOverlay
Inherited from RenderTask
ItemTask.getPos
Inherited from RenderTask
ItemTask.getRot
Inherited from RenderTask
ItemTask.setRot
Inherited from RenderTask
Sets the rotation of the task, relative to its attached part
overload 1:
ItemTask:setRot(rot) | Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | a Vector3 | |
| Return Value | a RenderTask |
overload 2:
ItemTask:setRot(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.getLight
Inherited from RenderTask
ItemTask.setLight
Inherited from RenderTask
Sets the light override value of this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
overload 1:
ItemTask:setLight(light) | Method Property | Fluent Description | Representation |
|---|---|---|
| light accepts | a Vector2 | |
| Return Value | a RenderTask |
overload 2:
ItemTask:setLight(blockLight, skyLight) | Method Property | Fluent Description | Representation |
|---|---|---|
| blockLight accepts | an Integer | |
| skyLight accepts | an Integer | |
| Return Value | a RenderTask |
ItemTask.getPositionMatrixRaw
Inherited from RenderTask
ItemTask.setMatrix
Inherited from RenderTask
Sets the given matrix as the position matrix for this render task
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 render task
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 render task
If you call setPos() or a similar function, the effects of setMatrix() will be overwritten
overload 1:
ItemTask:setMatrix(matrix) | Method Property | Fluent Description | Representation |
|---|---|---|
| matrix accepts | a Matrix4 | |
| Return Value | a RenderTask |
ItemTask.getNormalMatrix
Inherited from RenderTask
ItemTask.getPositionMatrix
Inherited from RenderTask
ItemTask.getNormalMatrixRaw
Inherited from RenderTask
ItemTask.getScale
Inherited from RenderTask
ItemTask.setPos
Inherited from RenderTask
Sets the position of the task, relative to its attached part
Uses model coordinates
Uses model coordinates
overload 1:
ItemTask:setPos(pos) | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | |
| Return Value | a RenderTask |
overload 2:
ItemTask:setPos(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.setOverlay
Inherited from RenderTask
Sets the overlay override value of this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
overload 1:
ItemTask:setOverlay(overlay) | Method Property | Fluent Description | Representation |
|---|---|---|
| overlay accepts | a Vector2 | |
| Return Value | a RenderTask |
overload 2:
ItemTask:setOverlay(whiteOverlay, hurtOverlay) | Method Property | Fluent Description | Representation |
|---|---|---|
| whiteOverlay accepts | an Integer | |
| hurtOverlay accepts | an Integer | |
| Return Value | a RenderTask |
ItemTask.isVisible
Inherited from RenderTask
ItemTask.item
Sets the Item for this task render
ItemTask.scale
Inherited from RenderTask
Sets the scale of the task, relative to its attached part
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.visible
Inherited from RenderTask
Sets whether or not this task should be rendered
overload 1:
ItemTask:visible(visible) | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | a Boolean | |
| Return Value | a RenderTask |
ItemTask.rot
Inherited from RenderTask
Sets the rotation of the task, relative to its attached part
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.light
Inherited from RenderTask
Sets the light override value of this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
overload 1:
ItemTask:light(light) | Method Property | Fluent Description | Representation |
|---|---|---|
| light accepts | a Vector2 | |
| Return Value | a RenderTask |
overload 2:
ItemTask:light(blockLight, skyLight) | Method Property | Fluent Description | Representation |
|---|---|---|
| blockLight accepts | an Integer | |
| skyLight accepts | an Integer | |
| Return Value | a RenderTask |
ItemTask.matrix
Inherited from RenderTask
Sets the given matrix as the position matrix for this render task
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 render task
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 render task
If you call setPos() or a similar function, the effects of setMatrix() will be overwritten
overload 1:
ItemTask:matrix(matrix) | Method Property | Fluent Description | Representation |
|---|---|---|
| matrix accepts | a Matrix4 | |
| Return Value | a RenderTask |
ItemTask.pos
Inherited from RenderTask
Sets the position of the task, relative to its attached part
Uses model coordinates
Uses model coordinates
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.overlay
Inherited from RenderTask
Sets the overlay override value of this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
overload 1:
ItemTask:overlay(overlay) | Method Property | Fluent Description | Representation |
|---|---|---|
| overlay accepts | a Vector2 | |
| Return Value | a RenderTask |
overload 2:
ItemTask:overlay(whiteOverlay, hurtOverlay) | Method Property | Fluent Description | Representation |
|---|---|---|
| whiteOverlay accepts | an Integer | |
| hurtOverlay accepts | an Integer | |
| Return Value | a 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.setOnRelease
Sets the function that is executed when this key is released
The function has two arguments
The first argument is a number containing a bitmask of the currently held modifier keys
Shift = 1, Ctrl = 2, Alt = 4
The second argument is this keybind itself
The function has two arguments
The first argument is a number containing a bitmask of the currently held modifier keys
Shift = 1, Ctrl = 2, Alt = 4
The second argument is this keybind itself
overload 1:
Keybind:setOnRelease(function) | Method Property | Fluent Description | Representation |
|---|---|---|
| function accepts | a function | |
| Return Value | a Keybind |
Keybind.setOnPress
Sets the function that is executed when this key is pressed
The function has two arguments
The first argument is a number containing a bitmask of the currently held modifier keys
Shift = 1, Ctrl = 2, Alt = 4
The second argument is this keybind itself
The function has two arguments
The first argument is a number containing a bitmask of the currently held modifier keys
Shift = 1, Ctrl = 2, Alt = 4
The second argument is this keybind itself
overload 1:
Keybind:setOnPress(function) | Method Property | Fluent Description | Representation |
|---|---|---|
| function accepts | a function | |
| Return Value | a Keybind |
Keybind.onRelease
Sets the function that is executed when this key is released
The function has two arguments
The first argument is a number containing a bitmask of the currently held modifier keys
Shift = 1, Ctrl = 2, Alt = 4
The second argument is this keybind itself
The function has two arguments
The first argument is a number containing a bitmask of the currently held modifier keys
Shift = 1, Ctrl = 2, Alt = 4
The second argument is this keybind itself
overload 1:
Keybind:onRelease(function) | Method Property | Fluent Description | Representation |
|---|---|---|
| function accepts | a function | |
| Return Value | a Keybind |
Keybind.onPress
Sets the function that is executed when this key is pressed
The function has two arguments
The first argument is a number containing a bitmask of the currently held modifier keys
Shift = 1, Ctrl = 2, Alt = 4
The second argument is this keybind itself
The function has two arguments
The first argument is a number containing a bitmask of the currently held modifier keys
Shift = 1, Ctrl = 2, Alt = 4
The second argument is this keybind itself
overload 1:
Keybind:onPress(function) | Method Property | Fluent Description | Representation |
|---|---|---|
| function accepts | a function | |
| Return Value | a Keybind |
Keybind.press
A function that runs when the key is pressed down
The function has two arguments
The first argument is a number containing a bitmask of the currently held modifier keys
Shift = 1, Ctrl = 2, Alt = 4
The second argument is this keybind itself
If the return value is true then all vanilla keybinds using same key will be ignored
The function has two arguments
The first argument is a number containing a bitmask of the currently held modifier keys
Shift = 1, Ctrl = 2, Alt = 4
The second argument is this keybind itself
If the return value is true then all vanilla keybinds using same key will be ignored
Keybind.release
A function that runs when the key is released
The function has two arguments
The first argument is a number containing a bitmask of the currently held modifier keys
Shift = 1, Ctrl = 2, Alt = 4
The second argument is this keybind itself
If the return value is true then all vanilla keybinds using same key will be ignored
The function has two arguments
The first argument is a number containing a bitmask of the currently held modifier keys
Shift = 1, Ctrl = 2, Alt = 4
The second argument is this keybind itself
If the return value is true then all vanilla keybinds using same key will be ignored
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.isAlive
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.isSneaking
Inherited from EntityAPI
LivingEntityAPI.isWet
Inherited from EntityAPI
LivingEntityAPI.isCute
Inherited from EntityAPI
LivingEntityAPI.getVelocity
Inherited from EntityAPI
LivingEntityAPI.isHamburger
Inherited from EntityAPI
LivingEntityAPI.hasAvatar
Inherited from EntityAPI
LivingEntityAPI.getMaxAir
Inherited from EntityAPI
LivingEntityAPI.getDimensionName
Inherited from EntityAPI
LivingEntityAPI.getLookDir
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.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.getNbt
Inherited from EntityAPI
LivingEntityAPI.getEyeHeight
Inherited from EntityAPI
LivingEntityAPI.getPose
Inherited from EntityAPI
LivingEntityAPI.isInLava
Inherited from EntityAPI
LivingEntityAPI.isOnFire
Inherited from EntityAPI
LivingEntityAPI.isCrouching
Inherited from EntityAPI
LivingEntityAPI.isInWater
Inherited from EntityAPI
LivingEntityAPI.isSilent
Inherited from EntityAPI
LivingEntityAPI.isInRain
Inherited from EntityAPI
LivingEntityAPI.isSprinting
Inherited from EntityAPI
LivingEntityAPI.getEyeY
Inherited from EntityAPI
LivingEntityAPI.isInvisible
Inherited from EntityAPI
LivingEntityAPI.getPermissionLevel
Inherited from EntityAPI
LivingEntityAPI.isOnGround
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
LivingEntityAPI.hasInventory
Inherited from EntityAPI
LivingEntityAPI.getTargetedEntity
Inherited from EntityAPI
Returns a proxy for your currently targeted Entity
This Entity appears on the F3 screen
Maximum and Default distance is 20, Minimum is 0
This Entity appears on the F3 screen
Maximum and Default distance is 20, Minimum is 0
LivingEntityAPI.hasContainer
Inherited from EntityAPI
LivingEntityAPI.getVariable
Inherited from EntityAPI
Gets the value of a variable this entity stored in themselves using the Avatar API's store() function
LivingEntityAPI.isGlowing
Inherited from EntityAPI
LivingEntityAPI.isUnderwater
Inherited from EntityAPI
LivingEntityAPI.getUUID
Inherited from EntityAPI
LivingEntityAPI.getBoundingBox
Inherited from EntityAPI
LivingEntityAPI.getVehicle
Inherited from EntityAPI
LivingEntityAPI.getPassengers
Inherited from EntityAPI
LivingEntityAPI.getControllingPassenger
Inherited from EntityAPI
LivingEntityAPI.getControlledVehicle
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
NameplateCustomization.setText
The text to use in this nameplate
overload 1:
NameplateCustomization:setText(text) | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | a String | |
| Return Value | a NameplateCustomization |
NameplateCustomizationGroup
A customization that holds another nameplate customizations
NameplateCustomizationGroup.setText
Sets the text for all its children customizations
overload 1:
NameplateCustomizationGroup:setText(text) | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | a String | |
| Return Value | a NameplateCustomizationGroup |
Page
An Action Wheel container which is used to store up to 8 actions
Page.getActions
Gets a table of the Actions shifted by the given number
If no shift is specified, it returns all Actions from this page
Note that the table is indexed as its slot number as key, so blank slots will result in nil values
If no shift is specified, it returns all Actions from this page
Note that the table is indexed as its slot number as key, so blank slots will result in nil values
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
Particle
Represents a particle that can be spawned and modified
Obtained by indexing the ParticleAPI
Exists as an object-oriented alternative to particles:addParticle()
Obtained by indexing the ParticleAPI
Exists as an object-oriented alternative to particles:addParticle()
Particle.setColor
Sets this particle color
Accepts and alpha value, but most particles do not support it
Default RGBA of 1
Accepts and alpha value, but most particles do not support it
Default RGBA of 1
Particle.setVelocity
Sets the velocity of this particle
The velocity is given in world coordinates
The velocity is given in world coordinates
Particle.setPos
Sets this particle position
The position is given in world coordinates
The position is given in world coordinates
Particle.color
Sets this particle color
Accepts and alpha value, but most particles do not support it
Default RGBA of 1
Accepts and alpha value, but most particles do not support it
Default RGBA of 1
Particle.velocity
Sets the velocity of this particle
The velocity is given in world coordinates
The velocity is given in world coordinates
Particle.pos
Sets this particle position
The position is given in world coordinates
The position is given in world coordinates
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.setScale
Sets the scale of the task, relative to its attached part
overload 1:
RenderTask:setScale(scale) | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | a Vector3 | |
| Return Value | a RenderTask |
overload 2:
RenderTask:setScale(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.setVisible
Sets whether or not this task should be rendered
overload 1:
RenderTask:setVisible(visible) | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | a Boolean | |
| Return Value | a RenderTask |
RenderTask.setRot
Sets the rotation of the task, relative to its attached part
overload 1:
RenderTask:setRot(rot) | Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | a Vector3 | |
| Return Value | a RenderTask |
overload 2:
RenderTask:setRot(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.setLight
Sets the light override value of this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
overload 1:
RenderTask:setLight(light) | Method Property | Fluent Description | Representation |
|---|---|---|
| light accepts | a Vector2 | |
| Return Value | a RenderTask |
overload 2:
RenderTask:setLight(blockLight, skyLight) | Method Property | Fluent Description | Representation |
|---|---|---|
| blockLight accepts | an Integer | |
| skyLight accepts | an Integer | |
| Return Value | a RenderTask |
RenderTask.setMatrix
Sets the given matrix as the position matrix for this render task
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 render task
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 render task
If you call setPos() or a similar function, the effects of setMatrix() will be overwritten
overload 1:
RenderTask:setMatrix(matrix) | Method Property | Fluent Description | Representation |
|---|---|---|
| matrix accepts | a Matrix4 | |
| Return Value | a RenderTask |
RenderTask.setPos
Sets the position of the task, relative to its attached part
Uses model coordinates
Uses model coordinates
overload 1:
RenderTask:setPos(pos) | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | |
| Return Value | a RenderTask |
overload 2:
RenderTask:setPos(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.setOverlay
Sets the overlay override value of this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
overload 1:
RenderTask:setOverlay(overlay) | Method Property | Fluent Description | Representation |
|---|---|---|
| overlay accepts | a Vector2 | |
| Return Value | a RenderTask |
overload 2:
RenderTask:setOverlay(whiteOverlay, hurtOverlay) | Method Property | Fluent Description | Representation |
|---|---|---|
| whiteOverlay accepts | an Integer | |
| hurtOverlay accepts | an Integer | |
| Return Value | a RenderTask |
RenderTask.scale
Sets the scale of the task, relative to its attached part
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.visible
Sets whether or not this task should be rendered
overload 1:
RenderTask:visible(visible) | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | a Boolean | |
| Return Value | a RenderTask |
RenderTask.rot
Sets the rotation of the task, relative to its attached part
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 |
RenderTask.light
Sets the light override value of this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
overload 1:
RenderTask:light(light) | Method Property | Fluent Description | Representation |
|---|---|---|
| light accepts | a Vector2 | |
| Return Value | a RenderTask |
overload 2:
RenderTask:light(blockLight, skyLight) | Method Property | Fluent Description | Representation |
|---|---|---|
| blockLight accepts | an Integer | |
| skyLight accepts | an Integer | |
| Return Value | a RenderTask |
RenderTask.matrix
Sets the given matrix as the position matrix for this render task
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 render task
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 render task
If you call setPos() or a similar function, the effects of setMatrix() will be overwritten
overload 1:
RenderTask:matrix(matrix) | Method Property | Fluent Description | Representation |
|---|---|---|
| matrix accepts | a Matrix4 | |
| Return Value | a RenderTask |
RenderTask.pos
Sets the position of the task, relative to its attached part
Uses model coordinates
Uses model coordinates
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.overlay
Sets the overlay override value of this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
overload 1:
RenderTask:overlay(overlay) | Method Property | Fluent Description | Representation |
|---|---|---|
| overlay accepts | a Vector2 | |
| Return Value | a RenderTask |
overload 2:
RenderTask:overlay(whiteOverlay, hurtOverlay) | Method Property | Fluent Description | Representation |
|---|---|---|
| whiteOverlay accepts | an Integer | |
| hurtOverlay accepts | an Integer | |
| Return Value | a RenderTask |
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.setPos
Sets the position of this sound
Position is given in world coordinates
Default 0
Position is given in world coordinates
Default 0
Sound.pos
Sets the position of this sound
Position is given in world coordinates
Default 0
Position is given in world coordinates
Default 0
SpriteTask.setSize
Sets the width and height used to render this sprite
overload 1:
SpriteTask:setSize(size) | Method Property | Fluent Description | Representation |
|---|---|---|
| size accepts | a Vector2 | |
| Return Value | a SpriteTask |
overload 2:
SpriteTask:setSize(width, height) | Method Property | Fluent Description | Representation |
|---|---|---|
| width accepts | an Integer | |
| height accepts | an Integer | |
| Return Value | a SpriteTask |
SpriteTask.setColor
Sets a color multiplier for this sprite
Values are RGBA from 0 to 1
Default values are 1, alpha is optional
Values are RGBA from 0 to 1
Default values are 1, alpha is optional
overload 1:
SpriteTask:setColor(rgb) | Method Property | Fluent Description | Representation |
|---|---|---|
| rgb accepts | a Vector3 | |
| Return Value | a SpriteTask |
overload 2:
SpriteTask:setColor(rgba) | Method Property | Fluent Description | Representation |
|---|---|---|
| rgba accepts | a Vector4 | |
| Return Value | a SpriteTask |
overload 3:
SpriteTask:setColor(r, g, b, a) | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | a Number | |
| g accepts | a Number | |
| b accepts | a Number | |
| a accepts | a Number | |
| Return Value | a SpriteTask |
SpriteTask.setRegion
Sets the texture UV region
Uses its dimensions to calculate the max UV
Uses its dimensions to calculate the max UV
overload 1:
SpriteTask:setRegion(region) | Method Property | Fluent Description | Representation |
|---|---|---|
| region accepts | a Vector2 | |
| Return Value | a SpriteTask |
overload 2:
SpriteTask:setRegion(width, height) | Method Property | Fluent Description | Representation |
|---|---|---|
| width accepts | an Integer | |
| height accepts | an Integer | |
| Return Value | a SpriteTask |
SpriteTask.setUV
Sets this texture UV offset
The Region and Dimension are used to calculate the end UV
The Region and Dimension are used to calculate the end UV
overload 1:
SpriteTask:setUV(uv) | Method Property | Fluent Description | Representation |
|---|---|---|
| uv accepts | a Vector2 | |
| Return Value | a SpriteTask |
overload 2:
SpriteTask:setUV(u, v) | Method Property | Fluent Description | Representation |
|---|---|---|
| u accepts | a Number | |
| v accepts | a Number | |
| Return Value | a SpriteTask |
SpriteTask.setUVPixels
Set this texture UV offset, in pixels, based on the texture's dimension
overload 1:
SpriteTask:setUVPixels(uv) | Method Property | Fluent Description | Representation |
|---|---|---|
| uv accepts | a Vector2 | |
| Return Value | a SpriteTask |
overload 2:
SpriteTask:setUVPixels(u, v) | Method Property | Fluent Description | Representation |
|---|---|---|
| u accepts | a Number | |
| v accepts | a Number | |
| Return Value | a SpriteTask |
SpriteTask.setTexture
Sets this task's texture
The texture's width and height must be provided if the texture is a location
For custom textures, the dimensions are optional
The texture's width and height must be provided if the texture is a location
For custom textures, the dimensions are optional
overload 1:
SpriteTask:setTexture(textureLocation, width, height) | Method Property | Fluent Description | Representation |
|---|---|---|
| textureLocation accepts | a String | |
| width accepts | an Integer | |
| height accepts | an Integer | |
| Return Value | a SpriteTask |
overload 2:
SpriteTask:setTexture(texture) | Method Property | Fluent Description | Representation |
|---|---|---|
| texture accepts | a Texture | |
| Return Value | a SpriteTask |
overload 3:
SpriteTask:setTexture(texture, width, height) | Method Property | Fluent Description | Representation |
|---|---|---|
| texture accepts | a Texture | |
| width accepts | an Integer | |
| height accepts | an Integer | |
| Return Value | a SpriteTask |
SpriteTask.setDimensions
Sets the texture dimensions, used in UV calculation
overload 1:
SpriteTask:setDimensions(dimensions) | Method Property | Fluent Description | Representation |
|---|---|---|
| dimensions accepts | a Vector2 | |
| Return Value | a SpriteTask |
overload 2:
SpriteTask:setDimensions(width, height) | Method Property | Fluent Description | Representation |
|---|---|---|
| width accepts | an Integer | |
| height accepts | an Integer | |
| Return Value | a SpriteTask |
SpriteTask.setRenderType
Sets the current render type of this sprite
TRANSLUCENT by default
Check the docs enum command for all render types
TRANSLUCENT by default
Check the docs enum command for all render types
overload 1:
SpriteTask:setRenderType(renderType) | Method Property | Fluent Description | Representation |
|---|---|---|
| renderType accepts | a String | |
| Return Value | a SpriteTask |
SpriteTask.getName
Inherited from RenderTask
SpriteTask.setScale
Inherited from RenderTask
Sets the scale of the task, relative to its attached part
overload 1:
SpriteTask:setScale(scale) | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | a Vector3 | |
| Return Value | a RenderTask |
overload 2:
SpriteTask:setScale(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a RenderTask |
SpriteTask.setVisible
Inherited from RenderTask
Sets whether or not this task should be rendered
overload 1:
SpriteTask:setVisible(visible) | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | a Boolean | |
| Return Value | a RenderTask |
SpriteTask.getOverlay
Inherited from RenderTask
SpriteTask.getPos
Inherited from RenderTask
SpriteTask.getRot
Inherited from RenderTask
SpriteTask.setRot
Inherited from RenderTask
Sets the rotation of the task, relative to its attached part
overload 1:
SpriteTask:setRot(rot) | Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | a Vector3 | |
| Return Value | a RenderTask |
overload 2:
SpriteTask:setRot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a RenderTask |
SpriteTask.getLight
Inherited from RenderTask
SpriteTask.setLight
Inherited from RenderTask
Sets the light override value of this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
overload 1:
SpriteTask:setLight(light) | Method Property | Fluent Description | Representation |
|---|---|---|
| light accepts | a Vector2 | |
| Return Value | a RenderTask |
overload 2:
SpriteTask:setLight(blockLight, skyLight) | Method Property | Fluent Description | Representation |
|---|---|---|
| blockLight accepts | an Integer | |
| skyLight accepts | an Integer | |
| Return Value | a RenderTask |
SpriteTask.getPositionMatrixRaw
Inherited from RenderTask
SpriteTask.setMatrix
Inherited from RenderTask
Sets the given matrix as the position matrix for this render task
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 render task
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 render task
If you call setPos() or a similar function, the effects of setMatrix() will be overwritten
overload 1:
SpriteTask:setMatrix(matrix) | Method Property | Fluent Description | Representation |
|---|---|---|
| matrix accepts | a Matrix4 | |
| Return Value | a RenderTask |
SpriteTask.getNormalMatrix
Inherited from RenderTask
SpriteTask.getPositionMatrix
Inherited from RenderTask
SpriteTask.getNormalMatrixRaw
Inherited from RenderTask
SpriteTask.getScale
Inherited from RenderTask
SpriteTask.setPos
Inherited from RenderTask
Sets the position of the task, relative to its attached part
Uses model coordinates
Uses model coordinates
overload 1:
SpriteTask:setPos(pos) | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | |
| Return Value | a RenderTask |
overload 2:
SpriteTask:setPos(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a RenderTask |
SpriteTask.setOverlay
Inherited from RenderTask
Sets the overlay override value of this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
overload 1:
SpriteTask:setOverlay(overlay) | Method Property | Fluent Description | Representation |
|---|---|---|
| overlay accepts | a Vector2 | |
| Return Value | a RenderTask |
overload 2:
SpriteTask:setOverlay(whiteOverlay, hurtOverlay) | Method Property | Fluent Description | Representation |
|---|---|---|
| whiteOverlay accepts | an Integer | |
| hurtOverlay accepts | an Integer | |
| Return Value | a RenderTask |
SpriteTask.isVisible
Inherited from RenderTask
SpriteTask.size
Sets the width and height used to render this sprite
overload 1:
SpriteTask:size(size) | Method Property | Fluent Description | Representation |
|---|---|---|
| size accepts | a Vector2 | |
| Return Value | a SpriteTask |
overload 2:
SpriteTask:size(width, height) | Method Property | Fluent Description | Representation |
|---|---|---|
| width accepts | an Integer | |
| height accepts | an Integer | |
| Return Value | a SpriteTask |
SpriteTask.color
Sets a color multiplier for this sprite
Values are RGBA from 0 to 1
Default values are 1, alpha is optional
Values are RGBA from 0 to 1
Default values are 1, alpha is optional
overload 1:
SpriteTask:color(rgb) | Method Property | Fluent Description | Representation |
|---|---|---|
| rgb accepts | a Vector3 | |
| Return Value | a SpriteTask |
overload 2:
SpriteTask:color(rgba) | Method Property | Fluent Description | Representation |
|---|---|---|
| rgba accepts | a Vector4 | |
| Return Value | a SpriteTask |
overload 3:
SpriteTask:color(r, g, b, a) | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | a Number | |
| g accepts | a Number | |
| b accepts | a Number | |
| a accepts | a Number | |
| Return Value | a SpriteTask |
SpriteTask.region
Sets the texture UV region
Uses its dimensions to calculate the max UV
Uses its dimensions to calculate the max UV
overload 1:
SpriteTask:region(region) | Method Property | Fluent Description | Representation |
|---|---|---|
| region accepts | a Vector2 | |
| Return Value | a SpriteTask |
overload 2:
SpriteTask:region(width, height) | Method Property | Fluent Description | Representation |
|---|---|---|
| width accepts | an Integer | |
| height accepts | an Integer | |
| Return Value | a SpriteTask |
SpriteTask.uv
Sets this texture UV offset
The Region and Dimension are used to calculate the end UV
The Region and Dimension are used to calculate the end UV
overload 1:
SpriteTask:uv(uv) | Method Property | Fluent Description | Representation |
|---|---|---|
| uv accepts | a Vector2 | |
| Return Value | a SpriteTask |
overload 2:
SpriteTask:uv(u, v) | Method Property | Fluent Description | Representation |
|---|---|---|
| u accepts | a Number | |
| v accepts | a Number | |
| Return Value | a SpriteTask |
SpriteTask.uvPixels
Set this texture UV offset, in pixels, based on the texture's dimension
overload 1:
SpriteTask:uvPixels(uv) | Method Property | Fluent Description | Representation |
|---|---|---|
| uv accepts | a Vector2 | |
| Return Value | a SpriteTask |
overload 2:
SpriteTask:uvPixels(u, v) | Method Property | Fluent Description | Representation |
|---|---|---|
| u accepts | a Number | |
| v accepts | a Number | |
| Return Value | a SpriteTask |
SpriteTask.texture
Sets this task's texture
The texture's width and height must be provided if the texture is a location
For custom textures, the dimensions are optional
The texture's width and height must be provided if the texture is a location
For custom textures, the dimensions are optional
overload 1:
SpriteTask:texture(textureLocation, width, height) | Method Property | Fluent Description | Representation |
|---|---|---|
| textureLocation accepts | a String | |
| width accepts | an Integer | |
| height accepts | an Integer | |
| Return Value | a SpriteTask |
overload 2:
SpriteTask:texture(texture) | Method Property | Fluent Description | Representation |
|---|---|---|
| texture accepts | a Texture | |
| Return Value | a SpriteTask |
overload 3:
SpriteTask:texture(texture, width, height) | Method Property | Fluent Description | Representation |
|---|---|---|
| texture accepts | a Texture | |
| width accepts | an Integer | |
| height accepts | an Integer | |
| Return Value | a SpriteTask |
SpriteTask.dimensions
Sets the texture dimensions, used in UV calculation
overload 1:
SpriteTask:dimensions(dimensions) | Method Property | Fluent Description | Representation |
|---|---|---|
| dimensions accepts | a Vector2 | |
| Return Value | a SpriteTask |
overload 2:
SpriteTask:dimensions(width, height) | Method Property | Fluent Description | Representation |
|---|---|---|
| width accepts | an Integer | |
| height accepts | an Integer | |
| Return Value | a SpriteTask |
SpriteTask.renderType
Sets the current render type of this sprite
TRANSLUCENT by default
Check the docs enum command for all render types
TRANSLUCENT by default
Check the docs enum command for all render types
overload 1:
SpriteTask:renderType(renderType) | Method Property | Fluent Description | Representation |
|---|---|---|
| renderType accepts | a String | |
| Return Value | a SpriteTask |
SpriteTask.scale
Inherited from RenderTask
Sets the scale of the task, relative to its attached part
overload 1:
SpriteTask:scale(scale) | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | a Vector3 | |
| Return Value | a RenderTask |
overload 2:
SpriteTask: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 |
SpriteTask.visible
Inherited from RenderTask
Sets whether or not this task should be rendered
overload 1:
SpriteTask:visible(visible) | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | a Boolean | |
| Return Value | a RenderTask |
SpriteTask.rot
Inherited from RenderTask
Sets the rotation of the task, relative to its attached part
overload 1:
SpriteTask:rot(rot) | Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | a Vector3 | |
| Return Value | a RenderTask |
overload 2:
SpriteTask: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 |
SpriteTask.light
Inherited from RenderTask
Sets the light override value of this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
overload 1:
SpriteTask:light(light) | Method Property | Fluent Description | Representation |
|---|---|---|
| light accepts | a Vector2 | |
| Return Value | a RenderTask |
overload 2:
SpriteTask:light(blockLight, skyLight) | Method Property | Fluent Description | Representation |
|---|---|---|
| blockLight accepts | an Integer | |
| skyLight accepts | an Integer | |
| Return Value | a RenderTask |
SpriteTask.matrix
Inherited from RenderTask
Sets the given matrix as the position matrix for this render task
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 render task
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 render task
If you call setPos() or a similar function, the effects of setMatrix() will be overwritten
overload 1:
SpriteTask:matrix(matrix) | Method Property | Fluent Description | Representation |
|---|---|---|
| matrix accepts | a Matrix4 | |
| Return Value | a RenderTask |
SpriteTask.pos
Inherited from RenderTask
Sets the position of the task, relative to its attached part
Uses model coordinates
Uses model coordinates
overload 1:
SpriteTask:pos(pos) | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | |
| Return Value | a RenderTask |
overload 2:
SpriteTask: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 |
SpriteTask.overlay
Inherited from RenderTask
Sets the overlay override value of this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
overload 1:
SpriteTask:overlay(overlay) | Method Property | Fluent Description | Representation |
|---|---|---|
| overlay accepts | a Vector2 | |
| Return Value | a RenderTask |
overload 2:
SpriteTask:overlay(whiteOverlay, hurtOverlay) | Method Property | Fluent Description | Representation |
|---|---|---|
| whiteOverlay accepts | an Integer | |
| hurtOverlay accepts | an Integer | |
| Return Value | a RenderTask |
TextTask.setBackgroundColor
Sets the background color of this text
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)
TextTask.setOutlineColor
Sets the outline color this Text should render
Only compatible with "Outline" mode
Only compatible with "Outline" mode
TextTask.setOutline
Toggles if the text should render with an outline
The text will always render at full brightness if it is given an outline
Not compatible with "Shadow" and "Emissive" modes
The text will always render at full brightness if it is given an outline
Not compatible with "Shadow" and "Emissive" modes
TextTask.getName
Inherited from RenderTask
TextTask.setScale
Inherited from RenderTask
Sets the scale of the task, relative to its attached part
overload 1:
TextTask:setScale(scale) | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | a Vector3 | |
| Return Value | a RenderTask |
overload 2:
TextTask:setScale(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.setVisible
Inherited from RenderTask
Sets whether or not this task should be rendered
overload 1:
TextTask:setVisible(visible) | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | a Boolean | |
| Return Value | a RenderTask |
TextTask.getOverlay
Inherited from RenderTask
TextTask.getPos
Inherited from RenderTask
TextTask.getRot
Inherited from RenderTask
TextTask.setRot
Inherited from RenderTask
Sets the rotation of the task, relative to its attached part
overload 1:
TextTask:setRot(rot) | Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | a Vector3 | |
| Return Value | a RenderTask |
overload 2:
TextTask:setRot(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.getLight
Inherited from RenderTask
TextTask.setLight
Inherited from RenderTask
Sets the light override value of this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
overload 1:
TextTask:setLight(light) | Method Property | Fluent Description | Representation |
|---|---|---|
| light accepts | a Vector2 | |
| Return Value | a RenderTask |
overload 2:
TextTask:setLight(blockLight, skyLight) | Method Property | Fluent Description | Representation |
|---|---|---|
| blockLight accepts | an Integer | |
| skyLight accepts | an Integer | |
| Return Value | a RenderTask |
TextTask.getPositionMatrixRaw
Inherited from RenderTask
TextTask.setMatrix
Inherited from RenderTask
Sets the given matrix as the position matrix for this render task
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 render task
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 render task
If you call setPos() or a similar function, the effects of setMatrix() will be overwritten
overload 1:
TextTask:setMatrix(matrix) | Method Property | Fluent Description | Representation |
|---|---|---|
| matrix accepts | a Matrix4 | |
| Return Value | a RenderTask |
TextTask.getNormalMatrix
Inherited from RenderTask
TextTask.getPositionMatrix
Inherited from RenderTask
TextTask.getNormalMatrixRaw
Inherited from RenderTask
TextTask.getScale
Inherited from RenderTask
TextTask.setPos
Inherited from RenderTask
Sets the position of the task, relative to its attached part
Uses model coordinates
Uses model coordinates
overload 1:
TextTask:setPos(pos) | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | |
| Return Value | a RenderTask |
overload 2:
TextTask:setPos(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.setOverlay
Inherited from RenderTask
Sets the overlay override value of this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
overload 1:
TextTask:setOverlay(overlay) | Method Property | Fluent Description | Representation |
|---|---|---|
| overlay accepts | a Vector2 | |
| Return Value | a RenderTask |
overload 2:
TextTask:setOverlay(whiteOverlay, hurtOverlay) | Method Property | Fluent Description | Representation |
|---|---|---|
| whiteOverlay accepts | an Integer | |
| hurtOverlay accepts | an Integer | |
| Return Value | a RenderTask |
TextTask.isVisible
Inherited from RenderTask
TextTask.backgroundColor
Sets the background color of this text
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)
TextTask.outlineColor
Sets the outline color this Text should render
Only compatible with "Outline" mode
Only compatible with "Outline" mode
TextTask.outline
Toggles if the text should render with an outline
The text will always render at full brightness if it is given an outline
Not compatible with "Shadow" and "Emissive" modes
The text will always render at full brightness if it is given an outline
Not compatible with "Shadow" and "Emissive" modes
TextTask.scale
Inherited from RenderTask
Sets the scale of the task, relative to its attached part
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.visible
Inherited from RenderTask
Sets whether or not this task should be rendered
overload 1:
TextTask:visible(visible) | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | a Boolean | |
| Return Value | a RenderTask |
TextTask.rot
Inherited from RenderTask
Sets the rotation of the task, relative to its attached part
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.light
Inherited from RenderTask
Sets the light override value of this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
overload 1:
TextTask:light(light) | Method Property | Fluent Description | Representation |
|---|---|---|
| light accepts | a Vector2 | |
| Return Value | a RenderTask |
overload 2:
TextTask:light(blockLight, skyLight) | Method Property | Fluent Description | Representation |
|---|---|---|
| blockLight accepts | an Integer | |
| skyLight accepts | an Integer | |
| Return Value | a RenderTask |
TextTask.matrix
Inherited from RenderTask
Sets the given matrix as the position matrix for this render task
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 render task
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 render task
If you call setPos() or a similar function, the effects of setMatrix() will be overwritten
overload 1:
TextTask:matrix(matrix) | Method Property | Fluent Description | Representation |
|---|---|---|
| matrix accepts | a Matrix4 | |
| Return Value | a RenderTask |
TextTask.pos
Inherited from RenderTask
Sets the position of the task, relative to its attached part
Uses model coordinates
Uses model coordinates
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.overlay
Inherited from RenderTask
Sets the overlay override value of this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
overload 1:
TextTask:overlay(overlay) | Method Property | Fluent Description | Representation |
|---|---|---|
| overlay accepts | a Vector2 | |
| Return Value | a RenderTask |
overload 2:
TextTask:overlay(whiteOverlay, hurtOverlay) | Method Property | Fluent Description | Representation |
|---|---|---|
| whiteOverlay accepts | an Integer | |
| hurtOverlay accepts | an Integer | |
| Return Value | a RenderTask |
Texture
A texture object, either generated by the model or created with the TextureAPI
Texture.fill
Sets the RGBA color of the entire specified region
Texture.applyFunc
Calls the given function on the specified area of this texture, it will iterate over each pixel, giving its current x, y, and color as arguments, the color is a vec4 in RGBA format, and the return value will set that pixel's color
Invalid return values or nil takes no effects
Invalid return values or nil takes no effects
overload 1:
Texture:applyFunc(x, y, width, height, func) Texture.setPixel
Sets the RGBA color of the specified pixel
Texture.applyMatrix
Transforms all pixels in the specified area of this texture by the matrix
If `clip` is true, the resulting colour channels will be clamped between 0 and 1
If `clip` is true, the resulting colour channels will be clamped between 0 and 1
Texture.pixel
Sets the RGBA color of the specified pixel
TextureAtlas
A texture atlas object, with helper functions related to a texture atlas
VanillaModelGroup
subclasses VanillaPart
Represents a group of model parts in a vanilla model
Used for easy reference of normal parts
All changes also applies to all children parts
Used for easy reference of normal parts
All changes also applies to all children parts
VanillaModelGroup.setScale
Inherited from VanillaPart
Set this part and its children's scale
overload 1:
VanillaModelGroup:setScale(scale) | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaModelGroup:setScale(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaModelGroup.setVisible
Inherited from VanillaPart
Sets this part and its children to be visible or invisible
overload 1:
VanillaModelGroup:setVisible(visible) | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | a Boolean | |
| Return Value | a VanillaPart |
VanillaModelGroup.setRot
Inherited from VanillaPart
Set this part and its children's rotation
overload 1:
VanillaModelGroup:setRot(rot) | Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaModelGroup:setRot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaModelGroup.setOffsetScale
Inherited from VanillaPart
Offsets this part and its children's scale, multiplying with the vanilla values
overload 1:
VanillaModelGroup:setOffsetScale(offsetScale) | Method Property | Fluent Description | Representation |
|---|---|---|
| offsetScale accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaModelGroup:setOffsetScale(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaModelGroup.setOffsetRot
Inherited from VanillaPart
Offsets this part and its children's rotation, adding on top of the vanilla values
overload 1:
VanillaModelGroup:setOffsetRot(offsetRot) | Method Property | Fluent Description | Representation |
|---|---|---|
| offsetRot accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaModelGroup:setOffsetRot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaModelGroup.setPos
Inherited from VanillaPart
Set this part and its children's position, preserving the previous values
overload 1:
VanillaModelGroup:setPos(pos) | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaModelGroup:setPos(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaModelGroup.getVisible
Inherited from VanillaPart
VanillaModelGroup.getPos
Inherited from VanillaPart
VanillaModelGroup.getRot
Inherited from VanillaPart
VanillaModelGroup.getOffsetRot
Inherited from VanillaPart
VanillaModelGroup.getOffsetScale
Inherited from VanillaPart
VanillaModelGroup.getScale
Inherited from VanillaPart
VanillaModelGroup.scale
Inherited from VanillaPart
Set this part and its children's scale
overload 1:
VanillaModelGroup:scale(scale) | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaModelGroup:scale(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaModelGroup.visible
Inherited from VanillaPart
Sets this part and its children to be visible or invisible
overload 1:
VanillaModelGroup:visible(visible) | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | a Boolean | |
| Return Value | a VanillaPart |
VanillaModelGroup.rot
Inherited from VanillaPart
Set this part and its children's rotation
overload 1:
VanillaModelGroup:rot(rot) | Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaModelGroup:rot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaModelGroup.offsetScale
Inherited from VanillaPart
Offsets this part and its children's scale, multiplying with the vanilla values
overload 1:
VanillaModelGroup:offsetScale(offsetScale) | Method Property | Fluent Description | Representation |
|---|---|---|
| offsetScale accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaModelGroup:offsetScale(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaModelGroup.offsetRot
Inherited from VanillaPart
Offsets this part and its children's rotation, adding on top of the vanilla values
overload 1:
VanillaModelGroup:offsetRot(offsetRot) | Method Property | Fluent Description | Representation |
|---|---|---|
| offsetRot accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaModelGroup:offsetRot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaModelGroup.pos
Inherited from VanillaPart
Set this part and its children's position, preserving the previous values
overload 1:
VanillaModelGroup:pos(pos) | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaModelGroup:pos(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaModelPart
subclasses VanillaPart
Represents a model part in a vanilla model
Can be queried for vanilla transform values
Can be queried for vanilla transform values
VanillaModelPart.setScale
Inherited from VanillaPart
Set this part's scale
overload 1:
VanillaModelPart:setScale(scale) | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaModelPart:setScale(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaModelPart.setVisible
Inherited from VanillaPart
Sets this part to be visible or invisible
overload 1:
VanillaModelPart:setVisible(visible) | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | a Boolean | |
| Return Value | a VanillaPart |
VanillaModelPart.getVisible
Inherited from VanillaPart
VanillaModelPart.getPos
Inherited from VanillaPart
VanillaModelPart.getRot
Inherited from VanillaPart
VanillaModelPart.setRot
Inherited from VanillaPart
Set this part's rotation
overload 1:
VanillaModelPart:setRot(rot) | Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaModelPart:setRot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaModelPart.getOffsetRot
Inherited from VanillaPart
VanillaModelPart.getOffsetScale
Inherited from VanillaPart
VanillaModelPart.setOffsetScale
Inherited from VanillaPart
Offsets this part's scale, multiplying with the vanilla values
overload 1:
VanillaModelPart:setOffsetScale(offsetScale) | Method Property | Fluent Description | Representation |
|---|---|---|
| offsetScale accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaModelPart:setOffsetScale(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaModelPart.setOffsetRot
Inherited from VanillaPart
Offsets this part's rotation, adding on top of the vanilla values
overload 1:
VanillaModelPart:setOffsetRot(offsetRot) | Method Property | Fluent Description | Representation |
|---|---|---|
| offsetRot accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaModelPart:setOffsetRot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaModelPart.getScale
Inherited from VanillaPart
VanillaModelPart.setPos
Inherited from VanillaPart
Set this part's position, preserving the previous values
overload 1:
VanillaModelPart:setPos(pos) | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaModelPart:setPos(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaModelPart.scale
Inherited from VanillaPart
Set this part's scale
overload 1:
VanillaModelPart:scale(scale) | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaModelPart:scale(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaModelPart.visible
Inherited from VanillaPart
Sets this part to be visible or invisible
overload 1:
VanillaModelPart:visible(visible) | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | a Boolean | |
| Return Value | a VanillaPart |
VanillaModelPart.rot
Inherited from VanillaPart
Set this part's rotation
overload 1:
VanillaModelPart:rot(rot) | Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaModelPart:rot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaModelPart.offsetScale
Inherited from VanillaPart
Offsets this part's scale, multiplying with the vanilla values
overload 1:
VanillaModelPart:offsetScale(offsetScale) | Method Property | Fluent Description | Representation |
|---|---|---|
| offsetScale accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaModelPart:offsetScale(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaModelPart.offsetRot
Inherited from VanillaPart
Offsets this part's rotation, adding on top of the vanilla values
overload 1:
VanillaModelPart:offsetRot(offsetRot) | Method Property | Fluent Description | Representation |
|---|---|---|
| offsetRot accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaModelPart:offsetRot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaModelPart.pos
Inherited from VanillaPart
Set this part's position, preserving the previous values
overload 1:
VanillaModelPart:pos(pos) | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaModelPart:pos(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaPart
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
VanillaPart.setScale
Set this part's scale
overload 1:
VanillaPart:setScale(scale) | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaPart:setScale(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaPart.setVisible
Sets this part to be visible or invisible
overload 1:
VanillaPart:setVisible(visible) | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | a Boolean | |
| Return Value | a VanillaPart |
VanillaPart.setRot
Set this part's rotation
overload 1:
VanillaPart:setRot(rot) | Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaPart:setRot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaPart.setOffsetScale
Offsets this part's scale, multiplying with the vanilla values
overload 1:
VanillaPart:setOffsetScale(offsetScale) | Method Property | Fluent Description | Representation |
|---|---|---|
| offsetScale accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaPart:setOffsetScale(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaPart.setOffsetRot
Offsets this part's rotation, adding on top of the vanilla values
overload 1:
VanillaPart:setOffsetRot(offsetRot) | Method Property | Fluent Description | Representation |
|---|---|---|
| offsetRot accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaPart:setOffsetRot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaPart.setPos
Set this part's position, preserving the previous values
overload 1:
VanillaPart:setPos(pos) | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaPart:setPos(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaPart.scale
Set this part's scale
overload 1:
VanillaPart:scale(scale) | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaPart:scale(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaPart.visible
Sets this part to be visible or invisible
overload 1:
VanillaPart:visible(visible) | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | a Boolean | |
| Return Value | a VanillaPart |
VanillaPart.rot
Set this part's rotation
overload 1:
VanillaPart:rot(rot) | Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaPart:rot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaPart.offsetScale
Offsets this part's scale, multiplying with the vanilla values
overload 1:
VanillaPart:offsetScale(offsetScale) | Method Property | Fluent Description | Representation |
|---|---|---|
| offsetScale accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaPart:offsetScale(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaPart.offsetRot
Offsets this part's rotation, adding on top of the vanilla values
overload 1:
VanillaPart:offsetRot(offsetRot) | Method Property | Fluent Description | Representation |
|---|---|---|
| offsetRot accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaPart:offsetRot(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
VanillaPart.pos
Set this part's position, preserving the previous values
overload 1:
VanillaPart:pos(pos) | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | |
| Return Value | a VanillaPart |
overload 2:
VanillaPart:pos(x, y, z) | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a Number | |
| y accepts | a Number | |
| z accepts | a Number | |
| Return Value | a VanillaPart |
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.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
Vector2.augmented
Returns the augmented form of this vector
The augmented form is a Vector of the same length + 1
The new axis will have the given value, or 1 when it is not specified
The augmented form is a Vector of the same length + 1
The new axis will have the given value, or 1 when it is not specified
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.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
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.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.augmented
Returns the augmented form of this vector
The augmented form is a Vector of the same length + 1
The new axis will have the given value, or 1 when it is not specified
The augmented form is a Vector of the same length + 1
The new axis will have the given value, or 1 when it is not specified
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.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
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.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.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.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
Vertex
A vertex object
Vertex.setUV
Sets the UV vector of this vertex
Vertex.setNormal
Sets the normal vector of this vertex
Vertex.setPos
Sets the position vector of this vertex
Vertex.uv
Sets the UV vector of this vertex
Vertex.normal
Sets the normal vector of this vertex
Vertex.pos
Sets the position vector of this vertex
ViewerAPI.getStatusEffects
Returns a table of all of the player's status effects
The table contains sub-tables, each of which contains the name, amplifier, duration, and particle visibility of each status effect
The table contains sub-tables, each of which contains the name, amplifier, duration, and particle visibility of each status effect
ViewerAPI.getExperienceProgress
Inherited from PlayerAPI
ViewerAPI.getChargedAttackDelay
Inherited from PlayerAPI
ViewerAPI.getShoulderEntity
Inherited from PlayerAPI
Returns a table of the nbt of this entity left or right shoulder entity
ViewerAPI.isSkinLayerVisible
Inherited from PlayerAPI
ViewerAPI.getGamemode
Inherited from PlayerAPI
ViewerAPI.isFishing
Inherited from PlayerAPI
ViewerAPI.hasSkin
Inherited from PlayerAPI
ViewerAPI.getModelType
Inherited from PlayerAPI
ViewerAPI.getExhaustion
Inherited from PlayerAPI
ViewerAPI.hasCape
Inherited from PlayerAPI
ViewerAPI.getIPAddress
Inherited from PlayerAPI
ViewerAPI.getTeamInfo
Inherited from PlayerAPI
ViewerAPI.getSaturation
Inherited from PlayerAPI
ViewerAPI.getExperienceLevel
Inherited from PlayerAPI
ViewerAPI.getFood
Inherited from PlayerAPI
ViewerAPI.isBlocking
Inherited from PlayerAPI
ViewerAPI.isVisuallySwimming
Inherited from PlayerAPI
ViewerAPI.isLeftHanded
Inherited from PlayerAPI
ViewerAPI.getBodyYaw
Inherited from PlayerAPI
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
ViewerAPI.isGliding
Inherited from PlayerAPI
ViewerAPI.riptideSpinning
Inherited from PlayerAPI
ViewerAPI.getActiveItem
Inherited from PlayerAPI
ViewerAPI.getSwingArm
Inherited from PlayerAPI
ViewerAPI.getActiveHand
Inherited from PlayerAPI
ViewerAPI.getActiveItemTime
Inherited from PlayerAPI
ViewerAPI.getHeldItem
Inherited from PlayerAPI
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
ViewerAPI.getDeathTime
Inherited from PlayerAPI
ViewerAPI.getEntityCategory
Inherited from PlayerAPI
ViewerAPI.getSwingTime
Inherited from PlayerAPI
ViewerAPI.isSwingingArm
Inherited from PlayerAPI
ViewerAPI.isClimbing
Inherited from PlayerAPI
ViewerAPI.getAbsorptionAmount
Inherited from PlayerAPI
ViewerAPI.isUsingItem
Inherited from PlayerAPI
ViewerAPI.getArrowCount
Inherited from PlayerAPI
ViewerAPI.getStingerCount
Inherited from PlayerAPI
ViewerAPI.isSensitiveToWater
Inherited from PlayerAPI
ViewerAPI.getSwingDuration
Inherited from PlayerAPI
ViewerAPI.getMaxHealth
Inherited from PlayerAPI
ViewerAPI.getHealth
Inherited from PlayerAPI
ViewerAPI.getArmor
Inherited from PlayerAPI
ViewerAPI.getName
Inherited from PlayerAPI
ViewerAPI.isAlive
Inherited from PlayerAPI
ViewerAPI.getType
Inherited from PlayerAPI
ViewerAPI.isLoaded
Inherited from PlayerAPI
ViewerAPI.getItem
Inherited from PlayerAPI
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
ViewerAPI.isSneaking
Inherited from PlayerAPI
ViewerAPI.isWet
Inherited from PlayerAPI
ViewerAPI.isCute
Inherited from PlayerAPI
ViewerAPI.getVelocity
Inherited from PlayerAPI
ViewerAPI.isHamburger
Inherited from PlayerAPI
ViewerAPI.hasAvatar
Inherited from PlayerAPI
ViewerAPI.getMaxAir
Inherited from PlayerAPI
ViewerAPI.getDimensionName
Inherited from PlayerAPI
ViewerAPI.getLookDir
Inherited from PlayerAPI
ViewerAPI.getFrozenTicks
Inherited from PlayerAPI
ViewerAPI.getPos
Inherited from PlayerAPI
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
ViewerAPI.getRot
Inherited from PlayerAPI
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
ViewerAPI.getNbt
Inherited from PlayerAPI
ViewerAPI.getEyeHeight
Inherited from PlayerAPI
ViewerAPI.getPose
Inherited from PlayerAPI
ViewerAPI.isInLava
Inherited from PlayerAPI
ViewerAPI.isOnFire
Inherited from PlayerAPI
ViewerAPI.isCrouching
Inherited from PlayerAPI
ViewerAPI.isInWater
Inherited from PlayerAPI
ViewerAPI.isSilent
Inherited from PlayerAPI
ViewerAPI.isInRain
Inherited from PlayerAPI
ViewerAPI.isSprinting
Inherited from PlayerAPI
ViewerAPI.getEyeY
Inherited from PlayerAPI
ViewerAPI.isInvisible
Inherited from PlayerAPI
ViewerAPI.getPermissionLevel
Inherited from PlayerAPI
ViewerAPI.isOnGround
Inherited from PlayerAPI
ViewerAPI.getTargetedBlock
Inherited from PlayerAPI
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
ViewerAPI.hasInventory
Inherited from PlayerAPI
ViewerAPI.getTargetedEntity
Inherited from PlayerAPI
Returns a proxy for your currently targeted Entity
This Entity appears on the F3 screen
Maximum and Default distance is 20, Minimum is 0
This Entity appears on the F3 screen
Maximum and Default distance is 20, Minimum is 0
ViewerAPI.hasContainer
Inherited from PlayerAPI
ViewerAPI.getVariable
Inherited from PlayerAPI
Gets the value of a variable this entity stored in themselves using the Avatar API's store() function
ViewerAPI.isGlowing
Inherited from PlayerAPI
ViewerAPI.isUnderwater
Inherited from PlayerAPI
ViewerAPI.getUUID
Inherited from PlayerAPI
ViewerAPI.getBoundingBox
Inherited from PlayerAPI
ViewerAPI.getVehicle
Inherited from PlayerAPI
ViewerAPI.getPassengers
Inherited from PlayerAPI
ViewerAPI.getControllingPassenger
Inherited from PlayerAPI
ViewerAPI.getControlledVehicle
Inherited from PlayerAPI
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.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
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.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
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 limits SKYE_BLUE sky skye skylar LILY_RED lily foxes fox KIRI_ORANGE kiri CHEESE largecheese large cheese LUA_LOG LUA_ERROR LUA_PING luna moff moth DEFAULT DISCORD KOFI GITHUB REDDIT MODRINTH CURSEFORGE 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 SITTING ROARING SNIFFING EMERGING DIGGING ItemDisplayModes
List of valid DisplayModes
Used within the Item RenderTask
Used within the Item RenderTask
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 iris.keybind.shaderPackSelection key.hotbar.4 key.hotbar.3 key.hotbar.2 key.togglePerspective key.hotbar.1 figura.config.wardrobe_button key.spectatorOutlines key.godown.crawl key.left iris.keybind.reload key.chat key.perspectivemod.toggle 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 iris.keybind.toggleShaders key.back key.swapOffhand key.command key.saveToolbarActivator key.inventory key.jump key.drop key.modmenu.open_menu 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 Model MODEL 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 HeadsUpDisplay Gui GUI GraphicalUserInterface JraficalUserInterface Camera CAMERA Billboard BILLBOARD Skull SKULL ☠ Portrait PORTRAIT Arrow ARROW Item ITEM 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 RenderModes
List of valid RenderModes
Used within the RENDER event
Used within the RENDER event
FIGURA_GUI PAPERDOLL MINECRAFT_GUI FIRST_PERSON FIRST_PERSON_WORLD RENDER WORLD OTHER RenderTypes
List of valid RenderTypes
Used within ModelParts
Used within ModelParts
NONE CUTOUT CUTOUT_CULL TRANSLUCENT TRANSLUCENT_CULL EMISSIVE EMISSIVE_SOLID EYES END_PORTAL END_GATEWAY TEXTURED_PORTAL GLINT GLINT2 TEXTURED_GLINT LINES LINES_STRIP SOLID BLURRY TextureTypes
List of valid TextureTypes
Used within ModelParts
Used within ModelParts
SKIN CAPE ELYTRA RESOURCE PRIMARY SECONDARY SPECULAR NORMAL CUSTOM UseActions
List of valid UseActions
Used within the ItemStackAPI
Used within the ItemStackAPI
NONE EAT DRINK BLOCK BOW SPEAR CROSSBOW SPYGLASS TOOT_HORN BRUSH