ToggleAction

subclasses Action

figura.docs.toggle_action

ToggleAction.toggled

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

ToggleAction.toggleTitle

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

ToggleAction.toggleColor

figura.docs.toggle_action.toggle_color
overload 1:
ToggleAction:toggleColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an Action
overload 2:
ToggleAction: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

ToggleAction.onToggle

figura.docs.toggle_action.on_toggle
overload 1:
ToggleAction:onToggle(leftFunction)
Method Property Fluent Description Representation
leftFunction accepts a function
Return Value an Action

ToggleAction.isToggled

figura.docs.toggle_action.is_toggled
overload 1:
ToggleAction:isToggled()
Method Property Fluent Description Representation
Return Value a Boolean

ToggleAction.onUntoggle

figura.docs.toggle_action.on_untoggle
overload 1:
ToggleAction:onUntoggle(rightFunction)
Method Property Fluent Description Representation
rightFunction accepts a function
Return Value an Action

ToggleAction.toggleItem

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

ToggleAction.getToggleColor

figura.docs.toggle_action.get_toggle_color
overload 1:
ToggleAction:getToggleColor()
Method Property Fluent Description Representation
Return Value a Vector3

ToggleAction.getToggleTitle

figura.docs.toggle_action.get_toggle_title
overload 1:
ToggleAction:getToggleTitle()
Method Property Fluent Description Representation
Return Value a String

ToggleAction.color

Inherited from Action

figura.docs.wheel_action.color
overload 1:
ToggleAction:color(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an Action
overload 2:
ToggleAction: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

ToggleAction.item

Inherited from Action

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

ToggleAction.title

Inherited from Action

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

ToggleAction.hoverItem

Inherited from Action

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

ToggleAction.hoverColor

Inherited from Action

figura.docs.wheel_action.hover_color
overload 1:
ToggleAction:hoverColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an Action
overload 2:
ToggleAction: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

ToggleAction.getHoverColor

Inherited from Action

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

ToggleAction.getColor

Inherited from Action

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

ToggleAction.toggle

figura.docs.toggle_action.toggle
field signature:
toggle
Method Property Fluent Description Representation
Field Type a function

ToggleAction.untoggle

figura.docs.toggle_action.untoggle
field signature:
untoggle
Method Property Fluent Description Representation
Field Type a function
a a