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

bloodsucker

Vars

all_bloodsucker_powersStatic typecache of all bloodsucker powers.
blood_displayBlood display HUD
blood_level_gainUsed for Bloodsuckers gaining levels from drinking blood
bloodsucker_blood_volumeHow much blood we have, starting off at default blood levels. Do not adjust this directly, use adjustBloodVolume(), and use getBloodVolume() to get the current value.
bloodsucker_levelHow many ranks we have, don't modify this directly, use AdjustRank() and use GetRank() to get the current value.
bloodsucker_level_unspentUnspent ranks, don't modify this directly, use AdjustUnspentRank() and use GetUnspentRank() to get the current value.
bloodsucker_nameUsed for assigning your name
bloodsucker_reputationUsed for assigning your reputation
bloodsucker_spam_healingTimer between alerts for Healing messages
bloodsucker_spam_sol_burnTimer between alerts for Burn messages
bloodsucker_spam_torporTimer between exiting torpor
bloodsucker_titleUsed for assigning your title
bloodsucker_traitsDefault Bloodsucker traits
broke_masqueradeHave we been broken the Masquerade?
frenziedIf we are currently in a Frenzy
ghoul_banned_antagsAntagonists that cannot be Ghouled no matter what
ghoulsGhouls under my control. Periodically remove the dead ones.
humanity_lostAmount of Humanity lost, don't modify this directly, use AddHumanityLost(), and use GetHumanityLost() to get the current value.
masquerade_infractionsHow many Masquerade Infractions do we have?
max_blood_volumeHow much blood we can have without it deckaying quickly, increases per level.
powersALL Powers currently owned
sol_levelsHow many levels you can get from Sol
special_ghoulsSpecial ghouls I own, to not have double of the same type.
vamprank_displayVampire level display HUD
ventrue_siredsired by a ventrue

Procs

AmValidAntagChecks if the target has antag datums and, if so, are they allowed to be Ghouled, or not, or banned. Args: target - The person we check for antag datums.
BuyPowerCalled when a Bloodsucker buys a power: (power)
DisableAllPowersDisables all powers, accounting for torpor
FinalDeathGibs the Bloodsucker, roundremoving them.
GetBloodVolume
HandleDeathFINAL DEATH
HandleHealing
LifeTickRuns from COMSIG_LIVING_LIFE, handles Bloodsucker constant proccesses.
RemovePowerCalled when a Bloodsucker loses a power: (power)
SelectFirstNameReturns a First name for the Bloodsucker.
SelectReputationReturns a Reputation for the Bloodsucker.
SelectTitleReturns a Title for the Bloodsucker.
antag_listing_nameName shown on antag list
antag_listing_statusWhatever interesting things happened to the antag admins should know about Include additional information about antag in this part
apply_innate_effectsApply innate effects is everything given to the mob When a body is tranferred, this is called on the new mob while on_gain is called ONCE per ANTAG, this is called ONCE per BODY.
assign_clan_and_baneGives Bloodsuckers the ability to choose a Clan. If they are already in a Clan, or is in a Frenzy, they will not be able to do so. The arg is optional and should really only be an Admin setting a Clan for a player. If set however, it will give them the control of their Clan instead of the Bloodsucker. This is selected through a radial menu over the player's body, even when an Admin is setting it. Args: person_selecting - Mob override for stuff like Admins selecting someone's clan.
break_masqueradeWhen a Bloodsucker breaks the Masquerade, they get their HUD icon changed, and Malkavian Bloodsuckers get alerted.
can_make_ghoul
check_begin_torpor
clear_powers_and_stats##clear_power_and_stats()
fix_masqueradeThis is admin-only of reverting a broken masquerade, sadly it doesn't remove the Malkavian objectives yet.
free_all_ghoulsCalled when a Bloodsucker reaches Final Death Releases all Ghouls and gives them the ex_ghoul datum.
handle_feedingmult: SILENT feed is 1/3 the amount
is_headchecks if we're a brainmob inside a brain & the brain is inside a head
is_valid_coffinis it something that is close enough to a coffin to let us heal/level up in it?
make_ghoulFirst will check if the target can be turned into a Ghoul, if so then it will turn them into one, log it, sync their minds, then updates the Rank Args: conversion_target - The person converted.
on_gainCalled when you get the antag datum, called only ONCE per antagonist.
on_removalCalled by the remove_antag_datum() and remove_all_antag_datums() mind procs for the antag datum to handle its own removal and deletion.
on_sol_endCalled when Sol first ends.
on_species_gainOverride some properties of incompatible species
remove_innate_effectsRemove innate effects is everything given to the mob When a body is transferred, this is called on the old mob. while on_removal is called ONCE per ANTAG, this is called ONCE per BODY.
return_vamp_examineReturns a Vampire's examine strings. Args: viewer - The person examining.
sol_near_startCalled when Sol is near starting.
sol_rank_up
talking_headTurns the bloodsucker into a wacky talking head.
update_bloodMakes your blood_volume look like your bloodsucker blood, unless you're Masquerading.
update_blood_hudUpdated every time blood is changed by either

Var Details

all_bloodsucker_powers

Static typecache of all bloodsucker powers.

blood_display

Blood display HUD

blood_level_gain

Used for Bloodsuckers gaining levels from drinking blood

bloodsucker_blood_volume

How much blood we have, starting off at default blood levels. Do not adjust this directly, use adjustBloodVolume(), and use getBloodVolume() to get the current value.

bloodsucker_level

How many ranks we have, don't modify this directly, use AdjustRank() and use GetRank() to get the current value.

bloodsucker_level_unspent

Unspent ranks, don't modify this directly, use AdjustUnspentRank() and use GetUnspentRank() to get the current value.

bloodsucker_name

Used for assigning your name

bloodsucker_reputation

Used for assigning your reputation

bloodsucker_spam_healing

Timer between alerts for Healing messages

bloodsucker_spam_sol_burn

Timer between alerts for Burn messages

bloodsucker_spam_torpor

Timer between exiting torpor

bloodsucker_title

Used for assigning your title

bloodsucker_traits

Default Bloodsucker traits

broke_masquerade

Have we been broken the Masquerade?

frenzied

If we are currently in a Frenzy

ghoul_banned_antags

Antagonists that cannot be Ghouled no matter what

ghouls

Ghouls under my control. Periodically remove the dead ones.

humanity_lost

Amount of Humanity lost, don't modify this directly, use AddHumanityLost(), and use GetHumanityLost() to get the current value.

masquerade_infractions

How many Masquerade Infractions do we have?

max_blood_volume

How much blood we can have without it deckaying quickly, increases per level.

powers

ALL Powers currently owned

sol_levels

How many levels you can get from Sol

special_ghouls

Special ghouls I own, to not have double of the same type.

vamprank_display

Vampire level display HUD

ventrue_sired

sired by a ventrue

Proc Details

AmValidAntag

Checks if the target has antag datums and, if so, are they allowed to be Ghouled, or not, or banned. Args: target - The person we check for antag datums.

BuyPower

Called when a Bloodsucker buys a power: (power)

DisableAllPowers

Disables all powers, accounting for torpor

FinalDeath

Gibs the Bloodsucker, roundremoving them.

GetBloodVolume

BLOOD STUFF

HandleDeath

FINAL DEATH

HandleHealing

HEALING

Constantly runs on Bloodsucker's LifeTick, and is increased by being in Torpor/Coffins

LifeTick

Runs from COMSIG_LIVING_LIFE, handles Bloodsucker constant proccesses.

RemovePower

Called when a Bloodsucker loses a power: (power)

SelectFirstName

Returns a First name for the Bloodsucker.

SelectReputation

Returns a Reputation for the Bloodsucker.

SelectTitle

Returns a Title for the Bloodsucker.

antag_listing_name

Name shown on antag list

antag_listing_status

Whatever interesting things happened to the antag admins should know about Include additional information about antag in this part

apply_innate_effects

Apply innate effects is everything given to the mob When a body is tranferred, this is called on the new mob while on_gain is called ONCE per ANTAG, this is called ONCE per BODY.

assign_clan_and_bane

Gives Bloodsuckers the ability to choose a Clan. If they are already in a Clan, or is in a Frenzy, they will not be able to do so. The arg is optional and should really only be an Admin setting a Clan for a player. If set however, it will give them the control of their Clan instead of the Bloodsucker. This is selected through a radial menu over the player's body, even when an Admin is setting it. Args: person_selecting - Mob override for stuff like Admins selecting someone's clan.

break_masquerade

When a Bloodsucker breaks the Masquerade, they get their HUD icon changed, and Malkavian Bloodsuckers get alerted.

can_make_ghoul

can_make_ghoul

Checks if the person is allowed to turn into the Bloodsucker's Ghoul, ensuring they are a player and valid. If they are a Ghoul themselves, will check if their master has broken the Masquerade, to steal them. Args: conversion_target - Person being ghouled

check_begin_torpor

Torpor

Torpor is what deals with the Bloodsucker falling asleep, their healing, the effects, ect. This is basically what Sol is meant to do to them, but they can also trigger it manually if they wish to heal, as Burn is only healed through Torpor. You cannot manually exit Torpor, it is instead entered/exited by:

Torpor is triggered by:

clear_powers_and_stats

##clear_power_and_stats()

Removes all Bloodsucker related Powers/Stats changes, setting them back to pre-Bloodsucker Order of steps and reason why: Remove clan - Clans like Nosferatu give Powers on removal, we have to make sure this is given before removing Powers. Powers - Remove all Powers, so things like Masquerade are off. Species traits, Traits, Language - Misc stuff, has no priority. Organs - At the bottom to ensure everything that changes them has reverted themselves already. Update Sight - Done after Eyes are regenerated.

fix_masquerade

This is admin-only of reverting a broken masquerade, sadly it doesn't remove the Malkavian objectives yet.

free_all_ghouls

Called when a Bloodsucker reaches Final Death Releases all Ghouls and gives them the ex_ghoul datum.

handle_feeding

mult: SILENT feed is 1/3 the amount

is_head

checks if we're a brainmob inside a brain & the brain is inside a head

is_valid_coffin

is it something that is close enough to a coffin to let us heal/level up in it?

make_ghoul

First will check if the target can be turned into a Ghoul, if so then it will turn them into one, log it, sync their minds, then updates the Rank Args: conversion_target - The person converted.

on_gain

Called when you get the antag datum, called only ONCE per antagonist.

on_removal

Called by the remove_antag_datum() and remove_all_antag_datums() mind procs for the antag datum to handle its own removal and deletion.

on_sol_end

Called when Sol first ends.

on_species_gain

Override some properties of incompatible species

remove_innate_effects

Remove innate effects is everything given to the mob When a body is transferred, this is called on the old mob. while on_removal is called ONCE per ANTAG, this is called ONCE per BODY.

return_vamp_examine

Returns a Vampire's examine strings. Args: viewer - The person examining.

sol_near_start

Called when Sol is near starting.

sol_rank_up

Assigning Sol

Sol is the sunlight, during this period, all Bloodsuckers must be in their coffin, else they burn. Ranks the Bloodsucker up, called by Sol.

talking_head

Turns the bloodsucker into a wacky talking head.

update_blood

Makes your blood_volume look like your bloodsucker blood, unless you're Masquerading.

update_blood_hud

Updated every time blood is changed by either