shikix/GS13NG
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
gh-pages
GS13NG/datum/antagonist.html
T
sheepishgoat 705fd9528e Deploying to gh-pages from @ e8e0068531 🚀
2025-02-05 06:19:18 +00:00

32 lines
39 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/antagonist - /tg/ Station 13</title></head><body><header><a href="index.html">/tg/ Station 13</a> - <a href="index.html#modules">Modules</a> - <a href="index.html#types">Types</a> — <a href="datum/antagonist.html#var">Var Details</a> - <a href="datum/antagonist.html#proc">Proc Details</a></header><main><h1>antagonist <aside>/<a href="datum.html">datum</a>/<a href="datum/antagonist.html">antagonist</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L3"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 3"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/antagonist.html#var/antag_hud_name">antag_hud_name</a></th><td>Name of the antag hud we provide to this mob.</td></tr><tr><th><a href="datum/antagonist.html#var/antag_hud_type">antag_hud_type</a></th><td>What is the configuration of this antagonist's hud icon, such as it's screen position and style, so thatit doesn't break other in-game hud icons.</td></tr><tr><th><a href="datum/antagonist.html#var/antag_memory">antag_memory</a></th><td>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.</td></tr><tr><th><a href="datum/antagonist.html#var/antag_moodlet">antag_moodlet</a></th><td>typepath of moodlet that the mob will gain when granted this antagonist type.</td></tr><tr><th><a href="datum/antagonist.html#var/antagpanel_category">antagpanel_category</a></th><td>Antagpanel will display these together, REQUIRED</td></tr><tr><th><a href="datum/antagonist.html#var/blacklisted_quirks">blacklisted_quirks</a></th><td>Quirks that will be removed upon gaining this antag. Pacifist and mute are default.</td></tr><tr><th><a href="datum/antagonist.html#var/can_coexist_with_others">can_coexist_with_others</a></th><td>Whether or not the person will be able to have more than one datum</td></tr><tr><th><a href="datum/antagonist.html#var/hijack_speed">hijack_speed</a></th><td>If above 0, this is the multiplier for the speed at which we hijack the shuttle. Do not directly read, use hijack_speed().</td></tr><tr><th><a href="datum/antagonist.html#var/info_button">info_button</a></th><td>button to access antag interface</td></tr><tr><th><a href="datum/antagonist.html#var/job_rank">job_rank</a></th><td>The define string we use to identify the role for bans/player polls to spawn a random new one in.</td></tr><tr><th><a href="datum/antagonist.html#var/name">name</a></th><td>Public name for this antagonist. Appears for player prompts and round-end reports.</td></tr><tr><th><a href="datum/antagonist.html#var/objectives">objectives</a></th><td>List of the objective datums that this role currently has, completing all objectives at round-end will cause this antagonist to greentext.</td></tr><tr><th><a href="datum/antagonist.html#var/owner">owner</a></th><td>Mind that owns this datum</td></tr><tr><th><a href="datum/antagonist.html#var/prevent_roundtype_conversion">prevent_roundtype_conversion</a></th><td>If false, the roundtype will still convert with this antag active</td></tr><tr><th><a href="datum/antagonist.html#var/preview_outfit">preview_outfit</a></th><td>The typepath for the outfit to show in the preview for the preferences menu.</td></tr><tr><th><a href="datum/antagonist.html#var/replace_banned">replace_banned</a></th><td>Should replace jobbanned player with ghosts if granted.</td></tr><tr><th><a href="datum/antagonist.html#var/requested_objective_changes">requested_objective_changes</a></th><td>Lazy list for antagonists to request the admins objectives.</td></tr><tr><th><a href="datum/antagonist.html#var/roundend_category">roundend_category</a></th><td>Section of roundend report, datums with same category will be displayed together, also default header for the section</td></tr><tr><th><a href="datum/antagonist.html#var/show_in_antagpanel">show_in_antagpanel</a></th><td>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</td></tr><tr><th><a href="datum/antagonist.html#var/show_in_roundend">show_in_roundend</a></th><td>Set to false to hide the antagonists from roundend report</td></tr><tr><th><a href="datum/antagonist.html#var/show_name_in_check_antagonists">show_name_in_check_antagonists</a></th><td>Will append antagonist name in admin listings - use for categories that share more than one antag type</td></tr><tr><th><a href="datum/antagonist.html#var/show_to_ghosts">show_to_ghosts</a></th><td>Should this antagonist be shown as antag to ghosts? Shouldn't be used for stealthy antagonists like traitors</td></tr><tr><th><a href="datum/antagonist.html#var/silent">silent</a></th><td>Silent will prevent the gain/lose texts to show</td></tr><tr><th><a href="datum/antagonist.html#var/soft_antag">soft_antag</a></th><td>If set to true, the antag will not be added to the living antag list.</td></tr><tr><th><a href="datum/antagonist.html#var/suicide_cry">suicide_cry</a></th><td>The battlecry this antagonist shouts when suiciding with C4/X4.</td></tr><tr><th><a href="datum/antagonist.html#var/threat">threat</a></th><td>Amount of threat this antag poses, for dynamic mode</td></tr><tr><th><a href="datum/antagonist.html#var/typecache_datum_blacklist">typecache_datum_blacklist</a></th><td>List of datums this type can't coexist with</td></tr><tr><th><a href="datum/antagonist.html#var/ui_name">ui_name</a></th><td>name of the UI that will try to open, right now having nothing means this won't exist but in the future all should.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/antagonist.html#proc/antag_panel_data">antag_panel_data</a></th><td>Additional data to display in the antagonist panel section.
For example, nuke disk code, genome count, etc</td></tr><tr><th><a href="datum/antagonist.html#proc/clean_request_from_del_objective">clean_request_from_del_objective</a></th><td>Clears change requests from deleted objectives to avoid broken references.</td></tr><tr><th><a href="datum/antagonist.html#proc/clear_antag_moodies">clear_antag_moodies</a></th><td>Proc that removes this antagonist's ascribed moodlet from the player.</td></tr><tr><th><a href="datum/antagonist.html#proc/farewell">farewell</a></th><td>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.</td></tr><tr><th><a href="datum/antagonist.html#proc/finish_preview_icon">finish_preview_icon</a></th><td>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.</td></tr><tr><th><a href="datum/antagonist.html#proc/get_admin_commands">get_admin_commands</a></th><td>List of [&quot;Command&quot;] = CALLBACK(), user will be appeneded to callback arguments on execution</td></tr><tr><th><a href="datum/antagonist.html#proc/get_objectives">get_objectives</a></th><td>generic helper to send objectives as data through tgui. supports smart objectives too!</td></tr><tr><th><a href="datum/antagonist.html#proc/get_preview_icon">get_preview_icon</a></th><td>Returns the icon to show on the preferences menu.</td></tr><tr><th><a href="datum/antagonist.html#proc/get_team">get_team</a></th><td>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, like families.</td></tr><tr><th><a href="datum/antagonist.html#proc/give_antag_moodies">give_antag_moodies</a></th><td>Proc that assigns this antagonist's ascribed moodlet to the player.</td></tr><tr><th><a href="datum/antagonist.html#proc/greet">greet</a></th><td>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.</td></tr><tr><th><a href="datum/antagonist.html#proc/handle_clown_mutation">handle_clown_mutation</a></th><td>Handles adding and removing the clumsy mutation from clown antags. Gets called in apply/remove_innate_effects</td></tr><tr><th><a href="datum/antagonist.html#proc/hijack_speed">hijack_speed</a></th><td>Gets how fast we can hijack the shuttle, return FALSE for can not hijack.
Defaults to hijack_speed var, override for custom stuff like buffing hijack speed for hijack objectives or something.</td></tr><tr><th><a href="datum/antagonist.html#proc/is_banned">is_banned</a></th><td>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.</td></tr><tr><th><a href="datum/antagonist.html#proc/on_body_transfer">on_body_transfer</a></th><td>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 transfered.</td></tr><tr><th><a href="datum/antagonist.html#proc/on_gain">on_gain</a></th><td>Called by the add_antag_datum() mind proc after the instanced datum is added to the mind's antag_datums list.</td></tr><tr><th><a href="datum/antagonist.html#proc/on_mindshield">on_mindshield</a></th><td>This is called when the antagonist is successfully mindshielded.</td></tr><tr><th><a href="datum/antagonist.html#proc/on_removal">on_removal</a></th><td>Called by the remove_antag_datum() and remove_all_antag_datums() mind procs for the antag datum to handle its own removal and deletion.</td></tr><tr><th><a href="datum/antagonist.html#proc/pre_mindshield">pre_mindshield</a></th><td>This is called when the antagonist is being mindshielded.</td></tr><tr><th><a href="datum/antagonist.html#proc/remove_blacklisted_quirks">remove_blacklisted_quirks</a></th><td>Removes invalid quirks.</td></tr><tr><th><a href="datum/antagonist.html#proc/render_preview_outfit">render_preview_outfit</a></th><td>Creates an icon from the preview outfit.
Custom implementors of <code>get_preview_icon</code> should use this, as the
result of <code>get_preview_icon</code> is expected to be the completed version.</td></tr><tr><th><a href="datum/antagonist.html#proc/replace_banned_player">replace_banned_player</a></th><td>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.</td></tr><tr><th><a href="datum/antagonist.html#proc/roundend_report">roundend_report</a></th><td>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.</td></tr><tr><th><a href="datum/antagonist.html#proc/roundend_report_footer">roundend_report_footer</a></th><td>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.</td></tr><tr><th><a href="datum/antagonist.html#proc/roundend_report_header">roundend_report_header</a></th><td>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.</td></tr><tr><th><a href="datum/antagonist.html#proc/threat">threat</a></th><td>Gets our threat level. Override this proc for custom functionality/dynamic threat level.</td></tr><tr><th><a href="datum/antagonist.html#proc/ui_interact">ui_interact</a></th><td>ANTAGONIST UI STUFF</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/antag_hud_name"><aside class="declaration">var </aside>antag_hud_name <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L34"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 34"></a></h3><p>Name of the antag hud we provide to this mob.</p><h3 id="var/antag_hud_type"><aside class="declaration">var </aside>antag_hud_type <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L32"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 32"></a></h3><p>What is the configuration of this antagonist's hud icon, such as it's screen position and style, so thatit doesn't break other in-game hud icons.</p><h3 id="var/antag_memory"><aside class="declaration">var </aside>antag_memory <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L27"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 27"></a></h3><p>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.</p><h3 id="var/antag_moodlet"><aside class="declaration">var </aside>antag_moodlet <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L29"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 29"></a></h3><p>typepath of moodlet that the mob will gain when granted this antagonist type.</p><h3 id="var/antagpanel_category"><aside class="declaration">var </aside>antagpanel_category <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L48"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 48"></a></h3><p>Antagpanel will display these together, REQUIRED</p><h3 id="var/blacklisted_quirks"><aside class="declaration">var </aside>blacklisted_quirks <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L60"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 60"></a></h3><p>Quirks that will be removed upon gaining this antag. Pacifist and mute are default.</p><h3 id="var/can_coexist_with_others"><aside class="declaration">var </aside>can_coexist_with_others <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L17"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 17"></a></h3><p>Whether or not the person will be able to have more than one datum</p><h3 id="var/hijack_speed"><aside class="declaration">var </aside>hijack_speed <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L36"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 36"></a></h3><p>If above 0, this is the multiplier for the speed at which we hijack the shuttle. Do not directly read, use hijack_speed().</p><h3 id="var/info_button"><aside class="declaration">var </aside>info_button <aside>– /<a href="datum.html">datum</a>/<a href="datum/action.html">action</a>/antag_info</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L76"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 76"></a></h3><p>button to access antag interface</p><h3 id="var/job_rank"><aside class="declaration">var </aside>job_rank <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L21"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 21"></a></h3><p>The define string we use to identify the role for bans/player polls to spawn a random new one in.</p><h3 id="var/name"><aside class="declaration">var </aside>name <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L5"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 5"></a></h3><p>Public name for this antagonist. Appears for player prompts and round-end reports.</p><h3 id="var/objectives"><aside class="declaration">var </aside>objectives <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L25"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 25"></a></h3><p>List of the objective datums that this role currently has, completing all objectives at round-end will cause this antagonist to greentext.</p><h3 id="var/owner"><aside class="declaration">var </aside>owner <aside>– /<a href="datum.html">datum</a>/<a href="datum/mind.html">mind</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L13"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 13"></a></h3><p>Mind that owns this datum</p><h3 id="var/prevent_roundtype_conversion"><aside class="declaration">var </aside>prevent_roundtype_conversion <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L11"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 11"></a></h3><p>If false, the roundtype will still convert with this antag active</p><h3 id="var/preview_outfit"><aside class="declaration">var </aside>preview_outfit <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L40"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 40"></a></h3><p>The typepath for the outfit to show in the preview for the preferences menu.</p><h3 id="var/replace_banned"><aside class="declaration">var </aside>replace_banned <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L23"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 23"></a></h3><p>Should replace jobbanned player with ghosts if granted.</p><h3 id="var/requested_objective_changes"><aside class="declaration">var </aside>requested_objective_changes <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L55"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 55"></a></h3><p>Lazy list for antagonists to request the admins objectives.</p><h3 id="var/roundend_category"><aside class="declaration">var </aside>roundend_category <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L7"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 7"></a></h3><p>Section of roundend report, datums with same category will be displayed together, also default header for the section</p><h3 id="var/show_in_antagpanel"><aside class="declaration">var </aside>show_in_antagpanel <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L46"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 46"></a></h3><p>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</p><h3 id="var/show_in_roundend"><aside class="declaration">var </aside>show_in_roundend <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L9"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 9"></a></h3><p>Set to false to hide the antagonists from roundend report</p><h3 id="var/show_name_in_check_antagonists"><aside class="declaration">var </aside>show_name_in_check_antagonists <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L50"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 50"></a></h3><p>Will append antagonist name in admin listings - use for categories that share more than one antag type</p><h3 id="var/show_to_ghosts"><aside class="declaration">var </aside>show_to_ghosts <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L52"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 52"></a></h3><p>Should this antagonist be shown as antag to ghosts? Shouldn't be used for stealthy antagonists like traitors</p><h3 id="var/silent"><aside class="declaration">var </aside>silent <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L15"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 15"></a></h3><p>Silent will prevent the gain/lose texts to show</p><h3 id="var/soft_antag"><aside class="declaration">var </aside>soft_antag <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L42"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 42"></a></h3><p>If set to true, the antag will not be added to the living antag list.</p><h3 id="var/suicide_cry"><aside class="declaration">var </aside>suicide_cry <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L38"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 38"></a></h3><p>The battlecry this antagonist shouts when suiciding with C4/X4.</p><h3 id="var/threat"><aside class="declaration">var </aside>threat <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L62"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 62"></a></h3><p>Amount of threat this antag poses, for dynamic mode</p><h3 id="var/typecache_datum_blacklist"><aside class="declaration">var </aside>typecache_datum_blacklist <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L19"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 19"></a></h3><p>List of datums this type can't coexist with</p><h3 id="var/ui_name"><aside class="declaration">var </aside>ui_name <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L72"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 72"></a></h3><p>name of the UI that will try to open, right now having nothing means this won't exist but in the future all should.</p><h2 id="proc">Proc Details</h2><h3 id="proc/antag_panel_data"><aside class="declaration">proc </aside>antag_panel_data<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L373"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 373"></a></aside></h3><p>Additional data to display in the antagonist panel section.
For example, nuke disk code, genome count, etc</p><h3 id="proc/clean_request_from_del_objective"><aside class="declaration">proc </aside>clean_request_from_del_objective<aside>(/<a href="datum.html">datum</a>/objective/source, force) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L534"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 534"></a></aside></h3><p>Clears change requests from deleted objectives to avoid broken references.</p><h3 id="proc/clear_antag_moodies"><aside class="declaration">proc </aside>clear_antag_moodies<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L282"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 282"></a></aside></h3><p>Proc that removes this antagonist's ascribed moodlet from the player.</p><h3 id="proc/farewell"><aside class="declaration">proc </aside>farewell<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L268"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 268"></a></aside></h3><p>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.</p><h3 id="proc/finish_preview_icon"><aside class="declaration">proc </aside>finish_preview_icon<aside>(/icon/icon) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L403"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 403"></a></aside></h3><p>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.</p><h3 id="proc/get_admin_commands"><aside class="declaration">proc </aside>get_admin_commands<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L385"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 385"></a></aside></h3><p>List of [&quot;Command&quot;] = CALLBACK(), user will be appeneded to callback arguments on execution</p><h3 id="proc/get_objectives"><aside class="declaration">proc </aside>get_objectives<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L500"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 500"></a></aside></h3><p>generic helper to send objectives as data through tgui. supports smart objectives too!</p><h3 id="proc/get_preview_icon"><aside class="declaration">proc </aside>get_preview_icon<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L417"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 417"></a></aside></h3><p>Returns the icon to show on the preferences menu.</p><h3 id="proc/get_team"><aside class="declaration">proc </aside>get_team<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L303"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 303"></a></aside></h3><p>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, like families.</p><h3 id="proc/give_antag_moodies"><aside class="declaration">proc </aside>give_antag_moodies<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L274"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 274"></a></aside></h3><p>Proc that assigns this antagonist's ascribed moodlet to the player.</p><h3 id="proc/greet"><aside class="declaration">proc </aside>greet<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L261"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 261"></a></aside></h3><p>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.</p><h3 id="proc/handle_clown_mutation"><aside class="declaration">proc </aside>handle_clown_mutation<aside>(/<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/mob_override, message, removing) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L149"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 149"></a></aside></h3><p>Handles adding and removing the clumsy mutation from clown antags. Gets called in apply/remove_innate_effects</p><h3 id="proc/hijack_speed"><aside class="declaration">proc </aside>hijack_speed<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L454"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 454"></a></aside></h3><p>Gets how fast we can hijack the shuttle, return FALSE for can not hijack.
Defaults to hijack_speed var, override for custom stuff like buffing hijack speed for hijack objectives or something.</p><h3 id="proc/is_banned"><aside class="declaration">proc </aside>is_banned<aside>(/<a href="mob.html">mob</a>/M) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L210"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 210"></a></aside></h3><p>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.</p>
<ul>
<li>mob/M: The mob that you are looking for on the banlist.</li>
</ul><h3 id="proc/on_body_transfer"><aside class="declaration">proc </aside>on_body_transfer<aside>(/<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/old_body, /<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/new_body) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L107"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 107"></a></aside></h3><p>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 transfered.</p><h3 id="proc/on_gain"><aside class="declaration">proc </aside>on_gain<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L166"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 166"></a></aside></h3><p>Called by the add_antag_datum() mind proc after the instanced datum is added to the mind's antag_datums list.</p><h3 id="proc/on_mindshield"><aside class="declaration">proc </aside>on_mindshield<aside>(/<a href="mob.html">mob</a>/implanter, /<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/mob_override) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L130"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 130"></a></aside></h3><p>This is called when the antagonist is successfully mindshielded.</p><h3 id="proc/on_removal"><aside class="declaration">proc </aside>on_removal<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L232"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 232"></a></aside></h3><p>Called by the remove_antag_datum() and remove_all_antag_datums() mind procs for the antag datum to handle its own removal and deletion.</p><h3 id="proc/pre_mindshield"><aside class="declaration">proc </aside>pre_mindshield<aside>(/<a href="mob.html">mob</a>/implanter, /<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/mob_override) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L125"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 125"></a></aside></h3><p>This is called when the antagonist is being mindshielded.</p><h3 id="proc/remove_blacklisted_quirks"><aside class="declaration">proc </aside>remove_blacklisted_quirks<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L290"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 290"></a></aside></h3><p>Removes invalid quirks.</p><h3 id="proc/render_preview_outfit"><aside class="declaration">proc </aside>render_preview_outfit<aside>(/<a href="datum.html">datum</a>/<a href="datum/outfit.html">outfit</a>/outfit, /<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/<a href="mob/living/carbon.html">carbon</a>/<a href="mob/living/carbon/human.html">human</a>/dummy) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L391"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 391"></a></aside></h3><p>Creates an icon from the preview outfit.
Custom implementors of <code>get_preview_icon</code> should use this, as the
result of <code>get_preview_icon</code> is expected to be the completed version.</p><h3 id="proc/replace_banned_player"><aside class="declaration">proc </aside>replace_banned_player<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L218"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 218"></a></aside></h3><p>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.</p><h3 id="proc/roundend_report"><aside class="declaration">proc </aside>roundend_report<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L311"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 311"></a></aside></h3><p>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.</p><h3 id="proc/roundend_report_footer"><aside class="declaration">proc </aside>roundend_report_footer<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L347"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 347"></a></aside></h3><p>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.</p><h3 id="proc/roundend_report_header"><aside class="declaration">proc </aside>roundend_report_header<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L339"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 339"></a></aside></h3><p>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.</p><h3 id="proc/threat"><aside class="declaration">proc </aside>threat<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L463"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 463"></a></aside></h3><p>Gets our threat level. Override this proc for custom functionality/dynamic threat level.</p><h3 id="proc/ui_interact"><aside class="parent"><a title="/datum" href="datum.html#proc/ui_interact">↑</a></aside>ui_interact<aside>(/<a href="mob.html">mob</a>/user, /<a href="datum.html">datum</a>/<a href="datum/tgui.html">tgui</a>/ui) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/_common/antag_datum.dm#L490"><img src="git.png" width="16" height="16" title="code/modules/antagonists/_common/antag_datum.dm 490"></a></aside></h3><p>ANTAGONIST UI STUFF</p></main><footer>tgstation.dme <a href="https://github.com/evilew/GS13-Citadel/tree/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e">e8e0068</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.9.0</a></footer></body></html>
Reference in New Issue View Git Blame Copy Permalink