io.github.thunderbots.lightning.control

Annotation Type ButtonHandler

@Retention(value=RUNTIME)
 @Target(value=METHOD)
 @Documented
public @interface ButtonHandler

ButtonHandler is an annotation that should be applied to all methods that handle joystick button presses. It specifies the button that should be responded to, the joystick that the button should come from, and if the method should be called on the press or release of the button.

Author:

Zach Ohara

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
JoystickButton	button Gets the button that should be responded to.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	joystick Gets the joystick that the button should come from.
ButtonHandler.PressType	type Gets the type of press that the method should be called in response to.

Element Detail

button

public abstract JoystickButton button

Gets the button that should be responded to.

Returns:

the button that should be responded to.

joystick

public abstract int joystick

Gets the joystick that the button should come from.

Returns:

the joystick that the button should come from.

Default:

1

type

public abstract ButtonHandler.PressType type

Gets the type of press that the method should be called in response to.

Returns:

the type of press that the method should be called in response to.

Default:

io.github.thunderbots.lightning.control.ButtonHandler.PressType.PRESS