mirror of
https://github.com/ppy/osu
synced 2024-12-13 18:37:04 +00:00
9574bc1382
At first I was planning on making `CompareTo` implemented at `IRulesetInfo` itself and shared across classes, but turns out it only implements it explicitly and not allow direct `IRulesetInfo.Equals` calls. It messed with my head enough that I decided to just let each class have its own implementation and only allow same type.
34 lines
1001 B
C#
34 lines
1001 B
C#
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
|
|
// See the LICENCE file in the repository root for full licence text.
|
|
|
|
using System;
|
|
using osu.Game.Database;
|
|
|
|
#nullable enable
|
|
|
|
namespace osu.Game.Rulesets
|
|
{
|
|
/// <summary>
|
|
/// A representation of a ruleset's metadata.
|
|
/// </summary>
|
|
public interface IRulesetInfo : IHasOnlineID<int>, IEquatable<IRulesetInfo>, IComparable<IRulesetInfo>
|
|
{
|
|
/// <summary>
|
|
/// The user-exposed name of this ruleset.
|
|
/// </summary>
|
|
string Name { get; }
|
|
|
|
/// <summary>
|
|
/// An acronym defined by the ruleset that can be used as a permanent identifier.
|
|
/// </summary>
|
|
string ShortName { get; }
|
|
|
|
/// <summary>
|
|
/// A string representation of this ruleset, to be used with reflection to instantiate the ruleset represented by this metadata.
|
|
/// </summary>
|
|
string InstantiationInfo { get; }
|
|
|
|
Ruleset CreateInstance();
|
|
}
|
|
}
|