2019-01-24 08:43:03 +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.
2018-04-13 09:19:50 +00:00
using System ;
using System.Collections.Generic ;
using osu.Framework.Allocation ;
using osu.Framework.Input.Bindings ;
using osu.Game.Rulesets ;
using System.Linq ;
namespace osu.Game.Input.Bindings
{
/// <summary>
/// A KeyBindingInputManager with a database backing for custom overrides.
/// </summary>
/// <typeparam name="T">The type of the custom action.</typeparam>
public class DatabasedKeyBindingContainer < T > : KeyBindingContainer < T >
where T : struct
{
private readonly RulesetInfo ruleset ;
private readonly int? variant ;
private KeyBindingStore store ;
public override IEnumerable < KeyBinding > DefaultKeyBindings = > ruleset . CreateInstance ( ) . GetDefaultKeyBindings ( variant ? ? 0 ) ;
/// <summary>
/// Create a new instance.
/// </summary>
/// <param name="ruleset">A reference to identify the current <see cref="Ruleset"/>. Used to lookup mappings. Null for global mappings.</param>
/// <param name="variant">An optional variant for the specified <see cref="Ruleset"/>. Used when a ruleset has more than one possible keyboard layouts.</param>
2019-11-17 12:48:23 +00:00
/// <param name="simultaneousMode">Specify how to deal with multiple matches of <see cref="KeyCombination"/>s and <typeparamref name="T"/>s.</param>
2018-04-13 09:19:50 +00:00
public DatabasedKeyBindingContainer ( RulesetInfo ruleset = null , int? variant = null , SimultaneousBindingMode simultaneousMode = SimultaneousBindingMode . None )
: base ( simultaneousMode )
{
this . ruleset = ruleset ;
this . variant = variant ;
if ( ruleset ! = null & & variant = = null )
throw new InvalidOperationException ( $"{nameof(variant)} can not be null when a non-null {nameof(ruleset)} is provided." ) ;
}
[BackgroundDependencyLoader]
private void load ( KeyBindingStore keyBindings )
{
store = keyBindings ;
}
protected override void LoadComplete ( )
{
base . LoadComplete ( ) ;
store . KeyBindingChanged + = ReloadMappings ;
}
protected override void Dispose ( bool isDisposing )
{
base . Dispose ( isDisposing ) ;
if ( store ! = null )
store . KeyBindingChanged - = ReloadMappings ;
}
protected override void ReloadMappings ( ) = > KeyBindings = store . Query ( ruleset ? . ID , variant ) . ToList ( ) ;
}
}