ability

Vars
ability_cooldown_time	If set to a numeric value, the ability cannot be used before the cooldown has expired.
ability_icon	Icon to draw on the ability HUD, if any.
ability_icon_state	Icon state to draw on the ability HUD, if any.
ability_use_channel	If set, a do_after() will be applied to this spell.
admin_blocked	If set, this ability cannot be used on the admin z-level.
associated_handler_type	An associated handler type, used in add_ability().
cancel_ability_1p_str	"You cease readying yourself to use an ability."
cast_failed_disabled_str	Failed due to being silenced/disabled
cast_failed_incapacitated	Failed due to being downed/buckled
cast_failed_no_admin_level	Failed due to being on admin level
cast_failed_no_charges	Failed due to still recharging
cast_failed_no_turf	Failed due to non-turf loc.
cast_failed_on_cooldown	Failed due to still being on cooldown from last use
cast_failed_purged_str	Failed due to purged/null rod.
cast_failed_wrong_mob_type	Failed due to being invalid mob type
cast_message_1p_str	"You use an ability."
cast_message_3p_str	"$USER$ uses an ability."
charge_delay	How long it takes between charges.
check_incapacitated	What flags to check before an ability can be used, if any.
copy_with_mind	Should this ability be copied between mobs when mind is transferred?
desc	A descriptive string about the ability.
end_prep_on_cast	Used in conjunction with prep_cast, if TRUE, ability will be untoggled after cast.
expected_mob_type	What type of mob is required to use this ability.
fail_cast_1p_str	"You fail to cast an ability."
hidden_from_codex	If not set, the ability will have documentation generated for the codex.
is_melee_invocation	Does this invocation trigger on a proximity click, if prepared?
is_ranged_invocation	Does this invocation trigger on a non-proximity click, if prepared?
is_supernatural	If set, this ability will be silenced by null rod and similar mechanics.
item_end_on_cast	Ability items invoking this ability will GC afterwards.
max_charge	Maximum charges that can be held of this item at a time. If unset, item does not accumulate charges.
name	A descriptive identifier string.
overlay_icon	If set, will attempt to draw from this icon on the turf where the ability is used.
overlay_icon_state	If set, will attempt to draw this icon_state on the turf where the ability is used.
overlay_lifespan	Will delete the overlay after this time.
prep_cast	If TRUE, ability is toggled on and will fire when a target is clicked, instead of instantaneously on use.
prepare_message_1p_str	"You begin preparing to use an ability on $TARGET$."
prepare_message_3p_str	"$USER$ begins preparing to use an ability on $TARGET$."
projectile_duration	Determines the lifetime of the projectile.
projectile_step_delay	Sets the projectile step_delay.
projectile_type	If set, this ability will create a projectile rather than applying the effect directly.
ready_ability_1p_str	"You ready yourself to use an ability."
requires_turf	If set, this ability can only be used while standing on a turf (not in an atom's contents or null loc).
target_selector	A decl type that handles retrieving and validating targets.
ui_element_type	Type of button to use for the UI. Should be /obj/screen/ability/button or subtype.
use_sound	If set, will play a sound when used.
use_sound_volume	Volume for above.

Var Details

var
ability_cooldown_time
–

If set to a numeric value, the ability cannot be used before the cooldown has expired.

var
ability_icon
–

Icon to draw on the ability HUD, if any.

var
ability_icon_state
–

Icon state to draw on the ability HUD, if any.

var
ability_use_channel
–

If set, a do_after() will be applied to this spell.

var
admin_blocked
–

If set, this ability cannot be used on the admin z-level.

var
associated_handler_type
–

An associated handler type, used in add_ability().

var
cancel_ability_1p_str
–

"You cease readying yourself to use an ability."

var
cast_failed_disabled_str
–

Failed due to being silenced/disabled

var
cast_failed_incapacitated
–

Failed due to being downed/buckled

var
cast_failed_no_admin_level
–

Failed due to being on admin level

var
cast_failed_no_charges
–

Failed due to still recharging

var
cast_failed_no_turf
–

Failed due to non-turf loc.

var
cast_failed_on_cooldown
–

Failed due to still being on cooldown from last use

var
cast_failed_purged_str
–

Failed due to purged/null rod.

var
cast_failed_wrong_mob_type
–

Failed due to being invalid mob type

var
cast_message_1p_str
–

"You use an ability."

var
cast_message_3p_str
–

"$USER$ uses an ability."

var
charge_delay
–

How long it takes between charges.

var
check_incapacitated
–

What flags to check before an ability can be used, if any.

var
copy_with_mind
–

Should this ability be copied between mobs when mind is transferred?

var
desc
–

A descriptive string about the ability.

var
end_prep_on_cast
–

Used in conjunction with prep_cast, if TRUE, ability will be untoggled after cast.

var
expected_mob_type
– /mob

What type of mob is required to use this ability.

var
fail_cast_1p_str
–

"You fail to cast an ability."

var
hidden_from_codex
–

If not set, the ability will have documentation generated for the codex.

var
is_melee_invocation
–

Does this invocation trigger on a proximity click, if prepared?

var
is_ranged_invocation
–

Does this invocation trigger on a non-proximity click, if prepared?

var
is_supernatural
–

If set, this ability will be silenced by null rod and similar mechanics.

var
item_end_on_cast
–

Ability items invoking this ability will GC afterwards.

var
max_charge
–

Maximum charges that can be held of this item at a time. If unset, item does not accumulate charges.

var
name
–

A descriptive identifier string.

var
overlay_icon
–

If set, will attempt to draw from this icon on the turf where the ability is used.

var
overlay_icon_state
–

If set, will attempt to draw this icon_state on the turf where the ability is used.

var
overlay_lifespan
–

Will delete the overlay after this time.

var
prep_cast
–

If TRUE, ability is toggled on and will fire when a target is clicked, instead of instantaneously on use.

var
prepare_message_1p_str
–

"You begin preparing to use an ability on $TARGET$."

var
prepare_message_3p_str
–

"$USER$ begins preparing to use an ability on $TARGET$."

var
projectile_duration
–

Determines the lifetime of the projectile.

var
projectile_step_delay
–

Sets the projectile step_delay.

var
projectile_type
–

If set, this ability will create a projectile rather than applying the effect directly.

var
ready_ability_1p_str
–

"You ready yourself to use an ability."

var
requires_turf
–

If set, this ability can only be used while standing on a turf (not in an atom's contents or null loc).

var
target_selector
– /decl/ability_targeting

A decl type that handles retrieving and validating targets.

var
ui_element_type
–

Type of button to use for the UI. Should be /obj/screen/ability/button or subtype.

var
use_sound
–

If set, will play a sound when used.

var
use_sound_volume
–

Volume for above.

ability /decl/ability

Vars

Var Details

var ability_cooldown_time –

var ability_icon –

var ability_icon_state –

var ability_use_channel –

var admin_blocked –

var associated_handler_type –

var cancel_ability_1p_str –

var cast_failed_disabled_str –

var cast_failed_incapacitated –

var cast_failed_no_admin_level –

var cast_failed_no_charges –

var cast_failed_no_turf –

var cast_failed_on_cooldown –

var cast_failed_purged_str –

var cast_failed_wrong_mob_type –

var cast_message_1p_str –

var cast_message_3p_str –

var charge_delay –

var check_incapacitated –

var copy_with_mind –

var desc –

var end_prep_on_cast –

var expected_mob_type – /mob

var fail_cast_1p_str –

var hidden_from_codex –

var is_melee_invocation –

var is_ranged_invocation –

var is_supernatural –

var item_end_on_cast –

var max_charge –

var name –

var overlay_icon –

var overlay_icon_state –

var overlay_lifespan –

var prep_cast –

var prepare_message_1p_str –

var prepare_message_3p_str –

var projectile_duration –

var projectile_step_delay –

var projectile_type –

var ready_ability_1p_str –

var requires_turf –

var target_selector – /decl/ability_targeting

var ui_element_type –

var use_sound –

var use_sound_volume –