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

From Spesoft/GameEx Wiki
Jump to navigation Jump to search
Line 3: Line 3:
<div class="note_block_red"><b>PLEASE NOTE:</b> ''This function only fires when the GameEx UI is visible.''</span></div>
<div class="note_block_red"><b>PLEASE NOTE:</b> ''This function only fires when the GameEx UI is visible.''</span></div>
<br />
<br />
== <span class="plugin_headline_text">Peramaters</span> ==
== <span class="plugin_headline_text">Perameters</span> ==
<span class="plugin_return_text">Buttons() [boolean]</span>: An array of buttons that denote the state of the buttons on the joystick.
<span class="plugin_return_text">Buttons() [boolean]</span>: An array of buttons that denote the state of the buttons on the joystick.
<br />
<br />
Line 10: Line 10:
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 />
== <span class="plugin_headline_text">Returns</span> ==
== <span class="plugin_headline_text">Returns</span> ==
This function returns a <span class="plugin_return_text">boolean</span> value.
This function returns a <span class="plugin_return_text">boolean</span> value.

Revision as of 00:24, 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, true means that the array position's button is currently pressed.
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;
}