docs: regenerate

This commit is contained in:
goat 2021-08-23 08:34:29 +02:00
parent d6fdb99fd0
commit 5bbefd95b5
No known key found for this signature in database
GPG key ID: F18F057873895461
40 changed files with 1381 additions and 1403 deletions

View file

@ -280,7 +280,7 @@ If &gt; 1.000.000, subtract 1.000.000 and treat it as HQ.</p>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_Dispose.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.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/Game/Gui/GameGui.cs/#L479">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L447">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_Dispose_" data-uid="Dalamud.Game.Gui.GameGui.Dispose*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_Dispose" data-uid="Dalamud.Game.Gui.GameGui.Dispose">Dispose()</h4>
@ -296,7 +296,7 @@ If &gt; 1.000.000, subtract 1.000.000 and treat it as HQ.</p>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_Enable.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.Enable%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/Game/Gui/GameGui.cs/#L461">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L429">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_Enable_" data-uid="Dalamud.Game.Gui.GameGui.Enable*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_Enable" data-uid="Dalamud.Game.Gui.GameGui.Enable">Enable()</h4>
@ -312,7 +312,7 @@ If &gt; 1.000.000, subtract 1.000.000 and treat it as HQ.</p>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_FindAgentInterface_System_IntPtr_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.FindAgentInterface(System.IntPtr)%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/Game/Gui/GameGui.cs/#L415">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L383">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_FindAgentInterface_" data-uid="Dalamud.Game.Gui.GameGui.FindAgentInterface*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_FindAgentInterface_System_IntPtr_" data-uid="Dalamud.Game.Gui.GameGui.FindAgentInterface(System.IntPtr)">FindAgentInterface(IntPtr)</h4>
@ -362,7 +362,7 @@ If &gt; 1.000.000, subtract 1.000.000 and treat it as HQ.</p>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_FindAgentInterface_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.FindAgentInterface(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/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L397">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L365">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_FindAgentInterface_" data-uid="Dalamud.Game.Gui.GameGui.FindAgentInterface*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_FindAgentInterface_System_String_" data-uid="Dalamud.Game.Gui.GameGui.FindAgentInterface(System.String)">FindAgentInterface(String)</h4>
@ -412,7 +412,7 @@ If &gt; 1.000.000, subtract 1.000.000 and treat it as HQ.</p>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_FindAgentInterface_System_Void__.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.FindAgentInterface(System.Void*)%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/Game/Gui/GameGui.cs/#L408">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L376">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_FindAgentInterface_" data-uid="Dalamud.Game.Gui.GameGui.FindAgentInterface*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_FindAgentInterface_System_Void__" data-uid="Dalamud.Game.Gui.GameGui.FindAgentInterface(System.Void*)">FindAgentInterface(Void*)</h4>
@ -462,7 +462,7 @@ If &gt; 1.000.000, subtract 1.000.000 and treat it as HQ.</p>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_GetAddonByName_System_String_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.GetAddonByName(System.String%2CSystem.Int32)%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/Game/Gui/GameGui.cs/#L375">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L343">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_GetAddonByName_" data-uid="Dalamud.Game.Gui.GameGui.GetAddonByName*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_GetAddonByName_System_String_System_Int32_" data-uid="Dalamud.Game.Gui.GameGui.GetAddonByName(System.String,System.Int32)">GetAddonByName(String, Int32)</h4>
@ -518,7 +518,7 @@ If &gt; 1.000.000, subtract 1.000.000 and treat it as HQ.</p>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_GetUIModule.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.GetUIModule%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/Game/Gui/GameGui.cs/#L356">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L324">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_GetUIModule_" data-uid="Dalamud.Game.Gui.GameGui.GetUIModule*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_GetUIModule" data-uid="Dalamud.Game.Gui.GameGui.GetUIModule">GetUIModule()</h4>
@ -591,68 +591,6 @@ If &gt; 1.000.000, subtract 1.000.000 and treat it as HQ.</p>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p>True if there were no errors and it could open the map.</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_Game_Gui_GameGui_ScreenToWorld_SharpDX_Vector2_SharpDX_Vector3__System_Single_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.ScreenToWorld(SharpDX.Vector2%2CSharpDX.Vector3%40%2CSystem.Single)%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/Game/Gui/GameGui.cs/#L250">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_ScreenToWorld_" data-uid="Dalamud.Game.Gui.GameGui.ScreenToWorld*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_ScreenToWorld_SharpDX_Vector2_SharpDX_Vector3__System_Single_" data-uid="Dalamud.Game.Gui.GameGui.ScreenToWorld(SharpDX.Vector2,SharpDX.Vector3@,System.Single)">ScreenToWorld(Vector2, out Vector3, Single)</h4>
<div class="markdown level1 summary"><p>Converts screen coordinates to in-world coordinates via raycasting.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool ScreenToWorld(Vector2 screenPos, out Vector3 worldPos, float rayDistance = 100000F)</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><span class="xref">SharpDX.Vector2</span></td>
<td><span class="parametername">screenPos</span></td>
<td><p>Screen coordinates.</p>
</td>
</tr>
<tr>
<td><span class="xref">SharpDX.Vector3</span></td>
<td><span class="parametername">worldPos</span></td>
<td><p>Converted coordinates.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">rayDistance</span></td>
<td><p>How far to search for a collision.</p>
</td>
</tr>
</tbody>
</table>
<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.Boolean</span></td>
<td><p>True if successful. On false, worldPos's contents are undefined.</p>
</td>
</tr>
</tbody>
@ -662,7 +600,7 @@ If &gt; 1.000.000, subtract 1.000.000 and treat it as HQ.</p>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_ScreenToWorld_System_Numerics_Vector2_System_Numerics_Vector3__System_Single_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.ScreenToWorld(System.Numerics.Vector2%2CSystem.Numerics.Vector3%40%2CSystem.Single)%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/Game/Gui/GameGui.cs/#L345">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L235">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_ScreenToWorld_" data-uid="Dalamud.Game.Gui.GameGui.ScreenToWorld*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_ScreenToWorld_System_Numerics_Vector2_System_Numerics_Vector3__System_Single_" data-uid="Dalamud.Game.Gui.GameGui.ScreenToWorld(System.Numerics.Vector2,System.Numerics.Vector3@,System.Single)">ScreenToWorld(Vector2, out Vector3, Single)</h4>
@ -719,15 +657,12 @@ If &gt; 1.000.000, subtract 1.000.000 and treat it as HQ.</p>
</tr>
</tbody>
</table>
<h5 id="Dalamud_Game_Gui_GameGui_ScreenToWorld_System_Numerics_Vector2_System_Numerics_Vector3__System_Single__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This overload requires a conversion to SharpDX vectors, however the penalty should be negligible.</p>
</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_Game_Gui_GameGui_SetBgm_System_UInt16_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.SetBgm(System.UInt16)%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/Game/Gui/GameGui.cs/#L456">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L424">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_SetBgm_" data-uid="Dalamud.Game.Gui.GameGui.SetBgm*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_SetBgm_System_UInt16_" data-uid="Dalamud.Game.Gui.GameGui.SetBgm(System.UInt16)">SetBgm(UInt16)</h4>
@ -752,62 +687,6 @@ If &gt; 1.000.000, subtract 1.000.000 and treat it as HQ.</p>
<td><span class="xref">System.UInt16</span></td>
<td><span class="parametername">bgmKey</span></td>
<td><p>The background music key.</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_Game_Gui_GameGui_WorldToScreen_SharpDX_Vector3_SharpDX_Vector2__.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.WorldToScreen(SharpDX.Vector3%2CSharpDX.Vector2%40)%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/Game/Gui/GameGui.cs/#L194">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_WorldToScreen_" data-uid="Dalamud.Game.Gui.GameGui.WorldToScreen*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_WorldToScreen_SharpDX_Vector3_SharpDX_Vector2__" data-uid="Dalamud.Game.Gui.GameGui.WorldToScreen(SharpDX.Vector3,SharpDX.Vector2@)">WorldToScreen(Vector3, out Vector2)</h4>
<div class="markdown level1 summary"><p>Converts in-world coordinates to screen coordinates (upper left corner origin).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool WorldToScreen(Vector3 worldPos, out Vector2 screenPos)</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><span class="xref">SharpDX.Vector3</span></td>
<td><span class="parametername">worldPos</span></td>
<td><p>Coordinates in the world.</p>
</td>
</tr>
<tr>
<td><span class="xref">SharpDX.Vector2</span></td>
<td><span class="parametername">screenPos</span></td>
<td><p>Converted coordinates.</p>
</td>
</tr>
</tbody>
</table>
<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.Boolean</span></td>
<td><p>True if worldPos corresponds to a position in front of the camera.</p>
</td>
</tr>
</tbody>
@ -817,7 +696,7 @@ If &gt; 1.000.000, subtract 1.000.000 and treat it as HQ.</p>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_WorldToScreen_System_Numerics_Vector3_System_Numerics_Vector2__.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.WorldToScreen(System.Numerics.Vector3%2CSystem.Numerics.Vector2%40)%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/Game/Gui/GameGui.cs/#L236">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L194">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_WorldToScreen_" data-uid="Dalamud.Game.Gui.GameGui.WorldToScreen*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_WorldToScreen_System_Numerics_Vector3_System_Numerics_Vector2__" data-uid="Dalamud.Game.Gui.GameGui.WorldToScreen(System.Numerics.Vector3,System.Numerics.Vector2@)">WorldToScreen(Vector3, out Vector2)</h4>
@ -868,9 +747,6 @@ If &gt; 1.000.000, subtract 1.000.000 and treat it as HQ.</p>
</tr>
</tbody>
</table>
<h5 id="Dalamud_Game_Gui_GameGui_WorldToScreen_System_Numerics_Vector3_System_Numerics_Vector2___remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This overload requires a conversion to SharpDX vectors, however the penalty should be negligible.</p>
</div>
<h3 id="events">Events
</h3>
<span class="small pull-right mobile-hide">