A game framework written with osu! in mind.
keii.dev
1// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
2// See the LICENCE file in the repository root for full licence text.
3
4namespace osu.Framework.Configuration.Tracking
5{
6 /// <summary>
7 /// Contains information that can be displayed when tracked settings change.
8 /// </summary>
9 public class SettingDescription
10 {
11 /// <summary>
12 /// The raw setting value.
13 /// </summary>
14 public readonly object RawValue;
15
16 /// <summary>
17 /// The readable setting name.
18 /// </summary>
19 public readonly string Name;
20
21 /// <summary>
22 /// The readable setting value.
23 /// </summary>
24 public readonly string Value;
25
26 /// <summary>
27 /// The shortcut keys that cause this setting to change.
28 /// </summary>
29 public readonly string Shortcut;
30
31 /// <summary>
32 /// Constructs a new <see cref="SettingDescription"/>.
33 /// </summary>
34 /// <param name="rawValue">The raw setting value.</param>
35 /// <param name="name">The readable setting name.</param>
36 /// <param name="value">The readable setting value.</param>
37 /// <param name="shortcut">The shortcut keys that cause this setting to change.</param>
38 public SettingDescription(object rawValue, string name, string value, string shortcut = @"")
39 {
40 RawValue = rawValue;
41 Name = name;
42 Value = value;
43 Shortcut = shortcut;
44 }
45 }
46}