Keyboard

Keyboard state singleton for checking modifier keys.

Overview

Keyboard is a singleton object that provides real-time access to modifier key states. Unlike event-based input which fires callbacks, Keyboard lets you poll whether shift, ctrl, alt, or system keys are currently held down.

Quick Reference

def handle_key(key, state):
    if state == mcrfpy.InputState.PRESSED:
        if key == mcrfpy.Key.S:
            if mcrfpy.Keyboard.ctrl:
                save_game()  # Ctrl+S
            elif mcrfpy.Keyboard.shift:
                save_as()    # Shift+S
            else:
                move_south() # Just S

scene.on_key = handle_key

# Check modifier states anywhere
if mcrfpy.Keyboard.shift:
    print("Shift is currently held")

Properties

Property	Type	Description
`shift`	bool	True if either shift key is held (read-only)
`ctrl`	bool	True if either control key is held (read-only)
`alt`	bool	True if either alt key is held (read-only)
`system`	bool	True if either system key is held (read-only)

Usage Patterns

Modifier Combinations

def on_key(key, state):
    if state != mcrfpy.InputState.PRESSED:
        return

    # Check for key combinations
    if key == mcrfpy.Key.Z:
        if mcrfpy.Keyboard.ctrl and mcrfpy.Keyboard.shift:
            redo()      # Ctrl+Shift+Z
        elif mcrfpy.Keyboard.ctrl:
            undo()      # Ctrl+Z

Run vs Walk

def update_movement():
    speed = 2.0
    if mcrfpy.Keyboard.shift:
        speed = 4.0  # Run when shift is held

    move_player(speed)