sheepishgoat
1 line
9.0 KiB
HTML
1 line
9.0 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/config_entry - /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/config_entry.html#var">Var Details</a> - <a href="datum/config_entry.html#proc">Proc Details</a></header><main><h1>config_entry <aside>/<a href="datum.html">datum</a>/<a href="datum/config_entry.html">config_entry</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/configuration/config_entry.dm#L9"><img src="git.png" width="16" height="16" title="code/controllers/configuration/config_entry.dm 9"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/config_entry.html#var/abstract_type">abstract_type</a></th><td>Do not instantiate if type matches this</td></tr><tr><th><a href="datum/config_entry.html#var/config_entry_value">config_entry_value</a></th><td>The configured value for this entry. This shouldn't be initialized in code, instead set default</td></tr><tr><th><a href="datum/config_entry.html#var/default">default</a></th><td>Read-only default value for this config entry, used for resetting value to defaults when necessary. This is what config_entry_value is initially set to</td></tr><tr><th><a href="datum/config_entry.html#var/default_protection">default_protection</a></th><td>Stores the original protection configuration, used for set_default()</td></tr><tr><th><a href="datum/config_entry.html#var/deprecated_by">deprecated_by</a></th><td>The config name of a configuration type that depricates this, if it exists</td></tr><tr><th><a href="datum/config_entry.html#var/dupes_allowed">dupes_allowed</a></th><td>Controls if error is thrown when duplicate configuration values for this entry type are encountered</td></tr><tr><th><a href="datum/config_entry.html#var/modified">modified</a></th><td>Set to TRUE if the default has been overridden by a config entry</td></tr><tr><th><a href="datum/config_entry.html#var/name">name</a></th><td>Read-only, this is determined by the last portion of the derived entry type</td></tr><tr><th><a href="datum/config_entry.html#var/postload_required">postload_required</a></th><td>Requires running OnPostload()</td></tr><tr><th><a href="datum/config_entry.html#var/protection">protection</a></th><td>The /datum/config_entry type that supercedes this one</td></tr><tr><th><a href="datum/config_entry.html#var/resident_file">resident_file</a></th><td>The file which this was loaded from, if any</td></tr><tr><th><a href="datum/config_entry.html#var/vv_VAS">vv_VAS</a></th><td>Force validate and set on VV. VAS proccall guard will run regardless.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/config_entry.html#proc/set_default">set_default</a></th><td>Returns the value of the configuration datum to its default, used for resetting a config value. Note this also sets the protection back to default.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/abstract_type"><aside class="declaration">var </aside>abstract_type <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/configuration/config_entry.dm#L25"><img src="git.png" width="16" height="16" title="code/controllers/configuration/config_entry.dm 25"></a></h3><p>Do not instantiate if type matches this</p><h3 id="var/config_entry_value"><aside class="declaration">var </aside>config_entry_value <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/configuration/config_entry.dm#L13"><img src="git.png" width="16" height="16" title="code/controllers/configuration/config_entry.dm 13"></a></h3><p>The configured value for this entry. This shouldn't be initialized in code, instead set default</p><h3 id="var/default"><aside class="declaration">var </aside>default <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/configuration/config_entry.dm#L15"><img src="git.png" width="16" height="16" title="code/controllers/configuration/config_entry.dm 15"></a></h3><p>Read-only default value for this config entry, used for resetting value to defaults when necessary. This is what config_entry_value is initially set to</p><h3 id="var/default_protection"><aside class="declaration">var </aside>default_protection <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/configuration/config_entry.dm#L35"><img src="git.png" width="16" height="16" title="code/controllers/configuration/config_entry.dm 35"></a></h3><p>Stores the original protection configuration, used for set_default()</p><h3 id="var/deprecated_by"><aside class="declaration">var </aside>deprecated_by <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/configuration/config_entry.dm#L21"><img src="git.png" width="16" height="16" title="code/controllers/configuration/config_entry.dm 21"></a></h3><p>The config name of a configuration type that depricates this, if it exists</p><h3 id="var/dupes_allowed"><aside class="declaration">var </aside>dupes_allowed <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/configuration/config_entry.dm#L31"><img src="git.png" width="16" height="16" title="code/controllers/configuration/config_entry.dm 31"></a></h3><p>Controls if error is thrown when duplicate configuration values for this entry type are encountered</p><h3 id="var/modified"><aside class="declaration">var </aside>modified <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/configuration/config_entry.dm#L19"><img src="git.png" width="16" height="16" title="code/controllers/configuration/config_entry.dm 19"></a></h3><p>Set to TRUE if the default has been overridden by a config entry</p><h3 id="var/name"><aside class="declaration">var </aside>name <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/configuration/config_entry.dm#L11"><img src="git.png" width="16" height="16" title="code/controllers/configuration/config_entry.dm 11"></a></h3><p>Read-only, this is determined by the last portion of the derived entry type</p><h3 id="var/postload_required"><aside class="declaration">var </aside>postload_required <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/configuration/config_entry.dm#L29"><img src="git.png" width="16" height="16" title="code/controllers/configuration/config_entry.dm 29"></a></h3><p>Requires running OnPostload()</p><h3 id="var/protection"><aside class="declaration">var </aside>protection <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/configuration/config_entry.dm#L23"><img src="git.png" width="16" height="16" title="code/controllers/configuration/config_entry.dm 23"></a></h3><p>The /datum/config_entry type that supercedes this one</p><h3 id="var/resident_file"><aside class="declaration">var </aside>resident_file <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/configuration/config_entry.dm#L17"><img src="git.png" width="16" height="16" title="code/controllers/configuration/config_entry.dm 17"></a></h3><p>The file which this was loaded from, if any</p><h3 id="var/vv_VAS"><aside class="declaration">var </aside>vv_VAS <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/configuration/config_entry.dm#L27"><img src="git.png" width="16" height="16" title="code/controllers/configuration/config_entry.dm 27"></a></h3><p>Force validate and set on VV. VAS proccall guard will run regardless.</p><h2 id="proc">Proc Details</h2><h3 id="proc/set_default"><aside class="declaration">proc </aside>set_default<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/controllers/configuration/config_entry.dm#L49"><img src="git.png" width="16" height="16" title="code/controllers/configuration/config_entry.dm 49"></a></aside></h3><p>Returns the value of the configuration datum to its default, used for resetting a config value. Note this also sets the protection back to default.</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> |