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

bloodsucker_clan

Bloodsucker clans

Handles everything related to clans. the entire idea of datumizing this came to me in a dream.

Vars

blood_drink_typeHow we will drink blood using Feed.
bloodsuckerdatumThe bloodsucker datum that owns this clan. Use this over 'source', because while it's the same thing, this is more consistent (and used for deletion).
clan_objectiveThe clan objective that is required to greentext.
descriptionDescription of what the clan is, given when joining and through your antag UI.
frenzy_stamina_modHow much stamina armor we get in frenzy
join_descriptionDescription shown when trying to join the clan.
join_iconThe icon of the radial icon to join this clan.
join_icon_stateSame as join_icon, but the state
joinable_clanWhether the clan can be joined by players. FALSE for flavortext-only clans.
nameThe name of the clan we're in.

Procs

favorite_ghoul_gainCalled when we are successfully turn a Ghoul into a Favorite Ghoul args: bloodsuckerdatum - antagonist datum of the Bloodsucker who turned them into a Ghoul. ghouldatum - the antagonist datum of the Ghoul being offered up.
handle_clan_lifeCalled during Bloodsucker's LifeTick args: bloodsuckerdatum - the antagonist datum of the Bloodsucker running this.
on_exit_torporCalled when a Bloodsucker exits Torpor args: source - the Bloodsucker exiting Torpor
on_final_deathCalled when a Bloodsucker enters Final Death args: source - the Bloodsucker exiting Torpor
on_ghoul_madeCalled when a Bloodsucker successfully Ghoulizes someone. args: bloodsuckerdatum - the antagonist datum of the Bloodsucker running this.
on_interact_with_ghoulCalled when we are trying to turn someone into a Favorite Ghoul args: bloodsuckerdatum - the antagonist datum of the Bloodsucker performing this. ghouldatum - the antagonist datum of the Ghoul being offered up.
on_spend_rankCalled when a Bloodsucker successfully starts spending their Rank args: bloodsuckerdatum - the antagonist datum of the Bloodsucker running this. target - The Ghoul (if any) we are upgrading. cost_rank - TRUE/FALSE on whether this will cost us a rank when we go through with it. blood_cost - A number saying how much it costs to rank up.

Var Details

blood_drink_type

How we will drink blood using Feed.

bloodsuckerdatum

The bloodsucker datum that owns this clan. Use this over 'source', because while it's the same thing, this is more consistent (and used for deletion).

clan_objective

The clan objective that is required to greentext.

description

Description of what the clan is, given when joining and through your antag UI.

frenzy_stamina_mod

How much stamina armor we get in frenzy

join_description

Description shown when trying to join the clan.

join_icon

The icon of the radial icon to join this clan.

join_icon_state

Same as join_icon, but the state

joinable_clan

Whether the clan can be joined by players. FALSE for flavortext-only clans.

name

The name of the clan we're in.

Proc Details

favorite_ghoul_gain

Called when we are successfully turn a Ghoul into a Favorite Ghoul args: bloodsuckerdatum - antagonist datum of the Bloodsucker who turned them into a Ghoul. ghouldatum - the antagonist datum of the Ghoul being offered up.

handle_clan_life

Called during Bloodsucker's LifeTick args: bloodsuckerdatum - the antagonist datum of the Bloodsucker running this.

on_exit_torpor

Called when a Bloodsucker exits Torpor args: source - the Bloodsucker exiting Torpor

on_final_death

Called when a Bloodsucker enters Final Death args: source - the Bloodsucker exiting Torpor

on_ghoul_made

Called when a Bloodsucker successfully Ghoulizes someone. args: bloodsuckerdatum - the antagonist datum of the Bloodsucker running this.

on_interact_with_ghoul

Called when we are trying to turn someone into a Favorite Ghoul args: bloodsuckerdatum - the antagonist datum of the Bloodsucker performing this. ghouldatum - the antagonist datum of the Ghoul being offered up.

on_spend_rank

Called when a Bloodsucker successfully starts spending their Rank args: bloodsuckerdatum - the antagonist datum of the Bloodsucker running this. target - The Ghoul (if any) we are upgrading. cost_rank - TRUE/FALSE on whether this will cost us a rank when we go through with it. blood_cost - A number saying how much it costs to rank up.