IGameMode.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Valentin Eloy
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
#include <string_view>
#include <vector>
 
#include "Core/Levels/LevelOutcome.h"
#include "Core/Physics/PlayerInput.h"

 
namespace hmi {

class IGameModePasses {
public:
    IGameModePasses() = default;
    virtual ~IGameModePasses() = default;
    IGameModePasses(const IGameModePasses&) = delete;
    IGameModePasses& operator=(const IGameModePasses&) = delete;
    IGameModePasses(IGameModePasses&&) = delete;
    IGameModePasses& operator=(IGameModePasses&&) = delete;

    virtual void snapshotPreviousPositions() = 0;
    virtual void advanceParticles(float fixedDelta) = 0;
    virtual void advanceScreenShake(float fixedDelta) = 0;
    virtual void moveCharacter(const core::PlayerInput& input, float fixedDelta) = 0;
    virtual void advanceAnimations(float fixedDelta) = 0;
    virtual void updateCamera(float fixedDelta) = 0;
    virtual void updateMechanisms(const core::PlayerInput& input) = 0;
    virtual void detectEvents() = 0;
    virtual void updateMechanismVisuals(float fixedDelta) = 0;
    [[nodiscard]] virtual core::LevelOutcome evaluateOutcome() = 0;
    virtual void onLevelLost() = 0;
};

class IGameMode {
public:
    IGameMode() = default;
    virtual ~IGameMode() = default;
    IGameMode(const IGameMode&) = delete;
    IGameMode& operator=(const IGameMode&) = delete;
    IGameMode(IGameMode&&) = delete;
    IGameMode& operator=(IGameMode&&) = delete;

    [[nodiscard]] virtual std::string_view name() const = 0;

    [[nodiscard]] virtual std::vector<std::string_view> passOrder() const = 0;

    virtual void onLoad(IGameModePasses& passes) = 0;

    virtual core::LevelOutcome step(IGameModePasses& passes, const core::PlayerInput& input,
                                    float fixedDelta) = 0;

    virtual void onUnload(IGameModePasses& passes) = 0;
};
 
}  // namespace hmi