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.''</div>
<div class="note_block_red"><b>PLEASE NOTE:</b> ''This function only fires when the GameEx UI is visible.''</div>
<br />
<br />
== <span class="plugin_headline_text">Perameters</span> ==
== <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.
<span class="plugin_return_text">Buttons() [boolean]</span>: An array of buttons that denote the state of the buttons on the joystick.
<br />
<br />
=== <span class="plugin_text_fx">Perameter Values</span> ===
=== <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 />
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.
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.

Revision as of 00:30, 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;
}