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
Dalamud/docs/api/Dalamud.Game.ClientState.GamePad.GamepadState.html
goat 1eb35f29eb
docs: regenerate
2021-08-21 22:57:51 +02:00

739 lines
38 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class GamepadState
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class GamepadState
">
<meta name="generator" content="docfx 2.58.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.GamePad.GamepadState">
<h1 id="Dalamud_Game_ClientState_GamePad_GamepadState" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState" class="text-break">Class GamepadState
</h1>
<div class="markdown level0 summary"><p>Exposes the game gamepad state to dalamud.</p>
<p>Will block game's gamepad input if <a class="xref" href="ImGuiNET.ImGuiConfigFlags.html#ImGuiNET_ImGuiConfigFlags_NavEnableGamepad">NavEnableGamepad</a> is set.</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">GamepadState</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">System.IDisposable</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.GamePad.html">Dalamud.Game.ClientState.GamePad</a></h6>
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
<h5 id="Dalamud_Game_ClientState_GamePad_GamepadState_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class GamepadState : IDisposable</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<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_ClientState_GamePad_GamepadState__ctor_Dalamud_Game_ClientState_ClientStateAddressResolver_.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadState.%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/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/GamePad/GamepadState.cs/#L29">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_GamePad_GamepadState__ctor_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.#ctor*"></a>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadState__ctor_Dalamud_Game_ClientState_ClientStateAddressResolver_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.#ctor(Dalamud.Game.ClientState.ClientStateAddressResolver)">GamepadState(ClientStateAddressResolver)</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Dalamud.Game.ClientState.GamePad.GamepadState.html">GamepadState</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 GamepadState(ClientStateAddressResolver resolver)</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">Dalamud.Game.ClientState.ClientStateAddressResolver</span></td>
<td><span class="parametername">resolver</span></td>
<td><p>Resolver knowing the pointer to the GamepadPoll function.</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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_GamePad_GamepadState_GamepadInputAddress.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadState.GamepadInputAddress%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/ClientState/GamePad/GamepadState.cs/#L48">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_GamePad_GamepadState_GamepadInputAddress_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.GamepadInputAddress*"></a>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadState_GamepadInputAddress" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.GamepadInputAddress">GamepadInputAddress</h4>
<div class="markdown level1 summary"><p>Gets the pointer to the current instance of the GamepadInput struct.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IntPtr GamepadInputAddress { get; }</code></pre>
</div>
<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.IntPtr</span></td>
<td></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_ClientState_GamePad_GamepadState_LeftStickDown.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadState.LeftStickDown%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/ClientState/GamePad/GamepadState.cs/#L68">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_GamePad_GamepadState_LeftStickDown_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.LeftStickDown*"></a>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadState_LeftStickDown" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.LeftStickDown">LeftStickDown</h4>
<div class="markdown level1 summary"><p>Gets the state of the left analogue stick in the down direction between 0 (not tilted) and 1 (max tilt).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public float LeftStickDown { get; }</code></pre>
</div>
<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.Single</span></td>
<td></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_ClientState_GamePad_GamepadState_LeftStickLeft.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadState.LeftStickLeft%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/ClientState/GamePad/GamepadState.cs/#L53">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_GamePad_GamepadState_LeftStickLeft_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.LeftStickLeft*"></a>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadState_LeftStickLeft" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.LeftStickLeft">LeftStickLeft</h4>
<div class="markdown level1 summary"><p>Gets the state of the left analogue stick in the left direction between 0 (not tilted) and 1 (max tilt).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public float LeftStickLeft { get; }</code></pre>
</div>
<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.Single</span></td>
<td></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_ClientState_GamePad_GamepadState_LeftStickRight.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadState.LeftStickRight%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/ClientState/GamePad/GamepadState.cs/#L58">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_GamePad_GamepadState_LeftStickRight_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.LeftStickRight*"></a>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadState_LeftStickRight" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.LeftStickRight">LeftStickRight</h4>
<div class="markdown level1 summary"><p>Gets the state of the left analogue stick in the right direction between 0 (not tilted) and 1 (max tilt).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public float LeftStickRight { get; }</code></pre>
</div>
<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.Single</span></td>
<td></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_ClientState_GamePad_GamepadState_LeftStickUp.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadState.LeftStickUp%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/ClientState/GamePad/GamepadState.cs/#L63">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_GamePad_GamepadState_LeftStickUp_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.LeftStickUp*"></a>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadState_LeftStickUp" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.LeftStickUp">LeftStickUp</h4>
<div class="markdown level1 summary"><p>Gets the state of the left analogue stick in the up direction between 0 (not tilted) and 1 (max tilt).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public float LeftStickUp { get; }</code></pre>
</div>
<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.Single</span></td>
<td></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_ClientState_GamePad_GamepadState_RightStickDown.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadState.RightStickDown%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/ClientState/GamePad/GamepadState.cs/#L88">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_GamePad_GamepadState_RightStickDown_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.RightStickDown*"></a>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadState_RightStickDown" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.RightStickDown">RightStickDown</h4>
<div class="markdown level1 summary"><p>Gets the state of the right analogue stick in the down direction between 0 (not tilted) and 1 (max tilt).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public float RightStickDown { get; }</code></pre>
</div>
<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.Single</span></td>
<td></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_ClientState_GamePad_GamepadState_RightStickLeft.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadState.RightStickLeft%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/ClientState/GamePad/GamepadState.cs/#L73">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_GamePad_GamepadState_RightStickLeft_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.RightStickLeft*"></a>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadState_RightStickLeft" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.RightStickLeft">RightStickLeft</h4>
<div class="markdown level1 summary"><p>Gets the state of the right analogue stick in the left direction between 0 (not tilted) and 1 (max tilt).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public float RightStickLeft { get; }</code></pre>
</div>
<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.Single</span></td>
<td></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_ClientState_GamePad_GamepadState_RightStickRight.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadState.RightStickRight%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/ClientState/GamePad/GamepadState.cs/#L78">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_GamePad_GamepadState_RightStickRight_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.RightStickRight*"></a>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadState_RightStickRight" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.RightStickRight">RightStickRight</h4>
<div class="markdown level1 summary"><p>Gets the state of the right analogue stick in the right direction between 0 (not tilted) and 1 (max tilt).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public float RightStickRight { get; }</code></pre>
</div>
<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.Single</span></td>
<td></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_ClientState_GamePad_GamepadState_RightStickUp.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadState.RightStickUp%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/ClientState/GamePad/GamepadState.cs/#L83">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_GamePad_GamepadState_RightStickUp_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.RightStickUp*"></a>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadState_RightStickUp" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.RightStickUp">RightStickUp</h4>
<div class="markdown level1 summary"><p>Gets the state of the right analogue stick in the up direction between 0 (not tilted) and 1 (max tilt).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public float RightStickUp { get; }</code></pre>
</div>
<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.Single</span></td>
<td></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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_GamePad_GamepadState_Dispose.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadState.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/ClientState/GamePad/GamepadState.cs/#L178">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_GamePad_GamepadState_Dispose_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.Dispose*"></a>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadState_Dispose" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.Dispose">Dispose()</h4>
<div class="markdown level1 summary"><p>Disposes this instance, alongside its hooks.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
</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_ClientState_GamePad_GamepadState_Enable.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadState.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/ClientState/GamePad/GamepadState.cs/#L170">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_GamePad_GamepadState_Enable_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.Enable*"></a>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadState_Enable" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.Enable">Enable()</h4>
<div class="markdown level1 summary"><p>Enables the hook of the GamepadPoll function.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Enable()</code></pre>
</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_ClientState_GamePad_GamepadState_Finalize.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadState.Finalize%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/ClientState/GamePad/GamepadState.cs/#L38">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_GamePad_GamepadState_Finalize_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.Finalize*"></a>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadState_Finalize" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.Finalize">Finalize()</h4>
<div class="markdown level1 summary"><p>Finalizes an instance of the <a class="xref" href="Dalamud.Game.ClientState.GamePad.GamepadState.html">GamepadState</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected void Finalize()</code></pre>
</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_ClientState_GamePad_GamepadState_Pressed_Dalamud_Game_ClientState_GamePad_GamepadButtons_.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadState.Pressed(Dalamud.Game.ClientState.GamePad.GamepadButtons)%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/ClientState/GamePad/GamepadState.cs/#L136">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_GamePad_GamepadState_Pressed_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.Pressed*"></a>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadState_Pressed_Dalamud_Game_ClientState_GamePad_GamepadButtons_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.Pressed(Dalamud.Game.ClientState.GamePad.GamepadButtons)">Pressed(GamepadButtons)</h4>
<div class="markdown level1 summary"><p>Gets whether <code data-dev-comment-type="paramref" class="paramref">button</code> has been pressed.</p>
<p>Only true on first frame of the press.
If ImGuiConfigFlags.NavEnableGamepad is set, this is unreliable.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public float Pressed(GamepadButtons button)</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.GamePad.GamepadButtons.html">GamepadButtons</a></td>
<td><span class="parametername">button</span></td>
<td><p>The button to check for.</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.Single</span></td>
<td><p>1 if pressed, 0 otherwise.</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_ClientState_GamePad_GamepadState_Raw_Dalamud_Game_ClientState_GamePad_GamepadButtons_.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadState.Raw(Dalamud.Game.ClientState.GamePad.GamepadButtons)%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/ClientState/GamePad/GamepadState.cs/#L165">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_GamePad_GamepadState_Raw_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.Raw*"></a>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadState_Raw_Dalamud_Game_ClientState_GamePad_GamepadButtons_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.Raw(Dalamud.Game.ClientState.GamePad.GamepadButtons)">Raw(GamepadButtons)</h4>
<div class="markdown level1 summary"><p>Gets the raw state of <code data-dev-comment-type="paramref" class="paramref">button</code>.</p>
<p>Is set the entire time a button is pressed down.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public float Raw(GamepadButtons button)</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.GamePad.GamepadButtons.html">GamepadButtons</a></td>
<td><span class="parametername">button</span></td>
<td><p>The button to check for.</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.Single</span></td>
<td><p>1 the whole time button is pressed, 0 otherwise.</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_ClientState_GamePad_GamepadState_Released_Dalamud_Game_ClientState_GamePad_GamepadButtons_.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadState.Released(Dalamud.Game.ClientState.GamePad.GamepadButtons)%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/ClientState/GamePad/GamepadState.cs/#L156">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_GamePad_GamepadState_Released_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.Released*"></a>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadState_Released_Dalamud_Game_ClientState_GamePad_GamepadButtons_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.Released(Dalamud.Game.ClientState.GamePad.GamepadButtons)">Released(GamepadButtons)</h4>
<div class="markdown level1 summary"><p>Gets whether <code data-dev-comment-type="paramref" class="paramref">button</code> has been released.</p>
<p>Only true the frame after release.
If ImGuiConfigFlags.NavEnableGamepad is set, this is unreliable.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public float Released(GamepadButtons button)</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.GamePad.GamepadButtons.html">GamepadButtons</a></td>
<td><span class="parametername">button</span></td>
<td><p>The button to check for.</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.Single</span></td>
<td><p>1 if released, 0 otherwise.</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_ClientState_GamePad_GamepadState_Repeat_Dalamud_Game_ClientState_GamePad_GamepadButtons_.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadState.Repeat(Dalamud.Game.ClientState.GamePad.GamepadButtons)%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/ClientState/GamePad/GamepadState.cs/#L146">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_GamePad_GamepadState_Repeat_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.Repeat*"></a>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadState_Repeat_Dalamud_Game_ClientState_GamePad_GamepadButtons_" data-uid="Dalamud.Game.ClientState.GamePad.GamepadState.Repeat(Dalamud.Game.ClientState.GamePad.GamepadButtons)">Repeat(GamepadButtons)</h4>
<div class="markdown level1 summary"><p>Gets whether <code data-dev-comment-type="paramref" class="paramref">button</code> is being pressed.</p>
<p>True in intervals if button is held down.
If ImGuiConfigFlags.NavEnableGamepad is set, this is unreliable.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public float Repeat(GamepadButtons button)</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.GamePad.GamepadButtons.html">GamepadButtons</a></td>
<td><span class="parametername">button</span></td>
<td><p>The button to check for.</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.Single</span></td>
<td><p>1 if still pressed during interval, 0 otherwise or in between intervals.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.IDisposable</span>
</div>
</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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_GamePad_GamepadState.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadState%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/ClientState/GamePad/GamepadState.cs/#L14" 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>
Reference in a new issue View git blame Copy permalink