byond - Modules - TypesVar Details - Proc Details

action

Vars

action_typeDefines what visual references will be initialized at round-start
hiddenIs this action explicitly hidden from the owner
keybinding_signalsUsed for keybindings , use KEYBINDING_NORMAL or KEYBINDING_ALTERNATE for keybinding_activation or alternate_ability_activate
toggledUsed for keeping track of the addition of the selected/active frames
visual_referencesHolds a set of misc visual references to use with the overlay API. Always atleast one

Procs

ai_should_start_considerShould a AI element occasionally see if this ability should be used?
ai_should_useWhen called, see if based on the surroundings should the AI use this ability
alternate_action_activateSignal Handler for alternate actions
clean_actionCleans up the action if the owner is deleted
deselectDeselecting this action for use
fail_activateassumption: if no keybind ref passed you want to call normally. would use _listen_lookup but that'd start getting cursed and overly expensive for what it is Add it if you need it
handle_button_status_visualsA proc called on update button action for additional visuals beyond the very base
keybind_activationSignal Handler for main action
keybind_triggerHandler for what action to trigger, inherit from this and call parent before for extra actions
selectSetting this action as the active action
set_toggleDepending on the action type , toggles the selected/active frame to show without allowing stacking multiple overlays
should_showWhether the owner can see this action
update_button_iconThe cutting needs to be done /BEFORE/ the string maptext gets changed. Since byond internally recognizes it as a different image, and doesn't cut it properly
update_map_textA handler used to update the maptext and show the change immediately.

Var Details

action_type

Defines what visual references will be initialized at round-start

hidden

Is this action explicitly hidden from the owner

keybinding_signals

Used for keybindings , use KEYBINDING_NORMAL or KEYBINDING_ALTERNATE for keybinding_activation or alternate_ability_activate

toggled

Used for keeping track of the addition of the selected/active frames

visual_references

Holds a set of misc visual references to use with the overlay API. Always atleast one

Proc Details

ai_should_start_consider

Should a AI element occasionally see if this ability should be used?

ai_should_use

When called, see if based on the surroundings should the AI use this ability

alternate_action_activate

Signal Handler for alternate actions

clean_action

Cleans up the action if the owner is deleted

deselect

Deselecting this action for use

fail_activate

assumption: if no keybind ref passed you want to call normally. would use _listen_lookup but that'd start getting cursed and overly expensive for what it is Add it if you need it

handle_button_status_visuals

A proc called on update button action for additional visuals beyond the very base

keybind_activation

Signal Handler for main action

keybind_trigger

Handler for what action to trigger, inherit from this and call parent before for extra actions

select

Setting this action as the active action

set_toggle

Depending on the action type , toggles the selected/active frame to show without allowing stacking multiple overlays

should_show

Whether the owner can see this action

update_button_icon

The cutting needs to be done /BEFORE/ the string maptext gets changed. Since byond internally recognizes it as a different image, and doesn't cut it properly

update_map_text

A handler used to update the maptext and show the change immediately.