- Added "fallbackpackagename" to all resouirce data types

- constructor/loading and refactor work in LuaCsSetup.cs
- Configuration system work.

Author: TBN-MapleWheels

Barotrauma/BarotraumaClient/ClientSource/LuaCs/Configuration/DisplayableData.cs

@@ -6,11 +6,13 @@ public record DisplayableData : IDisplayableData
 {
     public string InternalName { get; init; }
     public ContentPackage OwnerPackage { get; init; }
+    public string FallbackPackageName { get; init; }
     public string DisplayName { get; init; }
     public string DisplayModName { get; init; }
     public string DisplayCategory { get; init; }
     public string Tooltip { get; init; }
     public string ImageIcon { get; init; }
     public Point IconResolution { get; init; }
     public bool ShowWhenNotLoaded { get; init; }
+    public string Description { get; init; }
 }

Barotrauma/BarotraumaClient/ClientSource/LuaCs/Configuration/IDisplayables.cs

@@ -37,6 +37,10 @@ public interface IDisplayableData : IDataInfo
     /// Whether to show the entry in the menu when not loaded.
     /// </summary>
     bool ShowWhenNotLoaded { get; }
+    /// <summary>
+    /// What does this setting do?
+    /// </summary>
+    string Description { get; }
 }
 
 public interface IDisplayableInitialize

Barotrauma/BarotraumaClient/ClientSource/LuaCs/Services/Compatibility/ILuaCsNetworking.cs

@@ -0,0 +1,8 @@
+using Barotrauma.Networking;
+
+namespace Barotrauma.LuaCs.Services.Compatibility;
+
+internal partial interface ILuaCsNetworking : ILuaCsShim
+{
+    public void NetMessageReceived(IReadMessage netMessage, ServerPacketHeader header, Client client = null);
+}

Barotrauma/BarotraumaClient/ClientSource/LuaCs/Services/IConfigService.cs

@@ -9,23 +9,23 @@ namespace Barotrauma.LuaCs.Services;
 public partial interface IConfigService
 {
     /*
-     * Immediate mode, does not have displayable functionality
+     * Immediate mode
      */
-    IConfigEntry<T> AddConfigEntry<T>(IDisplayableData data,
+    FluentResults.Result<IConfigEntry<T>> AddConfigEntry<T>(IDisplayableData data,
         T defaultValue,
         NetSync syncMode = NetSync.None,
         ClientPermissions permissions = ClientPermissions.None,
         Func<T, bool> valueChangePredicate = null,
         Action<IConfigEntry<T>> onValueChanged = null) where T : IConvertible, IEquatable<T>;
 
-    IConfigList AddConfigList(IDisplayableData data,
+    FluentResults.Result<IConfigList> AddConfigList(IDisplayableData data,
         int defaultIndex, IReadOnlyList<string> values,
         NetSync syncMode = NetSync.None,
         ClientPermissions permissions = ClientPermissions.None,
         Func<IConfigList, int, bool> valueChangePredicate = null,
         Action<IConfigList, int> onValueChanged = null);
 
-    IConfigRangeEntry<T> AddConfigRangeEntry<T>(IDisplayableData data,
+    FluentResults.Result<IConfigRangeEntry<T>> AddConfigRangeEntry<T>(IDisplayableData data,
         T defaultValue, T minValue, T maxValue,
         Func<IConfigRangeEntry<T>, int> getStepCount,
         NetSync syncMode = NetSync.None,

Barotrauma/BarotraumaClient/ClientSource/Networking/GameClient.cs

@@ -586,7 +586,7 @@ private void ReadDataMessage(IReadMessage inc)
         {
             ServerPacketHeader header = (ServerPacketHeader)inc.ReadByte();
 
-            GameMain.LuaCs.Networking.NetMessageReceived(inc, header);
+            GameMain.LuaCs.NetworkingService.NetMessageReceived(inc, header);
 
             if (roundInitStatus == RoundInitStatus.WaitingForStartGameFinalize
                 && header is not (

Barotrauma/BarotraumaServer/ServerSource/GameMain.cs

@@ -444,7 +444,7 @@ public CoroutineHandle ShowLoading(IEnumerable<CoroutineStatus> loader, bool wai
         public void Exit()
         {
             ShouldRun = false;
-            GameMain.LuaCs.Stop();
+            GameMain.LuaCs.Dispose();
         }
     }
 }

Barotrauma/BarotraumaShared/SharedSource/Items/Item.cs

@@ -1313,7 +1313,7 @@ public Item(Rectangle newRect, ItemPrefab itemPrefab, Submarine submarine, bool
             if (Components.Any(ic => ic is Wire) && Components.All(ic => ic is Wire || ic is Holdable)) { isWire = true; }
             if (HasTag(Barotrauma.Tags.LogicItem)) { isLogic = true; }
 
-            GameMain.LuaCs.Hook.Call("item.created", this);
+            GameMain.LuaCs.Hook.Call<Item>("item.created", this);
 
             ApplyStatusEffects(ActionType.OnSpawn, 1.0f);
 
@@ -4491,7 +4491,7 @@ public override void ShallowRemove()
                 body = null;
             }
 
-            GameMain.LuaCs.Hook.Call("item.removed", this);
+            GameMain.LuaCs.Hook.Call<Item>("item.removed", this);
         }
 
         public override void Remove()
@@ -4577,7 +4577,7 @@ public override void Remove()
 
             RemoveProjSpecific();
 
-            GameMain.LuaCs.Hook.Call("item.removed", this);
+            GameMain.LuaCs.Hook.Call<Item>("item.removed", this);
         }
 
         private void RemoveFromLists()

Barotrauma/BarotraumaShared/SharedSource/LuaCs/Configuration/IConfigEntry.cs

@@ -9,4 +9,6 @@ public interface IConfigEntry<T> : IConfigBase, INetVar where T : IConvertible,
     bool TrySetValue(T value);
     bool IsAssignable(T value);
     void Initialize(IVarId id, T defaultValue);
+    
+    
 }

Barotrauma/BarotraumaShared/SharedSource/LuaCs/Data/DataInterfaceDefinitions.cs

@@ -31,6 +31,7 @@ public partial record ModConfigInfo : IModConfigInfo
 public record AssemblyResourceInfo : IAssemblyResourceInfo
 {
     public ContentPackage OwnerPackage { get; init; }
+    public string FallbackPackageName { get; init; }
     public string FriendlyName { get; init; }
     public bool IsScript { get; init; }
     public string InternalName { get; init; }
@@ -49,7 +50,7 @@ public record DependencyInfo : IPackageDependencyInfo
     public string InternalName { get; init; }
     public ContentPackage OwnerPackage { get; init; }
     public string FolderPath { get; init; }
-    public string PackageName { get; init; }
+    public string FallbackPackageName { get; init; }
     public ulong SteamWorkshopId { get; init; }
     public ContentPackage DependencyPackage { get; init; }
     public bool IsMissing { get; init; }
@@ -63,15 +64,19 @@ public override int GetHashCode()
             return DependencyPackage.GetHashCode();
         if (SteamWorkshopId != 0)
             return SteamWorkshopId.GetHashCode();
-        if (!PackageName.IsNullOrWhiteSpace() && !FolderPath.IsNullOrWhiteSpace())
-            return string.Concat(PackageName, FolderPath).GetHashCode();
+        if (!FallbackPackageName.IsNullOrWhiteSpace() && !FolderPath.IsNullOrWhiteSpace())
+            return string.Concat(FallbackPackageName, FolderPath).GetHashCode();
         if (!InternalName.IsNullOrWhiteSpace() && !FolderPath.IsNullOrWhiteSpace())
             return string.Concat(InternalName, FolderPath).GetHashCode();
 
         return base.GetHashCode();
     }
 
-    public bool Equals(IPackageDependencyInfo x, IPackageDependencyInfo y)
+    bool IEqualityComparer<IPackageDependencyInfo>.Equals(IPackageDependencyInfo x, IPackageDependencyInfo y) => DependencyInfo.Equals(x, y);
+    
+    public static bool operator ==(IPackageDependencyInfo x, DependencyInfo y) => y?.Equals(x) ?? false;
+    public static bool operator !=(IPackageDependencyInfo x, DependencyInfo y) => y?.Equals(x) ?? false;
+    public static bool Equals(IPackageDependencyInfo x, IPackageDependencyInfo y)
     {
         if (x is null)
             return false;
@@ -91,21 +96,27 @@ public bool Equals(IPackageDependencyInfo x, IPackageDependencyInfo y)
         if (!x.FolderPath.IsNullOrWhiteSpace() != !y.FolderPath.IsNullOrWhiteSpace()) 
             return false;
 
-        if (!x.PackageName.IsNullOrWhiteSpace() 
-            && !y.PackageName.IsNullOrWhiteSpace() 
-            && y.PackageName == x.PackageName)
+        if (!x.FallbackPackageName.IsNullOrWhiteSpace() 
+            && !y.FallbackPackageName.IsNullOrWhiteSpace() 
+            && y.FallbackPackageName == x.FallbackPackageName)
             return true;
 
         if (x.SteamWorkshopId != 0 && y.SteamWorkshopId == x.SteamWorkshopId)
             return true;
 
         return false;
     }
-
+    
+    /// <summary>
+    /// Returns the hash code unique for the package reference.
+    /// </summary>
+    /// <param name="obj"></param>
+    /// <returns></returns>
+    /// <remarks>The hash should only be collision-free when referring to different packages.</remarks>
     public int GetHashCode(IPackageDependencyInfo obj)
     {
         int hashCode = Seed;
-        hashCode = ApplyHashString(hashCode, obj.PackageName);
+        hashCode = ApplyHashString(hashCode, obj.FallbackPackageName);
         hashCode = ApplyHashString(hashCode, obj.InternalName);
         if (obj.SteamWorkshopId > 0)
             hashCode ^= (int)obj.SteamWorkshopId;
@@ -118,8 +129,8 @@ int ApplyHashString(int currentValue, string str)
                 if (str is null || str.Length < 1)
                     return currentValue;
                 byte[] b = Encoding.UTF8.GetBytes(str);
-                foreach (var b1 in b)
-                    currentValue ^= b1;
+                for (int i = 0; i < Math.Min(24, b.Length-1); i++)
+                    currentValue ^= b[i];   
                 return currentValue;
             }
             catch
@@ -138,6 +149,7 @@ public record LocalizationResourceInfo : ILocalizationResourceInfo
 {
     public string InternalName { get; init; }
     public ContentPackage OwnerPackage { get; init; }
+    public string FallbackPackageName { get; init; }
     public CultureInfo TargetCulture { get; init; }
     public Platform SupportedPlatforms { get; init; }
     public Target SupportedTargets { get; init; }
@@ -151,6 +163,7 @@ public record LocalizationResourceInfo : ILocalizationResourceInfo
 public readonly struct LuaScriptResourceInfo : ILuaResourceInfo
 {
     public ContentPackage OwnerPackage { get; init; }
+    public string FallbackPackageName { get; init; }
     public Platform SupportedPlatforms { get; init; }
     public Target SupportedTargets { get; init; }
     public int LoadPriority { get; init; }

Barotrauma/BarotraumaShared/SharedSource/LuaCs/Data/IConfigInfo.cs

@@ -1,29 +1,23 @@
 using System;
+using Barotrauma.LuaCs.Networking;
 using Barotrauma.Networking;
 
 namespace Barotrauma.LuaCs.Data;
 
 // TODO: Finish
 public partial interface IConfigInfo : IDataInfo
 {
-    ConfigDataType Type { get; }
+    /// <summary>
+    /// Specifies the data type this should be initialized to (ie. string, int, vector, etc.)
+    /// Custom types can be registered by mods.
+    /// </summary>
+    string DataType { get; }
     string DefaultValue { get; }
+    string StoredValue { get; }
     ClientPermissions RequiredPermissions { get; }
-}
-
-public enum ConfigDataType
-{
-    Boolean,
-    Int32,
-    Int64,
-    Single,
-    Double,
-    String,
-    Color,
-    Vector2,
-    Vector3,
-    List,
-    RangeInt32,
-    RangeSingle,
-    ControlInput
+    /// <summary>
+    /// Whether a value can be changed at runtime.
+    /// </summary>
+    bool IsReadOnly { get; }
+    NetSync NetSync { get; }
 }