mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
745 lines
34 KiB
HTML
745 lines
34 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class KeyState
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class KeyState
|
|
">
|
|
<meta name="generator" content="docfx 2.59.0.0">
|
|
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<meta property="docfx:navrel" content="">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
|
|
|
|
</head>
|
|
<body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="Dalamud.Game.ClientState.Keys.KeyState">
|
|
|
|
|
|
<h1 id="Dalamud_Game_ClientState_Keys_KeyState" data-uid="Dalamud.Game.ClientState.Keys.KeyState" class="text-break">Class KeyState
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Wrapper around the game keystate buffer, which contains the pressed state for all keyboard keys, indexed by virtual vkCode.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">System.Object</span></div>
|
|
<div class="level1"><span class="xref">KeyState</span></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetHashCode()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetType()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.MemberwiseClone()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ToString()</span>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Game.ClientState.Keys.html">Dalamud.Game.ClientState.Keys</a></h6>
|
|
<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>
|
|
</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
|
|
the value may be mildly useful, however retrieving the value is largely pointless. In testing, it wasn't possible without
|
|
setting the statue manually.
|
|
index & 0 = key pressed.
|
|
index & 1 = key down (ephemeral).
|
|
index & 2 = key up (ephemeral).
|
|
index & 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&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">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Keys_KeyState_Item_Dalamud_Game_ClientState_Keys_VirtualKey_.md&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>
|
|
</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>
|
|
<div class="markdown level1 summary"><p>Get or set the key-pressed state for a given vkCode.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool this[VirtualKey vkCode] { get; set; }</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.Keys.VirtualKey.html">VirtualKey</a></td>
|
|
<td><span class="parametername">vkCode</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="propertyValue">Property Value</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>Whether the specified key is currently pressed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.ArgumentException</span></td>
|
|
<td><p>If the vkCode is not valid. Refer to <a class="xref" href="Dalamud.Game.ClientState.Keys.KeyState.html#Dalamud_Game_ClientState_Keys_KeyState_IsVirtualKeyValid_System_Int32_">IsVirtualKeyValid(Int32)</a> or <a class="xref" href="Dalamud.Game.ClientState.Keys.KeyState.html#Dalamud_Game_ClientState_Keys_KeyState_GetValidVirtualKeys">GetValidVirtualKeys()</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.ArgumentOutOfRangeException</span></td>
|
|
<td><p>If the set value is non-zero.</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_Game_ClientState_Keys_KeyState_Item_System_Int32_.md&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>
|
|
</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>
|
|
<div class="markdown level1 summary"><p>Get or set the key-pressed state for a given vkCode.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool this[int vkCode] { get; set; }</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">System.Int32</span></td>
|
|
<td><span class="parametername">vkCode</span></td>
|
|
<td><p>The virtual key to change.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="propertyValue">Property Value</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>Whether the specified key is currently pressed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.ArgumentException</span></td>
|
|
<td><p>If the vkCode is not valid. Refer to <a class="xref" href="Dalamud.Game.ClientState.Keys.KeyState.html#Dalamud_Game_ClientState_Keys_KeyState_IsVirtualKeyValid_System_Int32_">IsVirtualKeyValid(Int32)</a> or <a class="xref" href="Dalamud.Game.ClientState.Keys.KeyState.html#Dalamud_Game_ClientState_Keys_KeyState_GetValidVirtualKeys">GetValidVirtualKeys()</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.ArgumentOutOfRangeException</span></td>
|
|
<td><p>If the set value is non-zero.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</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_ClearAll.md&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>
|
|
</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>
|
|
<div class="markdown level1 summary"><p>Clears the pressed state for all keys.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void ClearAll()</code></pre>
|
|
</div>
|
|
<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_GetRawValue_Dalamud_Game_ClientState_Keys_VirtualKey_.md&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>
|
|
</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>
|
|
<div class="markdown level1 summary"><p>Gets the value in the index array.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public int GetRawValue(VirtualKey vkCode)</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.Keys.VirtualKey.html">VirtualKey</a></td>
|
|
<td><span class="parametername">vkCode</span></td>
|
|
<td></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.Int32</span></td>
|
|
<td><p>The raw value stored in the index array.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.ArgumentException</span></td>
|
|
<td><p>If the vkCode is not valid. Refer to <a class="xref" href="Dalamud.Game.ClientState.Keys.KeyState.html#Dalamud_Game_ClientState_Keys_KeyState_IsVirtualKeyValid_System_Int32_">IsVirtualKeyValid(Int32)</a> or <a class="xref" href="Dalamud.Game.ClientState.Keys.KeyState.html#Dalamud_Game_ClientState_Keys_KeyState_GetValidVirtualKeys">GetValidVirtualKeys()</a>.</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_Game_ClientState_Keys_KeyState_GetRawValue_System_Int32_.md&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>
|
|
</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>
|
|
<div class="markdown level1 summary"><p>Gets the value in the index array.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public int GetRawValue(int vkCode)</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">System.Int32</span></td>
|
|
<td><span class="parametername">vkCode</span></td>
|
|
<td><p>The virtual key to change.</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.Int32</span></td>
|
|
<td><p>The raw value stored in the index array.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.ArgumentException</span></td>
|
|
<td><p>If the vkCode is not valid. Refer to <a class="xref" href="Dalamud.Game.ClientState.Keys.KeyState.html#Dalamud_Game_ClientState_Keys_KeyState_IsVirtualKeyValid_System_Int32_">IsVirtualKeyValid(Int32)</a> or <a class="xref" href="Dalamud.Game.ClientState.Keys.KeyState.html#Dalamud_Game_ClientState_Keys_KeyState_GetValidVirtualKeys">GetValidVirtualKeys()</a>.</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_Game_ClientState_Keys_KeyState_GetValidVirtualKeys.md&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>
|
|
</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>
|
|
<div class="markdown level1 summary"><p>Gets an array of virtual keys the game considers valid input.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public VirtualKey[] GetValidVirtualKeys()</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><a class="xref" href="Dalamud.Game.ClientState.Keys.VirtualKey.html">VirtualKey</a>[]</td>
|
|
<td><p>An array of valid virtual keys.</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_Game_ClientState_Keys_KeyState_IsVirtualKeyValid_Dalamud_Game_ClientState_Keys_VirtualKey_.md&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>
|
|
</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>
|
|
<div class="markdown level1 summary"><p>Gets a value indicating whether the given VirtualKey code is regarded as valid input by the game.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool IsVirtualKeyValid(VirtualKey vkCode)</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.Keys.VirtualKey.html">VirtualKey</a></td>
|
|
<td><span class="parametername">vkCode</span></td>
|
|
<td></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>If the code is valid.</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_Game_ClientState_Keys_KeyState_IsVirtualKeyValid_System_Int32_.md&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>
|
|
</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>
|
|
<div class="markdown level1 summary"><p>Gets a value indicating whether the given VirtualKey code is regarded as valid input by the game.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool IsVirtualKeyValid(int vkCode)</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">System.Int32</span></td>
|
|
<td><span class="parametername">vkCode</span></td>
|
|
<td><p>Virtual key code.</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>If the code is valid.</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_Game_ClientState_Keys_KeyState_SetRawValue_Dalamud_Game_ClientState_Keys_VirtualKey_System_Int32_.md&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>
|
|
</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>
|
|
<div class="markdown level1 summary"><p>Sets the value in the index array.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void SetRawValue(VirtualKey vkCode, int value)</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.Keys.VirtualKey.html">VirtualKey</a></td>
|
|
<td><span class="parametername">vkCode</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The raw value to set in the index array.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.ArgumentException</span></td>
|
|
<td><p>If the vkCode is not valid. Refer to <a class="xref" href="Dalamud.Game.ClientState.Keys.KeyState.html#Dalamud_Game_ClientState_Keys_KeyState_IsVirtualKeyValid_System_Int32_">IsVirtualKeyValid(Int32)</a> or <a class="xref" href="Dalamud.Game.ClientState.Keys.KeyState.html#Dalamud_Game_ClientState_Keys_KeyState_GetValidVirtualKeys">GetValidVirtualKeys()</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.ArgumentOutOfRangeException</span></td>
|
|
<td><p>If the set value is non-zero.</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_Game_ClientState_Keys_KeyState_SetRawValue_System_Int32_System_Int32_.md&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>
|
|
</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>
|
|
<div class="markdown level1 summary"><p>Sets the value in the index array.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void SetRawValue(int vkCode, int value)</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">System.Int32</span></td>
|
|
<td><span class="parametername">vkCode</span></td>
|
|
<td><p>The virtual key to change.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The raw value to set in the index array.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.ArgumentException</span></td>
|
|
<td><p>If the vkCode is not valid. Refer to <a class="xref" href="Dalamud.Game.ClientState.Keys.KeyState.html#Dalamud_Game_ClientState_Keys_KeyState_IsVirtualKeyValid_System_Int32_">IsVirtualKeyValid(Int32)</a> or <a class="xref" href="Dalamud.Game.ClientState.Keys.KeyState.html#Dalamud_Game_ClientState_Keys_KeyState_GetValidVirtualKeys">GetValidVirtualKeys()</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.ArgumentOutOfRangeException</span></td>
|
|
<td><p>If the set value is non-zero.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<div class="contribution">
|
|
<ul class="nav">
|
|
<li>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Keys_KeyState.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Keys.KeyState%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/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Keys/KeyState.cs/#L23" class="contribution-link">View Source</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<h5>In This Article</h5>
|
|
<div></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|
</body>
|
|
</html>
|