ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 18:27:23 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
Dalamud/docs/api/Dalamud.Dalamud.html
goat 4e5b5f6b24
docs: regenerate
2021-04-28 14:24:07 +02:00

341 lines
17 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class Dalamud
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Dalamud
">
<meta name="generator" content="docfx 2.56.6.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Dalamud.Dalamud">
<h1 id="Dalamud_Dalamud" data-uid="Dalamud.Dalamud" class="text-break">Class Dalamud
</h1>
<div class="markdown level0 summary"><p>The main Dalamud class containing all subsystems.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">Dalamud</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">System.IDisposable</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.html">Dalamud</a></h6>
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
<h5 id="Dalamud_Dalamud_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class Dalamud : IDisposable</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Dalamud__ctor_Dalamud_DalamudStartInfo_Serilog_Core_LoggingLevelSwitch_System_Threading_ManualResetEvent_.md&amp;value=---%0Auid%3A%20Dalamud.Dalamud.%23ctor(Dalamud.DalamudStartInfo%2CSerilog.Core.LoggingLevelSwitch%2CSystem.Threading.ManualResetEvent)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Dalamud.cs/#L45">View Source</a>
</span>
<a id="Dalamud_Dalamud__ctor_" data-uid="Dalamud.Dalamud.#ctor*"></a>
<h4 id="Dalamud_Dalamud__ctor_Dalamud_DalamudStartInfo_Serilog_Core_LoggingLevelSwitch_System_Threading_ManualResetEvent_" data-uid="Dalamud.Dalamud.#ctor(Dalamud.DalamudStartInfo,Serilog.Core.LoggingLevelSwitch,System.Threading.ManualResetEvent)">Dalamud(DalamudStartInfo, LoggingLevelSwitch, ManualResetEvent)</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Dalamud.Dalamud.html">Dalamud</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Dalamud(DalamudStartInfo info, LoggingLevelSwitch loggingLevelSwitch, ManualResetEvent finishSignal)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Dalamud.DalamudStartInfo.html">DalamudStartInfo</a></td>
<td><span class="parametername">info</span></td>
<td><p>DalamudStartInfo instance.</p>
</td>
</tr>
<tr>
<td><span class="xref">Serilog.Core.LoggingLevelSwitch</span></td>
<td><span class="parametername">loggingLevelSwitch</span></td>
<td><p>LoggingLevelSwitch to control Serilog level.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Threading.ManualResetEvent</span></td>
<td><span class="parametername">finishSignal</span></td>
<td><p>Signal signalling shutdown.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Dalamud_Dispose.md&amp;value=---%0Auid%3A%20Dalamud.Dalamud.Dispose%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Dalamud.cs/#L408">View Source</a>
</span>
<a id="Dalamud_Dalamud_Dispose_" data-uid="Dalamud.Dalamud.Dispose*"></a>
<h4 id="Dalamud_Dalamud_Dispose" data-uid="Dalamud.Dalamud.Dispose">Dispose()</h4>
<div class="markdown level1 summary"><p>Dispose Dalamud subsystems.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Dalamud_DisposePlugins.md&amp;value=---%0Auid%3A%20Dalamud.Dalamud.DisposePlugins%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Dalamud.cs/#L383">View Source</a>
</span>
<a id="Dalamud_Dalamud_DisposePlugins_" data-uid="Dalamud.Dalamud.DisposePlugins*"></a>
<h4 id="Dalamud_Dalamud_DisposePlugins" data-uid="Dalamud.Dalamud.DisposePlugins">DisposePlugins()</h4>
<div class="markdown level1 summary"><p>Dispose subsystems related to plugin handling.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void DisposePlugins()</code></pre>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Dalamud_LoadPluginSystem.md&amp;value=---%0Auid%3A%20Dalamud.Dalamud.LoadPluginSystem%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Dalamud.cs/#L321">View Source</a>
</span>
<a id="Dalamud_Dalamud_LoadPluginSystem_" data-uid="Dalamud.Dalamud.LoadPluginSystem*"></a>
<h4 id="Dalamud_Dalamud_LoadPluginSystem" data-uid="Dalamud.Dalamud.LoadPluginSystem">LoadPluginSystem()</h4>
<div class="markdown level1 summary"><p>Loads the plugin manager and repository.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void LoadPluginSystem()</code></pre>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Dalamud_Start.md&amp;value=---%0Auid%3A%20Dalamud.Dalamud.Start%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Dalamud.cs/#L192">View Source</a>
</span>
<a id="Dalamud_Dalamud_Start_" data-uid="Dalamud.Dalamud.Start*"></a>
<h4 id="Dalamud_Dalamud_Start" data-uid="Dalamud.Dalamud.Start">Start()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Start()</code></pre>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Dalamud_StartSubsystems.md&amp;value=---%0Auid%3A%20Dalamud.Dalamud.StartSubsystems%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Dalamud.cs/#L210">View Source</a>
</span>
<a id="Dalamud_Dalamud_StartSubsystems_" data-uid="Dalamud.Dalamud.StartSubsystems*"></a>
<h4 id="Dalamud_Dalamud_StartSubsystems" data-uid="Dalamud.Dalamud.StartSubsystems">StartSubsystems()</h4>
<div class="markdown level1 summary"><p>Start and initialize Dalamud subsystems.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void StartSubsystems()</code></pre>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Dalamud_Unload.md&amp;value=---%0Auid%3A%20Dalamud.Dalamud.Unload%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Dalamud.cs/#L358">View Source</a>
</span>
<a id="Dalamud_Dalamud_Unload_" data-uid="Dalamud.Dalamud.Unload*"></a>
<h4 id="Dalamud_Dalamud_Unload" data-uid="Dalamud.Dalamud.Unload">Unload()</h4>
<div class="markdown level1 summary"><p>Queue an unload of Dalamud when it gets the chance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Unload()</code></pre>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Dalamud_WaitForUnload.md&amp;value=---%0Auid%3A%20Dalamud.Dalamud.WaitForUnload%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Dalamud.cs/#L367">View Source</a>
</span>
<a id="Dalamud_Dalamud_WaitForUnload_" data-uid="Dalamud.Dalamud.WaitForUnload*"></a>
<h4 id="Dalamud_Dalamud_WaitForUnload" data-uid="Dalamud.Dalamud.WaitForUnload">WaitForUnload()</h4>
<div class="markdown level1 summary"><p>Wait for an unload request to start.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void WaitForUnload()</code></pre>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Dalamud_WaitForUnloadFinish.md&amp;value=---%0Auid%3A%20Dalamud.Dalamud.WaitForUnloadFinish%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Dalamud.cs/#L375">View Source</a>
</span>
<a id="Dalamud_Dalamud_WaitForUnloadFinish_" data-uid="Dalamud.Dalamud.WaitForUnloadFinish*"></a>
<h4 id="Dalamud_Dalamud_WaitForUnloadFinish" data-uid="Dalamud.Dalamud.WaitForUnloadFinish">WaitForUnloadFinish()</h4>
<div class="markdown level1 summary"><p>Wait for a queued unload to be finalized.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void WaitForUnloadFinish()</code></pre>
</div>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.IDisposable</span>
</div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Dalamud.md&amp;value=---%0Auid%3A%20Dalamud.Dalamud%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Dalamud.cs/#L25" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink