2018-04-13 09:19:50 +00:00
|
|
|
|
// Copyright (c) 2007-2018 ppy Pty Ltd <contact@ppy.sh>.
|
|
|
|
|
// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
|
|
|
|
|
|
|
|
|
|
using osu.Game.Graphics;
|
|
|
|
|
using System;
|
|
|
|
|
|
|
|
|
|
namespace osu.Game.Rulesets.Mods
|
|
|
|
|
{
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// The base class for gameplay modifiers.
|
|
|
|
|
/// </summary>
|
|
|
|
|
public abstract class Mod
|
|
|
|
|
{
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// The name of this mod.
|
|
|
|
|
/// </summary>
|
|
|
|
|
public abstract string Name { get; }
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// The shortened name of this mod.
|
|
|
|
|
/// </summary>
|
|
|
|
|
public abstract string ShortenedName { get; }
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// The icon of this mod.
|
|
|
|
|
/// </summary>
|
|
|
|
|
public virtual FontAwesome Icon => FontAwesome.fa_question;
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// The type of this mod.
|
|
|
|
|
/// </summary>
|
|
|
|
|
public virtual ModType Type => ModType.Special;
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// The user readable description of this mod.
|
|
|
|
|
/// </summary>
|
|
|
|
|
public virtual string Description => string.Empty;
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// The score multiplier of this mod.
|
|
|
|
|
/// </summary>
|
|
|
|
|
public abstract double ScoreMultiplier { get; }
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Returns true if this mod is implemented (and playable).
|
|
|
|
|
/// </summary>
|
|
|
|
|
public virtual bool HasImplementation => this is IApplicableMod;
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Returns if this mod is ranked.
|
|
|
|
|
/// </summary>
|
|
|
|
|
public virtual bool Ranked => false;
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// The mods this mod cannot be enabled with.
|
|
|
|
|
/// </summary>
|
|
|
|
|
public virtual Type[] IncompatibleMods => new Type[] { };
|
|
|
|
|
}
|
|
|
|
|
}
|