Input¶

Doriax exposes all input through the static Input class. It covers keyboard, mouse, touch, and modifier state for desktop, mobile, and web targets. All polling APIs are safe to call from any script or system update.

Keyboard¶

Keyboard key constants follow the S_KEY_* naming convention and are based on GLFW key codes.

if Input.isKeyPressed(S_KEY_SPACE) then
    player:jump()
end

if Input.isKeyDown(S_KEY_A) then
    player:moveLeft()
end

if (Input::isKeyPressed(S_KEY_SPACE)) {
    player.jump();
}

if (Input::isKeyDown(S_KEY_A)) {
    player.moveLeft();
}

Key query methods¶

Common key constants¶

See Input for the full constant list.

Mouse¶

if Input.isMousePressed(S_MOUSE_BUTTON_LEFT) then
    local pos = Input.getMousePosition()
    shoot(pos.x, pos.y)
end

if (Input::isMousePressed(S_MOUSE_BUTTON_LEFT)) {
    Vector2 pos = Input::getMousePosition();
    shoot(pos.x, pos.y);
}

Mouse methods¶

Mouse button constants¶

Touch¶

Touch input is the primary interaction model on mobile and web. Use the touch APIs for multi-touch aware code; configure mouse/touch mirroring in Engine settings if you want single-touch to also fire mouse events.

if Input.isTouch() then
    local n = Input.numTouches()
    for i = 0, n - 1 do
        local pos = Input.getTouchPosition(i)
        handleTap(pos.x, pos.y)
    end
end

if (Input::isTouch()) {
    int n = Input::numTouches();
    for (int i = 0; i < n; i++) {
        Vector2 pos = Input::getTouchPosition(i);
        handleTap(pos.x, pos.y);
    }
}

Touch methods¶

Modifiers¶

Modifier key state is available for keyboard shortcuts:

local mods = Input.getModifiers()
if mods == S_MODIFIER_CONTROL then
    -- Ctrl is held
end

int mods = Input::getModifiers();
if (mods & S_MODIFIER_CONTROL) {
    // Ctrl is held
}

Modifier constants include S_MODIFIER_SHIFT, S_MODIFIER_CONTROL, S_MODIFIER_ALT, S_MODIFIER_SUPER, S_MODIFIER_CAPS_LOCK, and S_MODIFIER_NUM_LOCK.

Mouse and touch mirroring¶

Configure the engine to mirror mouse events as touch events or vice versa:

Engine::setMouseAsTouch(true);    // mouse click fires touch callbacks
Engine::setTouchAsMouse(true);    // touch fires mouse callbacks

This simplifies cross-platform code — write one input path that works for both desktop and mobile.

UI input¶

UI widgets consume pointer and touch events automatically. To prevent UI clicks from also triggering gameplay input handlers (for example, shooting when the player taps a button), call:

Engine.setIgnoreEventsHandledByUI(true)

Engine::setIgnoreEventsHandledByUI(true);

Virtual keyboard (mobile / web)¶

On platforms without a hardware keyboard, open the system virtual keyboard for text input:

System.showVirtualKeyboard()
System.hideVirtualKeyboard()

System::showVirtualKeyboard();
System::hideVirtualKeyboard();

Cross-platform advice¶

• Always provide both keyboard/mouse and touch code paths.
• Use S_KEY_* names in comments so the code is readable even when constants are captured in variables.
• Avoid relying on platform-specific keys (e.g. Windows key, macOS Command) for core gameplay mechanics.
• Test canvas/input coordinate scaling together — a touch at screen position (x, y) maps to logical canvas coordinates depending on the active scaling mode.

See also¶

• Input — full API reference with all constants
• System — virtual keyboard and platform utilities
• User Interface — UI event handling