Action wheel (tutorial)

This page is under construction.

Untested scripts
Handle with care.

The Action Wheel is a GUI element added by Figura which allows you to add additional functionality to your avatar.

By default, the action wheel is opened with the B key. This can be changed in Figura's Settings.

The Action Wheel consists of a set of Pages, of which only one can be active at a time. Each page can have an unlimited number of Actions. Only 8 Actions can be rendered at a time, however — if more than 8 Actions are active on a page, the scroll wheel can be used to navigate between the sets of Actions (8 at a time.)

For full documentation, see:

• ActionWheelAPI for the global action_wheel,
• Page for pages, and
• Action for actions.

Example

The first step to using the Action Wheel is to create a page to hold the Actions, via newPage.

local mainPage = action_wheel:newPage()

This creates a new page, but doesn't do anything else. If you save the script and try to open the Action Wheel (B), you will see a message stating that there is no active page. Using setPage with the newly created page will change the current active page:

local mainPage = action_wheel:newPage()
action_wheel:setPage(mainPage)

The message about not having an active page should be gone now, but the page is still empty. Let's add some actions.

Adding actions

Create a new action by calling newAction on a Page, like so:

local mainPage = action_wheel:newPage()
action_wheel:setPage(mainPage)

local action = mainPage:newAction()