sheepishgoat
1 line
9.3 KiB
HTML
1 line
9.3 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/instrument - /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/instrument.html#var">Var Details</a></header><main><h1>instrument <aside>/<a href="datum.html">datum</a>/<a href="datum/instrument.html">instrument</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/instruments/instrument_data/_instrument_data.dm#L23"><img src="git.png" width="16" height="16" title="code/modules/instruments/instrument_data/_instrument_data.dm 23"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/instrument.html#var/HIGHEST_KEY">HIGHEST_KEY</a></th><td>Don't touch this</td></tr><tr><th><a href="datum/instrument.html#var/LOWEST_KEY">LOWEST_KEY</a></th><td>Don't touch this x2</td></tr><tr><th><a href="datum/instrument.html#var/abstract_type">abstract_type</a></th><td>Used for categorization subtypes</td></tr><tr><th><a href="datum/instrument.html#var/admin_only">admin_only</a></th><td>Oh no - For truly troll instruments.</td></tr><tr><th><a href="datum/instrument.html#var/category">category</a></th><td>Category</td></tr><tr><th><a href="datum/instrument.html#var/id">id</a></th><td>Uniquely identifies this instrument so runtime changes are possible as opposed to paths. If this is unset, things will use path instead.</td></tr><tr><th><a href="datum/instrument.html#var/instrument_flags">instrument_flags</a></th><td>See __DEFINES/flags/instruments.dm</td></tr><tr><th><a href="datum/instrument.html#var/legacy_instrument_ext">legacy_instrument_ext</a></th><td>For legacy instruments, our file extension</td></tr><tr><th><a href="datum/instrument.html#var/legacy_instrument_path">legacy_instrument_path</a></th><td>For legacy instruments, the path to our notes</td></tr><tr><th><a href="datum/instrument.html#var/name">name</a></th><td>Name of the instrument</td></tr><tr><th><a href="datum/instrument.html#var/real_samples">real_samples</a></th><td>Write here however many samples, follow this syntax: "%note num%"='%sample file%' eg. "27"='synthesizer/e2.ogg'. Key must never be lower than 0 and higher than 127</td></tr><tr><th><a href="datum/instrument.html#var/samples">samples</a></th><td>assoc list key = /datum/instrument_key. do not fill this yourself!</td></tr><tr><th><a href="datum/instrument.html#var/songs_using">songs_using</a></th><td>What songs are using us</td></tr><tr><th><a href="datum/instrument.html#var/volume_multiplier">volume_multiplier</a></th><td>Volume multiplier. Synthesized instruments are quite loud and I don't like to cut off potential detail via editing. (someone correct me if this isn't a thing)</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/HIGHEST_KEY"><aside class="declaration">var </aside>HIGHEST_KEY <aside>– /static</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/instruments/instrument_data/_instrument_data.dm#L45"><img src="git.png" width="16" height="16" title="code/modules/instruments/instrument_data/_instrument_data.dm 45"></a></h3><p>Don't touch this</p><h3 id="var/LOWEST_KEY"><aside class="declaration">var </aside>LOWEST_KEY <aside>– /static</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/instruments/instrument_data/_instrument_data.dm#L47"><img src="git.png" width="16" height="16" title="code/modules/instruments/instrument_data/_instrument_data.dm 47"></a></h3><p>Don't touch this x2</p><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/modules/instruments/instrument_data/_instrument_data.dm#L31"><img src="git.png" width="16" height="16" title="code/modules/instruments/instrument_data/_instrument_data.dm 31"></a></h3><p>Used for categorization subtypes</p><h3 id="var/admin_only"><aside class="declaration">var </aside>admin_only <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/instruments/instrument_data/_instrument_data.dm#L49"><img src="git.png" width="16" height="16" title="code/modules/instruments/instrument_data/_instrument_data.dm 49"></a></h3><p>Oh no - For truly troll instruments.</p><h3 id="var/category"><aside class="declaration">var </aside>category <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/instruments/instrument_data/_instrument_data.dm#L29"><img src="git.png" width="16" height="16" title="code/modules/instruments/instrument_data/_instrument_data.dm 29"></a></h3><p>Category</p><h3 id="var/id"><aside class="declaration">var </aside>id <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/instruments/instrument_data/_instrument_data.dm#L27"><img src="git.png" width="16" height="16" title="code/modules/instruments/instrument_data/_instrument_data.dm 27"></a></h3><p>Uniquely identifies this instrument so runtime changes are possible as opposed to paths. If this is unset, things will use path instead.</p><h3 id="var/instrument_flags"><aside class="declaration">var </aside>instrument_flags <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/instruments/instrument_data/_instrument_data.dm#L37"><img src="git.png" width="16" height="16" title="code/modules/instruments/instrument_data/_instrument_data.dm 37"></a></h3><p>See __DEFINES/flags/instruments.dm</p><h3 id="var/legacy_instrument_ext"><aside class="declaration">var </aside>legacy_instrument_ext <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/instruments/instrument_data/_instrument_data.dm#L41"><img src="git.png" width="16" height="16" title="code/modules/instruments/instrument_data/_instrument_data.dm 41"></a></h3><p>For legacy instruments, our file extension</p><h3 id="var/legacy_instrument_path"><aside class="declaration">var </aside>legacy_instrument_path <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/instruments/instrument_data/_instrument_data.dm#L39"><img src="git.png" width="16" height="16" title="code/modules/instruments/instrument_data/_instrument_data.dm 39"></a></h3><p>For legacy instruments, the path to our notes</p><h3 id="var/name"><aside class="declaration">var </aside>name <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/instruments/instrument_data/_instrument_data.dm#L25"><img src="git.png" width="16" height="16" title="code/modules/instruments/instrument_data/_instrument_data.dm 25"></a></h3><p>Name of the instrument</p><h3 id="var/real_samples"><aside class="declaration">var </aside>real_samples <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/instruments/instrument_data/_instrument_data.dm#L33"><img src="git.png" width="16" height="16" title="code/modules/instruments/instrument_data/_instrument_data.dm 33"></a></h3><p>Write here however many samples, follow this syntax: "%note num%"='%sample file%' eg. "27"='synthesizer/e2.ogg'. Key must never be lower than 0 and higher than 127</p><h3 id="var/samples"><aside class="declaration">var </aside>samples <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/instruments/instrument_data/_instrument_data.dm#L35"><img src="git.png" width="16" height="16" title="code/modules/instruments/instrument_data/_instrument_data.dm 35"></a></h3><p>assoc list key = /datum/instrument_key. do not fill this yourself!</p><h3 id="var/songs_using"><aside class="declaration">var </aside>songs_using <aside>– /list/datum/song</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/instruments/instrument_data/_instrument_data.dm#L43"><img src="git.png" width="16" height="16" title="code/modules/instruments/instrument_data/_instrument_data.dm 43"></a></h3><p>What songs are using us</p><h3 id="var/volume_multiplier"><aside class="declaration">var </aside>volume_multiplier <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/instruments/instrument_data/_instrument_data.dm#L51"><img src="git.png" width="16" height="16" title="code/modules/instruments/instrument_data/_instrument_data.dm 51"></a></h3><p>Volume multiplier. Synthesized instruments are quite loud and I don't like to cut off potential detail via editing. (someone correct me if this isn't a thing)</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> |