Paradise Station 13 - Modules - TypesVar Details - Proc Details

antagonist

Vars

antag_datum_blacklistList of other antag datum types that this type can't coexist with.
antag_hud_nameHolds the name of the hud's icon in the .dmi files, i.e "hudtraitor", "hudvampire", etc.
antag_hud_typeHolds the type of antagonist hud this datum will get, i.e. ANTAG_HUD_TRAITOR, ANTAG_HUD_VAMPIRE, etc.
antag_memoryAntagonist datum specific information that appears in the player's notes. Information stored here will be removed when the datum is removed from the player.
assigned_targetsA list of strings which contain targets of the antagonist's objectives. Used to prevent duplicate objectives.
clown_gain_textIf the owner is a clown, this text will be displayed to them when they gain this datum.
clown_removal_textIf the owner is a clown, this text will be displayed to them when they lose this datum.
delete_on_mind_deletionShould this datum be deleted when the owner's mind is deleted.
give_objectivesShould we automatically give this antagonist objectives upon them gaining the datum?
job_rankUsed to determine if the player jobbanned from this role. Things like SPECIAL_ROLE_TRAITOR should go here to determine the role.
nameThe name of the antagonist.
objectivesList of objectives connected to this datum.
ownerMind that owns this datum.
replace_bannedShould we replace the role-banned player with a ghost?
roundend_categorySection of roundend report, datums with same category will be displayed together, also default header for the section.
show_in_roundendSet to false to hide the antagonists from roundend report.
silentShould the owner mob get a greeting text? Determines whether or not the greet() proc is called.
special_roleThe special role that will be applied to the owner's special_role var. i.e. SPECIAL_ROLE_TRAITOR, SPECIAL_ROLE_VAMPIRE.
wiki_page_nameThe url page name for this antagonist, appended to the end of the wiki url in the form of: [GLOB.configuration.url.wiki_url]/index.php/[wiki_page_name]

Procs

add_antag_hudAdds this datum's antag hud to antag_mob.
add_objectiveCreate and add an objective of the given type.
add_owner_to_gamemodeAdds the owner to their respective gamemode's list. For example SSticker.mode.traitors |= owner.
announce_objectivesAnnounces all objectives of this datum, and only this datum.
apply_innate_effectsThis handles the application of antag huds/special abilities.
can_be_ownedLoops through the owner's antag_datums list and determines if this one is blacklisted by any others.
create_teamCreates a new antagonist team.
farewellDisplays a message to the antag mob while the datum is being deleted, i.e. "Your powers are gone and you're no longer a vampire!"
finalize_antagGive the antag any final information or items.
get_teamReturns the team the antagonist belongs to, if any.
give_objectivesGive the antagonist their objectives. Base proc, override as needed.
greetDisplays a message and their objectives to the antag mob after the datum is added to them, i.e. "Greetings you are a traitor! etc.
handle_clown_mutationHandles adding and removing the clumsy mutation from clown antags.
is_bannedChecks if the person trying to recieve this datum is role banned from it.
on_body_transferRemoves antagonist datum effects from the old body and applies it to the new one.
on_gainProc called when the datum is given to a mind.
remove_antag_hudRemoves this datum's antag hud from antag_mob.
remove_innate_effectsThis handles the removal of antag huds/special abilities.
remove_owner_from_gamemodeRemoves the owner from their respective gamemode's list. For example SSticker.mode.traitors -= owner.
replace_banned_playerAttempts to replace the role banned antag with a ghost player.
restore_last_hud_and_roleRe-sets the antag hud and special_role of the owner to that of the previous antag datum they had before this one was added.

Var Details

antag_datum_blacklist

List of other antag datum types that this type can't coexist with.

antag_hud_name

Holds the name of the hud's icon in the .dmi files, i.e "hudtraitor", "hudvampire", etc.

antag_hud_type

Holds the type of antagonist hud this datum will get, i.e. ANTAG_HUD_TRAITOR, ANTAG_HUD_VAMPIRE, etc.

antag_memory

Antagonist datum specific information that appears in the player's notes. Information stored here will be removed when the datum is removed from the player.

assigned_targets

A list of strings which contain targets of the antagonist's objectives. Used to prevent duplicate objectives.

clown_gain_text

If the owner is a clown, this text will be displayed to them when they gain this datum.

clown_removal_text

If the owner is a clown, this text will be displayed to them when they lose this datum.

delete_on_mind_deletion

Should this datum be deleted when the owner's mind is deleted.

give_objectives

Should we automatically give this antagonist objectives upon them gaining the datum?

job_rank

Used to determine if the player jobbanned from this role. Things like SPECIAL_ROLE_TRAITOR should go here to determine the role.

name

The name of the antagonist.

objectives

List of objectives connected to this datum.

owner

Mind that owns this datum.

replace_banned

Should we replace the role-banned player with a ghost?

roundend_category

Section of roundend report, datums with same category will be displayed together, also default header for the section.

show_in_roundend

Set to false to hide the antagonists from roundend report.

silent

Should the owner mob get a greeting text? Determines whether or not the greet() proc is called.

special_role

The special role that will be applied to the owner's special_role var. i.e. SPECIAL_ROLE_TRAITOR, SPECIAL_ROLE_VAMPIRE.

wiki_page_name

The url page name for this antagonist, appended to the end of the wiki url in the form of: [GLOB.configuration.url.wiki_url]/index.php/[wiki_page_name]

Proc Details

add_antag_hud

Adds this datum's antag hud to antag_mob.

Arguments:

add_objective

Create and add an objective of the given type.

If the given objective type needs a target, it will try to find a target which isn't already the target of different objective for this antag. If one cannot be found, it tries one more time. If one still cannot be found, it will be added as a "Free Objective" without a target.

Arguments:

add_owner_to_gamemode

Adds the owner to their respective gamemode's list. For example SSticker.mode.traitors |= owner.

announce_objectives

Announces all objectives of this datum, and only this datum.

apply_innate_effects

This handles the application of antag huds/special abilities.

Gives the antag mob their assigned hud. If they're a clown, removes their clumsy mutataion.

Arguments:

can_be_owned

Loops through the owner's antag_datums list and determines if this one is blacklisted by any others.

If it's in one of their blacklists, return FALSE. It cannot coexist with the datum we're trying to add here.

create_team

Creates a new antagonist team.

farewell

Displays a message to the antag mob while the datum is being deleted, i.e. "Your powers are gone and you're no longer a vampire!"

Called in on_removal() if silent is set to FALSE.

finalize_antag

Give the antag any final information or items.

get_team

Returns the team the antagonist belongs to, if any.

give_objectives

Give the antagonist their objectives. Base proc, override as needed.

greet

Displays a message and their objectives to the antag mob after the datum is added to them, i.e. "Greetings you are a traitor! etc.

Called in on_gain() if silent it set to FALSE.

handle_clown_mutation

Handles adding and removing the clumsy mutation from clown antags.

Arguments:

is_banned

Checks if the person trying to recieve this datum is role banned from it.

on_body_transfer

Removes antagonist datum effects from the old body and applies it to the new one.

Called in the/datum/mind/proc/transfer_to().

Arguments:

on_gain

Proc called when the datum is given to a mind.

remove_antag_hud

Removes this datum's antag hud from antag_mob.

Arguments:

remove_innate_effects

This handles the removal of antag huds/special abilities.

Removes the antag's assigned hud. If they're a clown, gives them back their clumsy mutataion.

Arguments:

remove_owner_from_gamemode

Removes the owner from their respective gamemode's list. For example SSticker.mode.traitors -= owner.

replace_banned_player

Attempts to replace the role banned antag with a ghost player.

restore_last_hud_and_role

Re-sets the antag hud and special_role of the owner to that of the previous antag datum they had before this one was added.

For example, if the owner has a traitor datum and a vampire datum, both at index 1 and 2 respectively, After the vampire datum gets removed, it sets the owner's antag hud/role to whatever is set for traitor datum.