⏸️ Pause() & Resume()

What are they?

The functions Pause() and Resume() allow you to pause and resume the game from any script.

These functions stop the internal game logic (movement, AI, physics, player Update, etc.), but the browser’s key events such as keydown continue working.

📖 Syntax

Pause();
Resume();

Both functions require no parameters.

🧩 What exactly does Pause() do?

Pause() activates the engine’s internal state gamePaused. When this state is active:

• ❌ Update(obj, dt) scripts are not executed
• ❌ Physics are not updated
• ❌ No object movement occurs
• ❌ No new animations are played
• ✔ Keyboard input events (keydown) still work
• ✔ You can display pause UIs or menus

▶️ What exactly does Resume() do?

Resume() disables the gamePaused state, and the engine resumes normal game execution:

• ✔ AI is reactivated
• ✔ Update(obj, dt) scripts run again
• ✔ Mechanics, physics, movement, etc. are resumed

📌 Basic example

// Pause or resume using Escape
if (IsAnyPressed("Escape")) {

    if (!paused) {
        Pause();
        Log("Game paused");
    } else {
        Resume();
        Log("Game resumed");
    }
}

📌 Example using the native browser event

document.addEventListener("keydown", e => {
    if (e.key === "Escape") {
        
        if (!paused) {
            Pause();
            Log("Pause");
        } else {
            Resume();
            Log("Resume");
        }
    }
});

📋 What can you do during the pause?

• Display a custom pause menu.
• Show options, help, or inventory screens.
• Continue detecting special keys (Escape, P, Enter…).
• Pause sounds (if using AudioSource).
• Show overlays (darkened screen, etc.).

🛠️ Best practices

• Use Pause() before showing a menu.
• Use Resume() right before hiding that menu.
• Do not use Update() to move objects while paused.
• If you want to detect keys while paused, use keydown.