Class InputModule

java.lang.Object

gaiasky.script.v2.impl.APIModule

gaiasky.script.v2.impl.InputModule

All Implemented Interfaces:

IObserver, InputAPI

public class InputModule
extends APIModule
implements IObserver, InputAPI

The camera module contains methods and calls to access and modify the input system.

Field Summary

Fields inherited from class APIModule

api, em, logger, me, name

Modifier and Type	Field	Description
protected final APIv2	api	Reference to API object.
protected final EventManager	em	Reference to event manager.
protected final Logger.Log	logger
protected final APIModule	me	Reference to self.
protected final String	name	Module name.

Constructor Summary

Constructors

Constructor	Description
InputModule(EventManager em, APIv2 api, String name)	Create a new module with the given attributes.

Method Summary

Modifier and Type	Method	Description
void	disable()	Disable all input events in Gaia Sky (mouse, keyboard, touchscreen, and gamepad) until a call to InputAPI.enable() is issued.
void	enable()	Enable all input events in Gaia Sky (mouse, keyboard, touchscreen, and gamepad).
void	notify(Event event, Object source, Object... data)	Event notification call.
void	wait_enter()	Block the execution until the Enter key is pressed.
void	wait_input()	Block the execution until any kind of input (keyboard, mouse, etc.) is received.
void	wait_input(int code)	Block the execution until the given key or button is pressed.

Methods inherited from class APIModule

dispose

Modifier and Type	Method	Description
void	dispose()	Method called whenever the module is disposed.

Methods inherited from class Object

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

Constructor Details

InputModule

public InputModule(EventManager em,
 APIv2 api,
 String name)

Create a new module with the given attributes.

Parameters:

api - Reference to the API class.

name - Name of the module.

Method Details

disable

public void disable()

Description copied from interface: InputAPI

Disable all input events in Gaia Sky (mouse, keyboard, touchscreen, and gamepad) until a call to InputAPI.enable() is issued.

After this method is called, Gaia Sky will not respond to any kind of input event.

Specified by:

disable in interface InputAPI

enable

public void enable()

Description copied from interface: InputAPI

Enable all input events in Gaia Sky (mouse, keyboard, touchscreen, and gamepad). This call re-enables all input events, which were possibly disabled with InputAPI.disable().

Specified by:

enable in interface InputAPI

wait_input

public void wait_input()

Description copied from interface: InputAPI

Block the execution until any kind of input (keyboard, mouse, etc.) is received.

Specified by:

wait_input in interface InputAPI

wait_enter

public void wait_enter()

Description copied from interface: InputAPI

Block the execution until the Enter key is pressed.

Specified by:

wait_enter in interface InputAPI

wait_input

public void wait_input(int code)

Description copied from interface: InputAPI

Block the execution until the given key or button is pressed.

Specified by:

wait_input in interface InputAPI

Parameters:

code - The key or button code. Please see Input.Keys and GSKeys.

notify

public void notify(Event event,
 Object source,
 Object... data)

Description copied from interface: IObserver

Event notification call.

Specified by:

notify in interface IObserver

Parameters:

event - The event type.

source - The source object, if any.

data - The data associated with this event.