Show everything 
listFiles 
action_wheel Miscellaneous Types
Miscellaneous Enums
BlockRaycastTypes Colors EntityPoses FluidRaycastTypes HeightmapTypes ItemDisplayModes KeyIDs Keybinds LoopModes ParentTypes PlayStates PlayerModelParts PostEffects Registries RenderModes RenderTypes StringEncodings TextureTypes UseActionsEventsAPI
A global API that contains all of the figura Events
Accessed using the name "events"
Accessed using the name "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