[In-Progress Work Sync] Work on Configuration APIs.

Author: TBN-MapleWheels

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

@@ -0,0 +1,142 @@
+using System;
+using System.Collections.Generic;
+using Barotrauma.LuaCs.Data;
+
+namespace Barotrauma.LuaCs.Configuration;
+
+
+/// <summary>
+/// Base type of all menu displayable types.
+/// </summary>
+public interface IDisplayableConfigBase : IDataInfo, IConfigDisplayInfo
+{
+    /// <summary>
+    /// Whether the current config is editable.
+    /// </summary>
+    bool IsEditable { get; }
+    /// <summary>
+    /// Used to indicate the implemented interface and targeted display logic.
+    /// </summary>
+    static virtual DisplayType DisplayOption => DisplayType.Undefined;
+}
+
+public interface IDisplayableConfigBase<out TDisplay, in TValue> : IDisplayableConfigBase
+{
+    void SetValue(TValue value);
+    TDisplay GetDisplayValue();
+}
+
+public interface IDisplayableConfigBool : IDisplayableConfigBase<bool, bool>
+{
+    static DisplayType IDisplayableConfigBase.DisplayOption => DisplayType.Boolean;
+}
+
+public interface IDisplayableConfigText : IDisplayableConfigBase<string, string>
+{
+    static DisplayType IDisplayableConfigBase.DisplayOption => DisplayType.Text;
+}
+
+public interface IDisplayableConfigInt : IDisplayableConfigBase<int, int>
+{
+    static DisplayType IDisplayableConfigBase.DisplayOption => DisplayType.Integer;
+}
+
+public interface IDisplayableConfigFloat : IDisplayableConfigBase<float, float>
+{
+    static DisplayType IDisplayableConfigBase.DisplayOption => DisplayType.Float;
+}
+
+public interface IDisplayableConfigSliderInt : IDisplayableConfigBase<(int Min, int Max, int Value, int Steps), int>
+{
+    static DisplayType IDisplayableConfigBase.DisplayOption => DisplayType.SliderInt;
+}
+
+public interface IDisplayableConfigSliderFloat : IDisplayableConfigBase<(float Min, float Max, float Value, int Steps), float>
+{
+    static DisplayType IDisplayableConfigBase.DisplayOption => DisplayType.SliderFloat;
+}
+
+public interface IDisplayableConfigDropdown : IDisplayableConfigBase<List<string>, string>
+{
+    static DisplayType IDisplayableConfigBase.DisplayOption => DisplayType.Dropdown;
+}
+
+/// <summary>
+/// Allows completely custom-designed UI for this configuration component.
+/// </summary>
+public interface IDisplayableConfigCustom : IDisplayableConfigBase
+{
+    static DisplayType IDisplayableConfigBase.DisplayOption => DisplayType.Custom;
+    /// <summary>
+    /// Draw your menu settings option.
+    /// </summary>
+    /// <param name="layoutGroup">Parent layout component.</param>
+    void DrawComponent(GUILayoutGroup layoutGroup);
+    /// <summary>
+    /// Called when the config element is set to be disposed to allow for cleanup.
+    /// </summary>
+    void DisposeGUI();
+    /// <summary>
+    /// Called when the UI indicates to save the current value as permanent.
+    /// </summary>
+    void OnValueSaved();
+    /// <summary>
+    /// Called when the UI indicates to discard the currently displayed value and revert to the last saved value.
+    /// </summary>
+    void OnValueDiscarded();
+}
+
+
+
+/// <summary>
+/// Indicates the intended display and feedback logic to be used by the <see cref="SettingsMenu"/>.
+/// <br/><b>[Important]</b>
+/// <br/>The type must implement the indicated interface for the selected option, or it will not be displayed.
+/// </summary>
+public enum DisplayType
+{
+    /// <summary>
+    /// Will not be displayed in menus.
+    /// </summary>
+    Undefined,
+    /// <summary>
+    /// Will be shown as a checkbox.
+    /// <br/><b>[Requires(<see cref="IDisplayableConfigBool"/>)]</b>
+    /// </summary>
+    Boolean,
+    /// <summary>
+    /// Shown as an editable text input.
+    /// <br/><b>[Requires(<see cref="IDisplayableConfigText"/>)]</b>
+    /// </summary>
+    Text,
+    /// <summary>
+    /// Shown as number input (no decimal input).
+    /// <br/><b>[Requires(<see cref="IDisplayableConfigInt"/>)]</b>
+    /// </summary>
+    Integer,
+    /// <summary>
+    /// Shown as a number input.
+    /// <br/><b>[Requires(<see cref="IDisplayableConfigFloat"/>)]</b>
+    /// </summary>
+    Float,
+    /// <summary>
+    /// Shown as a slider, values parsed as integers.
+    /// <br/><b>[Requires(<see cref="IDisplayableConfigSliderInt"/>)]</b>
+    /// </summary>
+    SliderInt,
+    /// <summary>
+    /// Shown as a slider, values parsed as single-precision decimal numbers.
+    /// <br/><b>[Requires(<see cref="IDisplayableConfigSliderFloat"/>)]</b>
+    /// </summary>
+    SliderFloat,
+    /// <summary>
+    /// Shown as a <see cref="GUIDropDown"/> menu, values parsed as strings.
+    /// <br/><b>[Requires(<see cref="IDisplayableConfigDropdown"/>)]</b>
+    /// </summary>
+    Dropdown,
+    /// <summary>
+    /// UI Display is implemented by inheritor and actioned by a call to <see cref="IDisplayableConfigCustom.DrawComponent"/>.
+    /// <br/><b>[Requires(<see cref="IDisplayableConfigCustom"/>)]</b>
+    /// </summary>
+    Custom
+}

Barotrauma/BarotraumaClient/ClientSource/LuaCs/Data/IConfigInfo.cs

@@ -2,8 +2,22 @@
 
 namespace Barotrauma.LuaCs.Data;
 
-public partial interface IConfigInfo
+public partial interface IConfigInfo : IConfigDisplayInfo { }
+
+public interface IConfigDisplayInfo
 {
+    /// <summary>
+    /// User-friendly name or Localization Token.
+    /// </summary>
+    string DisplayName { get; }
+    /// <summary>
+    /// User-friendly description or Localization Token.
+    /// </summary>
+    string Description { get; }
+    /// <summary>
+    /// The menu category to display under. Used for filtering.
+    /// </summary>
+    string DisplayCategory { get; }
     /// <summary>
     /// Should this config be displayed in end-user menus.
     /// </summary>

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

@@ -0,0 +1,27 @@
+using System;
+using System.Collections.Immutable;
+using Barotrauma.LuaCs.Configuration;
+using Barotrauma.Networking;
+using FluentResults;
+
+namespace Barotrauma.LuaCs.Services;
+
+public partial class ConfigService
+{
+    public ImmutableArray<IDisplayableConfigBase> GetDisplayableConfigs()
+    {
+        throw new NotImplementedException();
+    }
+
+    public ImmutableArray<IDisplayableConfigBase> GetDisplayableConfigsForPackage(ContentPackage package)
+    {
+        throw new NotImplementedException();
+    }
+
+    public Result<IConfigControl> AddConfigControl(ContentPackage package, string name, KeyOrMouse defaultValue, NetSync syncMode = NetSync.None,
+        ClientPermissions permissions = ClientPermissions.None, Func<KeyOrMouse, bool> valueChangePredicate = null,
+        Action<IConfigControl> onValueChanged = null)
+    {
+        throw new NotImplementedException();
+    }
+}

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

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Collections.Immutable;
 using Barotrauma.LuaCs.Configuration;
 using Barotrauma.LuaCs.Services;
 using Barotrauma.Networking;
@@ -8,5 +9,12 @@ namespace Barotrauma.LuaCs.Services;
 
 public partial interface IConfigService
 {
+    ImmutableArray<IDisplayableConfigBase> GetDisplayableConfigs();
+    ImmutableArray<IDisplayableConfigBase> GetDisplayableConfigsForPackage(ContentPackage package);
 
+    FluentResults.Result<IConfigControl> AddConfigControl(ContentPackage package, string name, KeyOrMouse defaultValue,
+        NetSync syncMode = NetSync.None,
+        ClientPermissions permissions = ClientPermissions.None,
+        Func<KeyOrMouse, bool> valueChangePredicate = null,
+        Action<IConfigControl> onValueChanged = null);
 }

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

@@ -44,6 +44,11 @@ public void NetMessageReceived(IReadMessage netMessage, ServerPacketHeader heade
         }
     }
 
+    public void SendNetVar(INetworkSyncEntity netVar)
+    {
+        throw new NotImplementedException();
+    }
+
     public void NetMessageReceived(IReadMessage message, ServerPacketHeader header)
     {
         throw new NotImplementedException();
@@ -89,6 +94,11 @@ public void Send(IWriteMessage netMessage, DeliveryMethod deliveryMethod = Deliv
         GameMain.Client.ClientPeer.Send(netMessage, deliveryMethod);
     }
 
+    public void RegisterNetVar(INetworkSyncEntity netVar)
+    {
+        throw new NotImplementedException();
+    }
+
     private void HandleNetMessageId(IReadMessage netMessage, Client client = null)
     {
         ushort id = netMessage.ReadUInt16();

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

@@ -1,20 +1,14 @@
 using System;
 using Barotrauma.LuaCs.Data;
+using Barotrauma.LuaCs.Services;
 using Barotrauma.Networking;
 
 namespace Barotrauma.LuaCs.Configuration;
 
-public partial interface IConfigBase : IVarId
+public partial interface IConfigBase : IEquatable<IConfigBase>
 {
-    bool IsInitialized { get; }
+    Type GetValueType();
     string GetValue();
     bool TrySetValue(string value);
     bool IsAssignable(string value);
-    Type GetValueType();
-    void Initialize(IVarId id, string defaultValue);
-}
-
-public interface IVarId : IDataInfo
-{
-    Guid InstanceId { get; }
 }

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

@@ -3,10 +3,9 @@
 
 namespace Barotrauma.LuaCs.Configuration;
 
-public interface IConfigEntry<T> : IConfigBase, INetVar where T : IConvertible, IEquatable<T>
+public interface IConfigEntry<T> : IConfigBase, INetworkSyncEntity where T : IConvertible, IEquatable<T>
 {
     T Value { get; }
     bool TrySetValue(T value);
     bool IsAssignable(T value);
-    void Initialize(IVarId id, T defaultValue);
 }

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

@@ -2,7 +2,7 @@
 
 namespace Barotrauma.LuaCs.Configuration;
 
-public interface IConfigList : IConfigBase, INetVar
+public interface IConfigList : IConfigBase, INetworkSyncEntity
 {
 
 }

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

@@ -1,51 +1,43 @@
 using System;
+using System.Xml.Linq;
 using Barotrauma.LuaCs.Services;
 using Barotrauma.Networking;
 
 namespace Barotrauma.LuaCs.Data;
 
-// TODO: Finish
+/// <summary>
+/// Parsed data from a configuration xml.
+/// </summary>
 public partial interface IConfigInfo : IDataInfo
 {
     /// <summary>
-    /// Specifies the data type this should be initialized to (ie. string, int, vector, etc.)
-    /// Custom types can be registered by mods.
+    /// Specifies the type initializer that will be used to instantiate the config var.
     /// </summary>
     Type DataType { get; }
     /// <summary>
-    /// String version of the default value. 
+    /// String version of the default value.
     /// </summary>
     string DefaultValue { get; }
     /// <summary>
-    /// The value the last time this config was saved, if found in /data/. 
+    /// The value the last time this config was saved.
+    /// <br/><b>[If(Type='<see cref="string"/>')]</b><br/>
+    /// The value is from the 'Value' Attribute. Typically used for types with single/simple values, such as primitives.
+    /// <br/><b>[If(Type='<see cref="XElement"/>')]</b><br/>
+    /// The value is from the first 'Value' child element. Typically used with complex config types, such as range and list.
     /// </summary>
-    string StoredValue { get; }
+    OneOf.OneOf<string, XElement> Value { get; }
     /// <summary>
-    /// Custom data storage for other type-specific information needed. IE. Used to store the min,
-    /// max and step values for the <b>IConfigRangeEntry(T)</b>.
+    /// In what <see cref="RunState"/>(s) is this config editable. Will be editable in the selected state, and lower value states.
+    /// <br/><br/>
+    /// <b>[Important]</b><br/> Setting this to value lower than 'Configuration` will render this config read-only.
+    /// <br/><br/><b>Expected Behaviour</b>:
+    /// <br/><b>[<see cref="RunState.Unloaded"/>|<see cref="RunState.Parsed"/>]</b>: Read-Only.
+    /// <br/><b>[<see cref="RunState.Configuration"/>]</b>: Can only be changed at the Main Menu (not in a lobby).
+    /// <br/><b>[<see cref="RunState.Running"/>]</b>: Can be changed at the Main Menu and while a lobby is active. 
     /// </summary>
-    string CustomParameters { get; }
-    /// <summary>
-    /// <b>[Multiplayer]</b><br/>
-    /// What permissions do clients require to change this setting.
-    /// </summary>
-    ClientPermissions RequiredPermissions { get; }
-    /// <summary>
-    /// In what <see cref="RunState"/>s is this config editable.
-    /// <br/>
-    /// Note: Setting this to value lower than 'Configuration` will render this config read-only.
-    /// </summary>
-    RunState CanEditStates { get; }
+    RunState EditableStates { get; }
     /// <summary>
     /// Network synchronization rules for this config.
     /// </summary>
     NetSync NetSync { get; }
-    /// <summary>
-    /// User friendly name or Localization Token.
-    /// </summary>
-    string DisplayName { get; }
-    /// <summary>
-    /// User friendly description or Localization Token.
-    /// </summary>
-    string Description { get; }
 }

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

@@ -0,0 +1,29 @@
+using System;
+using System.IO;
+
+namespace Barotrauma.LuaCs.Data;
+
+public interface IStorageConfigData
+{
+    string LocalDataPathRegex { get; }
+    string LocalPackagePath { get; }
+}
+
+public class StorageConfigData : IStorageConfigData
+{
+    public string LocalDataPathRegex => "<PACKAGENAME>";
+
+    public string LocalPackagePath
+    {
+        get
+        {
+            var val = GameMain.LuaCs?.LocalDataSavePath?.Value ?? "/Data/Mods/";
+            return ContainsIllegalPaths(val) ? $"/Data/Mods/{LocalDataPathRegex}" : Path.Combine(val, LocalDataPathRegex);
+        }
+    }
+
+    private bool ContainsIllegalPaths(string path)
+    {
+        throw new NotImplementedException();
+    }
+}