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

revenant

Revenants: "Ghosts" that are invisible and move like ghosts, cannot take damage while invisible Can hear deadchat, but are NOT normal ghosts and do NOT have x-ray vision Admin-spawn or random event

Vars

abilitiesList of action ability datums to grant on Initialize. Keep in mind that anything with the /aoe/revenant subtype starts locked by default.
dormantAre we currently dormant (ectoplasm'd)?
drained_mobsLazylist of drained mobs to ensure that we don't steal a soul from someone twice
drainingAre we currently draining someone?
essenceThe resource, and health, of revenants.
essence_accumulatedHow much essence the revenant has stolen
essence_excessHow much stolen essence is available for unlocks
essence_regen_amountHow much essence regenerates per second
essence_regeneratingIf the revenant regenerates essence or not
generated_objectives_and_spellsHave we already given this revenant abilities?
icon_drainThe icon we use while draining someone.
icon_idleThe icon we use while just floating around.
icon_revealThe icon we use while in a revealed state.
icon_stunThe icon we use when stunned (temporarily frozen)
max_essenceThe regeneration cap of essence (go figure); regenerates every Life() tick up to this amount.
perfectsoulsHow many perfect, regen-cap increasing souls the revenant has. //TODO, add objective for getting a perfect soul(s?)
unreveal_timeHow long the revenant is revealed for, is about 2 seconds times this var.

Procs

attempt_harvestContainer proc for harvest(), handles the pre-checks as well as potential early-exits for any reason. Will return FALSE if we can't execute harvest(), or will otherwise the result of harvest(): a boolean value.
create_login_stringGenerates the information the player needs to know how to play their role, and returns it as a list.
harvest_soulHarvest; activated by clicking a target, will try to drain their essence. Handles all messages and handling of the target. Returns FALSE if we exit out of the harvest, TRUE if it is fully done.
incorporeal_move_checkIncorporeal move check: blocked by holy-watered tiles and salt piles.
move_to_ectoplasmForces the mob, once dormant, to move inside ectoplasm until it can regenerate.
on_lifeSignal Handler Injection to handle Life() stuff for revenants

Var Details

abilities

List of action ability datums to grant on Initialize. Keep in mind that anything with the /aoe/revenant subtype starts locked by default.

dormant

Are we currently dormant (ectoplasm'd)?

drained_mobs

Lazylist of drained mobs to ensure that we don't steal a soul from someone twice

draining

Are we currently draining someone?

essence

The resource, and health, of revenants.

essence_accumulated

How much essence the revenant has stolen

essence_excess

How much stolen essence is available for unlocks

essence_regen_amount

How much essence regenerates per second

essence_regenerating

If the revenant regenerates essence or not

generated_objectives_and_spells

Have we already given this revenant abilities?

icon_drain

The icon we use while draining someone.

icon_idle

The icon we use while just floating around.

icon_reveal

The icon we use while in a revealed state.

icon_stun

The icon we use when stunned (temporarily frozen)

max_essence

The regeneration cap of essence (go figure); regenerates every Life() tick up to this amount.

perfectsouls

How many perfect, regen-cap increasing souls the revenant has. //TODO, add objective for getting a perfect soul(s?)

unreveal_time

How long the revenant is revealed for, is about 2 seconds times this var.

Proc Details

attempt_harvest

Container proc for harvest(), handles the pre-checks as well as potential early-exits for any reason. Will return FALSE if we can't execute harvest(), or will otherwise the result of harvest(): a boolean value.

create_login_string

Generates the information the player needs to know how to play their role, and returns it as a list.

harvest_soul

Harvest; activated by clicking a target, will try to drain their essence. Handles all messages and handling of the target. Returns FALSE if we exit out of the harvest, TRUE if it is fully done.

incorporeal_move_check

Incorporeal move check: blocked by holy-watered tiles and salt piles.

move_to_ectoplasm

Forces the mob, once dormant, to move inside ectoplasm until it can regenerate.

on_life

Signal Handler Injection to handle Life() stuff for revenants