1
0
mirror of https://github.com/ppy/osu.git synced 2024-12-16 21:42:55 +08:00
osu-lazer/osu.Game/Rulesets/Mods/Mod.cs

55 lines
1.6 KiB
C#
Raw Normal View History

2017-02-17 04:05:03 +08:00
// Copyright (c) 2007-2017 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;
2017-02-17 04:05:03 +08:00
2017-04-18 15:05:58 +08:00
namespace osu.Game.Rulesets.Mods
2017-02-17 04:05:03 +08:00
{
2017-02-23 19:59:27 +08:00
/// <summary>
/// The base class for gameplay modifiers.
/// </summary>
public abstract class Mod
2017-02-17 04:05:03 +08:00
{
2017-02-23 19:57:58 +08:00
/// <summary>
/// The name of this mod.
/// </summary>
public abstract string Name { get; }
2017-02-23 19:57:58 +08:00
/// <summary>
/// The icon of this mod.
/// </summary>
public virtual FontAwesome Icon => FontAwesome.fa_question;
2017-02-23 19:57:58 +08:00
2017-05-03 02:36:55 +08:00
/// <summary>
/// The type of this mod.
/// </summary>
public virtual ModType Type => ModType.Special;
2017-02-23 19:57:58 +08:00
/// <summary>
2017-03-02 08:57:33 +08:00
/// The user readable description of this mod.
2017-02-23 19:57:58 +08:00
/// </summary>
public virtual string Description => string.Empty;
2017-02-23 19:57:58 +08:00
/// <summary>
2017-03-02 08:57:33 +08:00
/// The score multiplier of this mod.
2017-02-23 19:57:58 +08:00
/// </summary>
2017-03-02 08:57:33 +08:00
public abstract double ScoreMultiplier { get; }
2017-02-23 19:57:58 +08:00
/// <summary>
2017-03-02 08:57:33 +08:00
/// Returns if this mod is ranked.
2017-02-23 19:57:58 +08:00
/// </summary>
public virtual bool Ranked => false;
2017-02-23 19:57:58 +08:00
/// <summary>
2017-03-02 08:57:33 +08:00
/// The mods this mod cannot be enabled with.
2017-02-23 19:57:58 +08:00
/// </summary>
public virtual Type[] IncompatibleMods => new Type[] { };
2017-08-05 10:59:58 +08:00
/// <summary>
2017-08-07 08:01:47 +08:00
/// Whether we should allow failing at the current point in time.
2017-08-05 10:59:58 +08:00
/// </summary>
public virtual bool AllowFail => true;
}
2017-03-02 08:57:33 +08:00
}