diff --git a/src/Ryujinx/Utilities/PlayReport/Analyzer.cs b/src/Ryujinx/Utilities/PlayReport/Analyzer.cs index 3d0963b5a..84bdbf085 100644 --- a/src/Ryujinx/Utilities/PlayReport/Analyzer.cs +++ b/src/Ryujinx/Utilities/PlayReport/Analyzer.cs @@ -132,7 +132,7 @@ namespace Ryujinx.Ava.Utilities.PlayReport } /// - /// A potential formatted value returned by a . + /// A potential formatted value returned by a . /// public readonly struct FormattedValue { @@ -175,16 +175,16 @@ namespace Ryujinx.Ava.Utilities.PlayReport public static FormattedValue ForceReset => new() { Handled = true, Reset = true }; /// - /// A delegate singleton you can use to always return in a . + /// A delegate singleton you can use to always return in a . /// - public static readonly PlayReportValueFormatter AlwaysResets = _ => ForceReset; + public static readonly ValueFormatter AlwaysResets = _ => ForceReset; /// /// A delegate factory you can use to always return the specified - /// in a . + /// in a . /// /// The string to always return for this delegate instance. - public static PlayReportValueFormatter AlwaysReturns(string formattedValue) => _ => formattedValue; + public static ValueFormatter AlwaysReturns(string formattedValue) => _ => formattedValue; } } @@ -206,7 +206,7 @@ namespace Ryujinx.Ava.Utilities.PlayReport /// The key name to match. /// The function which can return a potential formatted value. /// The current , for chaining convenience. - public GameSpec AddValueFormatter(string reportKey, PlayReportValueFormatter valueFormatter) + public GameSpec AddValueFormatter(string reportKey, ValueFormatter valueFormatter) { SimpleValueFormatters.Add(new FormatterSpec { @@ -224,7 +224,7 @@ namespace Ryujinx.Ava.Utilities.PlayReport /// The function which can return a potential formatted value. /// The current , for chaining convenience. public GameSpec AddValueFormatter(int priority, string reportKey, - PlayReportValueFormatter valueFormatter) + ValueFormatter valueFormatter) { SimpleValueFormatters.Add(new FormatterSpec { @@ -233,7 +233,14 @@ namespace Ryujinx.Ava.Utilities.PlayReport return this; } - public GameSpec AddMultiValueFormatter(string[] reportKeys, PlayReportMultiValueFormatter valueFormatter) + /// + /// Add a multi-value formatter to the current + /// matching a specific set of keys that could exist in a Play Report for the previously specified title IDs. + /// + /// The key names to match. + /// The function which can format the values. + /// The current , for chaining convenience. + public GameSpec AddMultiValueFormatter(string[] reportKeys, MultiValueFormatter valueFormatter) { MultiValueFormatters.Add(new MultiFormatterSpec { @@ -242,8 +249,16 @@ namespace Ryujinx.Ava.Utilities.PlayReport return this; } + /// + /// Add a multi-value formatter at a specific priority to the current + /// matching a specific set of keys that could exist in a Play Report for the previously specified title IDs. + /// + /// The resolution priority of this value formatter. Higher resolves sooner. + /// The key names to match. + /// The function which can format the values. + /// The current , for chaining convenience. public GameSpec AddMultiValueFormatter(int priority, string[] reportKeys, - PlayReportMultiValueFormatter valueFormatter) + MultiValueFormatter valueFormatter) { MultiValueFormatters.Add(new MultiFormatterSpec { @@ -259,7 +274,7 @@ namespace Ryujinx.Ava.Utilities.PlayReport { public required int Priority { get; init; } public required string ReportKey { get; init; } - public PlayReportValueFormatter ValueFormatter { get; init; } + public ValueFormatter ValueFormatter { get; init; } } /// @@ -269,12 +284,12 @@ namespace Ryujinx.Ava.Utilities.PlayReport { public required int Priority { get; init; } public required string[] ReportKeys { get; init; } - public PlayReportMultiValueFormatter ValueFormatter { get; init; } + public MultiValueFormatter ValueFormatter { get; init; } } } /// - /// The input data to a , + /// The input data to a , /// containing the currently running application's , /// and the matched from the Play Report. /// @@ -294,7 +309,7 @@ namespace Ryujinx.Ava.Utilities.PlayReport /// Access the as its underlying .NET type.
/// /// Does not seem to work well with comparing numeric types, - /// so use and the AsX (where X is a numerical type name i.e. Int32) methods for that. + /// so use XValue properties for that. ///
public object BoxedValue => PackedValue.ToObject(); @@ -327,7 +342,7 @@ namespace Ryujinx.Ava.Utilities.PlayReport ///
/// OR a signal to reset the value that the caller is using the for. /// - public delegate Analyzer.FormattedValue PlayReportValueFormatter(Value value); + public delegate Analyzer.FormattedValue ValueFormatter(Value value); /// /// The delegate type that powers multiple value formatters.
@@ -339,5 +354,5 @@ namespace Ryujinx.Ava.Utilities.PlayReport ///
/// OR a signal to reset the value that the caller is using the for. ///
- public delegate Analyzer.FormattedValue PlayReportMultiValueFormatter(Value[] value); + public delegate Analyzer.FormattedValue MultiValueFormatter(Value[] value); }