RoROdometerManager.as

// RoROdometer: Script for managing odometers on all types of vehicles.
// This file is under the MIT License. See LICENSE for details.
// Copyright (C) 2026 Ezequiel M.

#include "RoROdometer.as"

const string RoROdometerFile = "RoROdometer";
const string LogIdentifier = "[RoROdometerManager] ";

const uint64 OdometerAccuracy = 1000000;

class VehiclePositionInfo
{
    private BeamClass@ _vehicle;
    private vector3 _lastVehiclePos;
    private float _lastSpeed;
    
    VehiclePositionInfo(BeamClass@ vehicle)
    {
        @_vehicle = vehicle;
        _lastVehiclePos = vehicle.getPosition();
        _lastSpeed = 0;
    }

    ~VehiclePositionInfo()
    {
        Dispose();
    }
    
    BeamClass@ GetVehicle() { return _vehicle; }
    
    void Update(float dt, float&inout distanceDelta, float&inout speed, float&inout acceleration)
    {
        vector3 currentPositionVec = _vehicle.getPosition();
        vector3 deltaPositionVec = currentPositionVec - _lastVehiclePos;
        _lastVehiclePos = currentPositionVec;
        distanceDelta = deltaPositionVec.length();
        
        speed = distanceDelta / dt;
        acceleration = (speed - _lastSpeed) / dt;
        _lastSpeed = speed;
    }
    
    void Dispose()
    {
        @_vehicle = null;
    }
}

class Odometer : RoROdometer::Odometer
{
    private dictionary _odometerUsers;
    private string _odometerID;
    private string _vehicleName;
    private string _vehicleFile;
    private string _vehicleConfig;
    
    private double _mainOdometerKm;
    private double _tripOdometerKm;
    
    Odometer
    (
        string odometerID,
        string vehicleName,
        string vehicleFile,
        string vehicleConfig,
        double mainOdoKm,
        double tripOdoKm
    )
    {
        _odometerID = odometerID;
        _vehicleName = vehicleName;
        _vehicleFile = vehicleFile;
        _vehicleConfig = vehicleConfig;
        _mainOdometerKm = mainOdoKm;
        _tripOdometerKm = tripOdoKm;
    }

    string GetVehicleName() { return _vehicleName; }
    string GetVehicleTruckfile() { return _vehicleFile; }
    string GetVehicleConfigName() { return _vehicleConfig; }

    double GetMainOdometer() override { return _mainOdometerKm; }

    double GetTripOdometer() override { return _tripOdometerKm; }

    void ResetTripOdometer() override { _tripOdometerKm = 0; }
    
    uint GetUserCount() { return _odometerUsers.getSize(); }
    
    array<string>@ GetUserKeys() { return _odometerUsers.getKeys(); }
    
    void Update(float dt)
    {
        array<string>@ keys = _odometerUsers.getKeys();
        for (uint i = 0; i < _odometerUsers.getSize(); i++)
        {
            string key = keys[i];
            VehiclePositionInfo@ odometerUser = cast<VehiclePositionInfo>(_odometerUsers[key]);
            BeamClass@ vehicle = odometerUser.GetVehicle();
            float distanceDelta = 0, speed = 0, acceleration = 0;
            odometerUser.Update(dt, distanceDelta, speed, acceleration);
            
            // We´ll consider the distance delta invalid if
            // the wheel speed minus 0.1 (to avoid noise) is
            // less than the speed calculated using the delta,
            // unless the vehicle is decelerating.
            // That way we can ignore sudden changes in vehicle
            // position, such as resets or teleports.
            double addedMileage = 0;
            if (vehicle.getWheelSpeed() - 0.1 >= speed || acceleration < 0)
                addedMileage = double(distanceDelta) / 1000;
            
            _mainOdometerKm += addedMileage;
            _tripOdometerKm += addedMileage;
        }
    }
    
    void ResetOdometer() { _mainOdometerKm = 0; }
    
    void AddUser(BeamClass@ vehicle)
    {
        if (@vehicle != null && !_odometerUsers.exists("" + vehicle.getInstanceId()))
        {
            VehiclePositionInfo@ vehiclePosInfo = VehiclePositionInfo(vehicle);
            _odometerUsers.set("" + vehicle.getInstanceId(), @vehiclePosInfo);
        }
    }
    
    void RemoveUser(int actorInstanceID)
    {
        if (_odometerUsers.exists("" + actorInstanceID))
            _odometerUsers.delete("" + actorInstanceID);
    }
    
    void ClearUsers()
    {
        array<string>@ keys = _odometerUsers.getKeys();
        for (uint i = 0; i < _odometerUsers.getSize(); i++)
        {
            string key = keys[i];
            VehiclePositionInfo@ odometerUser = cast<VehiclePositionInfo>(_odometerUsers[key]);
            odometerUser.Dispose();
        }
        _odometerUsers.deleteAll();
    }
    
    void Save(LocalStorageClass@ odometersData)
    {
        odometersData.changeSection(_odometerID);
        odometersData.setString("Odometer", "" + uint64(_mainOdometerKm * OdometerAccuracy));
        odometersData.setString("TripOdometer", "" + uint64(_tripOdometerKm * OdometerAccuracy));
        odometersData.setString("VehicleName", _vehicleName);
        odometersData.setString("VehicleTruckfile", _vehicleFile);
        odometersData.setString("VehicleConfig", _vehicleConfig);
    }
}

class OdometerHelperImpl : RoROdometer::OdometerHelper
{
    private dictionary _actorIDsToOdometerKeys;
    dictionary Odometers;

    // Method overrides

    array<string>@ GetOdometerKeys() override { return Odometers.getKeys(); }

    RoROdometer::Odometer@ TryGetOdometerByKey(string odometerKey) override
    {
        Odometer@ odometer = null;
        if (Odometers.exists(odometerKey))
            @odometer = cast<Odometer>(Odometers[odometerKey]);

        return odometer;
    }

    RoROdometer::Odometer@ TryGetOdometerByActor(BeamClass@ vehicle) override
    {
        string vehicleID = RoROdometer::GetVehicleID(vehicle);
        return TryGetOdometerByKey(vehicleID);
    }

    bool TryRemoveOdometerByKey(string odometerKey) override
    {
        bool result = false;
        if (Odometers.exists(odometerKey))
        {
            Odometer@ odometer = cast<Odometer>(Odometers[odometerKey]);
            array<string>@ odometerUserKeys = odometer.GetUserKeys();
            for (uint i = 0; i < odometer.GetUserCount(); i++)
                _actorIDsToOdometerKeys.delete(odometerUserKeys[i]);

            odometer.ClearUsers();
            Odometers.delete(odometerKey);
            result = true;
        }

        return result;
    }

    bool TryRemoveOdometerByActor(BeamClass@ vehicle) override
    {
        string vehicleID = RoROdometer::GetVehicleID(vehicle);
        return TryRemoveOdometerByKey(vehicleID);
    }

    // Common methods

    RoROdometer::Odometer@ InitialiseOdometerFromData(LocalStorageClass@ odometersData, string odometerID)
    {
        odometersData.changeSection(odometerID);
        string strValue = odometersData.getString("Odometer");
        double mainOdoKm = parseInt(strValue) / double(OdometerAccuracy);
        strValue = odometersData.getString("TripOdometer");
        double tripOdoKm = parseInt(strValue) / double(OdometerAccuracy);
        RoROdometer::Odometer@ newOdometer = Odometer
        (
            odometerID,
            odometersData.getString("VehicleName"),
            odometersData.getString("VehicleTruckfile"),
            odometersData.getString("VehicleConfig"),
            mainOdoKm,
            tripOdoKm
        );

        return @newOdometer;
    }

    void InitialiseOdometersFromData(LocalStorageClass@ odometersData)
    {
        int index = 0;
        odometersData.changeSection("common");
        string odometerID = odometersData.getString("OdometerKey" + index);
        while (odometerID != "")
        {
            RoROdometer::Odometer@ newOdometer = InitialiseOdometerFromData(odometersData, odometerID);
            Odometers.set(odometerID, @newOdometer);
            
            index++;
            odometersData.changeSection("common");
            odometerID = odometersData.getString("OdometerKey" + index);
        }
    }

    void AddActorOdometer(int actorInstanceID)
    {
        BeamClass@ vehicle = game.getTruckByNum(actorInstanceID);
        if (@vehicle == null)
            return;
        
        bool isMovingVehicle =
            vehicle.getTruckType() == TT_AIRPLANE ||
            vehicle.getTruckType() == TT_TRUCK ||
            vehicle.getTruckType() == TT_BOAT;
        
        // Exclude MP vehicles as well since they don't belong to the user.
        if (isMovingVehicle && vehicle.getTruckState() != TS_NETWORKED)
        {
            string vehicleID = RoROdometer::GetVehicleID(vehicle);
            if (Odometers.exists(vehicleID))
            {
                Odometer@ odometer = cast<Odometer>(Odometers[vehicleID]);
                odometer.AddUser(vehicle);
            }
            else
            {
                Odometer@ newOdometer = Odometer
                (
                    vehicleID,
                    vehicle.getTruckName(),
                    vehicle.getTruckFileName(),
                    vehicle.getSectionConfig(),
                    0.0, 0.0
                );
                newOdometer.AddUser(vehicle);
                Odometers.set(vehicleID, @newOdometer);
            }

            _actorIDsToOdometerKeys.set("" + actorInstanceID, vehicleID);
        }
    }

    void UpdateOdometers(float dt)
    {
        array<string>@ keys = Odometers.getKeys();
        for (uint i = 0; i < Odometers.getSize(); i++)
        {
            string key = keys[i];
            Odometer@ odometer = cast<Odometer>(Odometers[key]);
            odometer.Update(dt);
        }
    }

    void RemoveActor(int actorInstanceID)
    {
        if (_actorIDsToOdometerKeys.exists("" + actorInstanceID))
        {
            string vehicleID = string(_actorIDsToOdometerKeys["" + actorInstanceID]);
            Odometer@ odometer = cast<Odometer>(Odometers[vehicleID]);
            odometer.RemoveUser(actorInstanceID);
            _actorIDsToOdometerKeys.delete("" + actorInstanceID);
        }
    }

    void SaveAllOdometers(LocalStorageClass@ odometersData)
    {
        // First, remove the old OdometerKeys
        int index = 0;
        odometersData.changeSection("common");
        string odometerKey = "OdometerKey" + index;
        string odometerID = odometersData.getString(odometerKey);
        while (odometerID != "")
        {
            odometersData.delete(odometerKey);
            DeleteKeysFromDataFile(odometerID, odometersData);
            
            index++;
            odometersData.changeSection("common");
            odometerKey = "OdometerKey" + index;
            odometerID = odometersData.getString(odometerKey);
        }

        array<string>@ keys = Odometers.getKeys();
        for (uint i = 0; i < Odometers.getSize(); i++)
        {
            odometersData.changeSection("common");
            string key = keys[i];
            odometersData.setString("OdometerKey" + i, key);
            
            Odometer@ odometer = cast<Odometer>(Odometers[key]);
            odometer.Save(odometersData);
        }

        WriteLog("Saved odometers: " + Odometers.getSize());
        
        odometersData.save();
    }

    void FreeResources()
    {
        array<string>@ keys = Odometers.getKeys();
        for (uint i = 0; i < Odometers.getSize(); i++)
        {
            string key = keys[i];
            Odometer@ odometer = cast<Odometer>(Odometers[key]);
            odometer.ClearUsers();
        }

        Odometers.deleteAll();
        _actorIDsToOdometerKeys.deleteAll();
    }

    private void DeleteKeysFromDataFile(string odometerID, LocalStorageClass@ odometersData)
    {
        odometersData.changeSection(odometerID);
        odometersData.delete("Odometer");
        odometersData.delete("TripOdometer");
        odometersData.delete("VehicleName");
        odometersData.delete("VehicleTruckfile");
        odometersData.delete("VehicleConfig");
    }
}

CVarClass@ G_app_state = console.cVarFind("app_state");
CVarClass@ G_OdometerScriptID = console.cVarGet(RoROdometer::OdometerScriptIDCVarName, 0);
LocalStorageClass@ G_OdometersData = null;
bool G_Initialised = false;
int G_PrevAppState = 0;

// Shared global variables
OdometerHelperImpl OdometerHelper;

void FreeResources()
{
    OdometerHelper.FreeResources();
    console.cVarSet(G_OdometerScriptID.getName(), "");
    @G_app_state = null;
    @G_OdometerScriptID = null;
    @G_OdometersData = null;
    G_Initialised = false;
}

void WriteLog(string msg)
{
    log(LogIdentifier + msg);
}

void main()
{
    WriteLog("Initialising manager. Script ID: " + thisScript);

    G_PrevAppState = G_app_state.getInt();
    
    @G_OdometersData = LocalStorageClass(RoROdometerFile);
    OdometerHelper.InitialiseOdometersFromData(G_OdometersData);
    WriteLog("Odometers found in data file: " + OdometerHelper.Odometers.getSize());

    console.cVarSet(G_OdometerScriptID.getName(), "" + thisScript);
    game.registerForEvent(SE_GENERIC_NEW_TRUCK);
    game.registerForEvent(SE_GENERIC_DELETED_TRUCK);
    game.registerForEvent(SE_ANGELSCRIPT_MANIPULATIONS);

    array<BeamClass@> currentTrucks = game.getAllTrucks();
    for (uint i = 0; i < currentTrucks.length(); i++)
        OdometerHelper.AddActorOdometer(currentTrucks[i].getInstanceId());

    G_Initialised = true;
}

void eventCallbackEx(scriptEvents ev, int a1, int a2, int a3, int a4, string a5, string a6, string a7, string a8)
{
    if (!G_Initialised)
        return;

    if (ev == SE_GENERIC_NEW_TRUCK)
        OdometerHelper.AddActorOdometer(a1);
    else if (ev == SE_GENERIC_DELETED_TRUCK)
        OdometerHelper.RemoveActor(a1);
    else if (ev == SE_ANGELSCRIPT_MANIPULATIONS && a1 == ASMANIP_SCRIPT_UNLOADING && a2 == thisScript)
    {
        OdometerHelper.SaveAllOdometers(G_OdometersData);
        FreeResources();
    }
}

void frameStep(float dt)
{
    if (!G_Initialised)
        return;
    
    if (G_app_state.getInt() == 2 /* Simulation */)
    {
        OdometerHelper.UpdateOdometers(dt);
    }

    if (G_PrevAppState != G_app_state.getInt())
    {
        if (G_app_state.getInt() == 3 /* Shutdown */)
        {
            OdometerHelper.SaveAllOdometers(G_OdometersData);
            FreeResources();
        }
        else if (G_app_state.getInt() != 2 /* Simulation */)
        {
            OdometerHelper.SaveAllOdometers(G_OdometersData);
        }
    }

    // G_app_state will be null after calling FreeResources(), so we need to check.
    if (@G_app_state != null)
        G_PrevAppState = G_app_state.getInt();
}