10 lines
4.2 KiB
HTML
10 lines
4.2 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><link rel="stylesheet" href="dmdoc.css"><title>/procpath - /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="procpath.html#var">Var Details</a></header><main><h1>procpath <aside>/<a href="procpath.html">procpath</a></aside><aside> inherits /<a href="datum.html">datum</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__DEFINES/procpath.dm#L13"><img src="git.png" width="16" height="16" title="code/__DEFINES/procpath.dm 13"></a></h1><p>Represents a proc or verb path.</p>
|
||
<p>Despite having no DM-defined static type, proc paths have some variables,
|
||
listed below. These are not modifiable, but for a given procpath P,
|
||
<code>new P(null, "Name", "Desc")</code> can be used to create a new procpath with the
|
||
same code but new <code>name</code> and <code>desc</code> values. The other variables cannot be
|
||
changed in this way.</p>
|
||
<p>This type exists only to act as an annotation, providing reasonable static
|
||
typing for procpaths. Previously, types like <code>/atom/verb</code> were used, with
|
||
the <code>name</code> and <code>desc</code> vars of <code>/atom</code> thus being accessible. Proc and verb
|
||
paths will fail <code>istype</code> and <code>ispath</code> checks against <code>/procpath</code>.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="procpath.html#var/category">category</a></th><td>The category or tab the verb will appear in.</td></tr><tr><th><a href="procpath.html#var/desc">desc</a></th><td>The verb's help text or description.</td></tr><tr><th><a href="procpath.html#var/hidden">hidden</a></th><td>Whether or not the verb appears in statpanel and commandbar when you press space</td></tr><tr><th><a href="procpath.html#var/invisibility">invisibility</a></th><td>Only clients/mobs with <code>see_invisibility</code> higher can use the verb.</td></tr><tr><th><a href="procpath.html#var/name">name</a></th><td>A text string of the verb's name.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/category"><aside class="declaration">var </aside>category <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__DEFINES/procpath.dm#L22"><img src="git.png" width="16" height="16" title="code/__DEFINES/procpath.dm 22"></a></h3><p>The category or tab the verb will appear in.</p><h3 id="var/desc"><aside class="declaration">var </aside>desc <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__DEFINES/procpath.dm#L20"><img src="git.png" width="16" height="16" title="code/__DEFINES/procpath.dm 20"></a></h3><p>The verb's help text or description.</p><h3 id="var/hidden"><aside class="declaration">var </aside>hidden <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__DEFINES/qdel.dm#L1"><img src="git.png" width="16" height="16" title="code/__DEFINES/qdel.dm 1"></a></h3><p>Whether or not the verb appears in statpanel and commandbar when you press space</p><h3 id="var/invisibility"><aside class="declaration">var </aside>invisibility <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__DEFINES/procpath.dm#L24"><img src="git.png" width="16" height="16" title="code/__DEFINES/procpath.dm 24"></a></h3><p>Only clients/mobs with <code>see_invisibility</code> higher can use the verb.</p><h3 id="var/name"><aside class="declaration">var </aside>name <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__DEFINES/procpath.dm#L18"><img src="git.png" width="16" height="16" title="code/__DEFINES/procpath.dm 18"></a></h3><p>A text string of the verb's name.</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> |