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

docs: regenerate

Browse source
This commit is contained in:
goat 2021-04-25 15:20:12 +02:00
parent 62e44bf30f
commit 392376b3fc
No known key found for this signature in database
GPG key ID: F18F057873895461
106 changed files with 4881 additions and 2447 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -558,7 +558,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_AddChatLinkHandler_System_UInt32_System_Action_System_UInt32_Dalamud_Game_Text_SeStringHandling_SeString__.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.AddChatLinkHandler(System.UInt32%2CSystem.Action%7BSystem.UInt32%2CDalamud.Game.Text.SeStringHandling.SeString%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/#L200">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L206">View Source</a>
</span>
<a id="Dalamud_Plugin_DalamudPluginInterface_AddChatLinkHandler_" data-uid="Dalamud.Plugin.DalamudPluginInterface.AddChatLinkHandler*"></a>
<h4 id="Dalamud_Plugin_DalamudPluginInterface_AddChatLinkHandler_System_UInt32_System_Action_System_UInt32_Dalamud_Game_Text_SeStringHandling_SeString__" data-uid="Dalamud.Plugin.DalamudPluginInterface.AddChatLinkHandler(System.UInt32,System.Action{System.UInt32,Dalamud.Game.Text.SeStringHandling.SeString})">AddChatLinkHandler(UInt32, Action&lt;UInt32, SeString&gt;)</h4>
@ -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/#L353">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L359">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>
@ -685,6 +685,38 @@
<tr>
<td><span class="xref">System.String</span></td>
<td><p>directory with path of AppData/XIVLauncher/pluginConfig/PluginInternalName.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_GetPluginLocDirectory.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.GetPluginLocDirectory%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/#L196">View Source</a>
</span>
<a id="Dalamud_Plugin_DalamudPluginInterface_GetPluginLocDirectory_" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetPluginLocDirectory*"></a>
<h4 id="Dalamud_Plugin_DalamudPluginInterface_GetPluginLocDirectory" data-uid="Dalamud.Plugin.DalamudPluginInterface.GetPluginLocDirectory">GetPluginLocDirectory()</h4>
<div class="markdown level1 summary"><p>Get the loc directory.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string GetPluginLocDirectory()</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><span class="xref">System.String</span></td>
<td><p>directory with path of AppData/XIVLauncher/pluginConfig/PluginInternalName/loc.</p>
</td>
</tr>
</tbody>
@ -694,7 +726,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/#L319">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L325">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 +767,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/#L342">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L348">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 +814,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/#L330">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L336">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>
@ -823,7 +855,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_RemoveChatLinkHandler.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.RemoveChatLinkHandler%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/#L217">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L223">View Source</a>
</span>
<a id="Dalamud_Plugin_DalamudPluginInterface_RemoveChatLinkHandler_" data-uid="Dalamud.Plugin.DalamudPluginInterface.RemoveChatLinkHandler*"></a>
<h4 id="Dalamud_Plugin_DalamudPluginInterface_RemoveChatLinkHandler" data-uid="Dalamud.Plugin.DalamudPluginInterface.RemoveChatLinkHandler">RemoveChatLinkHandler()</h4>
@ -839,7 +871,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_RemoveChatLinkHandler_System_UInt32_.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.RemoveChatLinkHandler(System.UInt32)%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/#L209">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L215">View Source</a>
</span>
<a id="Dalamud_Plugin_DalamudPluginInterface_RemoveChatLinkHandler_" data-uid="Dalamud.Plugin.DalamudPluginInterface.RemoveChatLinkHandler*"></a>
<h4 id="Dalamud_Plugin_DalamudPluginInterface_RemoveChatLinkHandler_System_UInt32_" data-uid="Dalamud.Plugin.DalamudPluginInterface.RemoveChatLinkHandler(System.UInt32)">RemoveChatLinkHandler(UInt32)</h4>
@ -907,7 +939,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/#L282">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L288">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>
@ -942,7 +974,7 @@ public void SendMessage(ExpandoObject message)</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/#L298">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L304">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>
@ -999,7 +1031,7 @@ public bool SendMessage(string pluginName, ExpandoObject message)</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/#L243">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L249">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>
@ -1040,7 +1072,7 @@ public void Subscribe(string pluginName, Action&lt;ExpandoObject&gt; action)</co
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_SubscribeAny_System_Action_System_String_System_Dynamic_ExpandoObject__.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.SubscribeAny(System.Action%7BSystem.String%2CSystem.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/#L229">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L235">View Source</a>
</span>
<a id="Dalamud_Plugin_DalamudPluginInterface_SubscribeAny_" data-uid="Dalamud.Plugin.DalamudPluginInterface.SubscribeAny*"></a>
<h4 id="Dalamud_Plugin_DalamudPluginInterface_SubscribeAny_System_Action_System_String_System_Dynamic_ExpandoObject__" data-uid="Dalamud.Plugin.DalamudPluginInterface.SubscribeAny(System.Action{System.String,System.Dynamic.ExpandoObject})">SubscribeAny(Action&lt;String, ExpandoObject&gt;)</h4>
@ -1075,7 +1107,7 @@ public void SubscribeAny(Action&lt;string, ExpandoObject&gt; action)</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/#L268">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L274">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>
@ -1110,7 +1142,7 @@ public void Unsubscribe(string pluginName)</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/#L255">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L261">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>