mirror of
https://github.com/ParadiseSS13/Paradise.git
synced 2026-08-26 13:37:58 +01:00
16 lines
12 KiB
HTML
16 lines
12 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/mind - Space Station 13</title></head><body><header><a href="index.html">Space Station 13</a> - <a href="index.html#modules">Modules</a> - <a href="index.html#types">Types</a> — <a href="datum/mind.html#var">Var Details</a> - <a href="datum/mind.html#proc">Proc Details</a></header><main><h1>mind <aside>/<a href="datum.html">datum</a>/<a href="datum/mind.html">mind</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/mind.dm#L22"><img src="git.png" width="16" height="16" title="code/datums/mind.dm 22"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/mind.html#var/antag_datums">antag_datums</a></th><td>A list of all the antagonist datums that the player is (does not include undatumized antags)</td></tr><tr><th><a href="datum/mind.html#var/assigned_role">assigned_role</a></th><td>Assigned role is what job you're assigned to when you join the station.</td></tr><tr><th><a href="datum/mind.html#var/destroyed_body_json">destroyed_body_json</a></th><td>A serialized copy of this mind's body when it was destroyed, for admin respawn usage.</td></tr><tr><th><a href="datum/mind.html#var/has_been_rev">has_been_rev</a></th><td>Tracks if this mind has been a rev or not</td></tr><tr><th><a href="datum/mind.html#var/job_datum">job_datum</a></th><td>This is the the job datum you have</td></tr><tr><th><a href="datum/mind.html#var/job_objectives">job_objectives</a></th><td>a list of objectives that a player with this job could complete for space credit rewards</td></tr><tr><th><a href="datum/mind.html#var/original_mob_UID">original_mob_UID</a></th><td>The original mob's UID. Used for example to see if a silicon with antag status is actually malf. Or just an antag put in a borg</td></tr><tr><th><a href="datum/mind.html#var/original_mob_name">original_mob_name</a></th><td>The original mob's name. Used in Dchat messages</td></tr><tr><th><a href="datum/mind.html#var/teams">teams</a></th><td>A lazy list of all teams the player is part of but doesnt have an antag role for, (i.e. a custom admin team)</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/mind.html#proc/add_antag_datum">add_antag_datum</a></th><td>Create and/or add the <code>datum_type_or_instance</code> antag datum to the src mind.</td></tr><tr><th><a href="datum/mind.html#proc/add_mind_objective">add_mind_objective</a></th><td>Add an objective to the mind</td></tr><tr><th><a href="datum/mind.html#proc/get_all_objectives">get_all_objectives</a></th><td>Gets every objective this mind owns, including all of those from any antag datums and teams they have, and returns them as a list.</td></tr><tr><th><a href="datum/mind.html#proc/get_hijack_speed">get_hijack_speed</a></th><td>This proc sets the hijack speed for a mob. If greater than zero, they can hijack. Outputs in seconds.</td></tr><tr><th><a href="datum/mind.html#proc/has_antag_datum">has_antag_datum</a></th><td>Returns an antag datum instance if the src mind has the specified <code>datum_type</code>. Returns <code>null</code> otherwise.</td></tr><tr><th><a href="datum/mind.html#proc/has_objectives">has_objectives</a></th><td>A quicker version of get_all_objectives() but only for seeing if they have any objectives at all</td></tr><tr><th><a href="datum/mind.html#proc/remove_all_antag_datums">remove_all_antag_datums</a></th><td>Removes all antag datums from the src mind.</td></tr><tr><th><a href="datum/mind.html#proc/remove_antag_datum">remove_antag_datum</a></th><td>Remove the specified <code>datum_type</code> antag datum from the src mind.</td></tr><tr><th><a href="datum/mind.html#proc/remove_mind_objective">remove_mind_objective</a></th><td>Completely remove the given objective from the mind, and include antagdatums/teams if remove_from_everything is true</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/antag_datums"><aside class="declaration">var </aside>antag_datums <aside>– /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/mind.dm#L63"><img src="git.png" width="16" height="16" title="code/datums/mind.dm 63"></a></h3><p>A list of all the antagonist datums that the player is (does not include undatumized antags)</p><h3 id="var/assigned_role"><aside class="declaration">var </aside>assigned_role <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/mind.dm#L37"><img src="git.png" width="16" height="16" title="code/datums/mind.dm 37"></a></h3><p>Assigned role is what job you're assigned to when you join the station.</p><h3 id="var/destroyed_body_json"><aside class="declaration">var </aside>destroyed_body_json <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/mind.dm#L27"><img src="git.png" width="16" height="16" title="code/datums/mind.dm 27"></a></h3><p>A serialized copy of this mind's body when it was destroyed, for admin respawn usage.</p><h3 id="var/has_been_rev"><aside class="declaration">var </aside>has_been_rev <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/mind.dm#L59"><img src="git.png" width="16" height="16" title="code/datums/mind.dm 59"></a></h3><p>Tracks if this mind has been a rev or not</p><h3 id="var/job_datum"><aside class="declaration">var </aside>job_datum <aside>– /<a href="datum.html">datum</a>/<a href="datum/job.html">job</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/mind.dm#L39"><img src="git.png" width="16" height="16" title="code/datums/mind.dm 39"></a></h3><p>This is the the job datum you have</p><h3 id="var/job_objectives"><aside class="declaration">var </aside>job_objectives <aside>– /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/mind.dm#L54"><img src="git.png" width="16" height="16" title="code/datums/mind.dm 54"></a></h3><p>a list of objectives that a player with this job could complete for space credit rewards</p><h3 id="var/original_mob_UID"><aside class="declaration">var </aside>original_mob_UID <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/mind.dm#L29"><img src="git.png" width="16" height="16" title="code/datums/mind.dm 29"></a></h3><p>The original mob's UID. Used for example to see if a silicon with antag status is actually malf. Or just an antag put in a borg</p><h3 id="var/original_mob_name"><aside class="declaration">var </aside>original_mob_name <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/mind.dm#L31"><img src="git.png" width="16" height="16" title="code/datums/mind.dm 31"></a></h3><p>The original mob's name. Used in Dchat messages</p><h3 id="var/teams"><aside class="declaration">var </aside>teams <aside>– /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/mind.dm#L65"><img src="git.png" width="16" height="16" title="code/datums/mind.dm 65"></a></h3><p>A lazy list of all teams the player is part of but doesnt have an antag role for, (i.e. a custom admin team)</p><h2 id="proc">Proc Details</h2><h3 id="proc/add_antag_datum"><aside class="declaration">proc </aside>add_antag_datum<aside>(datum_type_or_instance, /<a href="datum.html">datum</a>/<a href="datum/team.html">team</a>/team) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/mind.dm#L1764"><img src="git.png" width="16" height="16" title="code/datums/mind.dm 1764"></a></aside></h3><p>Create and/or add the <code>datum_type_or_instance</code> antag datum to the src mind.</p>
|
||
<p>Arguments:</p>
|
||
<ul>
|
||
<li>antag_datum - an antag datum typepath or instance. If it's a typepath, it will create a new antag datum</li>
|
||
<li>datum/team/team - the antag team that the src mind should join, if any</li>
|
||
</ul><h3 id="proc/add_mind_objective"><aside class="declaration">proc </aside>add_mind_objective<aside>(/<a href="datum.html">datum</a>/<a href="datum/objective.html">objective</a>/O, _explanation_text, /<a href="mob.html">mob</a>/target_override) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/mind.dm#L282"><img src="git.png" width="16" height="16" title="code/datums/mind.dm 282"></a></aside></h3><p>Add an objective to the mind</p><h3 id="proc/get_all_objectives"><aside class="declaration">proc </aside>get_all_objectives<aside>(include_team) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/mind.dm#L264"><img src="git.png" width="16" height="16" title="code/datums/mind.dm 264"></a></aside></h3><p>Gets every objective this mind owns, including all of those from any antag datums and teams they have, and returns them as a list.</p><h3 id="proc/get_hijack_speed"><aside class="declaration">proc </aside>get_hijack_speed<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/mind.dm#L1814"><img src="git.png" width="16" height="16" title="code/datums/mind.dm 1814"></a></aside></h3><p>This proc sets the hijack speed for a mob. If greater than zero, they can hijack. Outputs in seconds.</p><h3 id="proc/has_antag_datum"><aside class="declaration">proc </aside>has_antag_datum<aside>(datum_type, check_subtypes) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/mind.dm#L1831"><img src="git.png" width="16" height="16" title="code/datums/mind.dm 1831"></a></aside></h3><p>Returns an antag datum instance if the src mind has the specified <code>datum_type</code>. Returns <code>null</code> otherwise.</p>
|
||
<p>Arguments:</p>
|
||
<ul>
|
||
<li>datum_type - an antag datum typepath</li>
|
||
<li>check_subtypes - TRUE if this proc will consider subtypes of <code>datum_type</code> as valid. FALSE if only the exact same type should be considered.</li>
|
||
</ul><h3 id="proc/has_objectives"><aside class="declaration">proc </aside>has_objectives<aside>(include_team) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/mind.dm#L248"><img src="git.png" width="16" height="16" title="code/datums/mind.dm 248"></a></aside></h3><p>A quicker version of get_all_objectives() but only for seeing if they have any objectives at all</p><h3 id="proc/remove_all_antag_datums"><aside class="declaration">proc </aside>remove_all_antag_datums<aside>(handle_target_cryo) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/mind.dm#L1803"><img src="git.png" width="16" height="16" title="code/datums/mind.dm 1803"></a></aside></h3><p>Removes all antag datums from the src mind.</p>
|
||
<p>Use this over doing <code>QDEL_LIST_CONTENTS(antag_datums)</code>.</p><h3 id="proc/remove_antag_datum"><aside class="declaration">proc </aside>remove_antag_datum<aside>(datum_type, check_subtypes, silent_removal) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/mind.dm#L1792"><img src="git.png" width="16" height="16" title="code/datums/mind.dm 1792"></a></aside></h3><p>Remove the specified <code>datum_type</code> antag datum from the src mind.</p>
|
||
<p>Arguments:</p>
|
||
<ul>
|
||
<li>datum_type - an antag datum typepath</li>
|
||
</ul><h3 id="proc/remove_mind_objective"><aside class="declaration">proc </aside>remove_mind_objective<aside>(/<a href="datum.html">datum</a>/<a href="datum/objective.html">objective</a>/O, remove_from_everything) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/mind.dm#L293"><img src="git.png" width="16" height="16" title="code/datums/mind.dm 293"></a></aside></h3><p>Completely remove the given objective from the mind, and include antagdatums/teams if remove_from_everything is true</p></main><footer>paradise.dme <a href="https://github.com/ParadiseSS13/Paradise/tree/8a8a00a2a9bec485351e5f219982b7315d3504fa">8a8a00a</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.11.0</a></footer></body></html> |