1
0
mirror of https://github.com/ppy/osu.git synced 2025-01-26 18:52:55 +08:00

Rename property to AllowGameplayOverlays and update XMLDoc accordingly.

This commit is contained in:
Lucas A 2020-05-08 09:37:50 +02:00
parent 83998d5ba5
commit 30dd158c33
2 changed files with 5 additions and 5 deletions

View File

@ -488,13 +488,13 @@ namespace osu.Game.Rulesets.UI
protected virtual ResumeOverlay CreateResumeOverlay() => null;
/// <summary>
/// Whether to display the HUD with this ruleset.
/// Override to false to completely disable the display of the HUD with this ruleset.
/// Whether to display gameplay overlays with this ruleset.
/// Override to false to completely disable the display of gameplay overlays.
/// </summary>
/// <remarks>
/// HUD refers here to <see cref="HUDOverlay"/> in player as well as <see cref="BreakOverlay"/>.
/// Gameplay overlays refer here to <see cref="HUDOverlay"/> in player as well as <see cref="BreakOverlay"/>.
/// </remarks>
public virtual bool DisplayHud => true;
public virtual bool AllowGameplayOverlays => true;
/// <summary>
/// Sets a replay to be used, overriding local input.

View File

@ -184,7 +184,7 @@ namespace osu.Game.Screens.Play
addGameplayComponents(GameplayClockContainer, Beatmap.Value, playableBeatmap);
addOverlayComponents(GameplayClockContainer, Beatmap.Value);
if (!DrawableRuleset.DisplayHud)
if (!DrawableRuleset.AllowGameplayOverlays)
{
HUDOverlay.ShowHud.Value = false;
HUDOverlay.ShowHud.Disabled = true;