Powered.cs

using System;
using Microsoft.Xna.Framework;
using System.Collections.Generic;
using System.Linq;
#if CLIENT
using Barotrauma.Sounds;
#endif
 
namespace Barotrauma.Items.Components
{
    public enum PowerPriority
    {
        Default = 0, // Use for status effects and/or extraload
        Reactor = 1,
        Relay = 3,
        Battery = 5
    }
 
    readonly struct PowerRange
    {
        public readonly static PowerRange Zero = default;
 
        public readonly float Min;
        public readonly float Max;
 
        public readonly float ReactorMaxOutput;
 
        public PowerRange(float min, float max) : this(min, max, 0.0f)
        {
        }
 
        public PowerRange(float min, float max, float reactorMaxOutput)
        {
            System.Diagnostics.Debug.Assert(max >= min);
            System.Diagnostics.Debug.Assert(min >= 0);
            System.Diagnostics.Debug.Assert(max >= 0);
            Min = min;
            Max = max;
            ReactorMaxOutput = reactorMaxOutput;
        }
 
        public static PowerRange operator +(PowerRange a, PowerRange b)
        {
            return new PowerRange(a.Min + b.Min, a.Max + b.Max, a.ReactorMaxOutput + b.ReactorMaxOutput);
        }
        public static PowerRange operator -(PowerRange a, PowerRange b)
        {
            return new PowerRange(a.Min - b.Min, a.Max - b.Max, a.ReactorMaxOutput - b.ReactorMaxOutput);
        }
    }
 
    partial class Powered : ItemComponent
    {
        //TODO: test sparser update intervals?
        protected const float UpdateInterval = (float)Timing.Step;
 
        private static readonly List<Powered> poweredList = new List<Powered>();
        public static IEnumerable<Powered> PoweredList
        {
            get { return poweredList; }
        }
 
        public static readonly HashSet<Connection> ChangedConnections = new HashSet<Connection>();
 
        public readonly static Dictionary<int, GridInfo> Grids = new Dictionary<int, GridInfo>();
 
        protected float currPowerConsumption;
 
        private float voltage;
 
        private float minVoltage;
 
        protected float powerConsumption;
 
        protected Connection powerIn, powerOut;
 
        protected const float MaxOverVoltageFactor = 2.0f;
 
        protected virtual PowerPriority Priority { get { return PowerPriority.Default; } }
 
        [Header(localizedTextTag: "sp.powered.propertyheader")]
        [Editable, Serialize(0.5f, IsPropertySaveable.Yes, description: "The minimum voltage required for the device to function. " +
            "The voltage is calculated as power / powerconsumption, meaning that a device " +
            "with a power consumption of 1000 kW would need at least 500 kW of power to work if the minimum voltage is set to 0.5.")]
        public float MinVoltage
        {
            get { return powerConsumption <= 0.0f ? 0.0f : minVoltage; }
            set { minVoltage = value; }
        }
 
        [Editable, Serialize(0.0f, IsPropertySaveable.Yes, description: "How much power the device draws (or attempts to draw) from the electrical grid when active.")]
        public float PowerConsumption
        {
            get { return powerConsumption; }
            set { powerConsumption = value; }
        }
        
        [Serialize(false, IsPropertySaveable.Yes, description: "Is the device currently active. Inactive devices don't consume power.")]
        public override bool IsActive
        {
            get { return base.IsActive; }
            set
            {
                base.IsActive = value;
                if (!value)
                {
                    currPowerConsumption = 0.0f;
                }
            }
        }
 
        [Serialize(0.0f, IsPropertySaveable.Yes, description: "The current power consumption of the device. Intended to be used by StatusEffect conditionals (setting the value from XML is not recommended).")]
        public float CurrPowerConsumption
        {
            get {return currPowerConsumption; }
            set { currPowerConsumption = value; }
        }
 
        [Serialize(0.0f, IsPropertySaveable.Yes, description: "The current voltage of the item (calculated as power consumption / available power). Intended to be used by StatusEffect conditionals (setting the value from XML is not recommended).")]
        public float Voltage
        {
            get
            {
                if (PoweredByTinkering)
                {
                    return 1.0f;
                }
                else if (powerIn != null)
                {
                    if (powerIn?.Grid != null) { return powerIn.Grid.Voltage; }
                }
                else if (powerOut != null)
                {
                    if (powerOut?.Grid != null) { return powerOut.Grid.Voltage; }
                }
                return PowerConsumption <= 0.0f ? 1.0f : voltage;
            }
            set
            {
                voltage = Math.Max(0.0f, value);
            }
        }
 
        public float RelativeVoltage => minVoltage <= 0.0f ? 1.0f : MathHelper.Clamp(Voltage / minVoltage, 0.0f, 1.0f);
        
        public virtual bool HasPower => Voltage >= MinVoltage;
 
        public bool PoweredByTinkering { get; set; }
 
        [Editable, Serialize(true, IsPropertySaveable.Yes, description: "Can the item be damaged by electomagnetic pulses.")]
        public bool VulnerableToEMP
        {
            get;
            set;
        }
 
        public Powered(Item item, ContentXElement element)
            : base(item, element)
        {
            poweredList.Add(this);
            InitProjectSpecific(element);
        }
 
        partial void InitProjectSpecific(ContentXElement element);
 
        protected void UpdateOnActiveEffects(float deltaTime)
        {
            if (currPowerConsumption <= 0.0f && PowerConsumption <= 0.0f)
            {
                //if the item consumes no power, ignore the voltage requirement and
                //apply OnActive statuseffects as long as this component is active
                ApplyStatusEffects(ActionType.OnActive, deltaTime);                
                return;
            }
 
            if (Voltage > minVoltage)
            {
                ApplyStatusEffects(ActionType.OnActive, deltaTime);
            }
#if CLIENT
            if (Voltage > minVoltage)
            {
                if (!powerOnSoundPlayed && powerOnSound != null)
                {
                    SoundPlayer.PlaySound(powerOnSound.Sound, item.WorldPosition, powerOnSound.Volume, powerOnSound.Range, hullGuess: item.CurrentHull, ignoreMuffling: powerOnSound.IgnoreMuffling, freqMult: powerOnSound.GetRandomFrequencyMultiplier());                    
                    powerOnSoundPlayed = true;
                }
            }
            else if (Voltage < 0.1f)
            {
                powerOnSoundPlayed = false;
            }
#endif
        }
 
        public override void Update(float deltaTime, Camera cam)
        {
            UpdateOnActiveEffects(deltaTime);
        }
 
        public override void OnItemLoaded()
        {
            if (item.Connections == null) { return; }
            foreach (Connection c in item.Connections)
            {
                if (!c.IsPower) { continue; }
                if (this is PowerTransfer pt)
                {
                    if (c.Name == "power_in")
                    {
                        powerIn = c;
                    }
                    else if (c.Name == "power_out")
                    {
                        powerOut = c;
                        // Connection takes the lowest priority
                        if (Priority > powerOut.Priority)
                        {
                            powerOut.Priority = Priority;
                        }
                    }
                    else if (c.Name == "power")
                    {
                        powerIn = powerOut = c;
                    }
                }
                else
                {
                    if (c.IsOutput)
                    {
                        if (c.Name == "power_in")
                        {
#if DEBUG
                            DebugConsole.ThrowError($"Item \"{item.Name}\" has a power output connection called power_in. If the item is supposed to receive power through the connection, change it to an input connection.");
#else
                            DebugConsole.NewMessage($"Item \"{item.Name}\" has a power output connection called power_in. If the item is supposed to receive power through the connection, change it to an input connection.", Color.Orange);
#endif
                        }
                        powerOut = c;
                        // Connection takes the lowest priority
                        if (Priority > powerOut.Priority)
                        {
                            powerOut.Priority = Priority;
                        }
                    }
                    else
                    {
                        if (c.Name == "power_out")
                        {
#if DEBUG
                            DebugConsole.ThrowError($"Item \"{item.Name}\" has a power input connection called power_out. If the item is supposed to output power through the connection, change it to an output connection.");
#else
                            DebugConsole.NewMessage($"Item \"{item.Name}\" has a power input connection called power_out. If the item is supposed to output power through the connection, change it to an output connection.", Color.Orange);
#endif
                        }
                        powerIn = c;
                    }
                }
            }
        }
        
 
        public static void UpdateGrids(bool useCache = true)
        {
            //don't use cache if there are no existing grids
            if (Grids.Count > 0 && useCache)
            {
                //delete all grids that were affected
                foreach (Connection c in ChangedConnections)
                {
                    if (c.Grid != null)
                    {
                        Grids.Remove(c.Grid.ID);
                        c.Grid = null;
                    }
                }
 
                foreach (Connection c in ChangedConnections)
                {
                    //Make sure the connection grid hasn't been resolved by another connection update
                    //Ensure the connection has other connections
                    if (c.Grid == null && c.Recipients.Count > 0 && c.Item.Condition > 0.0f)
                    {
                        GridInfo grid = PropagateGrid(c);
                        Grids[grid.ID] = grid;
                    }
                }
            }
            else
            {
                //Clear all grid IDs from connections
                foreach (Powered powered in poweredList)
                {
                    //Only check devices with connectors
                    if (powered.powerIn != null)
                    {
                        powered.powerIn.Grid = null;
                    }
                    if (powered.powerOut != null)
                    {
                        powered.powerOut.Grid = null;
                    }
                }
 
                Grids.Clear();
 
                foreach (Powered powered in poweredList)
                {
                    //Probe through all connections that don't have a gridID
                    if (powered.powerIn != null && powered.powerIn.Grid == null && powered.powerIn != powered.powerOut && powered.Item.Condition > 0.0f)
                    {
                        // Only create grids for networks with more than 1 device
                        if (powered.powerIn.Recipients.Count > 0)
                        {
                            GridInfo grid = PropagateGrid(powered.powerIn);
                            Grids[grid.ID] = grid;
                        }
                    }
 
                    if (powered.powerOut != null && powered.powerOut.Grid == null && powered.Item.Condition > 0.0f)
                    {
                        //Only create grids for networks with more than 1 device
                        if (powered.powerOut.Recipients.Count > 0)
                        {
                            GridInfo grid = PropagateGrid(powered.powerOut);
                            Grids[grid.ID] = grid;
                        }
                    }
                }
            }
 
            //Clear changed connections after each update
            ChangedConnections.Clear();
        }
 
        private static GridInfo PropagateGrid(Connection conn)
        {
            //Generate unique Key
            int id = Rand.Int(int.MaxValue, Rand.RandSync.Unsynced);
            while (Grids.ContainsKey(id))
            {
                id = Rand.Int(int.MaxValue, Rand.RandSync.Unsynced);
            }
 
            return PropagateGrid(conn, id);
        }
 
        private static GridInfo PropagateGrid(Connection conn, int gridID)
        {
            Stack<Connection> probeStack = new Stack<Connection>();
 
            GridInfo grid = new GridInfo(gridID);
 
            probeStack.Push(conn);
 
            //Non recursive approach to traversing connection tree
            while (probeStack.Count > 0)
            {
                Connection c = probeStack.Pop();
                c.Grid = grid;
                grid.AddConnection(c);
 
                //Add on recipients 
                foreach (Connection otherC in c.Recipients)
                {
                    //Only add valid connections
                    if (otherC.Grid != grid && (otherC.Grid == null || !Grids.ContainsKey(otherC.Grid.ID)) && ValidPowerConnection(c, otherC))
                    {
                        otherC.Grid = grid; //Assigning ID early prevents unncessary adding to stack
                        probeStack.Push(otherC);
                    }
                }
            }
 
            return grid;
        }
 
        public static void UpdatePower(float deltaTime)
        {
            //Don't update the power if the round is ending
            if (GameMain.GameSession != null && GameMain.GameSession.RoundEnding)
            {
                return;
            }
 
            //Only update the power at the given update interval
            /*
            //Not use currently as update interval of 1/60
            if (updateTimer > 0.0f)
            {
                updateTimer -= deltaTime;
                return;
            }
            updateTimer = UpdateInterval;
            */
 
#if CLIENT
            System.Diagnostics.Stopwatch sw = new System.Diagnostics.Stopwatch();
            sw.Start();
#endif
            //Ensure all grids are updated correctly and have the correct connections
            UpdateGrids();
 
#if CLIENT
            sw.Stop();
            GameMain.PerformanceCounter.AddElapsedTicks("Update:Power", sw.ElapsedTicks);
            sw.Restart();
#endif
 
            //Reset all grids
            foreach (GridInfo grid in Grids.Values)
            {
                //Wipe priority groups as connections can change to not be outputting -- Can be improved caching wise --
                grid.PowerSourceGroups.Clear();
                grid.Power = 0;
                grid.Load = 0;
            }
 
            //Determine if devices are adding a load or providing power, also resolve solo nodes
            foreach (Powered powered in poweredList)
            {
                //Make voltage decay to ensure the device powers down.
                //This only effects devices with no power input (whose voltage is set by other means, e.g. status effects from a contained battery)
                //or devices that have been disconnected from the power grid - other devices use the voltage of the grid instead.
                powered.Voltage -= deltaTime;
 
                //Handle the device if it's got a power connection
                if (powered.powerIn != null && powered.powerOut != powered.powerIn)
                {
                    //Get the new load for the connection
                    float currLoad = powered.GetCurrentPowerConsumption(powered.powerIn);
 
                    //If its a load update its grid load
                    if (currLoad >= 0)
                    {
                        if (powered.PoweredByTinkering) { currLoad = 0.0f; }
                        powered.CurrPowerConsumption = currLoad;
                        if (powered.powerIn.Grid != null)
                        {
                            powered.powerIn.Grid.Load += currLoad;
                        }
                    }
                    else if (powered.powerIn.Grid != null)
                    {
                        //If connected to a grid add as a source to be processed
                        powered.powerIn.Grid.AddSrc(powered.powerIn);
                    }
                    else
                    {
                        powered.CurrPowerConsumption = -powered.GetConnectionPowerOut(powered.powerIn, 0, powered.MinMaxPowerOut(powered.powerIn, 0), 0);
                        powered.GridResolved(powered.powerIn);
                    }
                }
 
                //Handle the device power depending on if its powerout
                if (powered.powerOut != null)
                {
                    //Get the connection's load
                    float currLoad = powered.GetCurrentPowerConsumption(powered.powerOut);
 
                    //Update the device's output load to the correct variable
                    if (powered is PowerTransfer pt)
                    {
                        pt.PowerLoad = currLoad;
                    }
                    else if (powered is PowerContainer pc)
                    {
                        // PowerContainer handle its own output value
                    }
                    else
                    {
                        powered.CurrPowerConsumption = currLoad;
                    }
 
                    if (currLoad >= 0)
                    {
                        //Add to the grid load if possible
                        if (powered.powerOut.Grid != null)
                        {
                            powered.powerOut.Grid.Load += currLoad;
                        }
                    }
                    else if (powered.powerOut.Grid != null)
                    {
                        //Add connection as a source to be processed
                        powered.powerOut.Grid.AddSrc(powered.powerOut);
                    }
                    else
                    {
                        //Perform power calculations for the singular connection
                        float loadOut = -powered.GetConnectionPowerOut(powered.powerOut, 0, powered.MinMaxPowerOut(powered.powerOut, 0), 0);
                        if (powered is PowerTransfer pt2)
                        {
                            pt2.PowerLoad = loadOut;
                        }
                        else if (powered is PowerContainer pc)
                        {
                            //PowerContainer handles its own output value
                        }
                        else
                        {
                            powered.CurrPowerConsumption = loadOut;
                        }
 
                        //Indicate grid is resolved as it was the only device
                        powered.GridResolved(powered.powerOut);
                    }
                }
            }
 
            //Iterate through all grids to determine the power on the grid
            foreach (GridInfo grid in Grids.Values)
            {
                //Iterate through the priority src groups lowest first
                foreach (PowerSourceGroup scrGroup in grid.PowerSourceGroups.Values)
                {
                    scrGroup.MinMaxPower = PowerRange.Zero;
 
                    //Iterate through all connections in the group to get their minmax power and sum them
                    foreach (Connection c in scrGroup.Connections)
                    {
                        foreach (var device in c.Item.GetComponents<Powered>())
                        {
                            scrGroup.MinMaxPower += device.MinMaxPowerOut(c, grid.Load);
                        }
                    }
 
                    //Iterate through all connections to get their final power out provided the min max information
                    float addedPower = 0;
                    foreach (Connection c in scrGroup.Connections)
                    {
                        foreach (var device in c.Item.GetComponents<Powered>())
                        {
                            addedPower += device.GetConnectionPowerOut(c, grid.Power, scrGroup.MinMaxPower, grid.Load);
                        }
                    }
 
                    //Add the power to the grid
                    grid.Power += addedPower;
                }
 
                //Calculate Grid voltage, limit between 0 - 1000
                float newVoltage = MathHelper.Min(grid.Power / MathHelper.Max(grid.Load, 1E-10f), 1000);
                if (float.IsNegative(newVoltage))
                {
                    newVoltage = 0.0f;
                }
 
                grid.Voltage = newVoltage;
 
                //Iterate through all connections on that grid and run their gridResolved function
                foreach (Connection c in grid.Connections)
                {
                    foreach (var device in c.Item.GetComponents<Powered>())
                    {
                        device?.GridResolved(c);
                    }
                }
            }
 
#if CLIENT
            sw.Stop();
            GameMain.PerformanceCounter.AddElapsedTicks("Update:Power", sw.ElapsedTicks);
#endif
        }
 
        public virtual float GetCurrentPowerConsumption(Connection connection = null)
        {
            // If a handheld device there is no consumption
            if (powerIn == null && powerOut == null)
            {
                return 0;
            }
 
            // Add extraload for PowerTransfer devices
            if (this is PowerTransfer pt)
            {
                return PowerConsumption + pt.ExtraLoad;
            }
            else if (connection != this.powerIn || !IsActive)
            {
                //If not the power in connection or is inactive there is no draw
                return 0;
            }
 
            //Otherwise return the max powerconsumption of the device
            return PowerConsumption;
        }
 
        public virtual PowerRange MinMaxPowerOut(Connection conn, float load = 0)
        {
            return PowerRange.Zero;
        }
 
        public virtual float GetConnectionPowerOut(Connection conn, float power, PowerRange minMaxPower, float load)
        {
            return conn == powerOut ? MathHelper.Max(-CurrPowerConsumption, 0) : 0;
        }
 
        public virtual void GridResolved(Connection conn) { }
 
        public static bool ValidPowerConnection(Connection conn1, Connection conn2)
        {
            return 
                conn1.IsPower && conn2.IsPower && 
                conn1.Item.Condition > 0.0f && conn2.Item.Condition > 0.0f &&
                conn1.Item.GetComponent<PowerTransfer>() is not { CanTransfer: false } &&
                conn2.Item.GetComponent<PowerTransfer>() is not { CanTransfer: false } &&
                (conn1.Item.HasTag(Tags.JunctionBox) || conn2.Item.HasTag(Tags.JunctionBox) || conn1.Item.HasTag(Tags.DockingPort) || conn2.Item.HasTag(Tags.DockingPort) || conn1.IsOutput != conn2.IsOutput);
        }
 
        protected float GetAvailableInstantaneousBatteryPower()
        {
            if (item.Connections == null || powerIn == null) { return 0.0f; }
            float availablePower = 0.0f;
            var recipients = powerIn.Recipients;
            foreach (Connection recipient in recipients)
            {
                if (!recipient.IsPower || !recipient.IsOutput) { continue; }
                var battery = recipient.Item?.GetComponent<PowerContainer>();
                if (battery == null || battery.Item.Condition <= 0.0f) { continue; }
                if (battery.OutputDisabled) { continue; }
                float maxOutputPerFrame = battery.MaxOutPut / 60.0f;
                float framesPerMinute = 3600.0f;
                availablePower += Math.Min(battery.Charge * framesPerMinute, maxOutputPerFrame);
            }            
            return availablePower;
        }
 
        protected IEnumerable<PowerContainer> GetDirectlyConnectedBatteries()
        {
            if (item.Connections != null && powerIn != null)
            {
                foreach (Connection recipient in powerIn.Recipients)
                {
                    if (!recipient.IsPower || !recipient.IsOutput) { continue; }
                    if (recipient.Item?.GetComponent<PowerContainer>() is PowerContainer battery)
                    {
                        yield return battery;
                    }
                }
            }
        }
 
        protected override void RemoveComponentSpecific()
        {
            //Flag power connections to be updated
            if (item.Connections != null)
            {
                foreach (Connection c in item.Connections)
                {
                    if (c.IsPower && c.Grid != null)
                    {
                        ChangedConnections.Add(c);
                    }
                }
            }
 
            base.RemoveComponentSpecific();
            poweredList.Remove(this);
        }
    }
 
    partial class GridInfo
    {
        public readonly int ID;
        public float Voltage = 0;
        public float Load = 0;
        public float Power = 0;
 
        public readonly List<Connection> Connections = new List<Connection>();
        public readonly SortedList<PowerPriority, PowerSourceGroup> PowerSourceGroups = new SortedList<PowerPriority, PowerSourceGroup>();
 
        public GridInfo(int id)
        {
            ID = id;
        }
 
        public void RemoveConnection(Connection c)
        {
            Connections.Remove(c);
 
            //Remove the grid if it has no devices
            if (Connections.Count == 0 && Powered.Grids.ContainsKey(ID))
            {
                Powered.Grids.Remove(ID);
            }
        }
 
        public void AddConnection(Connection c)
        {
            Connections.Add(c);
        }
 
        public void AddSrc(Connection c)
        {
            if (PowerSourceGroups.ContainsKey(c.Priority))
            {
                PowerSourceGroups[c.Priority].Connections.Add(c);
            }
            else
            {
                PowerSourceGroup group = new PowerSourceGroup();
                group.Connections.Add(c);
                PowerSourceGroups[c.Priority] = group;
            }
        }
    }
 
    partial class PowerSourceGroup
    {
        public PowerRange MinMaxPower;
        public readonly List<Connection> Connections = new List<Connection>();
 
        public PowerSourceGroup()
        {
        }
    }
}