Difference between revisions of "PlugIn Development:GameEx Input Joystick Function"

From Spesoft/GameEx Wiki
Jump to navigation Jump to search
Line 7: Line 7:
<br />
<br />
=== <span class="plugin_text_fx">Perameter Values</span> ===
=== <span class="plugin_text_fx">Perameter Values</span> ===
For each item in the <span class="plugin_return_text">array</span>, <span class="plugin_return_text">true</span> means that the array position's button is currently pressed.<br />
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 <pre class="plugin_return_text">array</span>.<br />
So, if <span class="plugin_return_text">Array[0] = true</span> then Joystick Button 0 is pressed, and so on.
So, if <span class="plugin_return_text">Array[0] = true</span> then Joystick Button 0 is pressed, and so on.
<br />
<br />

Revision as of 00:25, 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.


Perameters

Buttons() [boolean]: An array of buttons that denote the state of the buttons on the joystick.

Perameter 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</span>.<br />
So, if <span class="plugin_return_text">Array[0] = true</span> then Joystick Button 0 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_block_func">
Public Function Input_Joystick(ByVal Buttons() As Boolean) As Boolean
     Return True
End Function

C#


public bool Input_Joystick(bool[] Buttons)
{
     return true;
}