bloodsucker_clan

Bloodsucker clans

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

Vars
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.
control_type	The clan's manipulation specialty.
description	Description of what the clan is, given when joining and through your antag UI.
frenzy_stun_immune	Whether they become entirely stun immune when entering 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.
rank_up_type	How the Bloodsucker ranks up, if they do.
Procs
get_clan	legacy code support
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_favorite_vassal	Called when we are successfully turn a Vassal into a Favorite Vassal args: bloodsuckerdatum - antagonist datum of the Bloodsucker who turned them into a Vassal. vassaldatum - the antagonist datum of the Vassal being offered up.
on_final_death	Called when a Bloodsucker enters Final Death args: source - the Bloodsucker exiting Torpor
on_offer_favorite	Called when we are trying to turn someone into a Favorite Vassal args: bloodsuckerdatum - the antagonist datum of the Bloodsucker performing this. vassaldatum - the antagonist datum of the Vassal 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 Vassal (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 ask - If they want to automatically spend the rest of their ranks
on_vassal_made	Called when a Bloodsucker successfully Vassalizes someone. args: bloodsuckerdatum - the antagonist datum of the Bloodsucker running this.

Var Details

var
blood_drink_type
–

How we will drink blood using Feed.

var
bloodsuckerdatum
– /datum/antagonist/bloodsucker

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).

var
clan_objective
– /datum/objective

The clan objective that is required to greentext.

var
control_type
–

The clan's manipulation specialty.

var
description
–

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

var
frenzy_stun_immune
–

Whether they become entirely stun immune when entering Frenzy.

var
join_description
–

Description shown when trying to join the clan.

var
join_icon
–

The icon of the radial icon to join this clan.

var
join_icon_state
–

Same as join_icon, but the state

var
joinable_clan
–

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

var
name
–

The name of the clan we're in.

var
rank_up_type
–

How the Bloodsucker ranks up, if they do.

Proc Details

proc
get_clan
()

legacy code support

proc
handle_clan_life
(/datum/antagonist/bloodsucker/source)

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

proc
on_exit_torpor
(/datum/antagonist/bloodsucker/source)

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

proc
on_favorite_vassal
(/datum/antagonist/bloodsucker/source, /datum/antagonist/vassal/vassaldatum)

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

proc
on_final_death
(/datum/antagonist/bloodsucker/source)

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

proc
on_offer_favorite
(/datum/antagonist/bloodsucker/source, /datum/antagonist/vassal/vassaldatum)

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

proc
on_spend_rank
(/datum/antagonist/bloodsucker/source, /mob/living/carbon/target, cost_rank, blood_cost, ask)

Called when a Bloodsucker successfully starts spending their Rank args: bloodsuckerdatum - the antagonist datum of the Bloodsucker running this. target - The Vassal (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 ask - If they want to automatically spend the rest of their ranks

proc
on_vassal_made
(/datum/antagonist/bloodsucker/source, /mob/living/user, /mob/living/target)

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

Caitiff /datum/bloodsucker_clan

Vars

Procs

Var Details

var blood_drink_type –

var bloodsuckerdatum – /datum/antagonist/bloodsucker

var clan_objective – /datum/objective

var control_type –

var description –

var frenzy_stun_immune –

var join_description –

var join_icon –

var join_icon_state –

var joinable_clan –

var name –

var rank_up_type –