Show everything

Miscellaneous Types

math
Action Page
Animation
EntityNameplateCustomization NameplateCustomization NameplateCustomizationGroup
Biome BlockState ItemStack
VanillaModelGroup VanillaModelPart
BlockTask ItemTask RenderTask TextTask
LivingEntityAPI
Event
Keybind
Vector2 Vector3 Vector4 Vector5 Vector6
Matrix2 Matrix3 Matrix4
Particle
Sound
PingFunction
Texture
Made by applejuice

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

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

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

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

Action.getTitle
Gets this Action title
overload 1:
Action:getTitle()
Method Property Fluent Description Representation
Return Value a String

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

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

Action.getToggleTitle
Gets this Action toggled title
overload 1:
Action:getToggleTitle()
Method Property Fluent Description Representation
Return Value a String

Action.getToggleColor
Gets this Action toggled color
overload 1:
Action:getToggleColor()
Method Property Fluent Description Representation
Return Value a Vector3

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

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

Action.getHoverColor
Gets this Action hover color
overload 1:
Action:getHoverColor()
Method Property Fluent Description Representation
Return Value a Vector3

Action.onToggle
figura.docs.wheel_action.on_toggle
overload 1:
Action:onToggle(leftFunction)
Method Property Fluent Description Representation
leftFunction accepts a function that takes a Boolean and an Action and will return anything
Return Value an Action

Action.onScroll
figura.docs.wheel_action.on_scroll
overload 1:
Action:onScroll(scrollFunction)
Method Property Fluent Description Representation
scrollFunction accepts a function that takes a Number and an Action and will return anything
Return Value an Action

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

Action.onLeftClick
Example by applejuice:
local myAction = myPage:newAction()

myAction:onLeftClick(function()
log("Heheh I got Left Clicked!")
end)
figura.docs.wheel_action.on_left_click
overload 1:
Action:onLeftClick(leftFunction)
Method Property Fluent Description Representation
leftFunction accepts a function that takes an Action and will return anything
Return Value an Action

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

Action.onRightClick
Example by applejuice:
local myAction = myPage:newAction()

myAction:onRightClick(function()
log("Heheh I got Right Clicked!")
end)
figura.docs.wheel_action.on_right_click
overload 1:
Action:onRightClick(rightFunction)
Method Property Fluent Description Representation
rightFunction accepts a function that takes an Action and will return anything
Return Value an Action

Action.onUntoggle
figura.docs.wheel_action.on_untoggle
overload 1:
Action:onUntoggle(rightFunction)
Method Property Fluent Description Representation
rightFunction accepts a function that takes a Boolean and an Action and will return anything
Return Value an Action

Action.isToggled
Checks if the Action is toggled or not
overload 1:
Action:isToggled()
Method Property Fluent Description Representation
Return Value a Boolean

Action.getColor
Gets this Action color
overload 1:
Action:getColor()
Method Property Fluent Description Representation
Return Value a Vector3

Action.leftClick
Function that is executed when the left mouse button is clicked
The function has one argument
The first argument is this action itself
field signature:
leftClick
Method Property Fluent Description Representation
Field Type a function that takes an Action and will return anything

Action.rightClick
Function that is executed when the right mouse button is clicked
The function has one argument
The first argument is this action itself
field signature:
rightClick
Method Property Fluent Description Representation
Field Type a function that takes an Action and will return anything

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
field signature:
toggle
Method Property Fluent Description Representation
Field Type a function that takes a Boolean and an Action and will return anything

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
field signature:
untoggle
Method Property Fluent Description Representation
Field Type a function that takes a Boolean and an Action and will return anything

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
field signature:
scroll
Method Property Fluent Description Representation
Field Type a function that takes a Number and an Action and will return anything
a a