h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2026-05-22 02:41:23 +08:00
Code Issues Releases Wiki Activity

Use IMod documentation where present

Browse Source
This commit is contained in:
Dan Balasescu
2025-04-17 18:32:26 +09:00
Unverified
parent 5bda93aac6
commit 95cf4887e1
1 changed files with 0 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files
osu.Game/Rulesets/Mods/Mod.cs
-55
View File
@@ -87,69 +87,17 @@ namespace osu.Game.Rulesets.Mods
[JsonIgnore]
public virtual bool HasImplementation => this is IApplicableMod;
/// <summary>
/// Whether this mod can be played by a real human user.
/// Non-user-playable mods are not viable for single-player score submission.
/// </summary>
/// <example>
/// <list type="bullet">
/// <item><see cref="ModDoubleTime"/> is user-playable.</item>
/// <item><see cref="ModAutoplay"/> is not user-playable.</item>
/// </list>
/// </example>
[JsonIgnore]
public virtual bool UserPlayable => true;
/// <summary>
/// Whether this mod can be specified as a "required" mod in a multiplayer context.
/// </summary>
/// <example>
/// <list type="bullet">
/// <item><see cref="ModHardRock"/> <b>is</b> valid for multiplayer.</item>
/// <item>
/// <see cref="ModDoubleTime"/> <b>is</b> valid for multiplayer as long as it is a <b>required</b> mod,
/// as that ensures the same duration of gameplay for all users in the room.
/// </item>
/// <item>
/// <see cref="ModAdaptiveSpeed"/> <b>is not</b> valid for multiplayer, as it leads to varying
/// gameplay duration depending on how the users in the room play.
/// </item>
/// <item><see cref="ModAutoplay"/> <b>is not</b> valid for multiplayer.</item>
/// </list>
/// </example>
[JsonIgnore]
public virtual bool ValidForMultiplayer => true;
/// <summary>
/// Whether this mod can be specified as a "required" mod on freestyle playlist items, indicating that all rulesets contain an implementation of this mod.
/// </summary>
/// <example>
/// <list type="bullet">
/// <item><see cref="ModHardRock"/> <b>is</b> valid as a freestyle required-mod.</item>
/// <item>
/// <c>OsuModNoScope</c> <b>is not</b> valid, as it is only implemented in the osu! ruleset.
/// </item>
/// </list>
/// </example>
public virtual bool ValidForFreestyleAsRequiredMod => false;
/// <summary>
/// Whether this mod can be specified as a "free" or "allowed" mod in a multiplayer context.
/// </summary>
/// <example>
/// <list type="bullet">
/// <item><see cref="ModHardRock"/> <b>is</b> valid for multiplayer as a free mod.</item>
/// <item>
/// <see cref="ModDoubleTime"/> <b>is not</b> valid for multiplayer as a free mod,
/// as it could to varying gameplay duration between users in the room depending on whether they picked it.
/// </item>
/// <item><see cref="ModAutoplay"/> <b>is not</b> valid for multiplayer as a free mod.</item>
/// </list>
/// </example>
[JsonIgnore]
public virtual bool ValidForMultiplayerAsFreeMod => true;
/// <inheritdoc/>
[JsonIgnore]
public virtual bool AlwaysValidForSubmission => false;
@@ -159,9 +107,6 @@ namespace osu.Game.Rulesets.Mods
[JsonIgnore]
public virtual bool RequiresConfiguration => false;
/// <summary>
/// Whether scores with this mod active can give performance points.
/// </summary>
[JsonIgnore]
public virtual bool Ranked => false;