cyberpresidentvanellope/Paradise
1
0
Fork 0
mirror of https://github.com/ParadiseSS13/Paradise.git synced 2026-08-26 13:37:58 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
Paradise/datum/objective/contract.html
T

22 lines
11 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/objective/contract - 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/objective/contract.html#var">Var Details</a> - <a href="datum/objective/contract.html#proc">Proc Details</a></header><main><h1>Contract Objective <aside>/<a href="datum.html">datum</a>/<a href="datum/objective.html">objective</a>/<a href="datum/objective/contract.html">contract</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/antagonists/traitor/contractor/datums/objective_contract.dm#L6"><img src="git.png" width="16" height="16" title="code/modules/antagonists/traitor/contractor/datums/objective_contract.dm 6"></a></h1><p>Describes the target to kidnap and the extraction area of a <a href="datum/syndicate_contract.html" title="/datum/syndicate_contract">/datum/syndicate_contract</a>.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/objective/contract.html#var/candidate_zones">candidate_zones</a></th><td>Associated lazy list of areas the contractor can pick from and extract the kidnapee there.
Structure: EXTRACTION_DIFFICULTY_(EASY|MEDIUM|HARD) =&gt; /area</td></tr><tr><th><a href="datum/objective/contract.html#var/chosen_difficulty">chosen_difficulty</a></th><td>The contract's difficulty. Determines the reward on completion.</td></tr><tr><th><a href="datum/objective/contract.html#var/extraction_zone">extraction_zone</a></th><td>The designated area where the kidnapee must be extracted to complete the objective.</td></tr><tr><th><a href="datum/objective/contract.html#var/forbidden_jobs">forbidden_jobs</a></th><td>Jobs that cannot be the kidnapping target.</td></tr><tr><th><a href="datum/objective/contract.html#var/name_fixer">name_fixer</a></th><td>Name fixer regex because area names have rogue characters sometimes.</td></tr><tr><th><a href="datum/objective/contract.html#var/owning_contract">owning_contract</a></th><td>The owning <a href="datum/syndicate_contract.html" title="/datum/syndicate_contract">/datum/syndicate_contract</a>.</td></tr><tr><th><a href="datum/objective/contract.html#var/possible_zone_names">possible_zone_names</a></th><td>Static whitelist of area names that can be used as an extraction zone, structured by difficulty.
An area's difficulty should be measured in how crowded it generally is, how out of the way it is and so on.
Outdoor or invalid areas are filtered out.
Structure: EXTRACTION_DIFFICULTY_(EASY|MEDIUM|HARD) =&gt; list(<area name>)</td></tr><tr><th><a href="datum/objective/contract.html#var/possible_zones">possible_zones</a></th><td>Static list that is basically <a href="datum/objective/contract.html#var/possible_zone_names" title="/datum/objective/contract">/datum/objective/contract/var/possible_zone_names</a> but with area names replaced by /area objects if available.</td></tr><tr><th><a href="datum/objective/contract.html#var/target_blacklist">target_blacklist</a></th><td>List of people who cannot be selected as contract target.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/objective/contract.html#proc/can_start_extraction_process">can_start_extraction_process</a></th><td>Returns whether the extraction process can be started.</td></tr><tr><th><a href="datum/objective/contract.html#proc/choose_difficulty">choose_difficulty</a></th><td>Updates the objective's information with the given difficulty.</td></tr><tr><th><a href="datum/objective/contract.html#proc/pick_candidate_zone">pick_candidate_zone</a></th><td>Assigns a randomly selected zone to the contract's selectable zone at the given difficulty.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/candidate_zones"><aside class="declaration">var </aside>candidate_zones <aside>– /list/<a href="area.html">area</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/antagonists/traitor/contractor/datums/objective_contract.dm#L156"><img src="git.png" width="16" height="16" title="code/modules/antagonists/traitor/contractor/datums/objective_contract.dm 156"></a></h3><p>Associated lazy list of areas the contractor can pick from and extract the kidnapee there.
Structure: EXTRACTION_DIFFICULTY_(EASY|MEDIUM|HARD) =&gt; /area</p><h3 id="var/chosen_difficulty"><aside class="declaration">var </aside>chosen_difficulty <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/antagonists/traitor/contractor/datums/objective_contract.dm#L153"><img src="git.png" width="16" height="16" title="code/modules/antagonists/traitor/contractor/datums/objective_contract.dm 153"></a></h3><p>The contract's difficulty. Determines the reward on completion.</p><h3 id="var/extraction_zone"><aside class="declaration">var </aside>extraction_zone <aside>– /<a href="area.html">area</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/antagonists/traitor/contractor/datums/objective_contract.dm#L151"><img src="git.png" width="16" height="16" title="code/modules/antagonists/traitor/contractor/datums/objective_contract.dm 151"></a></h3><p>The designated area where the kidnapee must be extracted to complete the objective.</p><h3 id="var/forbidden_jobs"><aside class="declaration">var </aside>forbidden_jobs <aside>– /static/list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/antagonists/traitor/contractor/datums/objective_contract.dm#L9"><img src="git.png" width="16" height="16" title="code/modules/antagonists/traitor/contractor/datums/objective_contract.dm 9"></a></h3><p>Jobs that cannot be the kidnapping target.</p><h3 id="var/name_fixer"><aside class="declaration">var </aside>name_fixer <aside>– /static/regex</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/antagonists/traitor/contractor/datums/objective_contract.dm#L164"><img src="git.png" width="16" height="16" title="code/modules/antagonists/traitor/contractor/datums/objective_contract.dm 164"></a></h3><p>Name fixer regex because area names have rogue characters sometimes.</p><h3 id="var/owning_contract"><aside class="declaration">var </aside>owning_contract <aside>– /<a href="datum.html">datum</a>/<a href="datum/syndicate_contract.html">syndicate_contract</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/antagonists/traitor/contractor/datums/objective_contract.dm#L162"><img src="git.png" width="16" height="16" title="code/modules/antagonists/traitor/contractor/datums/objective_contract.dm 162"></a></h3><p>The owning <a href="datum/syndicate_contract.html" title="/datum/syndicate_contract">/datum/syndicate_contract</a>.</p><h3 id="var/possible_zone_names"><aside class="declaration">var </aside>possible_zone_names <aside>– /static/alist</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/antagonists/traitor/contractor/datums/objective_contract.dm#L17"><img src="git.png" width="16" height="16" title="code/modules/antagonists/traitor/contractor/datums/objective_contract.dm 17"></a></h3><p>Static whitelist of area names that can be used as an extraction zone, structured by difficulty.
An area's difficulty should be measured in how crowded it generally is, how out of the way it is and so on.
Outdoor or invalid areas are filtered out.
Structure: EXTRACTION_DIFFICULTY_(EASY|MEDIUM|HARD) =&gt; list(<area name>)</p><h3 id="var/possible_zones"><aside class="declaration">var </aside>possible_zones <aside>– /static/list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/antagonists/traitor/contractor/datums/objective_contract.dm#L160"><img src="git.png" width="16" height="16" title="code/modules/antagonists/traitor/contractor/datums/objective_contract.dm 160"></a></h3><p>Static list that is basically <a href="datum/objective/contract.html#var/possible_zone_names" title="/datum/objective/contract">/datum/objective/contract/var/possible_zone_names</a> but with area names replaced by /area objects if available.</p><h3 id="var/target_blacklist"><aside class="declaration">var </aside>target_blacklist <aside>– /list/<a href="datum.html">datum</a>/<a href="datum/mind.html">mind</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/antagonists/traitor/contractor/datums/objective_contract.dm#L158"><img src="git.png" width="16" height="16" title="code/modules/antagonists/traitor/contractor/datums/objective_contract.dm 158"></a></h3><p>List of people who cannot be selected as contract target.</p><h2 id="proc">Proc Details</h2><h3 id="proc/can_start_extraction_process"><aside class="declaration">proc </aside>can_start_extraction_process<aside>(/<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>/extraction_caller) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/antagonists/traitor/contractor/datums/objective_contract.dm#L245"><img src="git.png" width="16" height="16" title="code/modules/antagonists/traitor/contractor/datums/objective_contract.dm 245"></a></aside></h3><p>Returns whether the extraction process can be started.</p>
<p>Arguments:</p>
<ul>
<li>caller - The person trying to call the extraction.</li>
</ul><h3 id="proc/choose_difficulty"><aside class="declaration">proc </aside>choose_difficulty<aside>(difficulty, /<a href="datum.html">datum</a>/<a href="datum/syndicate_contract.html">syndicate_contract</a>/S) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/antagonists/traitor/contractor/datums/objective_contract.dm#L228"><img src="git.png" width="16" height="16" title="code/modules/antagonists/traitor/contractor/datums/objective_contract.dm 228"></a></aside></h3><p>Updates the objective's information with the given difficulty.</p>
<p>Arguments:</p>
<ul>
<li>difficulty - The chosen difficulty.</li>
<li>S - The parent <a href="datum/syndicate_contract.html" title="/datum/syndicate_contract">/datum/syndicate_contract</a>.</li>
</ul><h3 id="proc/pick_candidate_zone"><aside class="declaration">proc </aside>pick_candidate_zone<aside>(difficulty) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/antagonists/traitor/contractor/datums/objective_contract.dm#L216"><img src="git.png" width="16" height="16" title="code/modules/antagonists/traitor/contractor/datums/objective_contract.dm 216"></a></aside></h3><p>Assigns a randomly selected zone to the contract's selectable zone at the given difficulty.</p>
<p>Arguments:</p>
<ul>
<li>difficulty - The difficulty to assign.</li>
</ul></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>
Reference in New Issue View Git Blame Copy Permalink