script.h

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
// Copyright 2025-2026 Arnis Lektauers
//
// Created by Arnis Lektauers on 28.12.2025
//
#pragma once
 
#include <core/eventHandler.h>
 
#define SCRIPT_NAME(Name) \
    static constexpr const char* scriptName() { return Name; }
 
namespace visutwin::canvas
{
    class Entity;
    class ScriptComponent;

    class Script: public EventHandler
    {
    public:
        virtual void initialize() {}

        virtual void postInitialize() {}
 
        /*
         * Called at a fixed interval for deterministic simulation (physics, etc.).
         * The fixedDt is constant across calls (default 1/60s).
         */
        virtual void fixedUpdate(float fixedDt) {}
 
        /*
         * Called for enabled (running state) scripts on each tick
         */
        virtual void update(float dt) {}
 
        /*
         * Called after all scripts update on each tick.
         */
        virtual void postUpdate(float dt) {}
 
        bool enabled() const;
 
    protected:
        Entity* entity() const { return _entity; }
 
    private:
        friend class ScriptComponent;
 
        bool _enabled = true;
        bool _initialized = false;
        bool _postInitialized = false;
        Entity* _entity = nullptr;
    };
}