action_wheel

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

ActionWheelAPI.execute

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

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

ActionWheelAPI.isEnabled

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

ActionWheelAPI.getSelected

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

ActionWheelAPI.getPage

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

ActionWheelAPI.setPage

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

ActionWheelAPI.createPage

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

ActionWheelAPI.leftClick

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

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

ActionWheelAPI.rightClick

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

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

ActionWheelAPI.scroll

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

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