feat: trigger listener now supports direct onKey and onButton callbacks which are triggered before the generic onAction callbacks, closes #1070

AlmasB · AlmasB · commit ffb97c648b16 · 2022-07-15T13:40:59.000+01:00
diff --git a/fxgl-core/src/main/kotlin/com/almasb/fxgl/input/Input.kt b/fxgl-core/src/main/kotlin/com/almasb/fxgl/input/Input.kt
@@ -20,7 +20,6 @@ import javafx.scene.Node
 import javafx.scene.input.*
 import java.util.*
 import java.util.concurrent.CopyOnWriteArrayList
-import kotlin.collections.ArrayList
 import kotlin.collections.HashMap
 import kotlin.collections.LinkedHashMap
 
@@ -271,15 +270,25 @@ class Input {
             currentActions[i].action()
         }
 
-        activeTriggers.forEach { trigger ->
-            listeners.forEach {
-                it.action(trigger)
-            }
+        activeTriggers.forEach {
+            updateTriggerListeners(it)
         }
 
         captureAppliers.forEach { it.update(tpf) }
     }
 
+    private fun updateTriggerListeners(trigger: Trigger) {
+        listeners.forEach {
+            if (trigger is KeyTrigger) {
+                it.actionKey(trigger)
+            } else if (trigger is MouseTrigger) {
+                it.actionBtn(trigger)
+            }
+
+            it.action(trigger)
+        }
+    }
+
     /**
      * Called automatically by FXGL on key event.
      */
@@ -337,9 +346,7 @@ class Input {
         if (newTrigger !in activeTriggers) {
             activeTriggers += newTrigger
 
-            listeners.forEach {
-                it.begin(newTrigger)
-            }
+            handleTriggerPressed(newTrigger)
         }
 
         bindings.filter { (act, trigger) -> act !in currentActions && trigger.isTriggered(event) }
@@ -361,12 +368,22 @@ class Input {
         }
     }
 
-    private fun handleReleased(event: InputEvent) {
-        val releasedTriggers = activeTriggers.filter { it.isReleased(event) }
-        releasedTriggers.forEach { trigger ->
-            listeners.forEach {
-                it.end(trigger)
+    private fun handleTriggerPressed(trigger: Trigger) {
+        listeners.forEach {
+            if (trigger is KeyTrigger) {
+                it.beginKey(trigger)
+            } else if (trigger is MouseTrigger) {
+                it.beginBtn(trigger)
             }
+
+            it.begin(trigger)
+        }
+    }
+
+    private fun handleReleased(event: InputEvent) {
+        val releasedTriggers = activeTriggers.filter { it.isReleased(event) || (it is KeyTrigger && isIllegal(it.key)) }
+        releasedTriggers.forEach {
+            handleTriggerReleased(it)
         }
 
         activeTriggers -= releasedTriggers
@@ -392,6 +409,18 @@ class Input {
         }
     }
 
+    private fun handleTriggerReleased(trigger: Trigger) {
+        listeners.forEach {
+            if (trigger is KeyTrigger) {
+                it.endKey(trigger)
+            } else if (trigger is MouseTrigger) {
+                it.endBtn(trigger)
+            }
+
+            it.end(trigger)
+        }
+    }
+
     fun addTriggerListener(triggerListener: TriggerListener) {
         listeners += triggerListener
     }
diff --git a/fxgl-core/src/main/kotlin/com/almasb/fxgl/input/TriggerListener.kt b/fxgl-core/src/main/kotlin/com/almasb/fxgl/input/TriggerListener.kt
@@ -16,6 +16,14 @@ abstract class TriggerListener {
     internal fun action(trigger: Trigger) = onAction(trigger)
     internal fun end(trigger: Trigger) = onActionEnd(trigger)
 
+    internal fun beginKey(trigger: KeyTrigger) = onKeyBegin(trigger)
+    internal fun actionKey(trigger: KeyTrigger) = onKey(trigger)
+    internal fun endKey(trigger: KeyTrigger) = onKeyEnd(trigger)
+
+    internal fun beginBtn(trigger: MouseTrigger) = onButtonBegin(trigger)
+    internal fun actionBtn(trigger: MouseTrigger) = onButton(trigger)
+    internal fun endBtn(trigger: MouseTrigger) = onButtonEnd(trigger)
+
     /**
      * Called once in the same tick when triggered.
      */
@@ -31,4 +39,36 @@ abstract class TriggerListener {
      * Called once in the same tick when trigger was released.
      */
     protected open fun onActionEnd(trigger: Trigger) {}
+
+    /**
+     * Called once in the same tick when triggered.
+     */
+    protected open fun onKeyBegin(keyTrigger: KeyTrigger) {}
+
+    /**
+     * Called as long as the trigger is being held (pressed).
+     * Starts from the next tick from the one when was triggered.
+     */
+    protected open fun onKey(keyTrigger: KeyTrigger) {}
+
+    /**
+     * Called once in the same tick when trigger was released.
+     */
+    protected open fun onKeyEnd(keyTrigger: KeyTrigger) {}
+
+    /**
+     * Called once in the same tick when triggered.
+     */
+    protected open fun onButtonBegin(mouseTrigger: MouseTrigger) {}
+
+    /**
+     * Called as long as the trigger is being held (pressed).
+     * Starts from the next tick from the one when was triggered.
+     */
+    protected open fun onButton(mouseTrigger: MouseTrigger) {}
+
+    /**
+     * Called once in the same tick when trigger was released.
+     */
+    protected open fun onButtonEnd(mouseTrigger: MouseTrigger) {}
 }
