aboutsummaryrefslogtreecommitdiff
path: root/engine/src/core/com/jme3/input/controls/ActionListener.java
diff options
context:
space:
mode:
Diffstat (limited to 'engine/src/core/com/jme3/input/controls/ActionListener.java')
-rw-r--r--engine/src/core/com/jme3/input/controls/ActionListener.java58
1 files changed, 58 insertions, 0 deletions
diff --git a/engine/src/core/com/jme3/input/controls/ActionListener.java b/engine/src/core/com/jme3/input/controls/ActionListener.java
new file mode 100644
index 0000000..8deed3c
--- /dev/null
+++ b/engine/src/core/com/jme3/input/controls/ActionListener.java
@@ -0,0 +1,58 @@
+/*
+ * Copyright (c) 2009-2010 jMonkeyEngine
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.jme3.input.controls;
+
+/**
+ * <code>ActionListener</code> is used to receive input events in "digital" style.
+ * <p>
+ * Generally all button inputs, such as keyboard, mouse button, and joystick button,
+ * will be represented exactly. Analog inputs will be converted into digital.
+ * <p>
+ * When an action listener is registered to a natively digital input, such as a button,
+ * the event will be invoked when the button is pressed, with <code>value</code>
+ * set to <code>true</code>, and will be invoked again when the button is released,
+ * with <code>value</code> set to <code>false</code>.
+ *
+ * @author Kirill Vainer
+ */
+public interface ActionListener extends InputListener {
+
+ /**
+ * Called when an input to which this listener is registered to is invoked.
+ *
+ * @param name The name of the mapping that was invoked
+ * @param isPressed True if the action is "pressed", false otherwise
+ * @param tpf The time per frame value.
+ */
+ public void onAction(String name, boolean isPressed, float tpf);
+}