MiraAPI/MiraAPI/GameOptions/Attributes/ModdedOptionAttribute.cs

using System;
using System.Reflection;

namespace MiraAPI.GameOptions.Attributes;

/// <summary>
/// Represents an attribute that is used to define an <see cref="IModdedOption"/>.
/// </summary>
/// <param name="title">The option title.</param>
/// <param name="roleType">Optional parameter to specify a role Type.</param>
/// <param name="modeType">Optional parameter to specify a game mode Type.</param>
[AttributeUsage(AttributeTargets.Property)]
public abstract class ModdedOptionAttribute(string title, Type? roleType = null, Type? modeType = null) : Attribute
{
    internal IModdedOption? HolderOption { get; set; }

    /// <summary>
    /// Gets the title of the option.
    /// </summary>
    public string Title { get; private set; } = title;

    /// <summary>
    /// Gets the role type of the option.
    /// </summary>
    protected Type? RoleType { get; private set; } = roleType;

    /// <summary>
    /// Gets the game mode type of the option.
    /// </summary>
    protected Type? ModeType { get; private set; } = modeType;

    /// <summary>
    /// Sets the value of the option.
    /// </summary>
    /// <param name="value">The new value as an <see langword="object"/>.</param>
    public abstract void SetValue(object value);

    /// <summary>
    /// Gets the value of the option.
    /// </summary>
    /// <returns>The value of the option as an <see langword="object"/>.</returns>
    public abstract object GetValue();

    internal abstract IModdedOption? CreateOption(object? value, PropertyInfo property);
}