Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

InputSystem

Add this in your code:

#include <engine/inputs/input_system.h>

Description

Class to read inputs (GamePads, Touch Screens, Keyboard, Mouse).

Macros

PLAYER_1 value: 0
PLAYER_2 value: 1
PLAYER_3 value: 2
PLAYER_4 value: 3
PLAYER_5 value: 4
PLAYER_6 value: 5
PLAYER_7 value: 6
PLAYER_8 value: 7

Static variables


NameTypeDescription
mousePositionVector2Position of the mouse in pixels
mouseSpeedVector2Speed of the mouse (affected by the window resolution)
mouseSpeedRawVector2Raw speed of the mouse
mouseWheelfloatSpeed of the mouse wheel

Static methods


GetKeyDown

Return true if the key has just been pressed.

Parameters:

  • keyCode: Key code to check
  • controllerIndex: Controller index (0-7)
bool GetKeyDown(const KeyCode keyCode, const int controllerIndex = 0)

Code sample:

if (InputSystem::GetKeyDown(KeyCode::A))
{
    Debug::Print("A key pressed");
}

if (InputSystem::GetKeyDown(KeyCode::CIRCLE), PLAYER_1)
{
    Debug::Print("CIRCLE button pressed");
}

GetKey

Return true if the key is held.

Parameters:

  • keyCode: Key code to check
  • controllerIndex: Controller index (0-7)
bool GetKey(const KeyCode keyCode, const int controllerIndex = 0)

Code sample:

if (InputSystem::GetKey(KeyCode::A))
{
    Debug::Print("A key held");
}

if (InputSystem::GetKey(KeyCode::CIRCLE), PLAYER_1)
{
    Debug::Print("CIRCLE button held");
}

GetKeyUp

Return true if the key has just been released.

Parameters:

  • keyCode: Key code to check
  • controllerIndex: Controller index (0-7)
bool GetKeyUp(const KeyCode keyCode, const int controllerIndex = 0)

Code sample:

if (InputSystem::GetKeyUp(KeyCode::A))
{
    Debug::Print("A key released");
}

if (InputSystem::GetKeyUp(KeyCode::CIRCLE), PLAYER_1)
{
    Debug::Print("CIRCLE button released");
}

GetLeftJoystick

Get left joystick value, values between -1.0f and 1.0f.

Parameters:

  • controllerIndex: Controller index (0-7)
Vector2 GetLeftJoystick(const int controllerIndex = 0)

Code sample:

Vector2 left = InputSystem::GetLeftJoystick(PLAYER_1);

GetRightJoystick

Get right joystick value, values between -1.0f and 1.0f.

Parameters:

  • controllerIndex: Controller index (0-7)
Vector2 GetRightJoystick(const int controllerIndex = 0)

Code sample:

Vector2 right = InputSystem::GetRightJoystick(PLAYER_1);

GetLeftTrigger

Get left trigger value (R2), values between 0.0f and 1.0f.

Parameters:

  • controllerIndex: Controller index (0-7)
 static float GetLeftTrigger(const int controllerIndex = 0)

Code sample:

float value = InputSystem::GetLeftTrigger(PLAYER_1);

GetRightTrigger

Get right trigger value (R2), values between 0.0f and 1.0f.

Parameters:

  • controllerIndex: Controller index (0-7)
static float GetRightTrigger(const int controllerIndex = 0)

Code sample:

float value = InputSystem::GetRightTrigger(PLAYER_1);

GetTouchScreenCount

Get how many touch screens the device has.

int GetTouchScreenCount()

Code sample:

int touchScreenCount = InputSystem::GetTouchScreenCount(); // = 2 on PsVita

GetTouchCount

Get how many touch inputs the screen has.

Parameters:

  • screenIndex: Screen index
int GetTouchCount(const int screenIndex)

Code sample:

int touchCount = InputSystem::GetTouchCount(0);

GetTouch

Get touch data.

Parameters:

  • touchIndex: Touch index
  • screenIndex: Screen index
Touch GetTouch(const int touchIndex, const int screenIndex)

Code sample:

int screenIndex = 0;
int touchCount = InputSystem::GetTouchCount(screenIndex);
if (touchCount >= 1)
{
    Touch touch = InputSystem::GetTouch(1, screenIndex);
}

HideMouse

Hide mouse.

void HideMouse()

Code sample:

InputSystem::HideMouse();

ShowMouse

Show mouse.

void ShowMouse()

Code sample:

InputSystem::ShowMouse();