Skip to content
Arseniy B. edited this page Aug 24, 2025 · 18 revisions

Welcome to the Figura-ActionLists documentation


About Action Lists

Action lists are a powerful, practical and convenient tool that allows you to reduce the amount of code and time spent searching for the desired action among a huge pile of other actions. This is also a completely new element of the action wheel. Actions in them are performed either by scrolling, pressing the left mouse button or the right mouse button.

Creating action list

Any action list, like a regular action, is created and placed on any page of the action wheel

local myPage = action_wheel:newPage() -- Creating an Action Wheel Page
local myActionList = myPage:newActionList() -- Creating an Action list

Appearance

You can customize the appearance of the action list in quite a lot of detail.


setColor() Aliases: color()

Sets the background color of the Action List

setColor()

Parameters:

Name Type Is required Description Default
color Vector3 Reqired The RGB value of the background, with each value between 0 and 1 vec(0,0,0)
shouldntMakeNewTitle Boolean Optional If there is too much init instructions you can choose to don't update title false

Returns:

Type Description
table Returns self for chaining

Example:

myActionList:setColor(vec(1, 0.5, 0,5)) -- Background is pink now

getColor()

Gets this Action List's background color

getColor()

Returns:

Type Description
Vector3 The RGB background color for this Action List

Example:

myActionList:getColor()

setHoverColor() Aliases: hoverColor()

Sets the background color of the Action List when it is being hovered

setHoverColor()

Parameters:

Name Type Is required Description Default
color Vector3 Reqired The RGB value of the background, with each value between 0 and 1 vec(0,0,0)
shouldntMakeNewTitle Boolean Optional If there is too much init instructions you can choose to don't update title false

Returns:

Type Description
table Returns self for chaining

Example:

myActionList:setHoverColor(vec(1, 0.5, 0,5)) -- Background is pink when action list is being hovered

getHoverColor()

Gets this Action List background hover color

getHoverColor()

Returns:

Type Description
Vector3 The RGB background hover color for this action list

Example:

myActionList:getHoverColor()

setItem() Aliases: item()

Sets the item of the Action List

setItem()

setHoverItem() Aliases: hoverItem()

Sets the item of the Action List when it is being hovered

setHoverItem()

setTexture() Aliases: texture()

Sets a Custom Texture to render in this Action List

setTexture()

setHoverTexture() Aliases: hoverTexture()

Sets a Custom Texture to render while this Action List is being hovered

setHoverTexture()

setTitle() Aliases: title()

Sets the title of the Action List

setTitle()

getTitle()

Gets this Action List title

getTitle()

setActionListColor() Aliases: actionListColor()

Sets the color of the Action List

setActionListColor()

getActionListColor()

Gets the list's color of this Action List

getActionListColor()

setSelectedActionColor() Aliases: selectedActionColor()

Sets the color of Selected Action

setSelectedActionColor()

getSelectedActionColor()

Gets the selected action's color of this Action List

getSelectedActionColor()

setVisualSize() Aliases: visualSize()

Sets the length of the visible part on the screen

setVisualSize()

getVisualSize()

Gets the length of the visible part of this Action List on the screen

getVisualSize()

Managing Action list


setActionList() Aliases: actionList()


getActionList()


setSelectedActionIndex() Aliases: selectedActionIndex()


Debug


getUserdata()


Clone this wiki locally