mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-15 05:04:15 +01:00
docs: regenerate, include docfx config
This commit is contained in:
goat
parent
6e486d0cea
commit
c59f53db2f
384 changed files with 248388 additions and 1052 deletions
|
|
@ -10,13 +10,13 @@
|
|||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class DalamudPluginInterface
|
||||
">
|
||||
<meta name="generator" content="docfx 2.43.1.0">
|
||||
<meta name="generator" content="docfx 2.48.1.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="../toc.html">
|
||||
<meta property="docfx:navrel" content="">
|
||||
<meta property="docfx:tocrel" content="toc.html">
|
||||
|
||||
|
||||
|
|
@ -81,6 +81,10 @@
|
|||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">DalamudPluginInterface</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>
|
||||
|
|
@ -109,20 +113,25 @@
|
|||
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
|
||||
<h5 id="Dalamud_Plugin_DalamudPluginInterface_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class DalamudPluginInterface</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class DalamudPluginInterface : 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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface__ctor_Dalamud_Dalamud_System_String_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.%23ctor(Dalamud.Dalamud%2CSystem.String)%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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L60">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Plugin_DalamudPluginInterface__ctor_" data-uid="Dalamud.Plugin.DalamudPluginInterface.#ctor*"></a>
|
||||
<h4 id="Dalamud_Plugin_DalamudPluginInterface__ctor_Dalamud_Dalamud_" data-uid="Dalamud.Plugin.DalamudPluginInterface.#ctor(Dalamud.Dalamud)">DalamudPluginInterface(Dalamud)</h4>
|
||||
<h4 id="Dalamud_Plugin_DalamudPluginInterface__ctor_Dalamud_Dalamud_System_String_" data-uid="Dalamud.Plugin.DalamudPluginInterface.#ctor(Dalamud.Dalamud,System.String)">DalamudPluginInterface(Dalamud, String)</h4>
|
||||
<div class="markdown level1 summary"><p>Set up the interface and populate all fields needed.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public DalamudPluginInterface(Dalamud dalamud)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public DalamudPluginInterface(Dalamud dalamud, string pluginName)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
|
|
@ -139,12 +148,22 @@
|
|||
<td><span class="parametername">dalamud</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">pluginName</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
|
||||
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_ClientState.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.ClientState%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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L31">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Plugin_DalamudPluginInterface_ClientState" data-uid="Dalamud.Plugin.DalamudPluginInterface.ClientState">ClientState</h4>
|
||||
<div class="markdown level1 summary"><p>The ClientState object that allows you to access current client memory information like actors, territories, etc.</p>
|
||||
</div>
|
||||
|
|
@ -168,8 +187,13 @@
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_CommandManager.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.CommandManager%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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L26">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Plugin_DalamudPluginInterface_CommandManager" data-uid="Dalamud.Plugin.DalamudPluginInterface.CommandManager">CommandManager</h4>
|
||||
<div class="markdown level1 summary"><p>The CommandManager object that allows you to add and remove custom chat commands.</p>
|
||||
</div>
|
||||
|
|
@ -193,8 +217,43 @@
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_Data.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.Data%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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L51">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Plugin_DalamudPluginInterface_Data" data-uid="Dalamud.Plugin.DalamudPluginInterface.Data">Data</h4>
|
||||
<div class="markdown level1 summary"><p>A <a class="xref" href="Dalamud.Data.DataManager.html">DataManager</a> instance which allows you to access game data needed by the main dalamud features.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public readonly DataManager Data</code></pre>
|
||||
</div>
|
||||
<h5 class="fieldValue">Field Value</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Dalamud.Data.DataManager.html">DataManager</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_Framework.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.Framework%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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L36">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Plugin_DalamudPluginInterface_Framework" data-uid="Dalamud.Plugin.DalamudPluginInterface.Framework">Framework</h4>
|
||||
<div class="markdown level1 summary"><p>The Framework object that allows you to interact with the client.</p>
|
||||
</div>
|
||||
|
|
@ -218,6 +277,154 @@
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_TargetModuleScanner.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.TargetModuleScanner%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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L46">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Plugin_DalamudPluginInterface_TargetModuleScanner" data-uid="Dalamud.Plugin.DalamudPluginInterface.TargetModuleScanner">TargetModuleScanner</h4>
|
||||
<div class="markdown level1 summary"><p>A <a class="xref" href="Dalamud.Game.SigScanner.html">SigScanner</a> instance targeting the main module of the FFXIV process.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public readonly SigScanner TargetModuleScanner</code></pre>
|
||||
</div>
|
||||
<h5 class="fieldValue">Field Value</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Dalamud.Game.SigScanner.html">SigScanner</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_UiBuilder.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.UiBuilder%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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L41">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Plugin_DalamudPluginInterface_UiBuilder" data-uid="Dalamud.Plugin.DalamudPluginInterface.UiBuilder">UiBuilder</h4>
|
||||
<div class="markdown level1 summary"><p>A <a class="xref" href="Dalamud.Plugin.DalamudPluginInterface.html#Dalamud_Plugin_DalamudPluginInterface_UiBuilder">UiBuilder</a> instance which allows you to draw UI into the game via ImGui draw calls.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public readonly UiBuilder UiBuilder</code></pre>
|
||||
</div>
|
||||
<h5 class="fieldValue">Field Value</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Dalamud.Interface.UiBuilder.html">UiBuilder</a></td>
|
||||
<td></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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_Dispose.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L75">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Plugin_DalamudPluginInterface_Dispose_" data-uid="Dalamud.Plugin.DalamudPluginInterface.Dispose*"></a>
|
||||
<h4 id="Dalamud_Plugin_DalamudPluginInterface_Dispose" data-uid="Dalamud.Plugin.DalamudPluginInterface.Dispose">Dispose()</h4>
|
||||
<div class="markdown level1 summary"><p>Unregister your plugin and dispose all references. You have to call this when your IDalamudPlugin is disposed.</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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_GetPluginConfig.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetPluginConfig%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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L103">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Plugin_DalamudPluginInterface_GetPluginConfig_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetPluginConfig*"></a>
|
||||
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetPluginConfig" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetPluginConfig">GetPluginConfig()</h4>
|
||||
<div class="markdown level1 summary"><p>Get a previously saved plugin configuration or null if none was saved before.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IPluginConfiguration GetPluginConfig()</code></pre>
|
||||
</div>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Dalamud.Configuration.IPluginConfiguration.html">IPluginConfiguration</a></td>
|
||||
<td><p>A previously saved config or null if none was saved before.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_SavePluginConfig_Dalamud_Configuration_IPluginConfiguration_.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.SavePluginConfig(Dalamud.Configuration.IPluginConfiguration)%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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L83">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Plugin_DalamudPluginInterface_SavePluginConfig_" data-uid="Dalamud.Plugin.DalamudPluginInterface.SavePluginConfig*"></a>
|
||||
<h4 id="Dalamud_Plugin_DalamudPluginInterface_SavePluginConfig_Dalamud_Configuration_IPluginConfiguration_" data-uid="Dalamud.Plugin.DalamudPluginInterface.SavePluginConfig(Dalamud.Configuration.IPluginConfiguration)">SavePluginConfig(IPluginConfiguration)</h4>
|
||||
<div class="markdown level1 summary"><p>Save a plugin configuration(inheriting IPluginConfiguration).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SavePluginConfig(IPluginConfiguration currentConfig)</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.Configuration.IPluginConfiguration.html">IPluginConfiguration</a></td>
|
||||
<td><span class="parametername">currentConfig</span></td>
|
||||
<td><p>The current configuration.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="implements">Implements</h3>
|
||||
<div>
|
||||
<span class="xref">System.IDisposable</span>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
|
|
@ -225,6 +432,12 @@
|
|||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface%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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L22" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue