AdamuSw/src/DataModel/Entities/Account.cs

// <copyright file="Account.cs" company="MUnique">
// Licensed under the MIT License. See LICENSE file in the project root for full license information.
// </copyright>

namespace MUnique.OpenMU.DataModel.Entities;

using System.ComponentModel;
using MUnique.OpenMU.AttributeSystem;
using MUnique.OpenMU.DataModel.Configuration;

/// <summary>
/// The state of an account.
/// </summary>
public enum AccountState
{
    /// <summary>
    /// Normal player account.
    /// </summary>
    Normal,

    /// <summary>
    /// Spectator account, invisible to players and monsters.
    /// </summary>
    Spectator,

    /// <summary>
    /// Game Master account.
    /// </summary>
    GameMaster,

    /// <summary>
    /// Game Master account, invisible to players and monsters.
    /// </summary>
    GameMasterInvisible,

    /// <summary>
    /// Banned account.
    /// </summary>
    Banned,

    /// <summary>
    /// Temporarily banned account.
    /// </summary>
    TemporarilyBanned,
}

/// <summary>
/// The account of a player.
/// </summary>
[AggregateRoot]
public class Account
{
    /// <summary>
    /// Gets or sets the unique login name.
    /// </summary>
    [Required]
    public string LoginName { get; set; } = string.Empty;

    /// <summary>
    /// Gets or sets the hash of the password, preferrably of BCrypt.
    /// </summary>
    public string PasswordHash { get; set; } = string.Empty;

    /// <summary>
    /// Gets or sets the security code which is used to confirm character deletion and guild kicks.
    /// </summary>
    public string SecurityCode { get; set; } = string.Empty;

    /// <summary>
    /// Gets or sets the e mail address.
    /// </summary>
    public string EMail { get; set; } = string.Empty;

    /// <summary>
    /// Gets or sets the iso code (ISO 639-2/3) of the preferred language of the player.
    /// </summary>
    [DefaultValue("en")]
    public string LanguageIsoCode { get; set; } = "en";

    /// <summary>
    /// Gets or sets the date and time until which the chat ban is in effect.
    /// </summary>
    public DateTime? ChatBanUntil { get; set; }

    /// <summary>
    /// Gets or sets the unlocked character classes which are locked by default.
    /// </summary>
    /// <remarks>
    /// Some classes are only available when the player reached a certain level before, or when he paid for some unlock ticket.
    /// </remarks>
    [HiddenAtCreation]
    public virtual ICollection<CharacterClass> UnlockedCharacterClasses { get; protected set; } = null!;

    /// <summary>
    /// Gets or sets the registration date.
    /// </summary>
    public DateTime RegistrationDate { get; set; } = DateTime.UtcNow;

    /// <summary>
    /// Gets or sets the state.
    /// </summary>
    public AccountState State { get; set; }

    /// <summary>
    /// Gets or sets the timezone of the player, difference to UTC.
    /// </summary>
    public short TimeZone { get; set; }

    /// <summary>
    /// Gets or sets the vault password.
    /// </summary>
    [HiddenAtCreation]
    public string VaultPassword { get; set; } = string.Empty;

    /// <summary>
    /// Gets or sets the vault.
    /// </summary>
    [MemberOfAggregate]
    [HiddenAtCreation]
    public virtual ItemStorage? Vault { get; set; }

    /// <summary>
    /// Gets or sets a value indicating whether this instance is vault extended.
    /// </summary>
    public bool IsVaultExtended { get; set; }

    /// <summary>
    /// Gets or sets a value indicating whether this instance is a template account
    /// and therefore read-only within the game server.
    /// </summary>
    public bool IsTemplate { get; set; }

    /// <summary>
    /// Gets or sets a value indicating whether this account is a server-side bot account.
    /// Bot accounts are generated and maintained by the bot feature; this flag is the reliable
    /// marker used to load them on startup (instead of regenerating) and to purge them.
    /// </summary>
    public bool IsBot { get; set; }

    /// <summary>
    /// Gets or sets the characters.
    /// </summary>
    [MemberOfAggregate]
    [HiddenAtCreation]
    public virtual ICollection<Character> Characters { get; protected set; } = null!;

    /// <summary>
    /// Gets or sets the stat attributes which are applied across all characters of the account.
    /// </summary>
    /// <remarks>
    /// Please note, that it's not possible to add stat attribute with the same
    /// attribute definition to the <see cref="Account.Attributes"/> and the <see cref="Character.Attributes"/>.
    /// </remarks>
    [MemberOfAggregate]
    public virtual ICollection<StatAttribute> Attributes { get; protected set; } = null!;

    /// <inheritdoc />
    public override string ToString()
    {
        return this.LoginName;
    }
}