sheepishgoat
11 lines
12 KiB
HTML
11 lines
12 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/job - /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/job.html#var">Var Details</a> - <a href="datum/job.html#proc">Proc Details</a></header><main><h1>job <aside>/<a href="datum.html">datum</a>/<a href="datum/job.html">job</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/jobs/job_types/_job.dm#L1"><img src="git.png" width="16" height="16" title="code/modules/jobs/job_types/_job.dm 1"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/job.html#var/allow_bureaucratic_error">allow_bureaucratic_error</a></th><td>Should this job be allowed to be picked for the bureaucratic error event?</td></tr><tr><th><a href="datum/job.html#var/alt_titles">alt_titles</a></th><td>What alternate titles does this job currently have?</td></tr><tr><th><a href="datum/job.html#var/always_can_respawn_as">always_can_respawn_as</a></th><td>Can you always join as this job even while respawning (should probably only be on for assistant)</td></tr><tr><th><a href="datum/job.html#var/considered_combat_role">considered_combat_role</a></th><td>Is this job considered a combat role for respawning? (usually sec/command)</td></tr><tr><th><a href="datum/job.html#var/departments">departments</a></th><td>Bitfield of departments this job belongs wit</td></tr><tr><th><a href="datum/job.html#var/exclusive_mail_goodies">exclusive_mail_goodies</a></th><td>If this job's mail goodies compete with generic goodies.</td></tr><tr><th><a href="datum/job.html#var/family_heirlooms">family_heirlooms</a></th><td>List of family heirlooms this job can get with the family heirloom quirk. List of types.</td></tr><tr><th><a href="datum/job.html#var/mail_goodies">mail_goodies</a></th><td>Goodies that can be received via the mail system.
|
||
Keep the _job definition for this empty and use /obj/item/mail to define general gifts.</td></tr><tr><th><a href="datum/job.html#var/random_spawns_possible">random_spawns_possible</a></th><td>Is this job affected by weird spawns like the ones from station traits</td></tr><tr><th><a href="datum/job.html#var/starting_modifiers">starting_modifiers</a></th><td>Starting skill modifiers.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/job.html#proc/after_latejoin_spawn">after_latejoin_spawn</a></th><td>Called after a successful latejoin spawn.
|
||
Client is in the mob.
|
||
This happens after after_spawn()</td></tr><tr><th><a href="datum/job.html#proc/after_roundstart_spawn">after_roundstart_spawn</a></th><td>Called after a successful roundstart spawn.
|
||
Client is not yet in the mob.
|
||
This happens after after_spawn()</td></tr><tr><th><a href="datum/job.html#proc/get_default_roundstart_spawn_point">get_default_roundstart_spawn_point</a></th><td>Handles finding and picking a valid roundstart effect landmark spawn point, in case no uncommon different spawning events occur.</td></tr><tr><th><a href="datum/job.html#proc/get_latejoin_spawn_point">get_latejoin_spawn_point</a></th><td>Finds a valid latejoin spawn point, checking for events and special conditions.</td></tr><tr><th><a href="datum/job.html#proc/get_mail_goodies">get_mail_goodies</a></th><td>An overridable getter for more dynamic goodies.</td></tr><tr><th><a href="datum/job.html#proc/get_roundstart_spawn_point">get_roundstart_spawn_point</a></th><td>Returns an atom where the mob should spawn in.</td></tr><tr><th><a href="datum/job.html#proc/map_check">map_check</a></th><td>Checks if we should be created on a certain map</td></tr><tr><th><a href="datum/job.html#proc/process_map_overrides">process_map_overrides</a></th><td>Processes map specific overrides</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/allow_bureaucratic_error"><aside class="declaration">var </aside>allow_bureaucratic_error <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/jobs/job_types/_job.dm#L70"><img src="git.png" width="16" height="16" title="code/modules/jobs/job_types/_job.dm 70"></a></h3><p>Should this job be allowed to be picked for the bureaucratic error event?</p><h3 id="var/alt_titles"><aside class="declaration">var </aside>alt_titles <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/jobs/job_types/_job.dm#L67"><img src="git.png" width="16" height="16" title="code/modules/jobs/job_types/_job.dm 67"></a></h3><p>What alternate titles does this job currently have?</p><h3 id="var/always_can_respawn_as"><aside class="declaration">var </aside>always_can_respawn_as <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/jobs/job_types/_job.dm#L103"><img src="git.png" width="16" height="16" title="code/modules/jobs/job_types/_job.dm 103"></a></h3><p>Can you always join as this job even while respawning (should probably only be on for assistant)</p><h3 id="var/considered_combat_role"><aside class="declaration">var </aside>considered_combat_role <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/jobs/job_types/_job.dm#L105"><img src="git.png" width="16" height="16" title="code/modules/jobs/job_types/_job.dm 105"></a></h3><p>Is this job considered a combat role for respawning? (usually sec/command)</p><h3 id="var/departments"><aside class="declaration">var </aside>departments <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/jobs/job_types/_job.dm#L83"><img src="git.png" width="16" height="16" title="code/modules/jobs/job_types/_job.dm 83"></a></h3><p>Bitfield of departments this job belongs wit</p><h3 id="var/exclusive_mail_goodies"><aside class="declaration">var </aside>exclusive_mail_goodies <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/jobs/job_types/_job.dm#L91"><img src="git.png" width="16" height="16" title="code/modules/jobs/job_types/_job.dm 91"></a></h3><p>If this job's mail goodies compete with generic goodies.</p><h3 id="var/family_heirlooms"><aside class="declaration">var </aside>family_heirlooms <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/jobs/job_types/_job.dm#L76"><img src="git.png" width="16" height="16" title="code/modules/jobs/job_types/_job.dm 76"></a></h3><p>List of family heirlooms this job can get with the family heirloom quirk. List of types.</p><h3 id="var/mail_goodies"><aside class="declaration">var </aside>mail_goodies <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/jobs/job_types/_job.dm#L88"><img src="git.png" width="16" height="16" title="code/modules/jobs/job_types/_job.dm 88"></a></h3><p>Goodies that can be received via the mail system.
|
||
Keep the _job definition for this empty and use /obj/item/mail to define general gifts.</p><h3 id="var/random_spawns_possible"><aside class="declaration">var </aside>random_spawns_possible <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/jobs/job_types/_job.dm#L73"><img src="git.png" width="16" height="16" title="code/modules/jobs/job_types/_job.dm 73"></a></h3><p>Is this job affected by weird spawns like the ones from station traits</p><h3 id="var/starting_modifiers"><aside class="declaration">var </aside>starting_modifiers <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/jobs/job_types/_job.dm#L99"><img src="git.png" width="16" height="16" title="code/modules/jobs/job_types/_job.dm 99"></a></h3><p>Starting skill modifiers.</p><h2 id="proc">Proc Details</h2><h3 id="proc/after_latejoin_spawn"><aside class="declaration">proc </aside>after_latejoin_spawn<aside>(/<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/spawning) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/jobs/job_types/_job.dm#L417"><img src="git.png" width="16" height="16" title="code/modules/jobs/job_types/_job.dm 417"></a></aside></h3><p>Called after a successful latejoin spawn.
|
||
Client is in the mob.
|
||
This happens after after_spawn()</p><h3 id="proc/after_roundstart_spawn"><aside class="declaration">proc </aside>after_roundstart_spawn<aside>(/<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/spawning, /<a href="client.html">client</a>/player_client) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/jobs/job_types/_job.dm#L408"><img src="git.png" width="16" height="16" title="code/modules/jobs/job_types/_job.dm 408"></a></aside></h3><p>Called after a successful roundstart spawn.
|
||
Client is not yet in the mob.
|
||
This happens after after_spawn()</p><h3 id="proc/get_default_roundstart_spawn_point"><aside class="declaration">proc </aside>get_default_roundstart_spawn_point<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/jobs/job_types/_job.dm#L359"><img src="git.png" width="16" height="16" title="code/modules/jobs/job_types/_job.dm 359"></a></aside></h3><p>Handles finding and picking a valid roundstart effect landmark spawn point, in case no uncommon different spawning events occur.</p><h3 id="proc/get_latejoin_spawn_point"><aside class="declaration">proc </aside>get_latejoin_spawn_point<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/jobs/job_types/_job.dm#L372"><img src="git.png" width="16" height="16" title="code/modules/jobs/job_types/_job.dm 372"></a></aside></h3><p>Finds a valid latejoin spawn point, checking for events and special conditions.</p><h3 id="proc/get_mail_goodies"><aside class="declaration">proc </aside>get_mail_goodies<aside>(/<a href="mob.html">mob</a>/recipient) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/jobs/job_types/_job.dm#L422"><img src="git.png" width="16" height="16" title="code/modules/jobs/job_types/_job.dm 422"></a></aside></h3><p>An overridable getter for more dynamic goodies.</p><h3 id="proc/get_roundstart_spawn_point"><aside class="declaration">proc </aside>get_roundstart_spawn_point<aside>(/<a href="mob.html">mob</a>/M) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/jobs/job_types/_job.dm#L380"><img src="git.png" width="16" height="16" title="code/modules/jobs/job_types/_job.dm 380"></a></aside></h3><p>Returns an atom where the mob should spawn in.</p><h3 id="proc/map_check"><aside class="declaration">proc </aside>map_check<aside>(/<a href="datum.html">datum</a>/<a href="datum/map_config.html">map_config</a>/C) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/jobs/job_types/_job.dm#L110"><img src="git.png" width="16" height="16" title="code/modules/jobs/job_types/_job.dm 110"></a></aside></h3><p>Checks if we should be created on a certain map</p><h3 id="proc/process_map_overrides"><aside class="declaration">proc </aside>process_map_overrides<aside>(/<a href="datum.html">datum</a>/<a href="datum/map_config.html">map_config</a>/C) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/jobs/job_types/_job.dm#L116"><img src="git.png" width="16" height="16" title="code/modules/jobs/job_types/_job.dm 116"></a></aside></h3><p>Processes map specific overrides</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> |