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

Revision as of 00:59, 28 April 2014

This function is called when the user presses a button on the keyboard.

PLEASE NOTE: This function only fires when the GameEx UI is visible.

Parameters

Code [integer]: The key code of the button pressed.
UsingDirectInput [boolean]: Specifies the Direct Input method.

Parameter Values

The Code integer is a constant, based on the key codes used by Windows. You can learn more about the various vKey codes at MSDN.
The UsingDirectInput boolean is passed as true if Direct Input mode has been detected.

Returns

This function returns a boolean value.

Return Values

Return true and GameEx will process the keyboard key.
Return false and GameEx will not process keyboard key.

Code Examples

VB.NET

Public Function Input_Keyboard(ByVal code As Integer, ByVal usingdirectinput As Boolean) As Boolean
     Return True
End Function

C#

public bool Input_Keyboard(int code, bool usingdirectinput)
{	
     return true;
}

@@ Line 1: / Line 1: @@
-This function is called when you press a button on the keyboard.
+This function is called when the user presses a button on the keyboard.
-You can return <span style="color:red;">'''TRUE'''</span> to continue processing the event or return <span style="color:red;">'''FALSE'''</span> and GameEx will not initialize the keyboard event.
-The <span style="color:red;">'''Code'''</span> and <span style="color:red;">'''UsingDirectInput'''</span> parameters are passed as the user presses a keyboard key.
 <br />
 <div class="note_block_red"><b>PLEASE NOTE:</b> ''This function only fires when the GameEx UI is visible.''</div>