Added a keyboard character input type, and a "1 only" value type to Inpution.

- These go together, and might be used for the editors one day.

Author: Espyo

source/documents/todo.txt

@@ -2,17 +2,12 @@
 
 
 Current tasks (tasks being worked on, but not yet committed)
-    Add a menu option to each editor that allows you to edit the file externally with a text editor
-    Make the analog-to-digital threshold customizable, as well as other magic numbers if any
-    Spatial navigation loop options per axis
-        Each GUI definition should say whether it allows looping in either direction
 
 
 Next tasks (roughly sorted most important first)
     --- To fix ---
     Binding the zoom button to the Deck's right trigger STILL causes a bunch of actions when pressed
     It's impossible to go on the inner triangle on DEV Lab at 1465, 370
-    Smaller enemies go for Winged Pikmin in vain
 
     --- 1.1.0 ---
     Swarming jingle
@@ -459,6 +454,7 @@ Small tasks (for when I'm feeling lazy)
         Remove magic numbers and magic strings (make numbers and strings into constants)
         Try to refactor the mission strategy patterns to also work for the area editor logic
         Clean up some coupling problems using https://github.com/larspensjo/SimpleSignal
+        Organize named enums better. Maybe using some smart macros. Some use EnumNameDatabase, some use readEnumProp, some do things their own way by themselves
 
 
 Misc things (so I don't forget)
@@ -535,6 +531,7 @@ Misc things (so I don't forget)
         Water depth (thanks ThyCheshireCat)
             Either way, consider giving water surfaces their own Z. Not just for drawing, but for the purposes of considering something submerged, too
         Enemies could have individual territories -- a circle that can be anywhere (detached from the mob) and have any radius, and the mob has to be confined to that
+        Smaller enemies try to chase Winged Pikmin in vain since they'll never reach them. Should they ignore them? How do the canon games do it?
         Objects falling from the sky
             When a leader approaches, when a Pikmin approaches, when carrying, etc.
         Game config parameters:
@@ -718,7 +715,7 @@ Misc things (so I don't forget)
         This would allow mobs to cast light, which would just lighten up that zone of the lightmap
     Base content to add
         Enemies
-            Add Helodity's Plasm Wraith
+            x Add Helodity's Plasm Wraith
             Burrowing Snagret
             Bulbears
             Scuttlebug?

source/source/lib/inpution/inpution.cpp

@@ -35,7 +35,7 @@ bool Manager::areBindRequirementsMet(const Bind& bind) const {
                 bind.modifiers.end(),
                 m.first
             ) != bind.modifiers.end();
-
+            
         if(needsDown != modIsDown) return false;
     }
 
@@ -90,6 +90,9 @@ float Manager::convertActionValue(int actionTypeId, float value) const {
         } case ACTION_VALUE_TYPE_DIGITAL: {
             return value >= options.digitalThreshold ? 1.0f : 0.0f;
             break;
+        } case ACTION_VALUE_TYPE_1_ONLY: {
+            return 1.0f;
+            break;
         }
         }
     }
@@ -175,19 +178,22 @@ void Manager::handleCleanInput(
     vector<int> actionTypesIds = getActionTypesFromInput(input);
 
     for(size_t a = 0; a < actionTypesIds.size(); a++) {
-        if(
-            !actionTypes[actionTypesIds[a]].directEvents &&
-            !forceDirectEvent
-        ) {
-            continue;
+        const ActionType& actionType = actionTypes[actionTypesIds[a]];
+        bool mustAddDirectly =
+            forceDirectEvent ||
+            actionType.directEvents ||
+            actionType.valueType == ACTION_VALUE_TYPE_1_ONLY;
+            
+        if(mustAddDirectly) {
+            //Add it to the action queue directly.
+            Action newAction;
+            newAction.actionTypeId = actionTypesIds[a];
+            newAction.value =
+                convertActionValue(actionTypesIds[a], input.value);
+            newAction.reinsertionLifetime =
+                actionTypes[actionTypesIds[a]].reinsertionTTL;
+            actionQueue.push_back(newAction);
         }
-        //Add it to the action queue directly.
-        Action newAction;
-        newAction.actionTypeId = actionTypesIds[a];
-        newAction.value = convertActionValue(actionTypesIds[a], input.value);
-        newAction.reinsertionLifetime =
-            actionTypes[actionTypesIds[a]].reinsertionTTL;
-        actionQueue.push_back(newAction);
     }
 }
 
@@ -268,6 +274,13 @@ bool Manager::handleInput(const Input& input) {
             handleCleanInput(singleInput, true);
         }
 
+    } else if(
+        input.source.type == INPUT_SOURCE_TYPE_KEYBOARD_CHAR
+    ) {
+        //Written characters are stateless. For instance, the user can insert
+        //the a-with-a-tilde character, but can't "release" that character.
+        handleCleanInput(input, true);
+        
     } else {
         //Regular input.
         handleCleanInput(input, false);

source/source/lib/inpution/inpution.h

@@ -33,6 +33,9 @@ enum INPUT_SOURCE_TYPE {
     //Keyboard key.
     INPUT_SOURCE_TYPE_KEYBOARD_KEY,
 
+    //Written character via keyboard.
+    INPUT_SOURCE_TYPE_KEYBOARD_CHAR,
+    
     //Mouse button.
     INPUT_SOURCE_TYPE_MOUSE_BUTTON,
 
@@ -79,11 +82,17 @@ enum ACTION_FLAG {
 enum ACTION_VALUE_TYPE {
 
     //A float in the range [0 - 1].
+    //e.g. Forward movement amount.
     ACTION_VALUE_TYPE_ANALOG,
 
     //Either 0 or 1 (basically up or down).
+    //e.g. jump button pressed or released.
     ACTION_VALUE_TYPE_DIGITAL,
 
+    //Just 1.
+    //e.g. Save command in the editor.
+    ACTION_VALUE_TYPE_1_ONLY,
+    
 };
 
 
@@ -132,7 +141,7 @@ struct Input {
     //Hardware source.
     InputSource source;
 
-    //Value associated, if applicable.
+    //Value associated, if applicable, [0 - 1].
     float value = 0.0f;
 
 };
@@ -156,10 +165,11 @@ struct Bind {
     InputSource inputSource;
 
     //If true, the modifiers have to be respected.
+    //See Manager::modifiers.
     bool requireModifiers = false;
 
     //List of modifiers that need to be on for the bind to work.
-    //See Manager::modifiers;
+    //See Manager::modifiers.
     vector<int> modifiers;
 
 };
@@ -233,7 +243,7 @@ struct Action {
     //Player number, starting at 1. 0 if N/A.
     int playerNr = 0;
 
-    //Value associated. [0 - 1].
+    //Value associated, if applicable, [0 - 1].
     float value = 0.0f;
 
     //Flags. Use ACTION_FLAG.
@@ -251,7 +261,7 @@ struct Action {
 struct ManagerOptions {
 
     //--- Members ---
-
+    
     //Threshold for converting analog values to digital.
     //If the value is equal to or higher than this, it will convert to 1.
     //Otherwise to 0.

source/source/lib/inpution/readme.md

@@ -38,34 +38,34 @@ int main() {
     myGame.setup();
 
     // 1. Teach Inpution what action types exist.
-    inpution.actionTypes[PLAYER_ACTION_MOVE_LEFT] = {
+    inpution.actionTypes[MyGame::PLAYER_ACTION_MOVE_LEFT] = {
         .id = PLAYER_ACTION_MOVE_LEFT,
     };
-    inpution.actionTypes[PLAYER_ACTION_MOVE_RIGHT] = {
+    inpution.actionTypes[MyGame::PLAYER_ACTION_MOVE_RIGHT] = {
         .id = PLAYER_ACTION_MOVE_RIGHT,
     };
-    inpution.actionTypes[PLAYER_ACTION_JUMP] = {
+    inpution.actionTypes[MyGame::PLAYER_ACTION_JUMP] = {
         .id = PLAYER_ACTION_JUMP,
-        .valueType = Inpution::ACTION_VALUE_TYPE_BOOLEAN,
+        .valueType = Inpution::ACTION_VALUE_TYPE_DIGITAL,
     };
 
     // 2. Teach Inpution what control binds the player has.
     inpution.binds.push_back({
-        .actionTypeId = PLAYER_ACTION_MOVE_LEFT,
+        .actionTypeId = MyGame::PLAYER_ACTION_MOVE_LEFT,
         .inputSource = {
             .type = Inpution::INPUT_SOURCE_TYPE_CONTROLLER_AXIS_NEG,
             .stickNr = MyGame::LEFT_STICK
         }
     });
     inpution.binds.push_back({
-        .actionTypeId = PLAYER_ACTION_MOVE_RIGHT,
+        .actionTypeId = MyGame::PLAYER_ACTION_MOVE_RIGHT,
         .inputSource = {
             .type = Inpution::INPUT_SOURCE_TYPE_CONTROLLER_AXIS_POS,
             .stickNr = MyGame::LEFT_STICK
         }
     });
     inpution.binds.push_back({
-        .actionTypeId = PLAYER_ACTION_JUMP,
+        .actionTypeId = MyGame::PLAYER_ACTION_JUMP,
         .inputSource = {
             .type = Inpution::INPUT_SOURCE_TYPE_CONTROLLER_BUTTON,
             .buttonNr = MyGame::A_BUTTON
@@ -109,13 +109,13 @@ int main() {
             std::vector<Inpution::Action> actions = inpution.newFrame(myGame.deltaT);
             for(const auto& a : actions) {
                 switch(a.actionTypeId) {
-                case PLAYER_ACTION_MOVE_LEFT:
+                case MyGame::PLAYER_ACTION_MOVE_LEFT:
                     character.horizontalSpeed = a.value * 100;
                     break;
-                case PLAYER_ACTION_MOVE_RIGHT:
+                case MyGame::PLAYER_ACTION_MOVE_RIGHT:
                     character.horizontalSpeed = -a.value * 100;
                     break;
-                case PLAYER_ACTION_JUMP:
+                case MyGame::PLAYER_ACTION_JUMP:
                     character.verticalSpeed = 100;
                     break;
                 }
@@ -130,7 +130,7 @@ int main() {
 ## Features
 
 * Many settings:
-  * Analog (range [0 - 1]) and digital (just 0 or 1) input values, and conversions between them (see `ActionType::valueType`).
+  * Analog (range [0 - 1]), digital (just 0 or 1), and "down-only" (just 1) input values, and conversions between them (see `ActionType::valueType`).
   * Auto-repeated action events as long as the input is held (see `ActionType::autoRepeat`).
   * Actions can be generated directly from input events, or from the total combined internal hardware state (see `ActionType::directEvents`).
   * Reinserting actions into the queue for a buffer effect (see `ActionType::reinsertionTTL`).
@@ -139,7 +139,7 @@ int main() {
 * Varied support:
   * Support for multiple controllers at once.
   * Support for the input source triggering multiple actions, and for multiple input sources triggering the same action.
-  * Support for stateful input sources (buttons, keys, analog sticks, etc.) and stateless sources (mouse wheel spins).
+  * Support for stateful input sources (buttons, keys, analog sticks, etc.) and stateless sources (mouse wheel spins, typed characters).
   * Support for binds with modifiers (e.g. pressing Ctrl before pressing S) (see `Manager::modifiers`).
 * Specific features:
   * Game states logic (see `Manager::setGameState()`).
@@ -151,13 +151,13 @@ int main() {
 ## Key terms
 
 * **Action**:
-  * An abstract representation of a specific action in the game that the player performed. The exact real-life movement the player made for this is not relevant.
+  * An abstract representation of a specific action in the game that the player performed. The exact real-life movement the player made for this is not relevant. This is essentially an event.
   * e.g. Move aiming reticle right, with a strength of 0.75.
 * **Action type**:
   * A type of action the player can perform in the game.
   * e.g. Crouch (and un-crouch).
 * **Bind**:
-  * Information about a bind between an action type and an input source.
+  * Information about a bind between an action type and an input source. Typically the player can customize these in the options menu.
   * e.g. The bind between the A button on the controller and the jump action.
 * **Input**:
   * A specific movement made by a human being, on a specific source, on a specific hardware device.