1
0
mirror of https://github.com/ppy/osu.git synced 2024-12-20 00:52:55 +08:00
osu-lazer/osu.Game/Rulesets/UI/RulesetInputManager.cs

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

267 lines
9.6 KiB
C#
Raw Normal View History

// 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.
2018-04-13 17:19:50 +08:00
2020-03-23 18:03:42 +08:00
using System;
using System.Linq;
using osu.Framework.Allocation;
2019-02-21 18:04:31 +08:00
using osu.Framework.Bindables;
using osu.Framework.Graphics;
using osu.Framework.Graphics.Containers;
using osu.Framework.Input;
using osu.Framework.Input.Bindings;
using osu.Framework.Input.Events;
using osu.Framework.Input.StateChanges;
using osu.Framework.Input.StateChanges.Events;
2018-07-21 10:38:28 +08:00
using osu.Framework.Input.States;
using osu.Game.Configuration;
using osu.Game.Input;
using osu.Game.Input.Bindings;
using osu.Game.Input.Handlers;
using osu.Game.Rulesets.Scoring;
using osu.Game.Screens.Play.HUD;
using osu.Game.Screens.Play.HUD.ClicksPerSecond;
using osuTK;
2018-06-11 22:00:26 +08:00
using static osu.Game.Input.Handlers.ReplayInputHandler;
2018-04-13 17:19:50 +08:00
namespace osu.Game.Rulesets.UI
{
public abstract partial class RulesetInputManager<T> : PassThroughInputManager, ICanAttachHUDPieces, IHasReplayHandler, IHasRecordingHandler
where T : struct
{
protected override bool AllowRightClickFromLongTouch => false;
public readonly KeyBindingContainer<T> KeyBindingContainer;
2024-07-03 15:33:48 +08:00
[Resolved]
private ScoreProcessor? scoreProcessor { get; set; }
2024-07-03 15:33:48 +08:00
private ReplayRecorder? recorder;
2020-03-23 18:03:42 +08:00
2024-07-03 15:33:48 +08:00
public ReplayRecorder? Recorder
2020-03-23 18:03:42 +08:00
{
set
{
if (value == recorder)
return;
if (value != null && recorder != null)
2020-03-23 18:03:42 +08:00
throw new InvalidOperationException("Cannot attach more than one recorder");
recorder?.Expire();
2020-03-23 18:03:42 +08:00
recorder = value;
if (recorder != null)
KeyBindingContainer.Add(recorder);
2020-03-23 18:03:42 +08:00
}
}
protected override InputState CreateInitialState() => new RulesetInputManagerInputState<T>(base.CreateInitialState());
2018-06-11 22:00:26 +08:00
protected override Container<Drawable> Content => content;
private readonly Container content;
2018-04-13 17:19:50 +08:00
protected RulesetInputManager(RulesetInfo ruleset, int variant, SimultaneousBindingMode unique)
{
InternalChild = KeyBindingContainer =
CreateKeyBindingContainer(ruleset, variant, unique)
.WithChild(content = new Container { RelativeSizeAxes = Axes.Both });
}
[BackgroundDependencyLoader(true)]
private void load(OsuConfigManager config)
{
mouseDisabled = config.GetBindable<bool>(OsuSetting.MouseDisableButtons);
tapsDisabled = config.GetBindable<bool>(OsuSetting.TouchDisableGameplayTaps);
}
2018-04-13 17:19:50 +08:00
#region Action mapping (for replays)
2018-04-13 17:19:50 +08:00
public override void HandleInputStateChange(InputStateChangeEvent inputStateChange)
{
switch (inputStateChange)
2018-06-11 22:00:26 +08:00
{
case ReplayStateChangeEvent<T> stateChangeEvent:
foreach (var action in stateChangeEvent.ReleasedActions)
KeyBindingContainer.TriggerReleased(action);
2018-04-13 17:19:50 +08:00
foreach (var action in stateChangeEvent.PressedActions)
KeyBindingContainer.TriggerPressed(action);
break;
case ReplayStatisticsFrameEvent statisticsStateChangeEvent:
scoreProcessor?.ResetFromReplayFrame(statisticsStateChangeEvent.Frame);
break;
default:
base.HandleInputStateChange(inputStateChange);
break;
2018-06-11 22:00:26 +08:00
}
}
2018-04-13 17:19:50 +08:00
#endregion
2018-04-13 17:19:50 +08:00
#region IHasReplayHandler
2018-04-13 17:19:50 +08:00
2024-07-03 15:33:48 +08:00
private ReplayInputHandler? replayInputHandler;
2024-07-03 15:33:48 +08:00
public ReplayInputHandler? ReplayInputHandler
{
get => replayInputHandler;
set
{
if (replayInputHandler == value)
return;
if (replayInputHandler != null)
RemoveHandler(replayInputHandler);
// ensures that all replay keys are released, that the last replay state is correctly cleared,
// and that all user-pressed keys are released, so that the replay handler may trigger them itself
// setting `UseParentInput` will only sync releases (https://github.com/ppy/osu-framework/blob/17d65f476d51cc5f2aaea818534f8fbac47e5fe6/osu.Framework/Input/PassThroughInputManager.cs#L179-L182)
new ReplayStateReset().Apply(CurrentState, this);
2018-04-13 17:19:50 +08:00
replayInputHandler = value;
2018-06-11 22:00:26 +08:00
UseParentInput = replayInputHandler == null;
2018-04-13 17:19:50 +08:00
if (replayInputHandler != null)
AddHandler(replayInputHandler);
}
}
2018-04-13 17:19:50 +08:00
#endregion
2018-04-13 17:19:50 +08:00
#region Setting application (disables etc.)
2018-04-13 17:19:50 +08:00
2024-07-03 15:33:48 +08:00
private Bindable<bool> mouseDisabled = null!;
private Bindable<bool> tapsDisabled = null!;
2018-04-13 17:19:50 +08:00
protected override bool Handle(UIEvent e)
{
2018-10-04 16:55:31 +08:00
switch (e)
{
2022-06-24 20:25:23 +08:00
case MouseDownEvent:
2018-10-04 16:55:31 +08:00
if (mouseDisabled.Value)
return true; // importantly, block upwards propagation so global bindings also don't fire.
2018-10-04 16:55:31 +08:00
break;
2019-04-01 11:44:46 +08:00
2018-10-04 16:55:31 +08:00
case MouseUpEvent mouseUp:
if (!CurrentState.Mouse.IsPressed(mouseUp.Button))
return false;
2018-10-04 16:55:31 +08:00
break;
}
return base.Handle(e);
}
protected override bool HandleMouseTouchStateChange(TouchStateChangeEvent e)
{
if (tapsDisabled.Value)
{
// Only propagate positional data when taps are disabled.
e = new TouchStateChangeEvent(e.State, e.Input, e.Touch, false, e.LastPosition);
}
return base.HandleMouseTouchStateChange(e);
}
#endregion
2018-04-13 17:19:50 +08:00
#region Key Counter Attachment
public void Attach(InputCountController inputCountController)
{
var triggers = KeyBindingContainer.DefaultKeyBindings
.Select(b => b.GetAction<T>())
.Distinct()
.Select(action => new KeyCounterActionTrigger<T>(action))
.ToArray();
KeyBindingContainer.AddRange(triggers);
inputCountController.AddRange(triggers);
}
2018-04-13 17:19:50 +08:00
#endregion
#region Keys per second Counter Attachment
public void Attach(ClicksPerSecondController controller) => KeyBindingContainer.Add(new ActionListener(controller));
2022-08-24 23:12:52 +08:00
private partial class ActionListener : Component, IKeyBindingHandler<T>
{
private readonly ClicksPerSecondController controller;
2022-08-24 23:12:52 +08:00
public ActionListener(ClicksPerSecondController controller)
{
this.controller = controller;
}
2022-08-24 18:36:01 +08:00
public bool OnPressed(KeyBindingPressEvent<T> e)
{
controller.AddInputTimestamp();
return false;
}
public void OnReleased(KeyBindingReleaseEvent<T> e)
{
}
}
#endregion
2020-03-23 16:33:02 +08:00
protected virtual KeyBindingContainer<T> CreateKeyBindingContainer(RulesetInfo ruleset, int variant, SimultaneousBindingMode unique)
2018-06-07 19:24:33 +08:00
=> new RulesetKeyBindingContainer(ruleset, variant, unique);
2019-01-23 13:51:13 +08:00
public partial class RulesetKeyBindingContainer : DatabasedKeyBindingContainer<T>
{
protected override bool HandleRepeats => false;
2019-01-23 13:51:13 +08:00
public RulesetKeyBindingContainer(RulesetInfo ruleset, int variant, SimultaneousBindingMode unique)
: base(ruleset, variant, unique)
{
}
protected override void ReloadMappings(IQueryable<RealmKeyBinding> realmKeyBindings)
{
base.ReloadMappings(realmKeyBindings);
KeyBindings = KeyBindings.Where(static b => RealmKeyBindingStore.CheckValidForGameplay(b.KeyCombination)).ToList();
RealmKeyBindingStore.ClearDuplicateBindings(KeyBindings);
}
2019-01-23 13:51:13 +08:00
}
private class ReplayStateReset : IInput
{
public void Apply(InputState state, IInputStateChangeHandler handler)
{
if (!(state is RulesetInputManagerInputState<T> inputState))
throw new InvalidOperationException($"{nameof(ReplayState<T>)} should only be applied to a {nameof(RulesetInputManagerInputState<T>)}");
new MouseButtonInput([], state.Mouse.Buttons).Apply(state, handler);
new KeyboardKeyInput([], state.Keyboard.Keys).Apply(state, handler);
new TouchInput(Enum.GetValues<TouchSource>().Select(s => new Touch(s, Vector2.Zero)), false).Apply(state, handler);
new JoystickButtonInput([], state.Joystick.Buttons).Apply(state, handler);
new MidiKeyInput(new MidiState(), state.Midi).Apply(state, handler);
new TabletPenButtonInput([], state.Tablet.PenButtons).Apply(state, handler);
new TabletAuxiliaryButtonInput([], state.Tablet.AuxiliaryButtons).Apply(state, handler);
handler.HandleInputStateChange(new ReplayStateChangeEvent<T>(state, this, inputState.LastReplayState?.PressedActions.ToArray() ?? [], []));
inputState.LastReplayState = null;
}
}
}
2018-04-13 17:19:50 +08:00
2018-06-11 22:00:26 +08:00
public class RulesetInputManagerInputState<T> : InputState
where T : struct
2018-06-11 22:00:26 +08:00
{
2024-07-03 15:33:48 +08:00
public ReplayState<T>? LastReplayState;
2024-07-03 15:33:48 +08:00
public RulesetInputManagerInputState(InputState state)
: base(state)
{
}
2018-06-11 22:00:26 +08:00
}
2017-08-24 19:32:55 +08:00
}