Goonstation 13 - Modules - TypesVar Details - Proc Details

/datum/antagonist

Vars

antagonist_iconThe icon state that should be used for the antagonist overlay for this antagonist type. Icons may be found in icons/mob/antag_overlays.dmi.
antagonist_panel_tab_typeThe type of tab that this antagonist type should be displayed under on the admin antagonist panel.
assigned_byHow this antagonist was created. Displayed at the end of the round.
display_nameHuman-readable name for displaying this antagonist for admin menus, round-end summary, etc.
factionThe faction given to the player by this antagonist role for AI targeting purposes.
has_info_popupIf TRUE, this antagonist has an associated browser window (ideally with the same ID as itself) that will be displayed in do_popup() by default.
idInternal ID used to track this type of antagonist. This should always be unique between types and subtypes.
keep_equipment_on_deathIf TRUE, the equipment is not removed on death. Only works if remove_on_death is TRUE.
mutually_exclusiveIf TRUE, no other antagonists can be naturally gained if this one is active. Admins can still manually add new ones.
objectivesThe objectives assigned to the player by this specific antagonist role.
ownerThe mind of the player that that this antagonist is assigned to.
pseudoPseudo antagonists are not "real" antagonists, as determined by the round. They have the abilities, but do not have objectives and ideally should not considered antagonists for the purposes of griefing rules, etc.
remove_on_cloneIf TRUE, the antag status will be removed when the person is cloned (zombies etc.)
remove_on_deathIf TRUE, the antag status will be removed when the person dies (changeling critters etc.)
silentWhether the addition or removal of this antagonist role is announced to the player.
success_medalThe medal unlocked at the end of the round by succeeding as this antagonist.
succinct_end_of_round_antagonist_entryIf TRUE, this antagonist will not have their own entry in the end of round credits antagonists tab, rather they will be displayed in a list below the primary entries.
uses_pref_nameDoes the owner of this antagonist role use their normal name set in character preferences as opposed to being assigned a random or chosen name?
vrVR antagonists, similar to pseudo antagonists, are not real antagonists. They lack some exploitative abilities, are not relocated, and are removed on death.

Procs

alt_equipmentFallback in case the antag must have some level of initalization even with no equipment.
announceDisplay a greeting to the player to inform that they're an antagonist. This can be anything, but by default it's just the name.
announce_removalDisplay something when this antagonist is removed.
assign_objectivesGenerate objectives for the antagonist and assign them to the mind.
borgedCalled when the player is made into a cyborg or AI
check_successReturns whether or not this antagonist is considered to have succeeded. By default, this checks all antagonist-specific objectives.
do_popupShow a popup window for this antagonist. Defaults to using the same ID as the antagonist itself.
get_statisticsReturns a list of data to be passed to the end of round credits pertaining to this antagonist, such as items purchased, units of blood drank, and so forth. Should return a list of "name"-"value" associative lists. If an item list utilising item icons is to be used, the "type" index should be set to "itemList", and "value" should itself be a list of "iconBase64"-"name" associative lists.
give_equipmentEquip the antagonist with abilities, custom equipment, and so on.
handle_cryoHandle this antagonist entering cryogenic storage, possibly temporarily.
handle_perma_cryoHandle this antagonist entering cryogenic storage permanently
handle_round_endHandle special behavior at the end of the round, such as awarding medals.
is_compatible_withReturns TRUE if this antagonist can be assigned to the given mind, and FALSE otherwise. This is intended to be special logic, overriden by subtypes; mutual exclusivity and other selection logic is not performed here.
relocateMove the antagonist to their spawn location, if applicable.
remove_equipmentThe inverse of give_equipment(). Remove things like changeling abilities, etc. Non-innate things like items should probably be kept.
remove_objectivesRemove objectives from the antagonist and the mind.
remove_selfCalls removal procs to soft-remove this antagonist from its owner. Actual movement or deletion of the datum still needs to happen elsewhere.
setup_antagonistBase proc to set up the antagonist. Depending on arguments, it can spawn equipment, assign objectives, move the player (if applicable), and announce itself.
unborgedCalled when the player is no longer a cybrorg or AI

Var Details

antagonist_icon

The icon state that should be used for the antagonist overlay for this antagonist type. Icons may be found in icons/mob/antag_overlays.dmi.

antagonist_panel_tab_type

The type of tab that this antagonist type should be displayed under on the admin antagonist panel.

assigned_by

How this antagonist was created. Displayed at the end of the round.

display_name

Human-readable name for displaying this antagonist for admin menus, round-end summary, etc.

faction

The faction given to the player by this antagonist role for AI targeting purposes.

has_info_popup

If TRUE, this antagonist has an associated browser window (ideally with the same ID as itself) that will be displayed in do_popup() by default.

id

Internal ID used to track this type of antagonist. This should always be unique between types and subtypes.

keep_equipment_on_death

If TRUE, the equipment is not removed on death. Only works if remove_on_death is TRUE.

mutually_exclusive

If TRUE, no other antagonists can be naturally gained if this one is active. Admins can still manually add new ones.

objectives

The objectives assigned to the player by this specific antagonist role.

owner

The mind of the player that that this antagonist is assigned to.

pseudo

Pseudo antagonists are not "real" antagonists, as determined by the round. They have the abilities, but do not have objectives and ideally should not considered antagonists for the purposes of griefing rules, etc.

remove_on_clone

If TRUE, the antag status will be removed when the person is cloned (zombies etc.)

remove_on_death

If TRUE, the antag status will be removed when the person dies (changeling critters etc.)

silent

Whether the addition or removal of this antagonist role is announced to the player.

success_medal

The medal unlocked at the end of the round by succeeding as this antagonist.

succinct_end_of_round_antagonist_entry

If TRUE, this antagonist will not have their own entry in the end of round credits antagonists tab, rather they will be displayed in a list below the primary entries.

uses_pref_name

Does the owner of this antagonist role use their normal name set in character preferences as opposed to being assigned a random or chosen name?

vr

VR antagonists, similar to pseudo antagonists, are not real antagonists. They lack some exploitative abilities, are not relocated, and are removed on death.

Proc Details

alt_equipment

Fallback in case the antag must have some level of initalization even with no equipment.

announce

Display a greeting to the player to inform that they're an antagonist. This can be anything, but by default it's just the name.

announce_removal

Display something when this antagonist is removed.

assign_objectives

Generate objectives for the antagonist and assign them to the mind.

borged

Called when the player is made into a cyborg or AI

check_success

Returns whether or not this antagonist is considered to have succeeded. By default, this checks all antagonist-specific objectives.

do_popup

Show a popup window for this antagonist. Defaults to using the same ID as the antagonist itself.

get_statistics

Returns a list of data to be passed to the end of round credits pertaining to this antagonist, such as items purchased, units of blood drank, and so forth. Should return a list of "name"-"value" associative lists. If an item list utilising item icons is to be used, the "type" index should be set to "itemList", and "value" should itself be a list of "iconBase64"-"name" associative lists.

give_equipment

Equip the antagonist with abilities, custom equipment, and so on.

handle_cryo

Handle this antagonist entering cryogenic storage, possibly temporarily.

handle_perma_cryo

Handle this antagonist entering cryogenic storage permanently

handle_round_end

Handle special behavior at the end of the round, such as awarding medals.

is_compatible_with

Returns TRUE if this antagonist can be assigned to the given mind, and FALSE otherwise. This is intended to be special logic, overriden by subtypes; mutual exclusivity and other selection logic is not performed here.

relocate

Move the antagonist to their spawn location, if applicable.

remove_equipment

The inverse of give_equipment(). Remove things like changeling abilities, etc. Non-innate things like items should probably be kept.

remove_objectives

Remove objectives from the antagonist and the mind.

remove_self

Calls removal procs to soft-remove this antagonist from its owner. Actual movement or deletion of the datum still needs to happen elsewhere.

setup_antagonist

Base proc to set up the antagonist. Depending on arguments, it can spawn equipment, assign objectives, move the player (if applicable), and announce itself.

unborged

Called when the player is no longer a cybrorg or AI