ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-15 05:04:15 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: regenerate

Browse source
This commit is contained in:
goat 2021-04-07 20:41:53 +02:00
parent 3f2a0c6bfe
commit 0c8e15a39f
81 changed files with 3440 additions and 905 deletions
Download patch file Download diff file Expand all files Collapse all files

36
docs/api/Dalamud.Plugin.DalamudPluginInterface.html
View file

@ -614,7 +614,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_Dispose.md&amp;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/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L347">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L353">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>
@ -694,7 +694,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_Log_System_String_System_Object___.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.Log(System.String%2CSystem.Object%5B%5D)%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/Plugin/DalamudPluginInterface.cs/#L313">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L319">View Source</a>
</span>
<a id="Dalamud_Plugin_DalamudPluginInterface_Log_" data-uid="Dalamud.Plugin.DalamudPluginInterface.Log*"></a>
<h4 id="Dalamud_Plugin_DalamudPluginInterface_Log_System_String_System_Object___" data-uid="Dalamud.Plugin.DalamudPluginInterface.Log(System.String,System.Object[])">Log(String, Object[])</h4>
@ -735,7 +735,7 @@ public void Log(string messageTemplate, params object[] values)</code></pre>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_LogError_System_Exception_System_String_System_Object___.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.LogError(System.Exception%2CSystem.String%2CSystem.Object%5B%5D)%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/Plugin/DalamudPluginInterface.cs/#L336">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L342">View Source</a>
</span>
<a id="Dalamud_Plugin_DalamudPluginInterface_LogError_" data-uid="Dalamud.Plugin.DalamudPluginInterface.LogError*"></a>
<h4 id="Dalamud_Plugin_DalamudPluginInterface_LogError_System_Exception_System_String_System_Object___" data-uid="Dalamud.Plugin.DalamudPluginInterface.LogError(System.Exception,System.String,System.Object[])">LogError(Exception, String, Object[])</h4>
@ -782,7 +782,7 @@ public void LogError(Exception exception, string messageTemplate, params object[
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_LogError_System_String_System_Object___.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.LogError(System.String%2CSystem.Object%5B%5D)%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/Plugin/DalamudPluginInterface.cs/#L324">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L330">View Source</a>
</span>
<a id="Dalamud_Plugin_DalamudPluginInterface_LogError_" data-uid="Dalamud.Plugin.DalamudPluginInterface.LogError*"></a>
<h4 id="Dalamud_Plugin_DalamudPluginInterface_LogError_System_String_System_Object___" data-uid="Dalamud.Plugin.DalamudPluginInterface.LogError(System.String,System.Object[])">LogError(String, Object[])</h4>
@ -907,7 +907,7 @@ public void LogError(string messageTemplate, params object[] values)</code></pre
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_SendMessage_System_Dynamic_ExpandoObject_.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.SendMessage(System.Dynamic.ExpandoObject)%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/Plugin/DalamudPluginInterface.cs/#L278">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L282">View Source</a>
</span>
<a id="Dalamud_Plugin_DalamudPluginInterface_SendMessage_" data-uid="Dalamud.Plugin.DalamudPluginInterface.SendMessage*"></a>
<h4 id="Dalamud_Plugin_DalamudPluginInterface_SendMessage_System_Dynamic_ExpandoObject_" data-uid="Dalamud.Plugin.DalamudPluginInterface.SendMessage(System.Dynamic.ExpandoObject)">SendMessage(ExpandoObject)</h4>
@ -916,7 +916,8 @@ public void LogError(string messageTemplate, params object[] values)</code></pre
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SendMessage(ExpandoObject message)</code></pre>
<pre><code class="lang-csharp hljs">[Obsolete(&quot;The current IPC mechanism is obsolete and scheduled to be replaced after API level 3.&quot;)]
public void SendMessage(ExpandoObject message)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@ -941,7 +942,7 @@ public void LogError(string messageTemplate, params object[] values)</code></pre
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_SendMessage_System_String_System_Dynamic_ExpandoObject_.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.SendMessage(System.String%2CSystem.Dynamic.ExpandoObject)%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/Plugin/DalamudPluginInterface.cs/#L293">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L298">View Source</a>
</span>
<a id="Dalamud_Plugin_DalamudPluginInterface_SendMessage_" data-uid="Dalamud.Plugin.DalamudPluginInterface.SendMessage*"></a>
<h4 id="Dalamud_Plugin_DalamudPluginInterface_SendMessage_System_String_System_Dynamic_ExpandoObject_" data-uid="Dalamud.Plugin.DalamudPluginInterface.SendMessage(System.String,System.Dynamic.ExpandoObject)">SendMessage(String, ExpandoObject)</h4>
@ -950,7 +951,8 @@ public void LogError(string messageTemplate, params object[] values)</code></pre
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool SendMessage(string pluginName, ExpandoObject message)</code></pre>
<pre><code class="lang-csharp hljs">[Obsolete(&quot;The current IPC mechanism is obsolete and scheduled to be replaced after API level 3.&quot;)]
public bool SendMessage(string pluginName, ExpandoObject message)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@ -997,7 +999,7 @@ public void LogError(string messageTemplate, params object[] values)</code></pre
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_Subscribe_System_String_System_Action_System_Dynamic_ExpandoObject__.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.Subscribe(System.String%2CSystem.Action%7BSystem.Dynamic.ExpandoObject%7D)%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/Plugin/DalamudPluginInterface.cs/#L242">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L243">View Source</a>
</span>
<a id="Dalamud_Plugin_DalamudPluginInterface_Subscribe_" data-uid="Dalamud.Plugin.DalamudPluginInterface.Subscribe*"></a>
<h4 id="Dalamud_Plugin_DalamudPluginInterface_Subscribe_System_String_System_Action_System_Dynamic_ExpandoObject__" data-uid="Dalamud.Plugin.DalamudPluginInterface.Subscribe(System.String,System.Action{System.Dynamic.ExpandoObject})">Subscribe(String, Action&lt;ExpandoObject&gt;)</h4>
@ -1006,7 +1008,8 @@ public void LogError(string messageTemplate, params object[] values)</code></pre
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Subscribe(string pluginName, Action&lt;ExpandoObject&gt; action)</code></pre>
<pre><code class="lang-csharp hljs">[Obsolete(&quot;The current IPC mechanism is obsolete and scheduled to be replaced after API level 3.&quot;)]
public void Subscribe(string pluginName, Action&lt;ExpandoObject&gt; action)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@ -1046,7 +1049,8 @@ public void LogError(string messageTemplate, params object[] values)</code></pre
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SubscribeAny(Action&lt;string, ExpandoObject&gt; action)</code></pre>
<pre><code class="lang-csharp hljs">[Obsolete(&quot;The current IPC mechanism is obsolete and scheduled to be replaced after API level 3.&quot;)]
public void SubscribeAny(Action&lt;string, ExpandoObject&gt; action)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@ -1071,7 +1075,7 @@ public void LogError(string messageTemplate, params object[] values)</code></pre
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_Unsubscribe_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.Unsubscribe(System.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/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L265">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L268">View Source</a>
</span>
<a id="Dalamud_Plugin_DalamudPluginInterface_Unsubscribe_" data-uid="Dalamud.Plugin.DalamudPluginInterface.Unsubscribe*"></a>
<h4 id="Dalamud_Plugin_DalamudPluginInterface_Unsubscribe_System_String_" data-uid="Dalamud.Plugin.DalamudPluginInterface.Unsubscribe(System.String)">Unsubscribe(String)</h4>
@ -1080,7 +1084,8 @@ public void LogError(string messageTemplate, params object[] values)</code></pre
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Unsubscribe(string pluginName)</code></pre>
<pre><code class="lang-csharp hljs">[Obsolete(&quot;The current IPC mechanism is obsolete and scheduled to be replaced after API level 3.&quot;)]
public void Unsubscribe(string pluginName)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@ -1105,7 +1110,7 @@ public void LogError(string messageTemplate, params object[] values)</code></pre
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_UnsubscribeAny.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.UnsubscribeAny%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/Plugin/DalamudPluginInterface.cs/#L253">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L255">View Source</a>
</span>
<a id="Dalamud_Plugin_DalamudPluginInterface_UnsubscribeAny_" data-uid="Dalamud.Plugin.DalamudPluginInterface.UnsubscribeAny*"></a>
<h4 id="Dalamud_Plugin_DalamudPluginInterface_UnsubscribeAny" data-uid="Dalamud.Plugin.DalamudPluginInterface.UnsubscribeAny">UnsubscribeAny()</h4>
@ -1114,7 +1119,8 @@ public void LogError(string messageTemplate, params object[] values)</code></pre
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void UnsubscribeAny()</code></pre>
<pre><code class="lang-csharp hljs">[Obsolete(&quot;The current IPC mechanism is obsolete and scheduled to be replaced after API level 3.&quot;)]
public void UnsubscribeAny()</code></pre>
</div>
<h3 id="events">Events
</h3>