Difference between revisions of "PlugIn Development:GameEx Input Keyboard Function"
Jump to navigation
Jump to search
| Line 2: | Line 2: | ||
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. | 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. | 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> | ||
<br /> | |||
== <span class="plugin_headline_text">Parameters</span> == | |||
<span class="plugin_return_text">Code [integer]</span>: The key code of the button pressed.<br /> | |||
<span class="plugin_return_text">UsingDirectInput [boolean]</span>: Specifies the Direct Input method.<br /> | |||
<br /> | |||
=== <span class="plugin_text_fx">Parameter Values</span> === | |||
The <span class="plugin_return_text">Code integer</span> is a constant, based on the key codes used by Windows. You can learn more about the various vKey codes [http://msdn.microsoft.com/en-us/library/windows/desktop/dd375731(v=vs.85).aspx at MSDN].<br /> | |||
The <span class="plugin_return_text">UsingDirectInput boolean</span> is passed as <span class="plugin_return_text">true</span> if Direct Input mode has been detected. | |||
<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 keyboard key.<br /> | |||
Return <span class="plugin_return_text">false</span> and GameEx will not process keyboard key. | |||
<br /> | |||
== <span class="plugin_headline_text">Code Examples</span> == | |||
== | === <span class="plugin_text_fx">VB.NET</span> === | ||
<pre class="code_block_func"> | |||
<pre | |||
Public Function Input_Keyboard(ByVal code As Integer, ByVal usingdirectinput As Boolean) As Boolean | Public Function Input_Keyboard(ByVal code As Integer, ByVal usingdirectinput 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_block_func"> | ||
public bool Input_Keyboard(int code, bool usingdirectinput) | public bool Input_Keyboard(int code, bool usingdirectinput) | ||
{ | { | ||
Revision as of 00:58, 28 April 2014
This function is called when you press a button on the keyboard.
You can return TRUE to continue processing the event or return FALSE and GameEx will not initialize the keyboard event.
The Code and UsingDirectInput parameters are passed as the user presses a keyboard key.
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;
}