antagonist

Vars
antag_flags	Flags for antags to turn on or off and check!
antag_hud_name	Name of the antag hud we provide to this mob.
antag_memory	String dialogue that is added to the player's in-round notes and memories regarding specifics of that antagonist, eg. the nuke code for nuke ops, or your unlock code for traitors.
antag_moodlet	typepath of moodlet that the mob will gain when granted this antagonist type.
antagpanel_category	Antagpanel will display these together, REQUIRED
block_midrounds	Whether this antag datum blocks rolling new antag datums
can_assign_self_objectives	If true, this antagonist can assign themself a new objective
can_coexist_with_others	Whether or not the person will be able to have more than one datum
can_elimination_hijack	If these antags are alone when a shuttle elimination happens.
count_against_dynamic_roll_chance	If set to true, the antag will not be added to the living antag list.
default_custom_objective	Default to fill in when entering a custom objective.
hardcore_random_bonus	Whether we give a hardcore random bonus for greentexting as this antagonist while playing hardcore random
hijack_speed	If above 0, this is the multiplier for the speed at which we hijack the shuttle. Do not directly read, use hijack_speed().
hud_icon	The antag hud's icon file
info_button_ref	weakref to button to access antag interface
job_rank	The define string we use to identify the role for bans/player polls to spawn a random new one in.
name	Public name for this antagonist. Appears for player prompts and round-end reports.
objectives	List of the objective datums that this role currently has, completing all objectives at round-end will cause this antagonist to greentext.
owner	Mind that owns this datum
prevent_roundtype_conversion	If false, the roundtype will still convert with this antag active
preview_outfit	The typepath for the outfit to show in the preview for the preferences menu.
replace_banned	Should replace jobbanned player with ghosts if granted.
roundend_category	Section of roundend report, datums with same category will be displayed together, also default header for the section
show_in_antagpanel	This will hide adding this antag type in antag panel, use only for internal subtypes that shouldn't be added directly but still show if possessed by mind
show_in_roundend	Set to false to hide the antagonists from roundend report
show_name_in_check_antagonists	Will append antagonist name in admin listings - use for categories that share more than one antag type
show_to_ghosts	Should this antagonist be shown as antag to ghosts? Shouldn't be used for stealthy antagonists like traitors
silent	Silent will prevent the gain/lose texts to show
stinger_sound	A path to the audio stinger that plays upon gaining this datum.
suicide_cry	The battlecry this antagonist shouts when suiciding with C4/X4.
team_hud_ref	A weakref to the HUD shown to teammates, created by `add_team_hud`
typecache_datum_blacklist	List of datums this type can't coexist with
ui_name	name of the UI that will try to open, right now using a generic ui
Procs
add_team_hud	Adds a HUD that will show you other members with the same antagonist. If an antag typepath is passed to `antag_to_check`, will check that, otherwise will use the source type.
admin_add	Called when using admin tools to give antag status
admin_remove	Called when removing antagonist using admin tools
antag_panel_data	Additional data to display in the antagonist panel section. For example, nuke disk code, genome count, etc
clear_antag_moodies	Proc that removes this antagonist's ascribed moodlet from the player.
farewell	Proc that sends fluff or instructional messages to the player when they lose this antag datum. Use this proc for playing sounds, sending alerts, or otherwise informing the player that they're no longer a specific antagonist type.
finish_preview_icon	Given an icon, will crop it to be consistent of those in the preferences menu. Not necessary, and in fact will look bad if it's anything other than a human.
forge_objectives	Used to create objectives for the antagonist.
get_admin_commands	List of ["Command"] = CALLBACK(), user will be appeneded to callback arguments on execution
get_objectives	generic helper to send objectives as data through tgui.
get_preview_icon	Returns the icon to show on the preferences menu.
get_team	Proc that will return the team this antagonist belongs to, when called. Helpful with antagonists that may belong to multiple potential teams in a single round.
give_antag_moodies	Proc that assigns this antagonist's ascribed moodlet to the player.
greet	Proc that sends fluff or instructional messages to the player when they are given this antag datum. Use this proc for playing sounds, sending alerts, or helping to setup non-gameplay influencing aspects of the antagonist type.
handle_clown_mutation	Handles adding and removing the clumsy mutation from clown antags. Gets called in apply/remove_innate_effects
hijack_speed	Gets how fast we can hijack the shuttle, return 0 for can not hijack. Defaults to hijack_speed var, override for custom stuff like buffing hijack speed for hijack objectives or something.
hud_image_on	Takes a location, returns an image drawing "on" it that matches this antag datum's hud icon
is_banned	Proc that checks the sent mob aganst the banlistfor this antagonist. Returns FALSE if no mob is sent, or the mob is not found to be banned.
on_body_transfer	Called by the transfer_to() mind proc after the mind (mind.current and new_character.mind) has moved but before the player (key and client) is transferred.
on_gain	Called by the add_antag_datum() mind proc after the instanced datum is added to the mind's antag_datums list.
on_mindshield	This is called when the antagonist is successfully mindshielded.
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.
play_stinger	Plays the antag stinger sound, if we have one
pre_mindshield	This is called when the antagonist is being mindshielded.
render_preview_outfit	Creates an icon from the preview outfit. Custom implementors of `get_preview_icon` should use this, as the result of `get_preview_icon` is expected to be the completed version.
replace_banned_player	Proc that replaces a player who cannot play a specific antagonist due to being banned via a poll, and alerts the player of their being on the banlist.
roundend_report	Proc that sends string information for the end-round report window to the server. This runs on every instance of every antagonist that exists at the end of the round. This is the body of the message, sandwiched between roundend_report_header and roundend_report_footer.
roundend_report_footer	Proc that sends string data for the round-end report. Displayed after roundend_report and roundend_report_footer. Appears at the end of the roundend_catagory section.
roundend_report_header	Proc that sends string data for the round-end report. Displayed before roundend_report and roundend_report_footer. Appears at start of roundend_catagory section.
submit_player_objective	Allows player to replace their objectives with a new one they wrote themselves.
ui_interact	ANTAGONIST UI STUFF

Var Details

var
antag_flags
–

Flags for antags to turn on or off and check!

var
antag_hud_name
–

Name of the antag hud we provide to this mob.

var
antag_memory
–

String dialogue that is added to the player's in-round notes and memories regarding specifics of that antagonist, eg. the nuke code for nuke ops, or your unlock code for traitors.

var
antag_moodlet
–

typepath of moodlet that the mob will gain when granted this antagonist type.

var
antagpanel_category
–

Antagpanel will display these together, REQUIRED

var
block_midrounds
–

Whether this antag datum blocks rolling new antag datums

var
can_assign_self_objectives
–

If true, this antagonist can assign themself a new objective

var
can_coexist_with_others
–

Whether or not the person will be able to have more than one datum

var
can_elimination_hijack
–

If these antags are alone when a shuttle elimination happens.

var
count_against_dynamic_roll_chance
–

If set to true, the antag will not be added to the living antag list.

var
default_custom_objective
–

Default to fill in when entering a custom objective.

var
hardcore_random_bonus
–

Whether we give a hardcore random bonus for greentexting as this antagonist while playing hardcore random

var
hijack_speed
–

If above 0, this is the multiplier for the speed at which we hijack the shuttle. Do not directly read, use hijack_speed().

var
hud_icon
–

The antag hud's icon file

var
info_button_ref
– /datum/weakref

weakref to button to access antag interface

var
job_rank
–

The define string we use to identify the role for bans/player polls to spawn a random new one in.

var
name
–

Public name for this antagonist. Appears for player prompts and round-end reports.

var
objectives
– /list

List of the objective datums that this role currently has, completing all objectives at round-end will cause this antagonist to greentext.

var
owner
– /datum/mind

Mind that owns this datum

var
prevent_roundtype_conversion
–

If false, the roundtype will still convert with this antag active

var
preview_outfit
–

The typepath for the outfit to show in the preview for the preferences menu.

var
replace_banned
–

Should replace jobbanned player with ghosts if granted.

var
roundend_category
–

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

var
show_in_antagpanel
–

This will hide adding this antag type in antag panel, use only for internal subtypes that shouldn't be added directly but still show if possessed by mind

var
show_in_roundend
–

Set to false to hide the antagonists from roundend report

var
show_name_in_check_antagonists
–

Will append antagonist name in admin listings - use for categories that share more than one antag type

var
show_to_ghosts
–

Should this antagonist be shown as antag to ghosts? Shouldn't be used for stealthy antagonists like traitors

var
silent
–

Silent will prevent the gain/lose texts to show

var
stinger_sound
–

A path to the audio stinger that plays upon gaining this datum.

var
suicide_cry
–

The battlecry this antagonist shouts when suiciding with C4/X4.

var
team_hud_ref
– /datum/weakref

A weakref to the HUD shown to teammates, created by add_team_hud

var
typecache_datum_blacklist
– /list

List of datums this type can't coexist with

var
ui_name
–

name of the UI that will try to open, right now using a generic ui

Proc Details

proc
add_team_hud
(/mob/target, antag_to_check)

Adds a HUD that will show you other members with the same antagonist. If an antag typepath is passed to antag_to_check, will check that, otherwise will use the source type.

proc
admin_add
(/datum/mind/new_owner, /mob/admin)

Called when using admin tools to give antag status

proc
admin_remove
(/mob/user)

Called when removing antagonist using admin tools

proc
antag_panel_data
()

Additional data to display in the antagonist panel section. For example, nuke disk code, genome count, etc

proc
clear_antag_moodies
()

Proc that removes this antagonist's ascribed moodlet from the player.

proc
farewell
()

Proc that sends fluff or instructional messages to the player when they lose this antag datum. Use this proc for playing sounds, sending alerts, or otherwise informing the player that they're no longer a specific antagonist type.

proc
finish_preview_icon
(/icon/icon)

Given an icon, will crop it to be consistent of those in the preferences menu. Not necessary, and in fact will look bad if it's anything other than a human.

proc
forge_objectives
()

Used to create objectives for the antagonist.

proc
get_admin_commands
()

List of ["Command"] = CALLBACK(), user will be appeneded to callback arguments on execution

proc
get_objectives
()

generic helper to send objectives as data through tgui.

proc
get_preview_icon
()

Returns the icon to show on the preferences menu.

proc
get_team
()

Proc that will return the team this antagonist belongs to, when called. Helpful with antagonists that may belong to multiple potential teams in a single round.

proc
give_antag_moodies
()

Proc that assigns this antagonist's ascribed moodlet to the player.

proc
greet
()

Proc that sends fluff or instructional messages to the player when they are given this antag datum. Use this proc for playing sounds, sending alerts, or helping to setup non-gameplay influencing aspects of the antagonist type.

proc
handle_clown_mutation
(/mob/living/mob_override, message, removing)

Handles adding and removing the clumsy mutation from clown antags. Gets called in apply/remove_innate_effects

proc
hijack_speed
()

Gets how fast we can hijack the shuttle, return 0 for can not hijack. Defaults to hijack_speed var, override for custom stuff like buffing hijack speed for hijack objectives or something.

proc
hud_image_on
(/mob/hud_loc)

Takes a location, returns an image drawing "on" it that matches this antag datum's hud icon

proc
is_banned
(/mob/player)

Proc that checks the sent mob aganst the banlistfor this antagonist. Returns FALSE if no mob is sent, or the mob is not found to be banned.

mob/player: The mob that you are looking for on the banlist.

proc
on_body_transfer
(/mob/living/old_body, /mob/living/new_body)

Called by the transfer_to() mind proc after the mind (mind.current and new_character.mind) has moved but before the player (key and client) is transferred.

proc
on_gain
()

Called by the add_antag_datum() mind proc after the instanced datum is added to the mind's antag_datums list.

proc
on_mindshield
(/mob/implanter, /mob/living/mob_override)

This is called when the antagonist is successfully mindshielded.

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

proc
play_stinger
()

Plays the antag stinger sound, if we have one

proc
pre_mindshield
(/mob/implanter, /mob/living/mob_override)

This is called when the antagonist is being mindshielded.

proc
render_preview_outfit
(/datum/outfit/outfit, /mob/living/carbon/human/dummy)

Creates an icon from the preview outfit. Custom implementors of get_preview_icon should use this, as the result of get_preview_icon is expected to be the completed version.

proc
replace_banned_player
()

Proc that replaces a player who cannot play a specific antagonist due to being banned via a poll, and alerts the player of their being on the banlist.

proc
roundend_report
()

Proc that sends string information for the end-round report window to the server. This runs on every instance of every antagonist that exists at the end of the round. This is the body of the message, sandwiched between roundend_report_header and roundend_report_footer.

proc
roundend_report_footer
()

Proc that sends string data for the round-end report. Displayed after roundend_report and roundend_report_footer. Appears at the end of the roundend_catagory section.

proc
roundend_report_header
()

Proc that sends string data for the round-end report. Displayed before roundend_report and roundend_report_footer. Appears at start of roundend_catagory section.

proc
submit_player_objective
(retain_existing, retain_escape, force)

Allows player to replace their objectives with a new one they wrote themselves.

retain_existing - If true, will just be added as a new objective instead of replacing existing ones.
retain_escape - If true, will retain specifically 'escape alive' objectives (or similar)
force - Skips the check about whether this antagonist is supposed to set its own objectives, for badminning

↑
ui_interact
(/mob/user, /datum/tgui/ui)

ANTAGONIST UI STUFF

antagonist /datum/antagonist

Vars

Procs

Var Details

var antag_flags –

var antag_hud_name –

var antag_memory –

var antag_moodlet –

var antagpanel_category –

var block_midrounds –

var can_assign_self_objectives –

var can_coexist_with_others –

var can_elimination_hijack –

var count_against_dynamic_roll_chance –

var default_custom_objective –

var hardcore_random_bonus –

var hijack_speed –

var hud_icon –

var info_button_ref – /datum/weakref

var job_rank –

var name –

var objectives – /list

var owner – /datum/mind

var prevent_roundtype_conversion –

var preview_outfit –

var replace_banned –

var roundend_category –

var show_in_antagpanel –

var show_in_roundend –

var show_name_in_check_antagonists –

var show_to_ghosts –

var silent –

var stinger_sound –

var suicide_cry –

var team_hud_ref – /datum/weakref

var typecache_datum_blacklist – /list

var ui_name –

Proc Details

proc add_team_hud(/mob/target, antag_to_check)

proc admin_add(/datum/mind/new_owner, /mob/admin)

proc admin_remove(/mob/user)

proc antag_panel_data()

proc clear_antag_moodies()

proc farewell()

proc finish_preview_icon(/icon/icon)

proc forge_objectives()

proc get_admin_commands()

proc get_objectives()

proc get_preview_icon()

proc get_team()

proc give_antag_moodies()

proc greet()

proc handle_clown_mutation(/mob/living/mob_override, message, removing)

proc hijack_speed()

proc hud_image_on(/mob/hud_loc)

proc is_banned(/mob/player)

proc on_body_transfer(/mob/living/old_body, /mob/living/new_body)

proc on_gain()

proc on_mindshield(/mob/implanter, /mob/living/mob_override)

proc on_removal()

proc play_stinger()

proc pre_mindshield(/mob/implanter, /mob/living/mob_override)

proc render_preview_outfit(/datum/outfit/outfit, /mob/living/carbon/human/dummy)

proc replace_banned_player()

proc roundend_report()

proc roundend_report_footer()

proc roundend_report_header()

proc submit_player_objective(retain_existing, retain_escape, force)

↑ui_interact(/mob/user, /datum/tgui/ui)