2020-03-23 10:07:09 +08:00
|
|
|
|
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
|
2019-01-24 16:43:03 +08:00
|
|
|
|
// See the LICENCE file in the repository root for full licence text.
|
2018-04-13 17:19:50 +08:00
|
|
|
|
|
|
|
|
|
using System;
|
2020-03-23 06:49:45 +08:00
|
|
|
|
using System.Collections.Generic;
|
|
|
|
|
using System.Linq;
|
|
|
|
|
using System.Reflection;
|
2018-11-28 12:12:29 +08:00
|
|
|
|
using Newtonsoft.Json;
|
2020-03-23 06:49:45 +08:00
|
|
|
|
using osu.Framework.Bindables;
|
2019-03-27 18:29:27 +08:00
|
|
|
|
using osu.Framework.Graphics.Sprites;
|
2020-03-23 06:49:45 +08:00
|
|
|
|
using osu.Game.Configuration;
|
2018-11-28 12:12:29 +08:00
|
|
|
|
using osu.Game.IO.Serialization;
|
2020-03-19 11:43:26 +08:00
|
|
|
|
using osu.Game.Rulesets.UI;
|
2018-04-13 17:19:50 +08:00
|
|
|
|
|
|
|
|
|
namespace osu.Game.Rulesets.Mods
|
|
|
|
|
{
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// The base class for gameplay modifiers.
|
|
|
|
|
/// </summary>
|
2018-11-30 16:16:00 +08:00
|
|
|
|
public abstract class Mod : IMod, IJsonSerializable
|
2018-04-13 17:19:50 +08:00
|
|
|
|
{
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// The name of this mod.
|
|
|
|
|
/// </summary>
|
2018-11-28 12:12:29 +08:00
|
|
|
|
[JsonIgnore]
|
2018-04-13 17:19:50 +08:00
|
|
|
|
public abstract string Name { get; }
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// The shortened name of this mod.
|
|
|
|
|
/// </summary>
|
2018-11-30 16:16:00 +08:00
|
|
|
|
public abstract string Acronym { get; }
|
2018-04-13 17:19:50 +08:00
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// The icon of this mod.
|
|
|
|
|
/// </summary>
|
2018-11-28 12:12:29 +08:00
|
|
|
|
[JsonIgnore]
|
2020-01-14 21:22:00 +08:00
|
|
|
|
public virtual IconUsage? Icon => null;
|
2018-04-13 17:19:50 +08:00
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// The type of this mod.
|
|
|
|
|
/// </summary>
|
2018-11-28 12:12:29 +08:00
|
|
|
|
[JsonIgnore]
|
2018-07-31 17:00:42 +08:00
|
|
|
|
public virtual ModType Type => ModType.Fun;
|
2018-04-13 17:19:50 +08:00
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// The user readable description of this mod.
|
|
|
|
|
/// </summary>
|
2018-11-28 12:12:29 +08:00
|
|
|
|
[JsonIgnore]
|
2018-04-13 17:19:50 +08:00
|
|
|
|
public virtual string Description => string.Empty;
|
|
|
|
|
|
2020-03-19 11:43:26 +08:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// The tooltip to display for this mod when used in a <see cref="ModIcon"/>.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <remarks>
|
|
|
|
|
/// Differs from <see cref="Name"/>, as the value of attributes (AR, CS, etc) changeable via the mod
|
|
|
|
|
/// are displayed in the tooltip.
|
|
|
|
|
/// </remarks>
|
|
|
|
|
[JsonIgnore]
|
2020-03-21 04:34:36 +08:00
|
|
|
|
public string IconTooltip
|
|
|
|
|
{
|
|
|
|
|
get
|
|
|
|
|
{
|
2020-03-23 10:06:54 +08:00
|
|
|
|
string settingDescription = string.IsNullOrEmpty(SettingDescription) ? string.Empty : $" ({SettingDescription})";
|
2020-03-21 04:34:36 +08:00
|
|
|
|
return $"{Name}{settingDescription}";
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// The description of editable settings of a mod to use in the <see cref="IconTooltip"/>.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <remarks>
|
|
|
|
|
/// Parentheses are added to the tooltip, surrounding the value of this property. If this property is <c>string.Empty</c>,
|
|
|
|
|
/// the tooltip will not have parentheses.
|
|
|
|
|
/// </remarks>
|
2020-03-23 06:49:45 +08:00
|
|
|
|
public virtual string SettingDescription
|
|
|
|
|
{
|
|
|
|
|
get
|
|
|
|
|
{
|
|
|
|
|
var tooltipTexts = new List<string>();
|
|
|
|
|
|
|
|
|
|
foreach ((SettingSourceAttribute attr, PropertyInfo property) in this.GetOrderedSettingsSourceProperties())
|
|
|
|
|
{
|
|
|
|
|
object bindableObj = property.GetValue(this);
|
|
|
|
|
bool? settingIsDefault = (bindableObj as IHasDefaultValue)?.IsDefault;
|
2020-03-23 10:51:29 +08:00
|
|
|
|
string tooltipText = settingIsDefault == true ? string.Empty : attr.Label + " " + bindableObj;
|
2020-03-23 06:49:45 +08:00
|
|
|
|
tooltipTexts.Add(tooltipText);
|
|
|
|
|
}
|
|
|
|
|
|
2020-03-23 10:07:09 +08:00
|
|
|
|
string joinedTooltipText = string.Join(", ", tooltipTexts.Where(s => !string.IsNullOrEmpty(s)));
|
|
|
|
|
return $"{joinedTooltipText}";
|
2020-03-23 06:49:45 +08:00
|
|
|
|
}
|
|
|
|
|
}
|
2020-03-19 11:43:26 +08:00
|
|
|
|
|
2018-04-13 17:19:50 +08:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// The score multiplier of this mod.
|
|
|
|
|
/// </summary>
|
2018-11-28 12:12:29 +08:00
|
|
|
|
[JsonIgnore]
|
2018-04-13 17:19:50 +08:00
|
|
|
|
public abstract double ScoreMultiplier { get; }
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Returns true if this mod is implemented (and playable).
|
|
|
|
|
/// </summary>
|
2018-11-28 12:12:29 +08:00
|
|
|
|
[JsonIgnore]
|
2018-04-13 17:19:50 +08:00
|
|
|
|
public virtual bool HasImplementation => this is IApplicableMod;
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Returns if this mod is ranked.
|
|
|
|
|
/// </summary>
|
2018-11-28 12:12:29 +08:00
|
|
|
|
[JsonIgnore]
|
2018-04-13 17:19:50 +08:00
|
|
|
|
public virtual bool Ranked => false;
|
|
|
|
|
|
2020-01-21 00:06:36 +08:00
|
|
|
|
/// <summary>
|
2020-01-21 11:44:22 +08:00
|
|
|
|
/// Whether this mod requires configuration to apply changes to the game.
|
2020-01-21 00:06:36 +08:00
|
|
|
|
/// </summary>
|
|
|
|
|
[JsonIgnore]
|
|
|
|
|
public virtual bool RequiresConfiguration => false;
|
|
|
|
|
|
2018-04-13 17:19:50 +08:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// The mods this mod cannot be enabled with.
|
|
|
|
|
/// </summary>
|
2018-11-28 12:12:29 +08:00
|
|
|
|
[JsonIgnore]
|
2019-11-28 21:41:29 +08:00
|
|
|
|
public virtual Type[] IncompatibleMods => Array.Empty<Type>();
|
2019-03-14 22:39:45 +08:00
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Creates a copy of this <see cref="Mod"/> initialised to a default state.
|
|
|
|
|
/// </summary>
|
2019-10-08 18:34:09 +08:00
|
|
|
|
public virtual Mod CreateCopy() => (Mod)MemberwiseClone();
|
2019-05-03 09:05:45 +08:00
|
|
|
|
|
|
|
|
|
public bool Equals(IMod other) => GetType() == other?.GetType();
|
2018-04-13 17:19:50 +08:00
|
|
|
|
}
|
|
|
|
|
}
|