sim1222/osukey
1
1
Fork 0
mirror of https://github.com/osukey/osukey.git synced 2025-07-02 16:59:53 +09:00
Code Issues Packages Projects Releases Wiki Activity

Introduce IsPlayable(...) and obsolete UserPlayable

Browse Source
This commit is contained in:
Salman Ahmed
2022-03-18 02:08:11 +03:00
parent b0d04a78f7
commit 51e5dd7d0e
4 changed files with 45 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
osu.Game/Rulesets/Mods/IMod.cs
View File

@ -33,24 +33,26 @@ namespace osu.Game.Rulesets.Mods
/// </summary>
IconUsage? Icon { get; }
/// <summary>
/// Whether this mod is playable for the given usage.
/// </summary>
/// <remarks>
/// <list type="bullet">
/// <item>Should be always <c>false</c> for cases where the user is not interacting with the game.</item>
/// <item>Should be <c>false</c> in <see cref="ModUsage.MultiplayerRequired"/> for mods that make gameplay duration dependent on user input (e.g. <see cref="ModAdaptiveSpeed"/>).</item>
/// <item>Should be <c>false</c> in <see cref="ModUsage.MultiplayerFree"/> for mods that affect the gameplay duration (e.g. <see cref="ModRateAdjust"/> and <see cref="ModTimeRamp"/>).</item>
/// </list>
/// </remarks>
/// <param name="usage">The mod usage.</param>
bool IsPlayable(ModUsage usage);
/// <summary>
/// Whether this mod is playable by an end user.
/// Should be <c>false</c> for cases where the user is not interacting with the game (so it can be excluded from multiplayer selection, for example).
/// </summary>
[Obsolete("Override IsPlayable instead.")] // Can be removed 20220918
bool UserPlayable { get; }
/// <summary>
/// Whether this mod is playable in a multiplayer match.
/// Should be <c>false</c> for mods that make gameplay duration dependent on user input (e.g. <see cref="ModAdaptiveSpeed"/>).
/// </summary>
bool PlayableInMultiplayer { get; }
/// <summary>
/// Whether this mod is valid to be a "free mod" in a multiplayer match.
/// Should be <c>false</c> for mods that affect the gameplay duration (e.g. <see cref="ModRateAdjust"/> and <see cref="ModTimeRamp"/>).
/// </summary>
bool ValidFreeModInMultiplayer { get; }
/// <summary>
/// Create a fresh <see cref="Mod"/> instance based on this mod.
/// </summary>