org.mini2Dx.ui.controller

Interface ControllerUiInput<T extends org.mini2Dx.core.controller.button.ControllerButton>

All Superinterfaces:

org.mini2Dx.core.controller.MdxControllerListener

All Known Implementing Classes:

PS4UiInput, Xbox360UiInput, XboxOneUiInput

public interface ControllerUiInput<T extends org.mini2Dx.core.controller.button.ControllerButton>
extends org.mini2Dx.core.controller.MdxControllerListener

Common interface for implementing MdxController based UI input

Method Summary

Modifier and Type	Method and Description
void	disable() Disables this controller input for the UiContainer
void	dispose() Cleans up and de-registers this instance from the associated UiContainer
void	enable() Enables this controller input for the UiContainer
T	getActionButton() Returns the button used to trigger Actionable instances
java.lang.String	getId() Returns the unique id of this ControllerUiInput
boolean	isEnabled() Returns if the controller input is enabled for the UiContainer
void	setActionButton(T actionButton) Sets the button used for triggering Actionable instances
void	update(float delta) Updates the input for repeating presses

Method Detail

update

void update(float delta)

Updates the input for repeating presses

Parameters:

delta - The time since the last frame (in seconds)

isEnabled

boolean isEnabled()

Returns if the controller input is enabled for the UiContainer

Returns:

True if enabled (enabled by default)

enable

void enable()

Enables this controller input for the UiContainer

disable

void disable()

Disables this controller input for the UiContainer

getActionButton

T getActionButton()

Returns the button used to trigger Actionable instances

Returns:

setActionButton

void setActionButton(T actionButton)

Sets the button used for triggering Actionable instances

Parameters:

actionButton -

dispose

void dispose()

Cleans up and de-registers this instance from the associated UiContainer

getId

java.lang.String getId()

Returns the unique id of this ControllerUiInput

Returns:

A non-null String