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

docs: regenerate

Browse source
This commit is contained in:
goat 2022-10-29 15:34:04 +02:00
parent 02f90899a3
commit 6fd636c26c
No known key found for this signature in database
GPG key ID: 49E2AA8C6A76498B
1239 changed files with 214126 additions and 66229 deletions
Download patch file Download diff file Expand all files Collapse all files

68
docs/api/Dalamud.Game.ClientState.Keys.KeyState.html
View file

@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class KeyState
">
<meta name="generator" content="docfx 2.59.1.0">
<meta name="generator" content="docfx 2.59.4.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
@ -81,6 +81,10 @@
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">KeyState</span></div>
</div>
<div class="implements">
<h5>Implements</h5>
<div><a class="xref" href="Dalamud.IServiceType.html">IServiceType</a></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
@ -109,7 +113,7 @@
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
<h5 id="Dalamud_Game_ClientState_Keys_KeyState_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class KeyState</code></pre>
<pre><code class="lang-csharp hljs">public class KeyState : IServiceType</code></pre>
</div>
<h5 id="Dalamud_Game_ClientState_Keys_KeyState_remarks"><strong>Remarks</strong></h5>
<div class="markdown level0 remarks"><p>The stored key state is actually a combination field, however the below ephemeral states are consumed each frame. Setting
@ -120,42 +124,6 @@ index &amp; 1 = key down (ephemeral).
index &amp; 2 = key up (ephemeral).
index &amp; 3 = short key press (ephemeral).</p>
</div>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Keys_KeyState__ctor_Dalamud_Game_ClientState_ClientStateAddressResolver_.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Keys.KeyState.%23ctor(Dalamud.Game.ClientState.ClientStateAddressResolver)%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/Game/ClientState/Keys/KeyState.cs/#L39">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Keys_KeyState__ctor_" data-uid="Dalamud.Game.ClientState.Keys.KeyState.#ctor*"></a>
<h4 id="Dalamud_Game_ClientState_Keys_KeyState__ctor_Dalamud_Game_ClientState_ClientStateAddressResolver_" data-uid="Dalamud.Game.ClientState.Keys.KeyState.#ctor(Dalamud.Game.ClientState.ClientStateAddressResolver)">KeyState(ClientStateAddressResolver)</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Dalamud.Game.ClientState.Keys.KeyState.html">KeyState</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public KeyState(ClientStateAddressResolver addressResolver)</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.Game.ClientState.ClientStateAddressResolver.html">ClientStateAddressResolver</a></td>
<td><span class="parametername">addressResolver</span></td>
<td><p>The ClientStateAddressResolver instance.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
@ -163,7 +131,7 @@ index &amp; 3 = short key press (ephemeral).</p>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Keys_KeyState_Item_Dalamud_Game_ClientState_Keys_VirtualKey_.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Keys.KeyState.Item(Dalamud.Game.ClientState.Keys.VirtualKey)%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/Game/ClientState/Keys/KeyState.cs/#L63">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Keys/KeyState.cs/#L61">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Keys_KeyState_Item_" data-uid="Dalamud.Game.ClientState.Keys.KeyState.Item*"></a>
<h4 id="Dalamud_Game_ClientState_Keys_KeyState_Item_Dalamud_Game_ClientState_Keys_VirtualKey_" data-uid="Dalamud.Game.ClientState.Keys.KeyState.Item(Dalamud.Game.ClientState.Keys.VirtualKey)">Item[VirtualKey]</h4>
@ -233,7 +201,7 @@ index &amp; 3 = short key press (ephemeral).</p>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Keys_KeyState_Item_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Keys.KeyState.Item(System.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/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Keys/KeyState.cs/#L56">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Keys/KeyState.cs/#L54">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Keys_KeyState_Item_" data-uid="Dalamud.Game.ClientState.Keys.KeyState.Item*"></a>
<h4 id="Dalamud_Game_ClientState_Keys_KeyState_Item_System_Int32_" data-uid="Dalamud.Game.ClientState.Keys.KeyState.Item(System.Int32)">Item[Int32]</h4>
@ -306,7 +274,7 @@ index &amp; 3 = short key press (ephemeral).</p>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Keys_KeyState_ClearAll.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Keys.KeyState.ClearAll%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/Game/ClientState/Keys/KeyState.cs/#L123">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Keys/KeyState.cs/#L121">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Keys_KeyState_ClearAll_" data-uid="Dalamud.Game.ClientState.Keys.KeyState.ClearAll*"></a>
<h4 id="Dalamud_Game_ClientState_Keys_KeyState_ClearAll" data-uid="Dalamud.Game.ClientState.Keys.KeyState.ClearAll">ClearAll()</h4>
@ -322,7 +290,7 @@ index &amp; 3 = short key press (ephemeral).</p>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Keys_KeyState_GetRawValue_Dalamud_Game_ClientState_Keys_VirtualKey_.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Keys.KeyState.GetRawValue(Dalamud.Game.ClientState.Keys.VirtualKey)%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/Game/ClientState/Keys/KeyState.cs/#L79">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Keys/KeyState.cs/#L77">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Keys_KeyState_GetRawValue_" data-uid="Dalamud.Game.ClientState.Keys.KeyState.GetRawValue*"></a>
<h4 id="Dalamud_Game_ClientState_Keys_KeyState_GetRawValue_Dalamud_Game_ClientState_Keys_VirtualKey_" data-uid="Dalamud.Game.ClientState.Keys.KeyState.GetRawValue(Dalamud.Game.ClientState.Keys.VirtualKey)">GetRawValue(VirtualKey)</h4>
@ -387,7 +355,7 @@ index &amp; 3 = short key press (ephemeral).</p>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Keys_KeyState_GetRawValue_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Keys.KeyState.GetRawValue(System.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/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Keys/KeyState.cs/#L75">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Keys/KeyState.cs/#L73">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Keys_KeyState_GetRawValue_" data-uid="Dalamud.Game.ClientState.Keys.KeyState.GetRawValue*"></a>
<h4 id="Dalamud_Game_ClientState_Keys_KeyState_GetRawValue_System_Int32_" data-uid="Dalamud.Game.ClientState.Keys.KeyState.GetRawValue(System.Int32)">GetRawValue(Int32)</h4>
@ -453,7 +421,7 @@ index &amp; 3 = short key press (ephemeral).</p>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Keys_KeyState_GetValidVirtualKeys.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Keys.KeyState.GetValidVirtualKeys%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/Game/ClientState/Keys/KeyState.cs/#L117">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Keys/KeyState.cs/#L115">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Keys_KeyState_GetValidVirtualKeys_" data-uid="Dalamud.Game.ClientState.Keys.KeyState.GetValidVirtualKeys*"></a>
<h4 id="Dalamud_Game_ClientState_Keys_KeyState_GetValidVirtualKeys" data-uid="Dalamud.Game.ClientState.Keys.KeyState.GetValidVirtualKeys">GetValidVirtualKeys()</h4>
@ -485,7 +453,7 @@ index &amp; 3 = short key press (ephemeral).</p>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Keys_KeyState_IsVirtualKeyValid_Dalamud_Game_ClientState_Keys_VirtualKey_.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Keys.KeyState.IsVirtualKeyValid(Dalamud.Game.ClientState.Keys.VirtualKey)%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/Game/ClientState/Keys/KeyState.cs/#L110">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Keys/KeyState.cs/#L108">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Keys_KeyState_IsVirtualKeyValid_" data-uid="Dalamud.Game.ClientState.Keys.KeyState.IsVirtualKeyValid*"></a>
<h4 id="Dalamud_Game_ClientState_Keys_KeyState_IsVirtualKeyValid_Dalamud_Game_ClientState_Keys_VirtualKey_" data-uid="Dalamud.Game.ClientState.Keys.KeyState.IsVirtualKeyValid(Dalamud.Game.ClientState.Keys.VirtualKey)">IsVirtualKeyValid(VirtualKey)</h4>
@ -534,7 +502,7 @@ index &amp; 3 = short key press (ephemeral).</p>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Keys_KeyState_IsVirtualKeyValid_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Keys.KeyState.IsVirtualKeyValid(System.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/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Keys/KeyState.cs/#L106">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Keys/KeyState.cs/#L104">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Keys_KeyState_IsVirtualKeyValid_" data-uid="Dalamud.Game.ClientState.Keys.KeyState.IsVirtualKeyValid*"></a>
<h4 id="Dalamud_Game_ClientState_Keys_KeyState_IsVirtualKeyValid_System_Int32_" data-uid="Dalamud.Game.ClientState.Keys.KeyState.IsVirtualKeyValid(System.Int32)">IsVirtualKeyValid(Int32)</h4>
@ -584,7 +552,7 @@ index &amp; 3 = short key press (ephemeral).</p>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Keys_KeyState_SetRawValue_Dalamud_Game_ClientState_Keys_VirtualKey_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Keys.KeyState.SetRawValue(Dalamud.Game.ClientState.Keys.VirtualKey%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/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Keys/KeyState.cs/#L98">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Keys/KeyState.cs/#L96">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Keys_KeyState_SetRawValue_" data-uid="Dalamud.Game.ClientState.Keys.KeyState.SetRawValue*"></a>
<h4 id="Dalamud_Game_ClientState_Keys_KeyState_SetRawValue_Dalamud_Game_ClientState_Keys_VirtualKey_System_Int32_" data-uid="Dalamud.Game.ClientState.Keys.KeyState.SetRawValue(Dalamud.Game.ClientState.Keys.VirtualKey,System.Int32)">SetRawValue(VirtualKey, Int32)</h4>
@ -644,7 +612,7 @@ index &amp; 3 = short key press (ephemeral).</p>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Keys_KeyState_SetRawValue_System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.Keys.KeyState.SetRawValue(System.Int32%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/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Keys/KeyState.cs/#L89">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Keys/KeyState.cs/#L87">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_Keys_KeyState_SetRawValue_" data-uid="Dalamud.Game.ClientState.Keys.KeyState.SetRawValue*"></a>
<h4 id="Dalamud_Game_ClientState_Keys_KeyState_SetRawValue_System_Int32_System_Int32_" data-uid="Dalamud.Game.ClientState.Keys.KeyState.SetRawValue(System.Int32,System.Int32)">SetRawValue(Int32, Int32)</h4>
@ -700,6 +668,10 @@ index &amp; 3 = short key press (ephemeral).</p>
</tr>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<a class="xref" href="Dalamud.IServiceType.html">IServiceType</a>
</div>
</article>
</div>