Differences

This shows you the differences between two versions of the page.

--- inputpolling [2019/04/18 16:10] – [Mouse] admin
+++ inputpolling [2020/11/04 14:52] – [Runtime] admin
@@ Line 6: / Line 6: @@
 Therefor we provide the easy to use **TGorillaInputController** component to access keyboard, mouse and gamepad feedbacks. Also in combination!
+===== Input Devices =====
+The input controller sets up handlers for keyboard, mouse and gamepad, and enables all by default.
+<file pascal>
+FInput.Supported := [TGorillaInputDeviceType.Keyboard, TGorillaInputDeviceType.Mouse,
+  TGorillaInputDeviceType.GamePad];
+</file>
+If you do not need any of the device, you can disable them, by reducing the "Supported" enumeration set. For example, if you only want to check for gamepad events:
+<file pascal>
+FInput.Supported := [TGorillaInputDeviceType.GamePad];
+</file>
 ===== HotKey =====
-A HotKey is a configuration inside of the TGorillaInputController, where you define a name and which inputs are necessary to execute a specific action.
+A HotKey is a combination of simultanously active inputs. Each HotKey can manage inputs from keyboard, mouse and/or gamepad.
-Those keys use a callback method or can be linked to a Delphi TAction instance.
+An input is a hardware message:
+  * For keyboards, inputs are the pressed keys
+  * For mouse, inputs are pressed mouse buttons
+  * For gamepad, inputs are pressed gamepad buttons
+You can define up to 4 inputs per device. Which means you can handle up to 12 simultanously active input messages.
+In case you define an input in two different HotKeys, the system will detect the more important Hotkey. The importance is defined by the number of set inputs.
+If a HotKey was detected, the controller will call the OnTriggered event and/or an attached TAction instance.
+You are allowed to setup your HotKeys at design- and runtime.
-You are allowed to setup your keys at design- and at runtime.
+==== LockTime ====
+Set the LockTime property (in milliseconds) to suppress a hotkey for a specific time.
+Because input commands come very often, f.e. if a button on the gamepad was pressed. As long as you hold the button the system will recognize the hotkey for this button.
+For sequence detection this may be a problem. Therefor we want to lock the gamepad hotkey for a certain time.
 ==== DesignTime ====
@@ Line 24: / Line 54: @@
   - Here we can now add a new **TGorillaHotKeyInputItem**.
   - In the item select the "**Kind**" of device.
-  - and add the message input code
+  - and add the message input code (tables below)
   - Repeat it for any further inputs you wish to combine.
 ==== Runtime ====
@@ Line 37: / Line 67: @@
 end;
+procedure TForm1.FormCreate(Sender: TObject);
 var
   FInput : TGorillaInputController;
@@ Line 50: / Line 81: @@
   LHotKey.AddInput(TGorillaInputDeviceType.Keyboard, Ord(GORILLA_INPUT_KEY_C));
   LHotKey.AddInput(TGorillaInputDeviceType.Keyboard, Ord(GORILLA_INPUT_KEY_RETURN));
+end;
+procedure TForm1.FormClose(Sender: TObject; var Action: TCloseAction);
+begin
+  FInput.DisposeOf();
+  FInput := nil;
+end;
 </file>
 ===== Persistent Messages =====
-Besides the HotKey settings the component supports persistent/continuously messages.
+Besides the HotKey settings the component supports persistent/continuous messages.
 A persistent message is a continuously notified message from the system and not a temporary message like a click or key-press.
+Persistent messages can not be notified by HotKeys. You need to request those separately.
 Supported persistent messages are:
@@ Line 83: / Line 121: @@
 </file>
-===== Input-Codes =====
+===== Input-Codes for HotKeys =====
-All available InputCodes are defined in the Gorilla.Controller.Input.Consts unit.
+All available InputCodes for HotKeys are defined in the Gorilla.Controller.Input.Consts unit.
 ==== Keyboard ====
@@ Line 192: / Line 230: @@
 | GORILLA_INPUT_MOUSE_XBUTTON_DBLCLK|8|
 | GORILLA_INPUT_MOUSE_WHEEL|9|
 ==== GamePad ====
@@ Line 210: / Line 249: @@
 | GORILLA_INPUT_GAMEPAD_SHOULDER_LEFT|9|
 | GORILLA_INPUT_GAMEPAD_SHOULDER_RIGHT|10|
 | GORILLA_INPUT_GAMEPAD_BUTTON_A|11|
 | GORILLA_INPUT_GAMEPAD_BUTTON_B|12|
 | GORILLA_INPUT_GAMEPAD_BUTTON_X|13|
 | GORILLA_INPUT_GAMEPAD_BUTTON_Y|14|
 | GORILLA_INPUT_GAMEPAD_TRIGGERS|$100|
 | GORILLA_INPUT_GAMEPAD_THUMBSTICK_POS_LEFT|$200|
 | GORILLA_INPUT_GAMEPAD_THUMBSTICK_POS_RIGHT|$201|
+===== Sequences =====
+HotKeys are a nice feature, but only work for simultaneous inputs.
+Imagine you build a combat game, where attacks or defences are represented by input-combos. For example a user needs to press Button A, then Button B and then Button X to do roundhouse kick.
+Therefor sequences come in place. Sequences are a descriptive plan of hotkeys, where the order is important.
+So Sequence #1
+<code>
+Button A + Button B + Button X
+</code>
+is not the same like
+<code>
+Button B + Button A + Button X
+</code>
+__Notes:__
+You are allowed declare an input multiple times in a sequence.
+Each sequence can hold up to 16 HotKeys.
+==== DesignTime ====
+==== Runtime ====
+<file pascal>
+procedure TForm1.DoOnSequence(const ASequence : TGorillaInputSequenceItem);
+begin
+  DebugOutput(Format('>>> Sequence: %s <<<', [ASequence.DisplayName]));
+end;
+[...]
+var LSequence: TGorillaInputSequenceItem;
+    LSeq1HK1, LSeq1HK2, LSeq1HK3 : TGorillaHotKeyItem;
+  [...]
+  // create hotkey #1
+  LSeq1HK1 := FInput.AddHotKey('STRIDE LEFT');
+  LSeq1HK1.AddInput(TGorillaInputDeviceType.Keyboard, Ord(GORILLA_INPUT_KEY_A));
+  // create hotkey #2
+  LSeq1HK2 := FInput.AddHotKey('FORWARD');
+  LSeq1HK2.AddInput(TGorillaInputDeviceType.Keyboard, Ord(GORILLA_INPUT_KEY_W));
+  // create hotkey #3
+  LSeq1HK3 := FInput.AddHotKey('STRIDE RIGHT');
+  LSeq1HK3.AddInput(TGorillaInputDeviceType.Keyboard, Ord(GORILLA_INPUT_KEY_D));
+  // create the sequence and add the relevant hotkeys
+  LSequence := FInput.AddSequence('TEST SEQUENCE', [LSeq1HK1, LSeq1HK2, LSeq1HK3]);
+  LSequence.OnTriggered := DoOnSequence;
+</file>
+Next: [[Pathfinding|Pathfinding]]