com.almasb.fxgl.input

Class UserAction

java.lang.Object

com.almasb.fxgl.input.UserAction

public abstract class UserAction
extends Object

Represents a user action which is typically triggered when a key or a mouse event has occurred. User actions have names so that they are easily identifiable. An action can be bound to a key or mouse event using Input.

Author:

Almas Baimagambetov (AlmasB) ([email protected])

Constructor Summary

Constructors

Constructor and Description
UserAction(String name) Constructs new user action with given name.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
void	fireAction()
void	fireActionBegin()
void	fireActionEnd()
String	getName()
int	hashCode()
protected void	onAction() Called as long as the trigger is being held (pressed).
protected void	onActionBegin() Called once in the same tick when triggered.
protected void	onActionEnd() Called once in the same tick when trigger was released.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UserAction

public UserAction(String name)

Constructs new user action with given name. Name examples: Walk Forward, Shoot, Use, Aim, etc.

Parameters:

name - unique name that identifies this action

Method Detail

getName

public final String getName()

Returns:

action name

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

onActionBegin

protected void onActionBegin()

Called once in the same tick when triggered.

onAction

protected void onAction()

Called as long as the trigger is being held (pressed). Starts from the next tick from the one when was triggered

onActionEnd

protected void onActionEnd()

Called once in the same tick when trigger was released.

fireActionBegin

public final void fireActionBegin()

fireAction

public final void fireAction()

fireActionEnd

public final void fireActionEnd()