spell

Vars
action	Action with a button linked to this spell.
action_background_icon	Same as action icon, but used for image background overlay. Usefull when our action icon has no background at all.
action_background_icon_state	State of the icon found in file, passed in "action_background_icon" variable.
action_icon	Action icon file. Its a main image overlay, often without background.
action_icon_state	State of the icon found in file, passed in "action_icon" variable.
base_cooldown	Recharge time in deciseconds
centcom_cancast	Whether or not the spell should be allowed on admin Z-level.
clothes_req	Spell can only be cast with special wizard garb, equipped in appropriete slots.
cooldown_handler	Handles a given spells cooldowns. Tracks the time until its off cooldown.
cooldown_min	This defines what spell quickened four timeshas as a cooldown. Make sure to set this for every spell.
create_attack_logs	does this spell generate attack logs?
create_custom_logs	If this spell creates custom logs using the write_custom_logs() proc. Will ignore create_attack_logs
custom_handler	Which spell_handler is used in addition to the normal spells behaviour, can be null. Set this in create_new_handler if needed
gain_desc	This message will be shown to user upon receiving the spell.
ghost	If set to `TRUE` spell will skip stat check, defined in "stat_allowed" variable.
holy_area_cancast	Whether or not the spell functions in a holy place
human_req	Spell can only be cast by humans.
interaction_flags_click	What panel the proc holder needs to go on.
invocation	What is uttered when the wizard casts the spell.
invocation_emote_self	If invocation_type is "emote", caster will perform emote on cast, should be same style as in [mob/living/emote.dm].
invocation_type	Can be "none", "whisper", "shout" and "emote".
level_max	The max possible level_max is 4.
message	Whatever it says to the guy affected by it.
need_active_overlay	Whether this spell need a white frame around the button while active, usefull for click based targeting.
nonabstract_req	Spell can only be cast by mobs that are physical entities. Currently checks whether caster is brain or pAI.
overlay	Wheter special overlay effect should be played on user, after spell cast.
overlay_icon	Special overlay icon file.
overlay_icon_state	Special overlay icon state.
overlay_lifespan	Time before special effect will be deleted.
phase_allowed	If set to `TRUE`, spell can be cast while phased, eg. blood crawling, ethereal jaunting.
school	Not relevant at now, but may be important later if there are changes to how spells work. the ones I used for now will probably be changed... maybe spell presets? lacking flexibility but with some other benefit?
selection_activated_message	The message displayed when a click based spell gets activated
selection_deactivated_message	The message displayed when a click based spell gets deactivated
should_recharge_after_cast	Whether an ability should start cooldown after cast or not.
smoke_type	Determines if the spell has smoke, and if so what effect the smoke has. See spell defines.
sound	The sound the spell makes when it is cast.
sparks_amt	Amount of sparks if "sparks_spread" is set to `TRUE`.
sparks_spread	Whether spell should make sparks visual effect on targets location, after the main cast.
spell_handlers	List with the handler datums per spell type. Key = src.type, value = the handler datum created by create_new_handler()
spell_level	If a spell can be taken multiple times, this raises.
starts_charged	Does this spell start ready to go?
stat_allowed	Checks user stat on cast, could be "CONSCIOUS", "UNCONSCIOUS", "DEAD".
still_recharging_msg	Messace user get when clicks on rechargins spell button.
targeting	Which targeting system is used. Set this in create_new_targeting
targeting_datums	List with the targeting datums per spell type. Key = src.type, value = the targeting datum created by create_new_targeting()
Procs
adjust_var	Handles the adjustment of the var when the spell is used. Has some hardcoded types.
after_spell_init	This proc will trigger when all necessary initialization is done. Usefull for staff like changing spell name.
cast	The proc where the actual spell gets cast.
cast_check	Checks if the user can cast the spell
choose_targets	Will try to choose targets using the targeting variable and perform the spell if it can Do not override this! Override create_new_targeting instead
create_new_cooldown	Creates and returns the spells cooldown handler, defaults to the standard recharge handler. Override this if you wish to use a different method of cooldown
create_new_handler	Creates and returns the handler datum for this spell type. Override this if you want a custom spell handler. Should return a value of type /datum/spell_handler or NONE
create_new_targeting	Creates and returns the targeting datum for this spell type. Override this! Should return a value of type /datum/spell_targeting
on_cooldown_tick	This will apply on every tick of cooldown process.
on_purchase_upgrade	Lets the spell have a special effect applied to it when upgraded. By default, does nothing.
on_spell_gain	Called when a spell is added
perform	Handles all the code for performing a spell once the targets are known
revert_cast	Resets recharge or readds a charge.
should_remove_click_intercept	Called in `try_perform` before removing the click interceptor. Useful to override if you have a spell that requires more than 1 click
spend_spell_cost	Will spend the cost of using this spell once. Will update the action button's icon if there is any
try_perform	Will try and perform the spell using the given targets and user. Will spend one charge of the spell
valid_target	Allows for spell specific target validation. Will be used by the spell_targeting datums
write_custom_logs	Will write additional logs if create_custom_logs is TRUE and the caster has a ckey. Override this

Var Details

var
action
– /datum/action/spell_action

Action with a button linked to this spell.

var
action_background_icon
–

Same as action icon, but used for image background overlay. Usefull when our action icon has no background at all.

var
action_background_icon_state
–

State of the icon found in file, passed in "action_background_icon" variable.

var
action_icon
–

Action icon file. Its a main image overlay, often without background.

var
action_icon_state
–

State of the icon found in file, passed in "action_icon" variable.

var
base_cooldown
–

Recharge time in deciseconds

var
centcom_cancast
–

Whether or not the spell should be allowed on admin Z-level.

var
clothes_req
–

Spell can only be cast with special wizard garb, equipped in appropriete slots.

var
cooldown_handler
– /datum/spell_cooldown

Handles a given spells cooldowns. Tracks the time until its off cooldown.

var
cooldown_min
–

This defines what spell quickened four timeshas as a cooldown. Make sure to set this for every spell.

var
create_attack_logs
–

does this spell generate attack logs?

var
create_custom_logs
–

If this spell creates custom logs using the write_custom_logs() proc. Will ignore create_attack_logs

var
custom_handler
– /datum/spell_handler

Which spell_handler is used in addition to the normal spells behaviour, can be null. Set this in create_new_handler if needed

var
gain_desc
–

This message will be shown to user upon receiving the spell.

var
ghost
–

If set to TRUE spell will skip stat check, defined in "stat_allowed" variable.

var
holy_area_cancast
–

Whether or not the spell functions in a holy place

var
human_req
–

Spell can only be cast by humans.

↑
interaction_flags_click
–

What panel the proc holder needs to go on.

var
invocation
–

What is uttered when the wizard casts the spell.

var
invocation_emote_self
–

If invocation_type is "emote", caster will perform emote on cast, should be same style as in [mob/living/emote.dm].

var
invocation_type
–

Can be "none", "whisper", "shout" and "emote".

var
level_max
–

The max possible level_max is 4.

var
message
–

Whatever it says to the guy affected by it.

var
need_active_overlay
–

Whether this spell need a white frame around the button while active, usefull for click based targeting.

var
nonabstract_req
–

Spell can only be cast by mobs that are physical entities. Currently checks whether caster is brain or pAI.

var
overlay
–

Wheter special overlay effect should be played on user, after spell cast.

var
overlay_icon
–

Special overlay icon file.

var
overlay_icon_state
–

Special overlay icon state.

var
overlay_lifespan
–

Time before special effect will be deleted.

var
phase_allowed
–

If set to TRUE, spell can be cast while phased, eg. blood crawling, ethereal jaunting.

var
school
–

Not relevant at now, but may be important later if there are changes to how spells work. the ones I used for now will probably be changed... maybe spell presets? lacking flexibility but with some other benefit?

var
selection_activated_message
–

The message displayed when a click based spell gets activated

var
selection_deactivated_message
–

The message displayed when a click based spell gets deactivated

var
should_recharge_after_cast
–

Whether an ability should start cooldown after cast or not.

var
smoke_type
–

Determines if the spell has smoke, and if so what effect the smoke has. See spell defines.

var
sound
–

The sound the spell makes when it is cast.

var
sparks_amt
–

Amount of sparks if "sparks_spread" is set to TRUE.

var
sparks_spread
–

Whether spell should make sparks visual effect on targets location, after the main cast.

var
spell_handlers
– /static/list

List with the handler datums per spell type. Key = src.type, value = the handler datum created by create_new_handler()

var
spell_level
–

If a spell can be taken multiple times, this raises.

var
starts_charged
–

Does this spell start ready to go?

var
stat_allowed
–

Checks user stat on cast, could be "CONSCIOUS", "UNCONSCIOUS", "DEAD".

var
still_recharging_msg
–

Messace user get when clicks on rechargins spell button.

var
targeting
– /datum/spell_targeting

Which targeting system is used. Set this in create_new_targeting

var
targeting_datums
– /static/list

List with the targeting datums per spell type. Key = src.type, value = the targeting datum created by create_new_targeting()

Proc Details

proc
adjust_var
(/mob/living/target, type, amount)

Handles the adjustment of the var when the spell is used. Has some hardcoded types.

proc
after_spell_init
()

This proc will trigger when all necessary initialization is done. Usefull for staff like changing spell name.

proc
cast
(/list/targets, /mob/user)

The proc where the actual spell gets cast.

Arguments:

targets - The targets being targeted by the spell
user - The caster of the spell

proc
cast_check
(charge_check, start_recharge, /mob/user)

Checks if the user can cast the spell

Arguments: charge_check - If the proc should do the cooldown check start_recharge - If the proc should set the cooldown user - The caster of the spell

proc
choose_targets
(/mob/user)

Will try to choose targets using the targeting variable and perform the spell if it can Do not override this! Override create_new_targeting instead

Arguments:

user - The caster of the spell

proc
create_new_cooldown
()

Creates and returns the spells cooldown handler, defaults to the standard recharge handler. Override this if you wish to use a different method of cooldown

proc
create_new_handler
()

Creates and returns the handler datum for this spell type. Override this if you want a custom spell handler. Should return a value of type /datum/spell_handler or NONE

proc
create_new_targeting
()

Creates and returns the targeting datum for this spell type. Override this! Should return a value of type /datum/spell_targeting

proc
on_cooldown_tick
()

This will apply on every tick of cooldown process.

proc
on_purchase_upgrade
()

Lets the spell have a special effect applied to it when upgraded. By default, does nothing.

proc
on_spell_gain
(/mob/user)

Called when a spell is added

proc
perform
(/list/targets, recharge, /mob/user)

Handles all the code for performing a spell once the targets are known

Arguments:

targets - The list of targets the spell is being cast on. Will not be empty or null
recharge - Whether or not the spell should go recharge
user - The caster of the spell

proc
revert_cast
(/mob/user)

Resets recharge or readds a charge.

proc
should_remove_click_intercept
(/mob/user)

Called in try_perform before removing the click interceptor. Useful to override if you have a spell that requires more than 1 click

proc
spend_spell_cost
(/mob/user)

Will spend the cost of using this spell once. Will update the action button's icon if there is any

Arguments:

user - Who used this spell?

proc
try_perform
(/list/targets, /mob/user)

Will try and perform the spell using the given targets and user. Will spend one charge of the spell

Arguments:

targets - The targets the spell is being performed on
user - The caster of the spell

proc
valid_target
(target, user)

Allows for spell specific target validation. Will be used by the spell_targeting datums

Arguments:

target - Who is being considered
user - Who is the user of this spell

proc
write_custom_logs
(/list/targets, /mob/user)

Will write additional logs if create_custom_logs is TRUE and the caster has a ckey. Override this

Arguments:

targets - The targets being targeted by the spell
user - The user of the spell

spell /obj/effect/proc_holder/spell

Vars

Procs

Var Details

var action – /datum/action/spell_action

var action_background_icon –

var action_background_icon_state –

var action_icon –

var action_icon_state –

var base_cooldown –

var centcom_cancast –

var clothes_req –

var cooldown_handler – /datum/spell_cooldown

var cooldown_min –

var create_attack_logs –

var create_custom_logs –

var custom_handler – /datum/spell_handler

var gain_desc –

var ghost –

var holy_area_cancast –

var human_req –

↑interaction_flags_click –

var invocation –

var invocation_emote_self –

var invocation_type –

var level_max –

var message –

var need_active_overlay –

var nonabstract_req –

var overlay –

var overlay_icon –

var overlay_icon_state –

var overlay_lifespan –

var phase_allowed –

var school –

var selection_activated_message –

var selection_deactivated_message –

var should_recharge_after_cast –

var smoke_type –

var sound –

var sparks_amt –

var sparks_spread –

var spell_handlers – /static/list

var spell_level –

var starts_charged –

var stat_allowed –

var still_recharging_msg –

var targeting – /datum/spell_targeting

var targeting_datums – /static/list

Proc Details

proc adjust_var(/mob/living/target, type, amount)

proc after_spell_init()

proc cast(/list/targets, /mob/user)

proc cast_check(charge_check, start_recharge, /mob/user)

proc choose_targets(/mob/user)

proc create_new_cooldown()

proc create_new_handler()

proc create_new_targeting()

proc on_cooldown_tick()

proc on_purchase_upgrade()

proc on_spell_gain(/mob/user)

proc perform(/list/targets, recharge, /mob/user)

proc revert_cast(/mob/user)

proc should_remove_click_intercept(/mob/user)

proc spend_spell_cost(/mob/user)

proc try_perform(/list/targets, /mob/user)

proc valid_target(target, user)

proc write_custom_logs(/list/targets, /mob/user)

spell
/obj/effect/proc_holder/spell

var
action
– /datum/action/spell_action

var
action_background_icon
–

var
action_background_icon_state
–

var
action_icon
–

var
action_icon_state
–

var
base_cooldown
–

var
centcom_cancast
–

var
clothes_req
–

var
cooldown_handler
– /datum/spell_cooldown

var
cooldown_min
–

var
create_attack_logs
–

var
create_custom_logs
–

var
custom_handler
– /datum/spell_handler

var
gain_desc
–

var
ghost
–

var
holy_area_cancast
–

var
human_req
–

↑
interaction_flags_click
–

var
invocation
–

var
invocation_emote_self
–

var
invocation_type
–

var
level_max
–

var
message
–

var
need_active_overlay
–

var
nonabstract_req
–

var
overlay
–

var
overlay_icon
–

var
overlay_icon_state
–

var
overlay_lifespan
–

var
phase_allowed
–

var
school
–

var
selection_activated_message
–

var
selection_deactivated_message
–

var
should_recharge_after_cast
–

var
smoke_type
–

var
sound
–

var
sparks_amt
–

var
sparks_spread
–

var
spell_handlers
– /static/list

var
spell_level
–

var
starts_charged
–

var
stat_allowed
–

var
still_recharging_msg
–

var
targeting
– /datum/spell_targeting

var
targeting_datums
– /static/list

proc
adjust_var
(/mob/living/target, type, amount)

proc
after_spell_init
()

proc
cast
(/list/targets, /mob/user)

proc
cast_check
(charge_check, start_recharge, /mob/user)

proc
choose_targets
(/mob/user)

proc
create_new_cooldown
()

proc
create_new_handler
()

proc
create_new_targeting
()

proc
on_cooldown_tick
()

proc
on_purchase_upgrade
()

proc
on_spell_gain
(/mob/user)

proc
perform
(/list/targets, recharge, /mob/user)

proc
revert_cast
(/mob/user)

proc
should_remove_click_intercept
(/mob/user)

proc
spend_spell_cost
(/mob/user)

proc
try_perform
(/list/targets, /mob/user)

proc
valid_target
(target, user)

proc
write_custom_logs
(/list/targets, /mob/user)