Deploy code docs to GitHub Pages for workflow run 3482

Commit: 179572f

_delegating_engine_installer_8cs_source.html

@@ -108,8 +108,8 @@
 <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer.html#ae0f1bf9e2fa66b51910d2c99fd82e3d9">   32</a></span>        <span class="keyword">public</span> Task <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer.html#ae0f1bf9e2fa66b51910d2c99fd82e3d9">CleanCache</a>(CancellationToken cancellationToken)</div>
 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>            =&gt; Task.WhenAll(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer.html#ae4d83ed1d4cd5e8ead71d932a5471d5c">delegatedInstallers</a>.Values.Select(installer =&gt; installer.CleanCache(cancellationToken)));</div>
 <div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
-<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer.html#a2261a1236dcaa47602c9b6dbd3554f70">   36</a></span>        <span class="keyword">public</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_i_engine_installation.html">IEngineInstallation</a> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer.html#a2261a1236dcaa47602c9b6dbd3554f70">CreateInstallation</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_engine_version.html">EngineVersion</a> version, <span class="keywordtype">string</span> path, Task installationTask)</div>
-<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>            =&gt; DelegateCall(version, installer =&gt; installer.CreateInstallation(version, path, installationTask));</div>
+<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer.html#a7ba043fa2330fa6ac1ef550055401515">   36</a></span>        <span class="keyword">public</span> ValueTask&lt;IEngineInstallation&gt; <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer.html#a7ba043fa2330fa6ac1ef550055401515">CreateInstallation</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_engine_version.html">EngineVersion</a> version, <span class="keywordtype">string</span> path, Task installationTask, CancellationToken cancellationToken)</div>
+<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>            =&gt; DelegateCall(version, installer =&gt; installer.CreateInstallation(version, path, installationTask, cancellationToken));</div>
 <div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span> </div>
 <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer.html#a747b57847efcd7a358f99dc585cb57ba">   40</a></span>        <span class="keyword">public</span> ValueTask&lt;IEngineInstallationData&gt; <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer.html#a747b57847efcd7a358f99dc585cb57ba">DownloadVersion</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_engine_version.html">EngineVersion</a> version, <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_job_progress_reporter.html">JobProgressReporter</a> jobProgressReporter, CancellationToken cancellationToken)</div>
 <div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span>            =&gt; DelegateCall(version, installer =&gt; installer.DownloadVersion(version, jobProgressReporter, cancellationToken));</div>
@@ -136,17 +136,16 @@
 <div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_engine_version_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_engine_version.html">Tgstation.Server.Api.Models.EngineVersion</a></div><div class="ttdoc">Information about an engine installation.</div><div class="ttdef"><b>Definition</b> <a href="_engine_version_8cs_source.html#l00013">EngineVersion.cs:14</a></div></div>
 <div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_engine_version_html_ae13db4c5dbd6b06c79d37ad9afd25af2"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_engine_version.html#ae13db4c5dbd6b06c79d37ad9afd25af2">Tgstation.Server.Api.Models.EngineVersion.Engine</a></div><div class="ttdeci">EngineType? Engine</div><div class="ttdoc">The EngineType.</div><div class="ttdef"><b>Definition</b> <a href="_engine_version_8cs_source.html#l00024">EngineVersion.cs:24</a></div></div>
 <div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer.html">Tgstation.Server.Host.Components.Engine.DelegatingEngineInstaller</a></div><div class="ttdoc">Implementation of IEngineInstaller that forwards calls to different IEngineInstaller based on their a...</div><div class="ttdef"><b>Definition</b> <a href="_delegating_engine_installer_8cs_source.html#l00015">DelegatingEngineInstaller.cs:16</a></div></div>
-<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer_html_a2261a1236dcaa47602c9b6dbd3554f70"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer.html#a2261a1236dcaa47602c9b6dbd3554f70">Tgstation.Server.Host.Components.Engine.DelegatingEngineInstaller.CreateInstallation</a></div><div class="ttdeci">IEngineInstallation CreateInstallation(EngineVersion version, string path, Task installationTask)</div><div class="ttdoc">Creates an IEngineInstallation for a given version .The IEngineInstallation.</div></div>
 <div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer_html_a34607a6ac7b8d83f13aab6431f8e4164"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer.html#a34607a6ac7b8d83f13aab6431f8e4164">Tgstation.Server.Host.Components.Engine.DelegatingEngineInstaller.DelegatingEngineInstaller</a></div><div class="ttdeci">DelegatingEngineInstaller(FrozenDictionary&lt; EngineType, IEngineInstaller &gt; delegatedInstallers)</div><div class="ttdoc">Initializes a new instance of the DelegatingEngineInstaller class.</div><div class="ttdef"><b>Definition</b> <a href="_delegating_engine_installer_8cs_source.html#l00026">DelegatingEngineInstaller.cs:26</a></div></div>
 <div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer_html_a6b2bca366871ac1f36187b67181ae976"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer.html#a6b2bca366871ac1f36187b67181ae976">Tgstation.Server.Host.Components.Engine.DelegatingEngineInstaller.DelegateCall&lt; TReturn &gt;</a></div><div class="ttdeci">TReturn DelegateCall&lt; TReturn &gt;(EngineVersion version, Func&lt; IEngineInstaller, TReturn &gt; call)</div><div class="ttdoc">Delegate a given call  to its appropriate IEngineInstaller.</div><div class="ttdef"><b>Definition</b> <a href="_delegating_engine_installer_8cs_source.html#l00062">DelegatingEngineInstaller.cs:62</a></div></div>
 <div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer_html_a6e7d69449d50fffb702a06fd7f36d011"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer.html#a6e7d69449d50fffb702a06fd7f36d011">Tgstation.Server.Host.Components.Engine.DelegatingEngineInstaller.Install</a></div><div class="ttdeci">ValueTask Install(EngineVersion version, string path, bool deploymentPipelineProcesses, CancellationToken cancellationToken)</div><div class="ttdoc">Does actions necessary to get an extracted installation working.A ValueTask representing the running ...</div></div>
 <div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer_html_a747b57847efcd7a358f99dc585cb57ba"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer.html#a747b57847efcd7a358f99dc585cb57ba">Tgstation.Server.Host.Components.Engine.DelegatingEngineInstaller.DownloadVersion</a></div><div class="ttdeci">ValueTask&lt; IEngineInstallationData &gt; DownloadVersion(EngineVersion version, JobProgressReporter jobProgressReporter, CancellationToken cancellationToken)</div><div class="ttdoc">Download a given engine version .A ValueTask&lt;TResult&gt; resulting in the IEngineInstallationData for th...</div></div>
+<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer_html_a7ba043fa2330fa6ac1ef550055401515"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer.html#a7ba043fa2330fa6ac1ef550055401515">Tgstation.Server.Host.Components.Engine.DelegatingEngineInstaller.CreateInstallation</a></div><div class="ttdeci">ValueTask&lt; IEngineInstallation &gt; CreateInstallation(EngineVersion version, string path, Task installationTask, CancellationToken cancellationToken)</div><div class="ttdoc">Creates an IEngineInstallation for a given version .A ValueTask&lt;TResult&gt; resulting in the IEngineInst...</div></div>
 <div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer_html_ab966144c4cfcc709f66440552a616420"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer.html#ab966144c4cfcc709f66440552a616420">Tgstation.Server.Host.Components.Engine.DelegatingEngineInstaller.UpgradeInstallation</a></div><div class="ttdeci">ValueTask UpgradeInstallation(EngineVersion version, string path, CancellationToken cancellationToken)</div><div class="ttdoc">Does actions necessary to get upgrade a version installed by a previous version of TGS....</div></div>
 <div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer_html_ae0f1bf9e2fa66b51910d2c99fd82e3d9"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer.html#ae0f1bf9e2fa66b51910d2c99fd82e3d9">Tgstation.Server.Host.Components.Engine.DelegatingEngineInstaller.CleanCache</a></div><div class="ttdeci">Task CleanCache(CancellationToken cancellationToken)</div><div class="ttdoc">Attempts to cleans the engine's cache folder for the system.A Task representing the running operation...</div></div>
 <div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer_html_ae4d83ed1d4cd5e8ead71d932a5471d5c"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer.html#ae4d83ed1d4cd5e8ead71d932a5471d5c">Tgstation.Server.Host.Components.Engine.DelegatingEngineInstaller.delegatedInstallers</a></div><div class="ttdeci">readonly FrozenDictionary&lt; EngineType, IEngineInstaller &gt; delegatedInstallers</div><div class="ttdoc">The FrozenDictionary&lt;TKey, TValue&gt; mapping EngineTypes to their appropriate IEngineInstaller.</div><div class="ttdef"><b>Definition</b> <a href="_delegating_engine_installer_8cs_source.html#l00020">DelegatingEngineInstaller.cs:20</a></div></div>
 <div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer_html_af0f4ffacf1cdf62dc66ed74f4f4f848e"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_delegating_engine_installer.html#af0f4ffacf1cdf62dc66ed74f4f4f848e">Tgstation.Server.Host.Components.Engine.DelegatingEngineInstaller.TrustDmbPath</a></div><div class="ttdeci">ValueTask TrustDmbPath(EngineVersion version, string fullDmbPath, CancellationToken cancellationToken)</div><div class="ttdoc">Add a given fullDmbPath  to the trusted DMBs list in BYOND's config.A ValueTask representing the runn...</div></div>
 <div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_job_progress_reporter_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_job_progress_reporter.html">Tgstation.Server.Host.Jobs.JobProgressReporter</a></div><div class="ttdoc">Progress reporter for a Job.</div><div class="ttdef"><b>Definition</b> <a href="_job_progress_reporter_8cs_source.html#l00013">JobProgressReporter.cs:14</a></div></div>
-<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_i_engine_installation_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_i_engine_installation.html">Tgstation.Server.Host.Components.Engine.IEngineInstallation</a></div><div class="ttdoc">Represents a BYOND installation.</div><div class="ttdef"><b>Definition</b> <a href="_i_engine_installation_8cs_source.html#l00017">IEngineInstallation.cs:18</a></div></div>
 <div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_i_engine_installer_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_i_engine_installer.html">Tgstation.Server.Host.Components.Engine.IEngineInstaller</a></div><div class="ttdoc">For downloading and installing game engines for a given system.</div><div class="ttdef"><b>Definition</b> <a href="_i_engine_installer_8cs_source.html#l00012">IEngineInstaller.cs:13</a></div></div>
 <div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_1_1_models_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html">Tgstation.Server.Api.Models</a></div><div class="ttdef"><b>Definition</b> <a href="_tgstation_8_server_8_api_2_models_2_chat_channel_8cs_source.html#l00005">ChatChannel.cs:6</a></div></div>
 <div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine.html">Tgstation.Server.Host.Components.Engine</a></div><div class="ttdef"><b>Definition</b> <a href="_byond_installation_8cs_source.html#l00011">ByondInstallation.cs:12</a></div></div>