cooldown

Preset for an action that has a cooldown.

Vars
active_background_icon_state	The icon state the background uses when active
active_icon_state	The active icon state of the spell's button icon, used for editing the icon "on"
active_overlay_icon_state	The active icon_state of the overlay we apply
base_background_icon_state	The base icon_state of this action's background
base_icon_state	The base icon state of the spell's button icon, used for editing the icon "off"
base_overlay_icon_state	The base icon_state of the overlay we apply
click_cd_override	The cooldown added onto the user's next click.
click_to_activate	Setting for intercepting clicks before activating the ability
cooldown_time	The default cooldown applied when StartCooldown() is called
initialized_actions	List of prerequisite actions that have been initialized
melee_cooldown_time	The default melee cooldown applied after the ability ends
next_melee_use_time	The actual next time the owner of this action can melee
next_use_time	The actual next time this ability can be used
panel	The stat panel this action shows up in the stat panel in. If null, will not show up.
ranged_mousepointer	What icon to replace our mouse cursor with when active. Optional
sequence_actions	List of prerequisite actions that are used in this sequenced ability, you cannot put other sequenced abilities in this
shared_cooldown	Shares cooldowns with other abiliies, bitflag
text_cooldown	Whether or not you want the cooldown for the ability to display in text form
unset_after_click	If TRUE, we will unset after using our click intercept.
write_log	If TRUE, will log action usage to the owner's action log.
Procs
Activate	To be implemented by subtypes (if not generic)
InterceptClickOn	Intercepts client owner clicks to activate the ability
PreActivate	For signal calling
StartCooldown	Starts a cooldown time to be shared with similar abilities Will use default cooldown time if an override is not specified
StartCooldownOthers	Starts a cooldown time for other abilities that share a cooldown with this. Has some niche usage with more complicated attack ai! Will use default cooldown time if an override is not specified
StartCooldownSelf	Starts a cooldown time for this ability only Will use default cooldown time if an override is not specified
create_sequence_actions	Initializes any sequence actions
handle_melee_attack	Cancels melee attacks if they are on cooldown.
is_valid_target	Check if the target we're casting on is a valid target. For no-target (self cast) actions, the target being checked (cast_on) is the caster. For click_to_activate actions, the target being checked is the clicked atom.
set_click_ability	Set our action as the click override on the passed mob.
set_statpanel_format	Formats the action to be returned to the stat panel.
unset_click_ability	Unset our action as the click override of the passed mob.

Var Details

var
active_background_icon_state
–

The icon state the background uses when active

var
active_icon_state
–

The active icon state of the spell's button icon, used for editing the icon "on"

var
active_overlay_icon_state
–

The active icon_state of the overlay we apply

var
base_background_icon_state
–

The base icon_state of this action's background

var
base_icon_state
–

The base icon state of the spell's button icon, used for editing the icon "off"

var
base_overlay_icon_state
–

The base icon_state of the overlay we apply

var
click_cd_override
–

The cooldown added onto the user's next click.

var
click_to_activate
–

Setting for intercepting clicks before activating the ability

var
cooldown_time
–

The default cooldown applied when StartCooldown() is called

var
initialized_actions
– /list

List of prerequisite actions that have been initialized

var
melee_cooldown_time
–

The default melee cooldown applied after the ability ends

var
next_melee_use_time
–

The actual next time the owner of this action can melee

var
next_use_time
–

The actual next time this ability can be used

var
panel
–

The stat panel this action shows up in the stat panel in. If null, will not show up.

var
ranged_mousepointer
–

What icon to replace our mouse cursor with when active. Optional

var
sequence_actions
– /list

List of prerequisite actions that are used in this sequenced ability, you cannot put other sequenced abilities in this

var
shared_cooldown
–

Shares cooldowns with other abiliies, bitflag

var
text_cooldown
–

Whether or not you want the cooldown for the ability to display in text form

var
unset_after_click
–

If TRUE, we will unset after using our click intercept.

var
write_log
–

If TRUE, will log action usage to the owner's action log.

Proc Details

proc
Activate
(/atom/target)

To be implemented by subtypes (if not generic)

proc
InterceptClickOn
(/mob/living/caller, params, /atom/target)

Intercepts client owner clicks to activate the ability

proc
PreActivate
(/atom/target)

For signal calling

proc
StartCooldown
(override_cooldown_time, override_melee_cooldown_time)

Starts a cooldown time to be shared with similar abilities Will use default cooldown time if an override is not specified

proc
StartCooldownOthers
(override_cooldown_time)

Starts a cooldown time for other abilities that share a cooldown with this. Has some niche usage with more complicated attack ai! Will use default cooldown time if an override is not specified

proc
StartCooldownSelf
(override_cooldown_time)

Starts a cooldown time for this ability only Will use default cooldown time if an override is not specified

proc
create_sequence_actions
()

Initializes any sequence actions

proc
handle_melee_attack
(/mob/source, /mob/target)

Cancels melee attacks if they are on cooldown.

proc
is_valid_target
(/atom/cast_on)

Check if the target we're casting on is a valid target. For no-target (self cast) actions, the target being checked (cast_on) is the caster. For click_to_activate actions, the target being checked is the clicked atom.

Return TRUE if cast_on is valid, FALSE otherwise

proc
set_click_ability
(/mob/on_who)

Set our action as the click override on the passed mob.

proc
set_statpanel_format
()

Formats the action to be returned to the stat panel.

proc
unset_click_ability
(/mob/on_who, refund_cooldown)

Unset our action as the click override of the passed mob.

if refund_cooldown is TRUE, we are being unset by the user clicking the action off if refund_cooldown is FALSE, we are being forcefully unset, likely by someone actually using the action

cooldown /datum/action/cooldown

Vars

Procs

Var Details

var active_background_icon_state –

var active_icon_state –

var active_overlay_icon_state –

var base_background_icon_state –

var base_icon_state –

var base_overlay_icon_state –

var click_cd_override –

var click_to_activate –

var cooldown_time –

var initialized_actions – /list

var melee_cooldown_time –

var next_melee_use_time –

var next_use_time –

var panel –

var ranged_mousepointer –

var sequence_actions – /list

var shared_cooldown –

var text_cooldown –

var unset_after_click –

var write_log –