civ14/Content.Client/Administration/Managers/IClientAdminManager.cs

using Content.Shared.Administration;

namespace Content.Client.Administration.Managers
{
    /// <summary>
    ///     Manages server admin permissions for the local player.
    /// </summary>
    public interface IClientAdminManager
    {
        /// <summary>
        ///     Fired when the admin status of the local player changes, such as losing admin privileges.
        /// </summary>
        event Action AdminStatusUpdated;

        /// <summary>
        ///     Gets the admin data for the client, if they are an admin.
        /// </summary>
        /// <param name="includeDeAdmin">
        ///     Whether to return admin data for admins that are current de-adminned.
        /// </param>
        /// <returns><see langword="null" /> if the player is not an admin.</returns>
        AdminData? GetAdminData(bool includeDeAdmin = false);

        /// <summary>
        ///     Checks whether the local player is an admin.
        /// </summary>
        /// <returns>true if the local player is an admin, false otherwise even if they are deadminned.</returns>
        bool IsActive();

        /// <summary>
        ///     Checks whether the local player has an admin flag.
        /// </summary>
        /// <param name="flag">The flags to check. Multiple flags can be specified, they must all be held.</param>
        /// <returns>False if the local player is not an admin, inactive, or does not have all the flags specified.</returns>
        bool HasFlag(AdminFlags flag);

        /// <summary>
        ///     Check if a player can execute a specified console command.
        /// </summary>
        bool CanCommand(string cmdName);

        /// <summary>
        ///     Check if the local player can open the VV menu.
        /// </summary>
        bool CanViewVar();

        /// <summary>
        ///     Check if the local player can spawn stuff in with the entity/tile spawn panel.
        /// </summary>
        bool CanAdminPlace();

        /// <summary>
        ///     Check if the local player can execute server-side C# scripts.
        /// </summary>
        bool CanScript();

        /// <summary>
        ///     Check if the local player can open the admin menu.
        /// </summary>
        bool CanAdminMenu();

        void Initialize();

        /// <summary>
        ///     Checks if the client is an admin.
        /// </summary>
        /// <param name="includeDeAdmin">
        ///     Whether to return admin data for admins that are current de-adminned.
        /// </param>
        /// <returns>true if the player is an admin, false otherwise.</returns>
        bool IsAdmin(bool includeDeAdmin = false)
        {
            return GetAdminData(includeDeAdmin) != null;
        }
    }
}