action

Vars
background_icon_state	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)
button_icon	This is the file for the BACKGROUND underlay icon of the button
button_icon_state	This is the icon state for the icon that appears on the button
buttontooltipstyle	The style the button's tooltips appear to be
check_flags	Flags that will determine of the owner / user of the action can... use the action
default_button_position	Where any buttons we create should be by default. Accepts screen_loc and location defines
desc	The description of what the action does, shown in button tooltips
icon_icon	This is the file for the icon that appears on the button
name	The name of the action
owner	This is who currently owns the action, and most often, this is who is using the action if it is triggered This can be the same as "target" but is not ALWAYS the same - this is set and unset with Grant() and Remove()
target	The target the action is attached to. If the target datum is deleted, the action is as well. Set in New() via the proc link_to(). PLEASE set a target if you're making an action
transparent_when_unavailable	Whether the button becomes transparent when it can't be used, or just reddened
viewers	List of all mobs that are viewing our action button -> A unique movable for them to view.
Procs
GiveAction	Gives our action to the passed viewer. Puts our action in their actions list and shows them the button.
HideFrom	Removes our action from the passed viewer.
IsAvailable	Whether our action is currently available to use or not
ShowTo	Adds our action button to the screen of the passed viewer.
Trigger	Actually triggers the effects of the action. Called when the on-screen button is clicked, for example.
clear_ref	Signal proc that clears any references based on the owner or target deleting If the owner's deleted, we will simply remove from them, but if the target's deleted, we will self-delete
update_status_on_signal	A general use signal proc that reacts to an event and updates JUST our button's status

Var Details

var
background_icon_state
–

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)

var
button_icon
–

This is the file for the BACKGROUND underlay icon of the button

var
button_icon_state
–

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

var
buttontooltipstyle
–

The style the button's tooltips appear to be

var
check_flags
–

Flags that will determine of the owner / user of the action can... use the action

var
default_button_position
–

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

var
desc
–

The description of what the action does, shown in button tooltips

var
icon_icon
–

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

var
name
–

The name of the action

var
owner
– /mob

This is who currently owns the action, and most often, this is who is using the action if it is triggered This can be the same as "target" but is not ALWAYS the same - this is set and unset with Grant() and Remove()

var
target
– /datum

The target the action is attached to. If the target datum is deleted, the action is as well. Set in New() via the proc link_to(). PLEASE set a target if you're making an action

var
transparent_when_unavailable
–

Whether the button becomes transparent when it can't be used, or just reddened

var
viewers
– /list

List of all mobs that are viewing our action button -> A unique movable for them to view.

Proc Details

proc
GiveAction
(/mob/viewer)

Gives our action to the passed viewer. Puts our action in their actions list and shows them the button.

proc
HideFrom
(/mob/viewer)

Removes our action from the passed viewer.

proc
IsAvailable
(silent)

Whether our action is currently available to use or not

silent - If false this is being called to check if we have any messages to show to the owner

proc
ShowTo
(/mob/viewer)

Adds our action button to the screen of the passed viewer.

proc
Trigger
()

Actually triggers the effects of the action. Called when the on-screen button is clicked, for example.

proc
clear_ref
(/datum/ref)

Signal proc that clears any references based on the owner or target deleting If the owner's deleted, we will simply remove from them, but if the target's deleted, we will self-delete

proc
update_status_on_signal
(/datum/source, new_stat, old_stat)

A general use signal proc that reacts to an event and updates JUST our button's status

action /datum/action

Vars

Procs

Var Details

var background_icon_state –

var button_icon –

var button_icon_state –

var buttontooltipstyle –

var check_flags –

var default_button_position –

var desc –

var icon_icon –

var name –

var owner – /mob

var target – /datum

var transparent_when_unavailable –

var viewers – /list