action

Var Details

action_disabled

Toggles whether this action is usable or not

background_icon

This is the icon state state for the BACKGROUND underlay icon of the button (If set to ACTION_BUTTON_DEFAULT_BACKGROUND, uses the hud's default background)

background_icon_state

Icon state of screen object background

button_icon

This is the file for the icon that appears on the button

button_icon_state

This is the icon state for the icon that appears on the button

default_button_position

Where any buttons we create should be by default. Accepts screen_loc and location defines

overlay_icon

This is the file for any FOREGROUND overlay icons on the button (such as borders)

overlay_icon_state

This is the icon state for any FOREGROUND overlay icons on the button (such as borders)

owner_has_control

If False, the owner of this action does not get a hud and cannot activate it on their own

show_to_observers

Whether or not this will be shown to observers

viewers

Map of huds viewing a button with our action -> their button

Proc Details

apply_button_background

Creates the background underlay for the button

button - what button are we editing? force - whether an update is forced regardless of existing status

apply_button_icon

Applies our button icon and icon state to the button

button - what button are we editing? force - whether an update is forced regardless of existing status

apply_button_overlay

Applies any overlays to our button

button - what button are we editing? force - whether an update is forced regardless of existing status

build_all_button_icons

Builds / updates all buttons we have shared or given out

build_button_icon

Builds the icon of the button.

Concept:

• Underlay (Background icon)
• Icon (button icon)
• Maptext
• Overlay (Background border)

button - which button we are modifying the icon of force - whether we're forcing a full update

is_action_active

Checks if our action is actively selected. Used for selecting icons primarily.

link_to

Links the passed target to our action, registering any relevant signals

on_target_icon_update

Updates our buttons if our target's icon was updated

update_button_name

Updates the name and description of the button to match our action name and discription.

button - what button are we editing? force - whether an update is forced regardless of existing status

update_button_status

Any other miscellaneous "status" updates within the action button is handled here, such as redding out when unavailable or modifying maptext.

button - what button are we editing? force - whether an update is forced regardless of existing status