SSSS wrappers

SecretAPI/Features/UserSettings/CustomButtonSetting.cs

@@ -0,0 +1,61 @@
+namespace SecretAPI.Features.UserSettings
+{
+    using System;
+    using global::UserSettings.ServerSpecific;
+    using SecretAPI.Interfaces;
+
+    /// <summary>
+    /// Wraps <see cref="SSButton"/>.
+    /// </summary>
+    public abstract class CustomButtonSetting : CustomSetting, ISetting<SSButton>
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CustomButtonSetting"/> class.
+        /// </summary>
+        /// <param name="button">The button base.</param>
+        protected CustomButtonSetting(SSButton button)
+            : base(button)
+        {
+            Base = button;
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CustomButtonSetting"/> class.
+        /// </summary>
+        /// <param name="id">The ID of the button.</param>
+        /// <param name="label">The setting's label.</param>
+        /// <param name="buttonText">The button text.</param>
+        /// <param name="holdTimeSeconds">The time to hold.</param>
+        /// <param name="hint">The hint to show.</param>
+        protected CustomButtonSetting(int? id, string label, string buttonText, float? holdTimeSeconds = null, string? hint = null)
+            : this(new SSButton(id, label, buttonText, holdTimeSeconds, hint))
+        {
+        }
+
+        /// <inheritdoc/>
+        public new SSButton Base { get; }
+
+        /// <summary>
+        /// Gets the <see cref="TimeSpan"/> of the last press.
+        /// </summary>
+        public TimeSpan LastPress => Base.SyncLastPress.Elapsed;
+
+        /// <summary>
+        /// Gets or sets the text of the button.
+        /// </summary>
+        public string Text
+        {
+            get => Base.ButtonText;
+            set => Base.ButtonText = value;
+        }
+
+        /// <summary>
+        /// Gets or sets the amount of time to hold the button in seconds.
+        /// </summary>
+        public float HoldTime
+        {
+            get => Base.HoldTimeSeconds;
+            set => Base.HoldTimeSeconds = value;
+        }
+    }
+}

SecretAPI/Features/UserSettings/CustomDropdownSetting.cs

@@ -0,0 +1,58 @@
+namespace SecretAPI.Features.UserSettings
+{
+    using global::UserSettings.ServerSpecific;
+    using SecretAPI.Interfaces;
+
+    /// <summary>
+    /// Custom <see cref="SSDropdownSetting"/> wrapper.
+    /// </summary>
+    public abstract class CustomDropdownSetting : CustomSetting, ISetting<SSDropdownSetting>
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CustomDropdownSetting"/> class.
+        /// </summary>
+        /// <param name="setting">The base setting to create the wrapper with.</param>
+        protected CustomDropdownSetting(SSDropdownSetting setting)
+            : base(setting)
+        {
+            Base = setting;
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CustomDropdownSetting"/> class.
+        /// </summary>
+        /// <param name="id">The ID of the setting.</param>
+        /// <param name="label">The setting's label.</param>
+        /// <param name="options">The array of string options to give.</param>
+        /// <param name="defaultOptionIndex">The default option (int index).</param>
+        /// <param name="entryType">The entry type.</param>
+        /// <param name="hint">The hint to show.</param>
+        protected CustomDropdownSetting(
+            int? id,
+            string label,
+            string[] options,
+            int defaultOptionIndex = 0,
+            SSDropdownSetting.DropdownEntryType entryType = SSDropdownSetting.DropdownEntryType.Regular,
+            string? hint = null)
+            : this(new SSDropdownSetting(id, label, options, defaultOptionIndex, entryType, hint))
+        {
+        }
+
+        /// <inheritdoc/>
+        public new SSDropdownSetting Base { get; }
+
+        /// <summary>
+        /// Gets or sets the options.
+        /// </summary>
+        public string[] Options
+        {
+            get => Base.Options;
+            set => Base.Options = value;
+        }
+
+        /// <summary>
+        /// Gets the selected option as string.
+        /// </summary>
+        public string SelectedOption => Base.SyncSelectionText;
+    }
+}

SecretAPI/Features/UserSettings/CustomHeader.cs

@@ -0,0 +1,35 @@
+namespace SecretAPI.Features.UserSettings
+{
+    using global::UserSettings.ServerSpecific;
+    using SecretAPI.Interfaces;
+
+    /// <summary>
+    /// Wraps <see cref="SSGroupHeader"/>.
+    /// </summary>
+    public class CustomHeader : ISetting<SSGroupHeader>
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CustomHeader"/> class.
+        /// </summary>
+        /// <param name="label">The label to show.</param>
+        /// <param name="reducedPadding">Reduced padding.</param>
+        /// <param name="hint">Hint displayed.</param>
+        public CustomHeader(string label, bool reducedPadding = false, string? hint = null)
+        {
+            Base = new SSGroupHeader(label, reducedPadding, hint);
+        }
+
+        /// <summary>
+        /// Gets a <see cref="CustomHeader"/> for Gameplay purposes.
+        /// </summary>
+        public static CustomHeader Gameplay { get; } = new("Gameplay");
+
+        /// <summary>
+        /// Gets a <see cref="CustomHeader"/> for Example purposes.
+        /// </summary>
+        public static CustomHeader Examples { get; } = new("Examples");
+
+        /// <inheritdoc />
+        public SSGroupHeader Base { get; }
+    }
+}

SecretAPI/Features/UserSettings/CustomKeybindSetting.cs

@@ -0,0 +1,43 @@
+namespace SecretAPI.Features.UserSettings
+{
+    using global::UserSettings.ServerSpecific;
+    using SecretAPI.Interfaces;
+    using UnityEngine;
+
+    /// <summary>
+    /// Wrapper for <see cref="SSKeybindSetting"/>.
+    /// </summary>
+    public abstract class CustomKeybindSetting : CustomSetting, ISetting<SSKeybindSetting>
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CustomKeybindSetting"/> class.
+        /// </summary>
+        /// <param name="setting">The setting to wrap.</param>
+        protected CustomKeybindSetting(SSKeybindSetting setting)
+            : base(setting)
+        {
+            Base = setting;
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CustomKeybindSetting"/> class.
+        /// </summary>
+        /// <param name="id">The ID of the setting.</param>
+        /// <param name="label">The setting's label.</param>
+        /// <param name="suggestedKey">The suggested key.</param>
+        /// <param name="preventInteractionOnGui">Whether to prevent interaction in a GUI.</param>
+        /// <param name="hint">The hint to show.</param>
+        protected CustomKeybindSetting(
+            int? id,
+            string label,
+            KeyCode suggestedKey = KeyCode.None,
+            bool preventInteractionOnGui = true,
+            string? hint = null)
+            : this(new SSKeybindSetting(id, label, suggestedKey, preventInteractionOnGui, hint))
+        {
+        }
+
+        /// <inheritdoc/>
+        public new SSKeybindSetting Base { get; }
+    }
+}

SecretAPI/Features/UserSettings/CustomPlainTextSetting.cs

@@ -0,0 +1,81 @@
+namespace SecretAPI.Features.UserSettings
+{
+    using global::UserSettings.ServerSpecific;
+    using SecretAPI.Interfaces;
+    using TMPro;
+
+    /// <summary>
+    /// Wrapper for <see cref="SSPlaintextSetting" />.
+    /// </summary>
+    public abstract class CustomPlainTextSetting : CustomSetting, ISetting<SSPlaintextSetting>
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CustomPlainTextSetting"/> class.
+        /// </summary>
+        /// <param name="setting">The setting to create wrapper from.</param>
+        protected CustomPlainTextSetting(SSPlaintextSetting setting)
+            : base(setting)
+        {
+            Base = setting;
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CustomPlainTextSetting"/> class.
+        /// </summary>
+        /// <param name="id">The ID of the setting.</param>
+        /// <param name="label">The setting's label.</param>
+        /// <param name="placeholder">The placeholder to use for the setting.</param>
+        /// <param name="characterLimit">The max allowed characters.</param>
+        /// <param name="contentType">The content type.</param>
+        /// <param name="hint">The hint to display for the setting.</param>
+        protected CustomPlainTextSetting(
+            int? id,
+            string label,
+            string placeholder = "...",
+            int characterLimit = 64,
+            TMP_InputField.ContentType contentType = TMP_InputField.ContentType.Standard,
+            string? hint = null)
+            : this(new SSPlaintextSetting(id, label, placeholder, characterLimit, contentType, hint))
+        {
+        }
+
+        /// <inheritdoc />
+        public new SSPlaintextSetting Base { get; }
+
+        /// <summary>
+        /// Gets or sets the synced input text.
+        /// </summary>
+        public string InputText
+        {
+            get => Base.SyncInputText;
+            set => Base.SyncInputText = value;
+        }
+
+        /// <summary>
+        /// Gets or sets the content type.
+        /// </summary>
+        public TMP_InputField.ContentType ContentType
+        {
+            get => Base.ContentType;
+            set => Base.ContentType = value;
+        }
+
+        /// <summary>
+        /// Gets or sets the placeholder.
+        /// </summary>
+        public string Placeholder
+        {
+            get => Base.Placeholder;
+            set => Base.Placeholder = value;
+        }
+
+        /// <summary>
+        /// Gets or sets the character limit.
+        /// </summary>
+        public int CharacterLimit
+        {
+            get => Base.CharacterLimit;
+            set => Base.CharacterLimit = value;
+        }
+    }
+}