/tg/ Station 13 - Modules - TypesVar Details - Proc Details

cult

Vars

activeWhether this spell is invoked / active.
active_overlay_fileThe file the overlay is made from.
active_overlay_held_nameThe overlay that is shown in hand invoked.
active_overlay_lhand_fileThe file that the left hand overlay takes from.
active_overlay_nameThe overlay that is shown when invoked.
active_overlay_rhand_fileThe file that the right hand overlay takes from.
base_descThe base description, so we can edit it.
chargesThe amount of charges of this spell.
examine_hintText displayed when examining the item while this spell is invoked.
invocationThe invocation said after a successful cast.
magic_sourceThe blood magic ability that created this spell
manually_handle_chargesIf FALSE, after_successful_spell() will be called automatically after a spell is used. If set to TRUE, you will need to handle saying the invocation and reducing the charges manually.

Procs

activateActivate the spell, registering signals to make it function.
after_successful_spellCalled after a spell is successfuly cast. Forces the user to say the invocation, Reduces the amount of charges, and updates the description if there are charges remaining.
deactivateDeactivate the spell, unregistering all the signals.
do_atom_spell_effectsCalled when (user) hits (hit) with (target).
do_hit_spell_effectsCalled when (user) hits (victim) with (target).
do_self_spell_effectsCalled when (user) hits themselves with (target).
on_droppedSignal proc for COMSIG_ITEM_DROPPED
on_equippedSignal proc for COMSIG_ITEM_EQUIPPED Un-invokes the spell when the item is equipped (picked up) by a non-cultist.
on_examineSignal proc for COMSIG_ATOM_EXAMINE.
on_item_update_overlaysSignal proc for COMSIG_ATOM_UPDATE_OVERLAYS, for the slab itself.
on_mob_update_overlaysSignal proc for COMSIG_ATOM_UPDATE_OVERLAYS, for the mob holding the slab.
try_spell_effectsSignal proc for COMSIG_ITEM_PRE_ATTACK.

Var Details

active

Whether this spell is invoked / active.

active_overlay_file

The file the overlay is made from.

active_overlay_held_name

The overlay that is shown in hand invoked.

active_overlay_lhand_file

The file that the left hand overlay takes from.

active_overlay_name

The overlay that is shown when invoked.

active_overlay_rhand_file

The file that the right hand overlay takes from.

base_desc

The base description, so we can edit it.

charges

The amount of charges of this spell.

examine_hint

Text displayed when examining the item while this spell is invoked.

invocation

The invocation said after a successful cast.

magic_source

The blood magic ability that created this spell

manually_handle_charges

If FALSE, after_successful_spell() will be called automatically after a spell is used. If set to TRUE, you will need to handle saying the invocation and reducing the charges manually.

Proc Details

activate

Activate the spell, registering signals to make it function.

after_successful_spell

Called after a spell is successfuly cast. Forces the user to say the invocation, Reduces the amount of charges, and updates the description if there are charges remaining.

deactivate

Deactivate the spell, unregistering all the signals.

do_atom_spell_effects

Called when (user) hits (hit) with (target).

Return TRUE to return COMPONENT_NO_AFTERATTACK.

do_hit_spell_effects

Called when (user) hits (victim) with (target).

Return TRUE to return COMPONENT_NO_AFTERATTACK.

do_self_spell_effects

Called when (user) hits themselves with (target).

Return TRUE to return COMPONENT_NO_AFTERATTACK.

on_dropped

Signal proc for COMSIG_ITEM_DROPPED

on_equipped

Signal proc for COMSIG_ITEM_EQUIPPED Un-invokes the spell when the item is equipped (picked up) by a non-cultist.

on_examine

Signal proc for COMSIG_ATOM_EXAMINE.

on_item_update_overlays

Signal proc for COMSIG_ATOM_UPDATE_OVERLAYS, for the slab itself.

on_mob_update_overlays

Signal proc for COMSIG_ATOM_UPDATE_OVERLAYS, for the mob holding the slab.

try_spell_effects

Signal proc for COMSIG_ITEM_PRE_ATTACK.

Calls do_self_spell_effects() if (user) hits themselves with (target). Calls do_hit_spell_effects() if (user) hits (a mob, hit) with (target). Calls do_atom_spell_effects() if (user) hits (a non-mob atom, hit) with (target).

If either return TRUE, and manually_handle_charges is FALSE, then we call after_successful_spell().