Index (squidpress 4.0.9 API)

B C D E F G H I K L M N O P Q R S T U V
All Classes and Interfaces|All Packages|Constant Field Values

B

BACKSPACE - Static variable in class com.github.yellowstonegames.press.SquidInput: Backspace key on most PC keyboards; Delete key on Mac keyboards.

C

cellHeight - Variable in class com.github.yellowstonegames.press.SquidMouse
cellWidth - Variable in class com.github.yellowstonegames.press.SquidMouse
CENTER_ARROW - Static variable in class com.github.yellowstonegames.press.SquidInput: Not typically a dedicated key, but if numpadDirections is enabled, this will be sent by Numpad 5.
clearMapping() - Method in class com.github.yellowstonegames.press.SquidInput: Removes any remappings to key bindings that were in use in this SquidInput.
com.github.yellowstonegames.press - package com.github.yellowstonegames.press
combineModifiers(char, boolean, boolean, boolean) - Static method in class com.github.yellowstonegames.press.SquidInput: Combines the key (as it would be given to SquidInput.KeyHandler.handle(char, boolean, boolean, boolean)) with the three booleans for the alt, ctrl, and shift modifier keys, returning an int that can be used with the internal queue of ints or the public SquidInput.mapping of received inputs to actual inputs the program can process.

D

DOWN_ARROW - Static variable in class com.github.yellowstonegames.press.SquidInput: Down arrow key.
DOWN_LEFT_ARROW - Static variable in class com.github.yellowstonegames.press.SquidInput: Not typically a dedicated key, but if numpadDirections is enabled, this will be sent by Numpad 1.
DOWN_RIGHT_ARROW - Static variable in class com.github.yellowstonegames.press.SquidInput: Not typically a dedicated key, but if numpadDirections is enabled, this will be sent by Numpad 3.
drain() - Method in class com.github.yellowstonegames.press.SquidInput: Processes all events queued up, passing them through this object's key processing and then to keyHandler.

E

END - Static variable in class com.github.yellowstonegames.press.SquidInput: End key (commonly used for moving a cursor to end of line).
ENTER - Static variable in class com.github.yellowstonegames.press.SquidInput: Enter key, also called Return key.
ESCAPE - Static variable in class com.github.yellowstonegames.press.SquidInput: Esc or Escape key

F

F1 - Static variable in class com.github.yellowstonegames.press.SquidInput: Function key F1
F10 - Static variable in class com.github.yellowstonegames.press.SquidInput: Function key F10
F11 - Static variable in class com.github.yellowstonegames.press.SquidInput: Function key F11
F12 - Static variable in class com.github.yellowstonegames.press.SquidInput: Function key F12
F2 - Static variable in class com.github.yellowstonegames.press.SquidInput: Function key F2
F3 - Static variable in class com.github.yellowstonegames.press.SquidInput: Function key F3
F4 - Static variable in class com.github.yellowstonegames.press.SquidInput: Function key F4
F5 - Static variable in class com.github.yellowstonegames.press.SquidInput: Function key F5
F6 - Static variable in class com.github.yellowstonegames.press.SquidInput: Function key F6
F7 - Static variable in class com.github.yellowstonegames.press.SquidInput: Function key F7
F8 - Static variable in class com.github.yellowstonegames.press.SquidInput: Function key F8
F9 - Static variable in class com.github.yellowstonegames.press.SquidInput: Function key F9
flush() - Method in class com.github.yellowstonegames.press.SquidInput: Empties the backing queue of data.
FORWARD_DELETE - Static variable in class com.github.yellowstonegames.press.SquidInput: Delete key on most PC keyboards; no equivalent on some (all?) Mac keyboards.
fromCode(int, boolean) - Method in class com.github.yellowstonegames.press.SquidInput: Maps keycodes to Unicode chars, sometimes depending on whether the Shift key is held.

G

GAMEPAD_A - Static variable in class com.github.yellowstonegames.press.SquidInput: Gamepad A button.
GAMEPAD_B - Static variable in class com.github.yellowstonegames.press.SquidInput: Gamepad B button.
GAMEPAD_C - Static variable in class com.github.yellowstonegames.press.SquidInput: Gamepad C button.
GAMEPAD_L1 - Static variable in class com.github.yellowstonegames.press.SquidInput: Gamepad L1 button.
GAMEPAD_L2 - Static variable in class com.github.yellowstonegames.press.SquidInput: Gamepad L2 button.
GAMEPAD_LEFT_THUMB - Static variable in class com.github.yellowstonegames.press.SquidInput: Gamepad Left Thumb button.
GAMEPAD_R1 - Static variable in class com.github.yellowstonegames.press.SquidInput: Gamepad R1 button.
GAMEPAD_R2 - Static variable in class com.github.yellowstonegames.press.SquidInput: Gamepad R2 button.
GAMEPAD_RIGHT_THUMB - Static variable in class com.github.yellowstonegames.press.SquidInput: Gamepad Right Thumb button.
GAMEPAD_SELECT - Static variable in class com.github.yellowstonegames.press.SquidInput: Gamepad Select button.
GAMEPAD_START - Static variable in class com.github.yellowstonegames.press.SquidInput: Gamepad Start button.
GAMEPAD_X - Static variable in class com.github.yellowstonegames.press.SquidInput: Gamepad X button.
GAMEPAD_Y - Static variable in class com.github.yellowstonegames.press.SquidInput: Gamepad Y button.
GAMEPAD_Z - Static variable in class com.github.yellowstonegames.press.SquidInput: Gamepad Z button.
getCellHeight() - Method in class com.github.yellowstonegames.press.SquidMouse
getCellWidth() - Method in class com.github.yellowstonegames.press.SquidMouse
getGridHeight() - Method in class com.github.yellowstonegames.press.SquidMouse
getGridWidth() - Method in class com.github.yellowstonegames.press.SquidMouse
getIgnoreInput() - Method in class com.github.yellowstonegames.press.SquidInput: Get the status for whether this should ignore input right now or not.
getKeyHandler() - Method in class com.github.yellowstonegames.press.SquidInput
getMouse() - Method in class com.github.yellowstonegames.press.SquidInput
getOffsetX() - Method in class com.github.yellowstonegames.press.SquidMouse
getOffsetY() - Method in class com.github.yellowstonegames.press.SquidMouse
getProcessor() - Method in class com.github.yellowstonegames.press.SquidMouse: Gets the InputProcessor this object uses to handle mouse input.
getRepeatGap() - Method in class com.github.yellowstonegames.press.SquidInput: Gets the amount of milliseconds of holding a key this requires to count as a key repeat.
gridHeight - Variable in class com.github.yellowstonegames.press.SquidMouse
gridWidth - Variable in class com.github.yellowstonegames.press.SquidMouse

H

handle(char, boolean, boolean, boolean) - Method in interface com.github.yellowstonegames.press.SquidInput.KeyHandler: The only method you need to implement yourself in KeyHandler, this should react to keys such as 'a' (produced by pressing the A key while not holding Shift), 'E' (produced by pressing the E key while holding Shift), and '\u2190' ('←' in Unicode, also available as SquidInput.LEFT_ARROW in SquidInput, produced by pressing the left arrow key even though that key does not have a default Unicode representation).
hasNext() - Method in class com.github.yellowstonegames.press.SquidInput: Returns true if at least one event is queued, but also will call SquidInput.keyDown(int) if a key is being held but there is a failure to process the repeated event.
heldCodes - Variable in class com.github.yellowstonegames.press.SquidInput
HOME - Static variable in class com.github.yellowstonegames.press.SquidInput: Home key (commonly used for moving a cursor to start of line).

I

ignoreInput - Variable in class com.github.yellowstonegames.press.SquidInput
INSERT - Static variable in class com.github.yellowstonegames.press.SquidInput: Insert key.
isUsingNumpadDirections() - Method in class com.github.yellowstonegames.press.SquidInput

K

keyAction - Variable in class com.github.yellowstonegames.press.SquidInput
keyDown(int) - Method in class com.github.yellowstonegames.press.SquidInput
keyMappingFromString(String) - Method in class com.github.yellowstonegames.press.SquidInput: Reads in a String (almost certainly produced by SquidInput.keyMappingToString()) to set the current key remapping.
keyMappingToString() - Method in class com.github.yellowstonegames.press.SquidInput: Gets the current key remapping as a String, which can be saved in a file and read back with SquidInput.keyMappingFromString(String).
keyTyped(char) - Method in class com.github.yellowstonegames.press.SquidInput
keyUp(int) - Method in class com.github.yellowstonegames.press.SquidInput

L

lastKeyTime - Variable in class com.github.yellowstonegames.press.SquidInput
LEFT_ARROW - Static variable in class com.github.yellowstonegames.press.SquidInput: Left arrow key.

M

mapping - Variable in class com.github.yellowstonegames.press.SquidInput
mouse - Variable in class com.github.yellowstonegames.press.SquidInput
mouseMoved(int, int) - Method in class com.github.yellowstonegames.press.SquidInput
mouseMoved(int, int) - Method in class com.github.yellowstonegames.press.SquidMouse

N

next() - Method in class com.github.yellowstonegames.press.SquidInput: Processes the first key event queued up, passing it to this object's InputProcessor.
numpadDirections - Variable in class com.github.yellowstonegames.press.SquidInput

O

offsetX - Variable in class com.github.yellowstonegames.press.SquidMouse
offsetY - Variable in class com.github.yellowstonegames.press.SquidMouse
onGrid(int, int) - Method in class com.github.yellowstonegames.press.SquidMouse: Returns true if the provided screen coordinate is on the grid, ignoring the current offset.

P

PAGE_DOWN - Static variable in class com.github.yellowstonegames.press.SquidInput: Page Down key.
PAGE_UP - Static variable in class com.github.yellowstonegames.press.SquidInput: Page Up key.
processor - Variable in class com.github.yellowstonegames.press.SquidMouse

Q

queue - Variable in class com.github.yellowstonegames.press.SquidInput

R

reinitialize(float, float) - Method in class com.github.yellowstonegames.press.SquidMouse
reinitialize(float, float, float, float, int, int) - Method in class com.github.yellowstonegames.press.SquidMouse
remap(char, boolean, boolean, boolean, char, boolean, boolean, boolean) - Method in class com.github.yellowstonegames.press.SquidInput: Remaps a char that could be input and processed by SquidInput.KeyHandler.handle(char, boolean, boolean, boolean) (possibly with some pressed modifiers) to another char with possible modifiers.
remap(int[]) - Method in class com.github.yellowstonegames.press.SquidInput: Remaps many keypress combinations, each of which is a char and several potential modifiers, to other keypress combinations.
remap(int, int) - Method in class com.github.yellowstonegames.press.SquidInput: Remaps a keypress combination, which is a char and several potential modifiers, to another keypress combination.
repeatGapMillis - Variable in class com.github.yellowstonegames.press.SquidInput
RIGHT_ARROW - Static variable in class com.github.yellowstonegames.press.SquidInput: Down arrow key.

S

scrolled(float, float) - Method in class com.github.yellowstonegames.press.SquidInput
scrolled(float, float) - Method in class com.github.yellowstonegames.press.SquidMouse
setCellHeight(float) - Method in class com.github.yellowstonegames.press.SquidMouse
setCellWidth(float) - Method in class com.github.yellowstonegames.press.SquidMouse
setGridHeight(float) - Method in class com.github.yellowstonegames.press.SquidMouse
setGridWidth(float) - Method in class com.github.yellowstonegames.press.SquidMouse
setIgnoreInput(boolean) - Method in class com.github.yellowstonegames.press.SquidInput: Set the status for whether this should ignore input right now or not.
setKeyHandler(SquidInput.KeyHandler) - Method in class com.github.yellowstonegames.press.SquidInput
setMouse(SquidMouse) - Method in class com.github.yellowstonegames.press.SquidInput
setOffsetX(int) - Method in class com.github.yellowstonegames.press.SquidMouse
setOffsetY(int) - Method in class com.github.yellowstonegames.press.SquidMouse
setProcessor(InputProcessor) - Method in class com.github.yellowstonegames.press.SquidMouse: Sets the InputProcessor this object uses to handle mouse input.
setRepeatGap(long) - Method in class com.github.yellowstonegames.press.SquidInput: Sets the amount of milliseconds of holding a key this requires to count as a key repeat.
setUsingNumpadDirections(boolean) - Method in class com.github.yellowstonegames.press.SquidInput
SquidInput - Class in com.github.yellowstonegames.press: This input processing class can handle mouse and keyboard input, using a SquidMouse for Mouse input and a user implementation of SquidInput.KeyHandler (often a lambda) to react to keys represented as chars and the modifiers those keys were pressed with, any of alt, ctrl, and/or shift.
SquidInput() - Constructor for class com.github.yellowstonegames.press.SquidInput: Constructs a new SquidInput that does not respond to keyboard or mouse input.
SquidInput(SquidInput.KeyHandler) - Constructor for class com.github.yellowstonegames.press.SquidInput: Constructs a new SquidInput that does not respond to mouse input, but does take keyboard input and sends keyboard events through some processing before calling keyHandler.handle() on keypresses that can sensibly be processed.
SquidInput(SquidInput.KeyHandler, boolean) - Constructor for class com.github.yellowstonegames.press.SquidInput: Constructs a new SquidInput that does not respond to mouse input, but does take keyboard input and sends keyboard events through some processing before calling keyHandler.handle() on keypresses that can sensibly be processed.
SquidInput(SquidInput.KeyHandler, SquidMouse) - Constructor for class com.github.yellowstonegames.press.SquidInput: Constructs a new SquidInput that responds to mouse and keyboard input when given a SquidMouse and a SquidInput.KeyHandler implementation.
SquidInput(SquidInput.KeyHandler, SquidMouse, boolean) - Constructor for class com.github.yellowstonegames.press.SquidInput: Constructs a new SquidInput that responds to mouse and keyboard input when given a SquidMouse and a SquidInput.KeyHandler implementation, and can be put in an initial state where it ignores input until told otherwise via setIgnoreInput(boolean).
SquidInput(SquidMouse) - Constructor for class com.github.yellowstonegames.press.SquidInput: Constructs a new SquidInput that does not respond to keyboard input, but does take mouse input and passes mouse events along to the given SquidMouse.
SquidInput.KeyHandler - Interface in com.github.yellowstonegames.press: A single-method interface used to process "typed" characters, special characters produced by unusual keys, and modifiers that can affect them.
SquidMouse - Class in com.github.yellowstonegames.press: This mouse processor allows for easy conversion to a grid based system.
SquidMouse(float, float, float, float, int, int, InputProcessor) - Constructor for class com.github.yellowstonegames.press.SquidMouse: Sets the size of the cell so that all mouse input can be evaluated as relative to the grid.
SquidMouse(float, float, InputProcessor) - Constructor for class com.github.yellowstonegames.press.SquidMouse: Sets the size of the cell so that all mouse input can be evaluated as relative to the grid.

T

TAB - Static variable in class com.github.yellowstonegames.press.SquidInput: Tab key.
touchDown(int, int, int, int) - Method in class com.github.yellowstonegames.press.SquidInput
touchDown(int, int, int, int) - Method in class com.github.yellowstonegames.press.SquidMouse
touchDragged(int, int, int) - Method in class com.github.yellowstonegames.press.SquidInput
touchDragged(int, int, int) - Method in class com.github.yellowstonegames.press.SquidMouse
touchUp(int, int, int, int) - Method in class com.github.yellowstonegames.press.SquidInput
touchUp(int, int, int, int) - Method in class com.github.yellowstonegames.press.SquidMouse
translateX(int) - Method in class com.github.yellowstonegames.press.SquidMouse: Translates the given screen pixel coordinate to the underlying grid coordinate, taking into account the related offset.
translateY(int) - Method in class com.github.yellowstonegames.press.SquidMouse: Translates the given screen pixel coordinate to the underlying grid coordinate, taking into account the related offset.

U

unmap(char, boolean, boolean, boolean) - Method in class com.github.yellowstonegames.press.SquidInput: Removes a keypress combination from the mapping by specifying the char and any modifiers that are part of the keypress combination.
unmap(int) - Method in class com.github.yellowstonegames.press.SquidInput: Removes a keypress combination from the mapping by specifying the keypress combination as an int.
UP_ARROW - Static variable in class com.github.yellowstonegames.press.SquidInput: Up arrow key.
UP_LEFT_ARROW - Static variable in class com.github.yellowstonegames.press.SquidInput: Not typically a dedicated key, but if numpadDirections is enabled, this will be sent by Numpad 7.
UP_RIGHT_ARROW - Static variable in class com.github.yellowstonegames.press.SquidInput: Not typically a dedicated key, but if numpadDirections is enabled, this will be sent by Numpad 9.

V

VERTICAL_ARROW - Static variable in class com.github.yellowstonegames.press.SquidInput: Not typically a dedicated key, but if numpadDirections is enabled, this will be sent by Numpad 0.

B C D E F G H I K L M N O P Q R S T U V
All Classes and Interfaces|All Packages|Constant Field Values