// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. // See the LICENCE file in the repository root for full licence text. using System.Collections.Generic; using System.Linq; using osu.Framework.Input.Bindings; using osu.Game.Database; using osu.Game.Input.Bindings; using osu.Game.Rulesets; #nullable enable namespace osu.Game.Input { public class RealmKeyBindingStore { private readonly RealmContextFactory realmFactory; public RealmKeyBindingStore(RealmContextFactory realmFactory) { this.realmFactory = realmFactory; } /// /// Retrieve all user-defined key combinations (in a format that can be displayed) for a specific action. /// /// The action to lookup. /// A set of display strings for all the user's key configuration for the action. public IReadOnlyList GetReadableKeyCombinationsFor(GlobalAction globalAction) { List combinations = new List(); using (var context = realmFactory.GetForRead()) { foreach (var action in context.Realm.All().Where(b => (GlobalAction)b.ActionInt == globalAction)) { string str = action.KeyCombination.ReadableString(); // even if found, the readable string may be empty for an unbound action. if (str.Length > 0) combinations.Add(str); } } return combinations; } /// /// Register a new type of , adding default bindings from . /// /// The container to populate defaults from. public void Register(KeyBindingContainer container) => insertDefaults(container.DefaultKeyBindings); /// /// Register a ruleset, adding default bindings for each of its variants. /// /// The ruleset to populate defaults from. public void Register(RulesetInfo ruleset) { var instance = ruleset.CreateInstance(); foreach (var variant in instance.AvailableVariants) insertDefaults(instance.GetDefaultKeyBindings(variant), ruleset.ID, variant); } private void insertDefaults(IEnumerable defaults, int? rulesetId = null, int? variant = null) { using (var usage = realmFactory.GetForWrite()) { // compare counts in database vs defaults foreach (var defaultsForAction in defaults.GroupBy(k => k.Action)) { int existingCount = usage.Realm.All().Count(k => k.RulesetID == rulesetId && k.Variant == variant && k.ActionInt == (int)defaultsForAction.Key); if (defaultsForAction.Count() <= existingCount) continue; foreach (var k in defaultsForAction.Skip(existingCount)) { // insert any defaults which are missing. usage.Realm.Add(new RealmKeyBinding { KeyCombinationString = k.KeyCombination.ToString(), ActionInt = (int)k.Action, RulesetID = rulesetId, Variant = variant }); } } usage.Commit(); } } /// /// Keys which should not be allowed for gameplay input purposes. /// private static readonly IEnumerable banned_keys = new[] { InputKey.MouseWheelDown, InputKey.MouseWheelLeft, InputKey.MouseWheelUp, InputKey.MouseWheelRight }; public static bool CheckValidForGameplay(KeyCombination combination) { foreach (var key in banned_keys) { if (combination.Keys.Contains(key)) return false; } return true; } } }