com.almasb.fxgl.input

Annotation Type OnUserAction

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface OnUserAction

Indicates that a method is called when user triggers an action. Note: the method signature must be public void anyName().

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name Returns name of the action.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
ActionType	type Returns type of the action, i.e.

Element Detail

name

public abstract String name

Returns name of the action. The action must have been specified during initInput() as com.almasb.fxgl.input.InputMapping.

Returns:

action name

type

public abstract ActionType type

Returns type of the action, i.e. when the method should be called. Based on the type, the method is called when the action starts, continues or stops.

Returns:

action type

Default Value:

ActionType#ON_ACTION

Default:

<error>