Difference between revisions of "PlugIn Development:GameEx Input Joystick Function"
Jump to navigation
Jump to search
(Created page with "==<span style="font-size:150%;">Input Joystick Function [GameEx]</span>== This function is called when you press a button on the joystick. You can return <span style="color:re...") |
|||
| (17 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
This function is called when you press a button on the joystick. | This function is called when you press a button on the joystick. | ||
<br /> | |||
<div class="note_block_red"><b>PLEASE NOTE:</b> ''This function only fires when the GameEx UI is visible.''</div> | |||
<br /> | |||
== <span class="plugin_headline_text">Parameters</span> == | |||
<span class="plugin_return_text">Buttons() [boolean]</span>: An array of buttons that denote the state of the buttons on the joystick. | |||
<br /> | |||
=== <span class="plugin_text_fx">Parameter Values</span> === | |||
For each item in the <span class="plugin_return_text">array</span>, a parameter of <span class="plugin_return_text">true</span> means that the position button is currently pressed in that instance of the <span class="plugin_return_text">array</span>.<br /> | |||
So, if <span class="plugin_return_text">Array[0] = true</span> then <span class="plugin_return_text">Joystick Button 0</span> is pressed, and so on. | |||
<br /> | |||
== <span class="plugin_headline_text">Returns</span> == | |||
This function returns a <span class="plugin_return_text">boolean</span> value. | |||
<br /> | |||
=== <span class="plugin_text_fx">Return Values</span> === | |||
Return <span class="plugin_return_text">true</span> and GameEx will process the joystick button press.<br /> | |||
Return <span class="plugin_return_text">false</span> and GameEx will not process the joystick button press. | |||
<br /> | |||
== <span class="plugin_headline_text">Code Examples</span> == | |||
=== <span class="plugin_text_fx">VB.NET</span> === | |||
<pre class="code_vb"> | |||
== | |||
<span | |||
<pre | |||
Public Function Input_Joystick(ByVal Buttons() As Boolean) As Boolean | Public Function Input_Joystick(ByVal Buttons() As Boolean) As Boolean | ||
Return True | Return True | ||
End Function</pre> | End Function</pre> | ||
<span | === <span class="plugin_text_fx">C#</span> === | ||
<pre | <pre class="code_cs"> | ||
public bool Input_Joystick(bool[] Buttons) | public bool Input_Joystick(bool[] Buttons) | ||
{ | { | ||
return true; | return true; | ||
}</pre> | }</pre> | ||
<br /> | |||
[[Category:PlugIn Development]] | [[Category:PlugIn Development]] | ||
Latest revision as of 07:11, 28 April 2014
This function is called when you press a button on the joystick.
PLEASE NOTE: This function only fires when the GameEx UI is visible.
Parameters
Buttons() [boolean]: An array of buttons that denote the state of the buttons on the joystick.
Parameter Values
For each item in the array, a parameter of true means that the position button is currently pressed in that instance of the array.
So, if Array[0] = true then Joystick Button 0 is pressed, and so on.
Returns
This function returns a boolean value.
Return Values
Return true and GameEx will process the joystick button press.
Return false and GameEx will not process the joystick button press.
Code Examples
VB.NET
Public Function Input_Joystick(ByVal Buttons() As Boolean) As Boolean
Return True
End Function
C#
public bool Input_Joystick(bool[] Buttons)
{
return true;
}