Module technology.sola.engine

Package technology.sola.engine.input

Class SolaControls

java.lang.Object

technology.sola.engine.input.SolaControls

@NullMarked
public class SolaControls
extends Object

SolaControls contains control definitions for a Sola to use. Each control that is added can have multiple ControlInputs. If any ControlInput is in an active state then the control will be considered active.

Constructor Summary

Constructors

Constructor	Description
SolaControls(KeyboardInput keyboardInput, MouseInput mouseInput)	Creates a SolaControls instance wrapping all supported input devices.

Method Summary

Modifier and Type	Method	Description
SolaControls	addControl(String id, List<ControlInput> controlInputs)	Adds a control with specified ControlInputs.
SolaControls	addControl(String id, ControlInput controlInput)	Adds a control with only a single specified ControlInput.
SolaControls	addControls(ControlsConfig controlsConfig)	Adds all controls from a ControlsConfig.
boolean	isActive(String controlId)	Checks to see if specified control is currently active.
SolaControls	setControls(ControlsConfig controlsConfig)	Clears any existing controls and adds all controls from a ControlsConfig.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SolaControls

public SolaControls(KeyboardInput keyboardInput,
 MouseInput mouseInput)

Creates a SolaControls instance wrapping all supported input devices.

Parameters:

keyboardInput - the KeyboardInput

mouseInput - the MouseInput

Method Details

isActive

public boolean isActive(String controlId)

Checks to see if specified control is currently active.

Parameters:

controlId - the control to check

Returns:

true if the control is active

addControl

public SolaControls addControl(String id,
 ControlInput controlInput)

Adds a control with only a single specified ControlInput.

Parameters:

id - the control id

controlInput - the ControlInput for the control

Returns:

this

addControl

public SolaControls addControl(String id,
 List<ControlInput> controlInputs)

Adds a control with specified ControlInputs.

Parameters:

id - the control id

controlInputs - the ControlInputs for the control

Returns:

this

addControls

public SolaControls addControls(ControlsConfig controlsConfig)

Adds all controls from a ControlsConfig.

Parameters:

controlsConfig - the ControlsConfig

Returns:

this

setControls

public SolaControls setControls(ControlsConfig controlsConfig)

Clears any existing controls and adds all controls from a ControlsConfig.

Parameters:

controlsConfig - the ControlsConfig

Returns:

this