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.GamepadInput.html
goaaats 077c1bca96
docs: regenerate
2022-04-03 04:09:45 +02:00

405 lines
19 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>Struct GamepadInput
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Struct GamepadInput
">
<meta name="generator" content="docfx 2.59.1.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.GamepadInput">
<h1 id="Dalamud_Game_ClientState_GamePad_GamepadInput" data-uid="Dalamud.Game.ClientState.GamePad.GamepadInput" class="text-break">Struct GamepadInput
</h1>
<div class="markdown level0 summary"><p>Struct which gets populated by polling the gamepads.</p>
<p>Has an array of gamepads, among many other things (here not mapped).
All we really care about is the final data which the game uses to determine input.</p>
<p>The size is definitely bigger than only the following fields but I do not know how big.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.ValueType.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.ValueType.GetHashCode()</span>
</div>
<div>
<span class="xref">System.ValueType.ToString()</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</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_GamepadInput_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public struct GamepadInput</code></pre>
</div>
<h3 id="fields">Fields
</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_GamePad_GamepadInput_ButtonsPressed.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadInput.ButtonsPressed%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/GamePad/GamepadInput.cs/#L56">View Source</a>
</span>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadInput_ButtonsPressed" data-uid="Dalamud.Game.ClientState.GamePad.GamepadInput.ButtonsPressed">ButtonsPressed</h4>
<div class="markdown level1 summary"><p>Button pressed, set once when the button is pressed. See <a class="xref" href="Dalamud.Game.ClientState.GamePad.GamepadButtons.html">GamepadButtons</a> for the mapping.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ushort ButtonsPressed</code></pre>
</div>
<h5 class="fieldValue">Field 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.UInt16</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Dalamud_Game_ClientState_GamePad_GamepadInput_ButtonsPressed_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This is a bitfield.</p>
</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_GamePad_GamepadInput_ButtonsRaw.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadInput.ButtonsRaw%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/GamePad/GamepadInput.cs/#L47">View Source</a>
</span>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadInput_ButtonsRaw" data-uid="Dalamud.Game.ClientState.GamePad.GamepadInput.ButtonsRaw">ButtonsRaw</h4>
<div class="markdown level1 summary"><p>Raw input, set the whole time while a button is held. See <a class="xref" href="Dalamud.Game.ClientState.GamePad.GamepadButtons.html">GamepadButtons</a> for the mapping.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ushort ButtonsRaw</code></pre>
</div>
<h5 class="fieldValue">Field 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.UInt16</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Dalamud_Game_ClientState_GamePad_GamepadInput_ButtonsRaw_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This is a bitfield.</p>
</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_GamePad_GamepadInput_ButtonsReleased.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadInput.ButtonsReleased%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/GamePad/GamepadInput.cs/#L65">View Source</a>
</span>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadInput_ButtonsReleased" data-uid="Dalamud.Game.ClientState.GamePad.GamepadInput.ButtonsReleased">ButtonsReleased</h4>
<div class="markdown level1 summary"><p>Button released input, set once right after the button is not hold anymore. See <a class="xref" href="Dalamud.Game.ClientState.GamePad.GamepadButtons.html">GamepadButtons</a> for the mapping.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ushort ButtonsReleased</code></pre>
</div>
<h5 class="fieldValue">Field 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.UInt16</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Dalamud_Game_ClientState_GamePad_GamepadInput_ButtonsReleased_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This is a bitfield.</p>
</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_GamePad_GamepadInput_ButtonsRepeat.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadInput.ButtonsRepeat%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/GamePad/GamepadInput.cs/#L74">View Source</a>
</span>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadInput_ButtonsRepeat" data-uid="Dalamud.Game.ClientState.GamePad.GamepadInput.ButtonsRepeat">ButtonsRepeat</h4>
<div class="markdown level1 summary"><p>Repeatedly emits the held button input in fixed intervals. See <a class="xref" href="Dalamud.Game.ClientState.GamePad.GamepadButtons.html">GamepadButtons</a> for the mapping.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ushort ButtonsRepeat</code></pre>
</div>
<h5 class="fieldValue">Field 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.UInt16</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Dalamud_Game_ClientState_GamePad_GamepadInput_ButtonsRepeat_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This is a bitfield.</p>
</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_GamePad_GamepadInput_LeftStickX.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadInput.LeftStickX%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/GamePad/GamepadInput.cs/#L20">View Source</a>
</span>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadInput_LeftStickX" data-uid="Dalamud.Game.ClientState.GamePad.GamepadInput.LeftStickX">LeftStickX</h4>
<div class="markdown level1 summary"><p>Left analogue stick's horizontal value, -99 for left, 99 for right.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int LeftStickX</code></pre>
</div>
<h5 class="fieldValue">Field 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.Int32</span></td>
<td></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_GamePad_GamepadInput_LeftStickY.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadInput.LeftStickY%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/GamePad/GamepadInput.cs/#L26">View Source</a>
</span>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadInput_LeftStickY" data-uid="Dalamud.Game.ClientState.GamePad.GamepadInput.LeftStickY">LeftStickY</h4>
<div class="markdown level1 summary"><p>Left analogue stick's vertical value, -99 for down, 99 for up.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int LeftStickY</code></pre>
</div>
<h5 class="fieldValue">Field 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.Int32</span></td>
<td></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_GamePad_GamepadInput_RightStickX.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadInput.RightStickX%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/GamePad/GamepadInput.cs/#L32">View Source</a>
</span>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadInput_RightStickX" data-uid="Dalamud.Game.ClientState.GamePad.GamepadInput.RightStickX">RightStickX</h4>
<div class="markdown level1 summary"><p>Right analogue stick's horizontal value, -99 for left, 99 for right.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int RightStickX</code></pre>
</div>
<h5 class="fieldValue">Field 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.Int32</span></td>
<td></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_GamePad_GamepadInput_RightStickY.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadInput.RightStickY%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/GamePad/GamepadInput.cs/#L38">View Source</a>
</span>
<h4 id="Dalamud_Game_ClientState_GamePad_GamepadInput_RightStickY" data-uid="Dalamud.Game.ClientState.GamePad.GamepadInput.RightStickY">RightStickY</h4>
<div class="markdown level1 summary"><p>Right analogue stick's vertical value, -99 for down, 99 for up.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int RightStickY</code></pre>
</div>
<h5 class="fieldValue">Field 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.Int32</span></td>
<td></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_GamePad_GamepadInput.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.GamePad.GamepadInput%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/GamePad/GamepadInput.cs/#L13" 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