🔥 Events module¶

Features for detecting user events.

🔢 Types¶

type Vector2D struct {
    X float32
    Y float32
}

Events include detecting keyboard keys, so here's the names Vuelto uses for identifying keys when asked.

{
    "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", // letters
    "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z", // letters
    "Up", "Down", "Left", "Right", // arrows
    "Num0", "Num1", "Num2", "Num3", "Num4", "Num5", "Num6", "Num7", "Num8", "Num9", // numberpad
    "Space", "Enter", "Escape", "Tab", "Shift", "Control", "Alt", // command keys
    "F1", "F2", "F3", "F4", "F5", "F6", "F7", "F8", "F9", "F10", "F11", "F12", // function keys
}

All of these keys are stored in a map:

vuelto.Keys["<Key-here>"]

ℹ️ Usage¶

For now you have the ability to detect key press and key release, with KeyPressed(), KeyReleased() and KeyPressedOnce(). All these functions take a key name (as shown above) as a unique argument, and return a boolean indicating the status.

if window.KeyPressed(vuelto.Keys["E"]) {
    // This runs when I press the E key
}

if window.KeyPressedOnce(vuelto.Keys["G"]) {
        // This runs only once when I press the G key
}

if window.KeyReleased(vuelto.Keys["F"]) {
    // This runs when I release the F key
}

The return value of these functions is reactive, meaning their values changes immediately to reflect what the user's doing. With if KeyPressed("E"), the code inside the if statement will fire as many times as I press E.

For mouse position, you can use MousePos() with no args. It returns a Vector2D.

// assume my mouse is at X 20 and Y 30
pos := win.MousePos() // { X: 20, Y: 30 }
pos.X // 20 (X)
pos.Y // 30 (Y)
pos.Pos() // 20, 30

Unlike key press events, this value does not constantly change, it gives the exact value for the moment of the call. Use loops if you constantly need the value.