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

5 lines
12 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/tcomms_message - 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/tcomms_message.html#var">Var Details</a> - <a href="datum/tcomms_message.html#proc">Proc Details</a></header><main><h1>Telecommunications Message <aside>/<a href="datum.html">datum</a>/<a href="datum/tcomms_message.html">tcomms_message</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/machinery/tcomms/tcomms_base.dm#L174"><img src="git.png" width="16" height="16" title="code/game/machinery/tcomms/tcomms_base.dm 174"></a></h1><p>Datum which holds all the data for a message being sent</p>
<p>This used to be a single associative list with just keys and values
It had no typepath or presence checking, and was absolutely awful to work with
This fixes that</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/tcomms_message.html#var/connection">connection</a></th><td>Origin of the signal</td></tr><tr><th><a href="datum/tcomms_message.html#var/follow_target">follow_target</a></th><td>Follow target for AI use</td></tr><tr><th><a href="datum/tcomms_message.html#var/freq">freq</a></th><td>What frequency the message is sent on</td></tr><tr><th><a href="datum/tcomms_message.html#var/message_pieces">message_pieces</a></th><td>Pieces of the message</td></tr><tr><th><a href="datum/tcomms_message.html#var/needs_tcomms">needs_tcomms</a></th><td>Did the signal come from a device that requires tcomms to function</td></tr><tr><th><a href="datum/tcomms_message.html#var/pass">pass</a></th><td>Should this signal be re-broadcasted (Can be modified by NTTC, defaults to TRUE)</td></tr><tr><th><a href="datum/tcomms_message.html#var/pre_modify_name">pre_modify_name</a></th><td>sender_name before modify_message modifies it, because it introduces html tags.</td></tr><tr><th><a href="datum/tcomms_message.html#var/radio">radio</a></th><td>The radio it was sent from</td></tr><tr><th><a href="datum/tcomms_message.html#var/reject">reject</a></th><td>Is this signal meant to be rejected</td></tr><tr><th><a href="datum/tcomms_message.html#var/sender">sender</a></th><td>Who sent it</td></tr><tr><th><a href="datum/tcomms_message.html#var/sender_job">sender_job</a></th><td>What job are they</td></tr><tr><th><a href="datum/tcomms_message.html#var/sender_name">sender_name</a></th><td>Who sent the message</td></tr><tr><th><a href="datum/tcomms_message.html#var/sender_rank">sender_rank</a></th><td>What rank are they (this is used for formatting)</td></tr><tr><th><a href="datum/tcomms_message.html#var/signal_type">signal_type</a></th><td>The signal type (See defines/radio.dm)</td></tr><tr><th><a href="datum/tcomms_message.html#var/source_level">source_level</a></th><td>Source Z-level</td></tr><tr><th><a href="datum/tcomms_message.html#var/verbage">verbage</a></th><td>Verbage used</td></tr><tr><th><a href="datum/tcomms_message.html#var/vmask">vmask</a></th><td>Was it sent with a voice changer</td></tr><tr><th><a href="datum/tcomms_message.html#var/vname">vname</a></th><td>Voice name if the person doesnt have a name (diona, alien, etc)</td></tr><tr><th><a href="datum/tcomms_message.html#var/zlevels">zlevels</a></th><td>List of all channels this can be sent or received on</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/tcomms_message.html#proc/Destroy">Destroy</a></th><td>Destructor for the TCM datum.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/connection"><aside class="declaration">var </aside>connection <aside>– /<a href="datum.html">datum</a>/radio_frequency</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/machinery/tcomms/tcomms_base.dm#L192"><img src="git.png" width="16" height="16" title="code/game/machinery/tcomms/tcomms_base.dm 192"></a></h3><p>Origin of the signal</p><h3 id="var/follow_target"><aside class="declaration">var </aside>follow_target <aside>– /<a href="atom.html">atom</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/machinery/tcomms/tcomms_base.dm#L202"><img src="git.png" width="16" height="16" title="code/game/machinery/tcomms/tcomms_base.dm 202"></a></h3><p>Follow target for AI use</p><h3 id="var/freq"><aside class="declaration">var </aside>freq <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/machinery/tcomms/tcomms_base.dm#L186"><img src="git.png" width="16" height="16" title="code/game/machinery/tcomms/tcomms_base.dm 186"></a></h3><p>What frequency the message is sent on</p><h3 id="var/message_pieces"><aside class="declaration">var </aside>message_pieces <aside>– /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/machinery/tcomms/tcomms_base.dm#L182"><img src="git.png" width="16" height="16" title="code/game/machinery/tcomms/tcomms_base.dm 182"></a></h3><p>Pieces of the message</p><h3 id="var/needs_tcomms"><aside class="declaration">var </aside>needs_tcomms <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/machinery/tcomms/tcomms_base.dm#L190"><img src="git.png" width="16" height="16" title="code/game/machinery/tcomms/tcomms_base.dm 190"></a></h3><p>Did the signal come from a device that requires tcomms to function</p><h3 id="var/pass"><aside class="declaration">var </aside>pass <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/machinery/tcomms/tcomms_base.dm#L212"><img src="git.png" width="16" height="16" title="code/game/machinery/tcomms/tcomms_base.dm 212"></a></h3><p>Should this signal be re-broadcasted (Can be modified by NTTC, defaults to TRUE)</p><h3 id="var/pre_modify_name"><aside class="declaration">var </aside>pre_modify_name <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/machinery/tcomms/tcomms_base.dm#L208"><img src="git.png" width="16" height="16" title="code/game/machinery/tcomms/tcomms_base.dm 208"></a></h3><p>sender_name before modify_message modifies it, because it introduces html tags.</p><h3 id="var/radio"><aside class="declaration">var </aside>radio <aside>– /<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/<a href="obj/item/radio.html">radio</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/machinery/tcomms/tcomms_base.dm#L196"><img src="git.png" width="16" height="16" title="code/game/machinery/tcomms/tcomms_base.dm 196"></a></h3><p>The radio it was sent from</p><h3 id="var/reject"><aside class="declaration">var </aside>reject <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/machinery/tcomms/tcomms_base.dm#L204"><img src="git.png" width="16" height="16" title="code/game/machinery/tcomms/tcomms_base.dm 204"></a></h3><p>Is this signal meant to be rejected</p><h3 id="var/sender"><aside class="declaration">var </aside>sender <aside>– /<a href="atom.html">atom</a>/<a href="atom/movable.html">movable</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/machinery/tcomms/tcomms_base.dm#L194"><img src="git.png" width="16" height="16" title="code/game/machinery/tcomms/tcomms_base.dm 194"></a></h3><p>Who sent it</p><h3 id="var/sender_job"><aside class="declaration">var </aside>sender_job <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/machinery/tcomms/tcomms_base.dm#L178"><img src="git.png" width="16" height="16" title="code/game/machinery/tcomms/tcomms_base.dm 178"></a></h3><p>What job are they</p><h3 id="var/sender_name"><aside class="declaration">var </aside>sender_name <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/machinery/tcomms/tcomms_base.dm#L176"><img src="git.png" width="16" height="16" title="code/game/machinery/tcomms/tcomms_base.dm 176"></a></h3><p>Who sent the message</p><h3 id="var/sender_rank"><aside class="declaration">var </aside>sender_rank <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/machinery/tcomms/tcomms_base.dm#L180"><img src="git.png" width="16" height="16" title="code/game/machinery/tcomms/tcomms_base.dm 180"></a></h3><p>What rank are they (this is used for formatting)</p><h3 id="var/signal_type"><aside class="declaration">var </aside>signal_type <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/machinery/tcomms/tcomms_base.dm#L198"><img src="git.png" width="16" height="16" title="code/game/machinery/tcomms/tcomms_base.dm 198"></a></h3><p>The signal type (See defines/radio.dm)</p><h3 id="var/source_level"><aside class="declaration">var </aside>source_level <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/machinery/tcomms/tcomms_base.dm#L184"><img src="git.png" width="16" height="16" title="code/game/machinery/tcomms/tcomms_base.dm 184"></a></h3><p>Source Z-level</p><h3 id="var/verbage"><aside class="declaration">var </aside>verbage <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/machinery/tcomms/tcomms_base.dm#L200"><img src="git.png" width="16" height="16" title="code/game/machinery/tcomms/tcomms_base.dm 200"></a></h3><p>Verbage used</p><h3 id="var/vmask"><aside class="declaration">var </aside>vmask <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/machinery/tcomms/tcomms_base.dm#L188"><img src="git.png" width="16" height="16" title="code/game/machinery/tcomms/tcomms_base.dm 188"></a></h3><p>Was it sent with a voice changer</p><h3 id="var/vname"><aside class="declaration">var </aside>vname <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/machinery/tcomms/tcomms_base.dm#L206"><img src="git.png" width="16" height="16" title="code/game/machinery/tcomms/tcomms_base.dm 206"></a></h3><p>Voice name if the person doesnt have a name (diona, alien, etc)</p><h3 id="var/zlevels"><aside class="declaration">var </aside>zlevels <aside>– /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/machinery/tcomms/tcomms_base.dm#L210"><img src="git.png" width="16" height="16" title="code/game/machinery/tcomms/tcomms_base.dm 210"></a></h3><p>List of all channels this can be sent or received on</p><h2 id="proc">Proc Details</h2><h3 id="proc/Destroy">Destroy<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/machinery/tcomms/tcomms_base.dm#L219"><img src="git.png" width="16" height="16" title="code/game/machinery/tcomms/tcomms_base.dm 219"></a></aside></h3><p>Destructor for the TCM datum.</p>
<p>This needs to happen like this so that things dont keep references held in place</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>
Reference in New Issue View Git Blame Copy Permalink