antagonist

Vars
antag_hud_name	Name of the antag hud we provide to this mob.
can_hijack	Variable to check how this antag interacts with hijacking the shuttle.
company	The corporation employing us
count_towards_antag_cap	Does this antag count towards the storytellers antag cap (False by default, but set to true for any antag of suitable size)
hud_icon	The antag hud's icon file
info_button_ref	weakref to button to access antag interface
min_account_age	Minimum account age in days to be valid for picking by this antag
preview_outfit	The typepath for the outfit to show in the preview for the preferences menu.
team_hud_ref	A weakref to the HUD shown to teammates, created by `add_team_hud`
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.
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.
get_objectives	generic helper to send objectives as data through tgui.
get_preview_icon	Returns the icon to show on the preferences menu.
handle_clown_mutation	Handles adding and removing the clumsy mutation from clown antags. Gets called in apply/remove_innate_effects
hud_image_on	Takes a location, returns an image drawing "on" it that matches this antag datum's hud icon
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.
ui_interact	ANTAGONIST UI STUFF

Var Details

var
antag_hud_name
–

Name of the antag hud we provide to this mob.

var
can_hijack
–

Variable to check how this antag interacts with hijacking the shuttle.

var
company
– /datum/corporation

The corporation employing us

var
count_towards_antag_cap
–

Does this antag count towards the storytellers antag cap (False by default, but set to true for any antag of suitable size)

var
hud_icon
–

The antag hud's icon file

var
info_button_ref
– /datum/weakref

weakref to button to access antag interface

var
min_account_age
–

Minimum account age in days to be valid for picking by this antag

var
preview_outfit
–

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

var
team_hud_ref
– /datum/weakref

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

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
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
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
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
hud_image_on
(/mob/hud_loc)

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

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.

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

ANTAGONIST UI STUFF

Antagonist /datum/antagonist

Vars

Procs

Var Details

var antag_hud_name –

var can_hijack –

var company – /datum/corporation

var count_towards_antag_cap –

var hud_icon –

var info_button_ref – /datum/weakref

var min_account_age –

var preview_outfit –

var team_hud_ref – /datum/weakref

var ui_name –