Buy Me a Coffee at ko-fi.com

A global API which is used for customizing your player's Action Wheel

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:
ActionWheelAPI.execute(): ActionWheelAPI
typings.1118886197
Method PropertyFluent DescriptionRepresentation
Return Value
overload 2:
ActionWheelAPI.execute(index: Integer): ActionWheelAPI
typings.-672261858typings.1118886197
Method PropertyFluent DescriptionRepresentation
index accepts
Return Value
overload 3:
ActionWheelAPI.execute(index: Integer, rightClick: Boolean): ActionWheelAPI
typings.-672261858typings.1729365000typings.1118886197
Method PropertyFluent DescriptionRepresentation
index accepts
rightClick accepts
Return Value

Returns the current set Page from the Action Wheel, or NIL if no Page has been set

overload 1:
ActionWheelAPI.getCurrentPage(): Page | nil
typings.1825473468
Method PropertyFluent DescriptionRepresentation
Return Value

Returns a stored Page by the given title
If no title is given, returns a table with all registered Pages

overload 1:
ActionWheelAPI.getPage(): Page | nil
typings.1825473468
Method PropertyFluent DescriptionRepresentation
Return Value
overload 2:
ActionWheelAPI.getPage(pageTitle: String): Page
typings.-1808118735typings.2479791
Method PropertyFluent DescriptionRepresentation
pageTitle accepts
Return Value

Returns the index of the currently selected action

overload 1:
ActionWheelAPI.getSelected(): Integer
typings.-672261858
Method PropertyFluent DescriptionRepresentation
Return Value

Returns the Action that is currently selected in the Action Wheel

overload 1:
ActionWheelAPI.getSelectedAction(): Action
typings.1955883606
Method PropertyFluent DescriptionRepresentation
Return Value

Returns if the Action Wheel is being currently rendered or not

overload 1:
ActionWheelAPI.isEnabled(): Boolean
typings.1729365000
Method PropertyFluent DescriptionRepresentation
Return Value

Creates a new Action that is not automatically assigned to a Page

overload 1:
ActionWheelAPI.newAction(): Action
typings.1955883606
Method PropertyFluent DescriptionRepresentation
Return Value

Creates a new Page for the action wheel
A Title can be given to store this page internally
If no Title is given, the Page will just be returned from this function

overload 1:
ActionWheelAPI.newPage(): Page
typings.2479791
Method PropertyFluent DescriptionRepresentation
Return Value
overload 2:
ActionWheelAPI.newPage(title: String): Page
typings.-1808118735typings.2479791
Method PropertyFluent DescriptionRepresentation
title accepts
Return Value

Sets the Page of the action wheel to the given Title or Page

overload 1:
ActionWheelAPI.setPage(pageTitle: String): ActionWheelAPI
typings.-1808118735typings.1118886197
Method PropertyFluent DescriptionRepresentation
pageTitle accepts
Return Value
overload 2:
ActionWheelAPI.setPage(page: Page): ActionWheelAPI
typings.2479791typings.1118886197
Method PropertyFluent DescriptionRepresentation
page accepts
Return Value

Function that is executed when the left mouse button is clicked

field signature:
ActionWheelAPI.leftClick: () -> AnyType
typings.589264950
Method PropertyFluent DescriptionRepresentation
Field Type

Function that is executed when the right mouse button is clicked

field signature:
ActionWheelAPI.rightClick: () -> AnyType
typings.589264950
Method PropertyFluent DescriptionRepresentation
Field Type

Function that is executed when the mouse is scrolled

field signature:
ActionWheelAPI.scroll: (Number) -> AnyType
typings.-2024887265
Method PropertyFluent DescriptionRepresentation
Field Type