2019-01-29 12:48:35 +00:00
|
|
|
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
|
|
|
|
// See the LICENCE file in the repository root for full licence text.
|
2019-01-23 11:52:00 +00:00
|
|
|
|
2019-02-21 10:04:31 +00:00
|
|
|
using osu.Framework.Bindables;
|
2019-01-23 11:52:00 +00:00
|
|
|
using osu.Framework.Screens;
|
2019-02-01 06:42:15 +00:00
|
|
|
using osu.Game.Beatmaps;
|
2019-01-28 06:41:54 +00:00
|
|
|
using osu.Game.Overlays;
|
2019-02-01 06:42:15 +00:00
|
|
|
using osu.Game.Rulesets;
|
2019-01-23 11:52:00 +00:00
|
|
|
|
|
|
|
namespace osu.Game.Screens
|
|
|
|
{
|
|
|
|
public interface IOsuScreen : IScreen
|
|
|
|
{
|
|
|
|
/// <summary>
|
|
|
|
/// Whether the beatmap or ruleset should be allowed to be changed by the user or game.
|
|
|
|
/// Used to mark exclusive areas where this is strongly prohibited, like gameplay.
|
|
|
|
/// </summary>
|
2019-02-01 06:42:15 +00:00
|
|
|
bool DisallowExternalBeatmapRulesetChanges { get; }
|
2019-01-23 11:52:00 +00:00
|
|
|
|
2019-06-25 07:55:49 +00:00
|
|
|
/// <summary>
|
|
|
|
/// Whether the user can exit this this <see cref="IOsuScreen"/> by pressing the back button.
|
|
|
|
/// </summary>
|
|
|
|
bool AllowBackButton { get; }
|
|
|
|
|
2019-02-13 10:43:01 +00:00
|
|
|
/// <summary>
|
|
|
|
/// Whether a top-level component should be allowed to exit the current screen to, for example,
|
2019-02-25 05:01:51 +00:00
|
|
|
/// complete an import. Note that this can be overridden by a user if they specifically request.
|
2019-02-13 10:43:01 +00:00
|
|
|
/// </summary>
|
|
|
|
bool AllowExternalScreenChange { get; }
|
|
|
|
|
2019-01-23 11:52:00 +00:00
|
|
|
/// <summary>
|
|
|
|
/// Whether this <see cref="OsuScreen"/> allows the cursor to be displayed.
|
|
|
|
/// </summary>
|
|
|
|
bool CursorVisible { get; }
|
2019-01-28 06:41:54 +00:00
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Whether all overlays should be hidden when this screen is entered or resumed.
|
|
|
|
/// </summary>
|
|
|
|
bool HideOverlaysOnEnter { get; }
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Whether overlays should be able to be opened once this screen is entered or resumed.
|
|
|
|
/// </summary>
|
|
|
|
OverlayActivation InitialOverlayActivationMode { get; }
|
2019-01-31 09:10:21 +00:00
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// The amount of parallax to be applied while this screen is displayed.
|
|
|
|
/// </summary>
|
|
|
|
float BackgroundParallaxAmount { get; }
|
2019-02-01 06:42:15 +00:00
|
|
|
|
|
|
|
Bindable<WorkingBeatmap> Beatmap { get; }
|
|
|
|
|
|
|
|
Bindable<RulesetInfo> Ruleset { get; }
|
2019-01-23 11:52:00 +00:00
|
|
|
}
|
|
|
|
}
|