MultiplayerRoomUser.cs

// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.

using System;
using System.Collections.Generic;
using System.Linq;
using MessagePack;
using Newtonsoft.Json;
using osu.Game.Online.API;
using osu.Game.Online.API.Requests.Responses;
using osu.Game.Online.Rooms;

namespace osu.Game.Online.Multiplayer
{
    [Serializable]
    [MessagePackObject]
    public class MultiplayerRoomUser : IEquatable<MultiplayerRoomUser>
    {
        [Key(0)]
        public readonly int UserID;

        [Key(1)]
        public MultiplayerUserState State { get; set; } = MultiplayerUserState.Idle;

        /// <summary>
        /// The availability state of the current beatmap.
        /// </summary>
        [Key(2)]
        public BeatmapAvailability BeatmapAvailability { get; set; } = BeatmapAvailability.Unknown();

        /// <summary>
        /// Any mods applicable only to the local user.
        /// </summary>
        [Key(3)]
        public IEnumerable<APIMod> Mods { get; set; } = Enumerable.Empty<APIMod>();

        [Key(4)]
        public MatchUserState? MatchState { get; set; }

        /// <summary>
        /// If not-null, a local override for this user's ruleset selection.
        /// </summary>
        [Key(5)]
        public int? RulesetId;

        /// <summary>
        /// If not-null, a local override for this user's beatmap selection.
        /// </summary>
        [Key(6)]
        public int? BeatmapId;

        /// <summary>
        /// Whether this user voted to skip the beatmap intro.
        /// </summary>
        [Key(7)]
        public bool VotedToSkipIntro;

        [IgnoreMember]
        public APIUser? User { get; set; }

        [JsonConstructor]
        public MultiplayerRoomUser(int userId)
        {
            UserID = userId;
        }

        public bool Equals(MultiplayerRoomUser? other)
        {
            if (ReferenceEquals(this, other)) return true;
            if (other == null) return false;

            return UserID == other.UserID;
        }

        public override bool Equals(object? obj)
        {
            if (ReferenceEquals(this, obj)) return true;
            if (obj?.GetType() != GetType()) return false;

            return Equals((MultiplayerRoomUser)obj);
        }

        public override int GetHashCode() => UserID.GetHashCode();

        /// <summary>
        /// Whether this user has finished loading and can start gameplay.
        /// </summary>
        public bool CanStartGameplay()
        {
            switch (State)
            {
                case MultiplayerUserState.Loaded:
                case MultiplayerUserState.ReadyForGameplay:
                    return true;

                default:
                    return false;
            }
        }
    }
}