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 2020-05-12 20:44:53 +02:00
parent 5a80342243
commit 054315dfc0
85 changed files with 24425 additions and 2247 deletions
Download patch file Download diff file Expand all files Collapse all files

145
docs/api/Dalamud.Game.Internal.Gui.GameGui.html
View file

@ -121,7 +121,7 @@
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_GameGui__ctor_System_IntPtr_Dalamud_Game_SigScanner_Dalamud_Dalamud_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.GameGui.%23ctor(System.IntPtr%2CDalamud.Game.SigScanner%2CDalamud.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">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Internal/Gui/GameGui.cs/#L48">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Internal/Gui/GameGui.cs/#L58">View Source</a>
</span>
<a id="Dalamud_Game_Internal_Gui_GameGui__ctor_" data-uid="Dalamud.Game.Internal.Gui.GameGui.#ctor*"></a>
<h4 id="Dalamud_Game_Internal_Gui_GameGui__ctor_System_IntPtr_Dalamud_Game_SigScanner_Dalamud_Dalamud_" data-uid="Dalamud.Game.Internal.Gui.GameGui.#ctor(System.IntPtr,Dalamud.Game.SigScanner,Dalamud.Dalamud)">GameGui(IntPtr, SigScanner, Dalamud)</h4>
@ -165,7 +165,7 @@
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_GameGui_Chat.md&amp;value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.GameGui.Chat%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/Internal/Gui/GameGui.cs/#L11">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Internal/Gui/GameGui.cs/#L12">View Source</a>
</span>
<a id="Dalamud_Game_Internal_Gui_GameGui_Chat_" data-uid="Dalamud.Game.Internal.Gui.GameGui.Chat*"></a>
<h4 id="Dalamud_Game_Internal_Gui_GameGui_Chat" data-uid="Dalamud.Game.Internal.Gui.GameGui.Chat">Chat</h4>
@ -195,7 +195,7 @@
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_GameGui_HoveredItem.md&amp;value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.GameGui.HoveredItem%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/Internal/Gui/GameGui.cs/#L41">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Internal/Gui/GameGui.cs/#L51">View Source</a>
</span>
<a id="Dalamud_Game_Internal_Gui_GameGui_HoveredItem_" data-uid="Dalamud.Game.Internal.Gui.GameGui.HoveredItem*"></a>
<h4 id="Dalamud_Game_Internal_Gui_GameGui_HoveredItem" data-uid="Dalamud.Game.Internal.Gui.GameGui.HoveredItem">HoveredItem</h4>
@ -227,7 +227,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_Internal_Gui_GameGui_HoveredItemChanged.md&amp;value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.GameGui.HoveredItemChanged%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/Internal/Gui/GameGui.cs/#L46">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Internal/Gui/GameGui.cs/#L56">View Source</a>
</span>
<a id="Dalamud_Game_Internal_Gui_GameGui_HoveredItemChanged_" data-uid="Dalamud.Game.Internal.Gui.GameGui.HoveredItemChanged*"></a>
<h4 id="Dalamud_Game_Internal_Gui_GameGui_HoveredItemChanged" data-uid="Dalamud.Game.Internal.Gui.GameGui.HoveredItemChanged">HoveredItemChanged</h4>
@ -260,7 +260,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_Internal_Gui_GameGui_Dispose.md&amp;value=---%0Auid%3A%20Dalamud.Game.Internal.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/Internal/Gui/GameGui.cs/#L171">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Internal/Gui/GameGui.cs/#L294">View Source</a>
</span>
<a id="Dalamud_Game_Internal_Gui_GameGui_Dispose_" data-uid="Dalamud.Game.Internal.Gui.GameGui.Dispose*"></a>
<h4 id="Dalamud_Game_Internal_Gui_GameGui_Dispose" data-uid="Dalamud.Game.Internal.Gui.GameGui.Dispose">Dispose()</h4>
@ -275,7 +275,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_Internal_Gui_GameGui_Enable.md&amp;value=---%0Auid%3A%20Dalamud.Game.Internal.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/Internal/Gui/GameGui.cs/#L164">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Internal/Gui/GameGui.cs/#L287">View Source</a>
</span>
<a id="Dalamud_Game_Internal_Gui_GameGui_Enable_" data-uid="Dalamud.Game.Internal.Gui.GameGui.Enable*"></a>
<h4 id="Dalamud_Game_Internal_Gui_GameGui_Enable" data-uid="Dalamud.Game.Internal.Gui.GameGui.Enable">Enable()</h4>
@ -290,11 +290,12 @@ 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_Internal_Gui_GameGui_OpenMapWithMapLink_Dalamud_Game_Chat_SeStringHandling_Payloads_MapLinkPayload_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.GameGui.OpenMapWithMapLink(Dalamud.Game.Chat.SeStringHandling.Payloads.MapLinkPayload)%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/Internal/Gui/GameGui.cs/#L129">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Internal/Gui/GameGui.cs/#L150">View Source</a>
</span>
<a id="Dalamud_Game_Internal_Gui_GameGui_OpenMapWithMapLink_" data-uid="Dalamud.Game.Internal.Gui.GameGui.OpenMapWithMapLink*"></a>
<h4 id="Dalamud_Game_Internal_Gui_GameGui_OpenMapWithMapLink_Dalamud_Game_Chat_SeStringHandling_Payloads_MapLinkPayload_" data-uid="Dalamud.Game.Internal.Gui.GameGui.OpenMapWithMapLink(Dalamud.Game.Chat.SeStringHandling.Payloads.MapLinkPayload)">OpenMapWithMapLink(MapLinkPayload)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Opens the in-game map with a flag on the location of the parameter</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -313,7 +314,8 @@ If &gt; 1.000.000, subtract 1.000.000 and treat it as HQ</p>
<tr>
<td><a class="xref" href="Dalamud.Game.Chat.SeStringHandling.Payloads.MapLinkPayload.html">MapLinkPayload</a></td>
<td><span class="parametername">mapLink</span></td>
<td></td>
<td><p>Link to the map to be opened</p>
</td>
</tr>
</tbody>
</table>
@ -328,7 +330,70 @@ If &gt; 1.000.000, subtract 1.000.000 and treat it as HQ</p>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></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_Internal_Gui_GameGui_ScreenToWorld_SharpDX_Vector2_SharpDX_Vector3__System_Single_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Internal.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/Internal/Gui/GameGui.cs/#L223">View Source</a>
</span>
<a id="Dalamud_Game_Internal_Gui_GameGui_ScreenToWorld_" data-uid="Dalamud.Game.Internal.Gui.GameGui.ScreenToWorld*"></a>
<h4 id="Dalamud_Game_Internal_Gui_GameGui_ScreenToWorld_SharpDX_Vector2_SharpDX_Vector3__System_Single_" data-uid="Dalamud.Game.Internal.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>
</table>
@ -337,7 +402,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_Internal_Gui_GameGui_SetBgm_System_UInt16_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Internal.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/Internal/Gui/GameGui.cs/#L162">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Internal/Gui/GameGui.cs/#L285">View Source</a>
</span>
<a id="Dalamud_Game_Internal_Gui_GameGui_SetBgm_" data-uid="Dalamud.Game.Internal.Gui.GameGui.SetBgm*"></a>
<h4 id="Dalamud_Game_Internal_Gui_GameGui_SetBgm_System_UInt16_" data-uid="Dalamud.Game.Internal.Gui.GameGui.SetBgm(System.UInt16)">SetBgm(UInt16)</h4>
@ -364,6 +429,62 @@ If &gt; 1.000.000, subtract 1.000.000 and treat it as HQ</p>
</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_Internal_Gui_GameGui_WorldToScreen_SharpDX_Vector3_SharpDX_Vector2__.md&amp;value=---%0Auid%3A%20Dalamud.Game.Internal.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/Internal/Gui/GameGui.cs/#L188">View Source</a>
</span>
<a id="Dalamud_Game_Internal_Gui_GameGui_WorldToScreen_" data-uid="Dalamud.Game.Internal.Gui.GameGui.WorldToScreen*"></a>
<h4 id="Dalamud_Game_Internal_Gui_GameGui_WorldToScreen_SharpDX_Vector3_SharpDX_Vector2__" data-uid="Dalamud.Game.Internal.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>
</table>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.IDisposable</span>
@ -379,7 +500,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_Internal_Gui_GameGui.md&amp;value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.GameGui%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/Game/Internal/Gui/GameGui.cs/#L8" class="contribution-link">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Internal/Gui/GameGui.cs/#L9" class="contribution-link">View Source</a>
</li>
</ul>
</div>