cyberpresidentvanellope/Paradise
1
0
Fork 0
mirror of https://github.com/ParadiseSS13/Paradise.git synced 2026-08-27 22:17:32 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
Paradise/datum/controller/subsystem/processing/instruments.html
T

17 lines
10 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/controller/subsystem/processing/instruments - 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/controller/subsystem/processing/instruments.html#var">Var Details</a> - <a href="datum/controller/subsystem/processing/instruments.html#proc">Proc Details</a></header><main><h1>instruments <aside>/<a href="datum.html">datum</a>/<a href="datum/controller.html">controller</a>/<a href="datum/controller/subsystem.html">subsystem</a>/<a href="datum/controller/subsystem/processing/instruments.html">processing/instruments</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/processing/SSinstruments.dm#L1"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/processing/SSinstruments.dm 1"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/controller/subsystem/processing/instruments.html#var/current_instrument_channels">current_instrument_channels</a></th><td>Current number of channels allocated for instruments</td></tr><tr><th><a href="datum/controller/subsystem/processing/instruments.html#var/instrument_data">instrument_data</a></th><td>List of all instrument data, associative id = datum</td></tr><tr><th><a href="datum/controller/subsystem/processing/instruments.html#var/max_instrument_channels">max_instrument_channels</a></th><td>Maximum instrument channels total instruments are allowed to use. This is so you don't have instruments deadlocking all sound channels.</td></tr><tr><th><a href="datum/controller/subsystem/processing/instruments.html#var/musician_hearcheck_mindelay">musician_hearcheck_mindelay</a></th><td>Deciseconds between hearchecks. Too high and instruments seem to lag when people are moving around in terms of who can hear it. Too low and the server lags from this.</td></tr><tr><th><a href="datum/controller/subsystem/processing/instruments.html#var/musician_maxlinechars">musician_maxlinechars</a></th><td>Max characters per line in songs</td></tr><tr><th><a href="datum/controller/subsystem/processing/instruments.html#var/musician_maxlines">musician_maxlines</a></th><td>Max lines in songs</td></tr><tr><th><a href="datum/controller/subsystem/processing/instruments.html#var/songs">songs</a></th><td>List of all song datums.</td></tr><tr><th><a href="datum/controller/subsystem/processing/instruments.html#var/synthesizer_instrument_ids">synthesizer_instrument_ids</a></th><td>Single cached list for synthesizer instrument ids, so you don't have to have a new list with every synthesizer.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/controller/subsystem/processing/instruments.html#proc/get_instrument">get_instrument</a></th><td>Returns the instrument datum at the given ID or path</td></tr><tr><th><a href="datum/controller/subsystem/processing/instruments.html#proc/initialize_instrument_data">initialize_instrument_data</a></th><td>Initializes all instrument datums</td></tr><tr><th><a href="datum/controller/subsystem/processing/instruments.html#proc/on_song_del">on_song_del</a></th><td>Called when a datum/song is deleted</td></tr><tr><th><a href="datum/controller/subsystem/processing/instruments.html#proc/on_song_new">on_song_new</a></th><td>Called when a datum/song is created</td></tr><tr><th><a href="datum/controller/subsystem/processing/instruments.html#proc/reserve_instrument_channel">reserve_instrument_channel</a></th><td>Reserves a sound channel for a given instrument datum</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/current_instrument_channels"><aside class="declaration">var </aside>current_instrument_channels <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/processing/SSinstruments.dm#L21"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/processing/SSinstruments.dm 21"></a></h3><p>Current number of channels allocated for instruments</p><h3 id="var/instrument_data"><aside class="declaration">var </aside>instrument_data <aside>– /list/<a href="datum.html">datum</a>/<a href="datum/instrument.html">instrument</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/processing/SSinstruments.dm#L9"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/processing/SSinstruments.dm 9"></a></h3><p>List of all instrument data, associative id = datum</p><h3 id="var/max_instrument_channels"><aside class="declaration">var </aside>max_instrument_channels <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/processing/SSinstruments.dm#L19"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/processing/SSinstruments.dm 19"></a></h3><p>Maximum instrument channels total instruments are allowed to use. This is so you don't have instruments deadlocking all sound channels.</p><h3 id="var/musician_hearcheck_mindelay"><aside class="declaration">var </aside>musician_hearcheck_mindelay <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/processing/SSinstruments.dm#L17"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/processing/SSinstruments.dm 17"></a></h3><p>Deciseconds between hearchecks. Too high and instruments seem to lag when people are moving around in terms of who can hear it. Too low and the server lags from this.</p><h3 id="var/musician_maxlinechars"><aside class="declaration">var </aside>musician_maxlinechars <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/processing/SSinstruments.dm#L15"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/processing/SSinstruments.dm 15"></a></h3><p>Max characters per line in songs</p><h3 id="var/musician_maxlines"><aside class="declaration">var </aside>musician_maxlines <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/processing/SSinstruments.dm#L13"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/processing/SSinstruments.dm 13"></a></h3><p>Max lines in songs</p><h3 id="var/songs"><aside class="declaration">var </aside>songs <aside>– /list/<a href="datum.html">datum</a>/<a href="datum/song.html">song</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/processing/SSinstruments.dm#L11"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/processing/SSinstruments.dm 11"></a></h3><p>List of all song datums.</p><h3 id="var/synthesizer_instrument_ids"><aside class="declaration">var </aside>synthesizer_instrument_ids <aside>– /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/processing/SSinstruments.dm#L23"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/processing/SSinstruments.dm 23"></a></h3><p>Single cached list for synthesizer instrument ids, so you don't have to have a new list with every synthesizer.</p><h2 id="proc">Proc Details</h2><h3 id="proc/get_instrument"><aside class="declaration">proc </aside>get_instrument<aside>(id_or_path) <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/processing/SSinstruments.dm#L84"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/processing/SSinstruments.dm 84"></a></aside></h3><p>Returns the instrument datum at the given ID or path</p>
<p>Arguments:</p>
<ul>
<li>id_or_path - The ID or path of the instrument</li>
</ul><h3 id="proc/initialize_instrument_data"><aside class="declaration">proc </aside>initialize_instrument_data<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/processing/SSinstruments.dm#L32"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/processing/SSinstruments.dm 32"></a></aside></h3><p>Initializes all instrument datums</p><h3 id="proc/on_song_del"><aside class="declaration">proc </aside>on_song_del<aside>(/<a href="datum.html">datum</a>/<a href="datum/song.html">song</a>/S) <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/processing/SSinstruments.dm#L75"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/processing/SSinstruments.dm 75"></a></aside></h3><p>Called when a datum/song is deleted</p>
<p>Arguments:</p>
<ul>
<li>S - The deleted datum/song</li>
</ul><h3 id="proc/on_song_new"><aside class="declaration">proc </aside>on_song_new<aside>(/<a href="datum.html">datum</a>/<a href="datum/song.html">song</a>/S) <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/processing/SSinstruments.dm#L66"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/processing/SSinstruments.dm 66"></a></aside></h3><p>Called when a datum/song is created</p>
<p>Arguments:</p>
<ul>
<li>S - The created datum/song</li>
</ul><h3 id="proc/reserve_instrument_channel"><aside class="declaration">proc </aside>reserve_instrument_channel<aside>(/<a href="datum.html">datum</a>/<a href="datum/instrument.html">instrument</a>/I) <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/controllers/subsystem/processing/SSinstruments.dm#L53"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/processing/SSinstruments.dm 53"></a></aside></h3><p>Reserves a sound channel for a given instrument datum</p>
<p>Arguments:</p>
<ul>
<li>I - The instrument datum</li>
</ul></main><footer>paradise.dme <a href="https://github.com/ParadiseSS13/Paradise/tree/776b9861f70566b1e6a0763a465ef22f7920a3d6">776b986</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