From 731d7e0f6e8206a0137bcd1ffc4e6c93766f62b5 Mon Sep 17 00:00:00 2001 From: goaaats Date: Fri, 25 Apr 2025 22:48:26 +0200 Subject: [PATCH] Un-whether-or-not the codebase --- .../Internal/DalamudConfiguration.cs | 54 ++++----- .../Internal/EnvironmentConfiguration.cs | 2 +- Dalamud/Console/ConsoleEntry.cs | 6 +- Dalamud/Console/ConsoleManager.cs | 108 +++++++++--------- .../Game/Addon/Lifecycle/AddonSetupHook.cs | 12 +- Dalamud/Game/ChatHandlers.cs | 2 +- Dalamud/Game/ClientState/Fates/Fate.cs | 4 +- .../ClientState/JobGauge/Types/BLMGauge.cs | 6 +- .../ClientState/JobGauge/Types/PCTGauge.cs | 16 +-- .../Objects/Enums/CustomizeIndex.cs | 2 +- Dalamud/Game/Gui/Dtr/DtrBar.cs | 2 +- Dalamud/Game/Gui/Dtr/DtrBarEntry.cs | 2 +- Dalamud/Game/Gui/GameGui.cs | 4 +- .../Gui/NamePlate/NamePlateQuotedParts.cs | 2 +- .../MarketBoardItemRequest.cs | 2 +- .../Game/Network/Internal/NetworkHandlers.cs | 2 +- Dalamud/Game/SigScanner.cs | 4 +- Dalamud/Game/TargetSigScanner.cs | 2 +- .../SeStringHandling/Payloads/ItemPayload.cs | 4 +- .../Payloads/UIForegroundPayload.cs | 2 +- .../Payloads/UIGlowPayload.cs | 2 +- .../Text/SeStringHandling/SeStringBuilder.cs | 2 +- Dalamud/Hooking/AsmHook.cs | 6 +- Dalamud/Hooking/Hook.cs | 8 +- Dalamud/Hooking/IDalamudHook.cs | 4 +- Dalamud/Hooking/Internal/CallHook.cs | 2 +- Dalamud/Interface/Animation/Easing.cs | 4 +- .../ImGuiFileDialog/DriveListLoader.cs | 2 +- .../Interface/Internal/DalamudInterface.cs | 2 +- .../Interface/Internal/InterfaceManager.cs | 4 +- .../SelfTest/Steps/LuminaSelfTestStep.cs | 2 +- .../Windows/Settings/SettingsEntry.cs | 6 +- .../TitleScreenMenu/TitleScreenMenuEntry.cs | 2 +- Dalamud/Interface/UiBuilder.cs | 12 +- Dalamud/Interface/Windowing/Window.cs | 14 +-- Dalamud/Logging/Internal/TaskTracker.cs | 8 +- Dalamud/NativeFunctions.cs | 26 ++--- Dalamud/Plugin/DalamudPluginInterface.cs | 2 +- Dalamud/Plugin/IDalamudPluginInterface.cs | 4 +- Dalamud/Plugin/InstalledPluginState.cs | 4 +- .../Internal/AutoUpdate/AutoUpdateManager.cs | 2 +- Dalamud/Plugin/Internal/PluginManager.cs | 4 +- Dalamud/Plugin/Internal/Profiles/Profile.cs | 20 ++-- .../Internal/Profiles/ProfileManager.cs | 10 +- .../Internal/Profiles/ProfileModelV1.cs | 6 +- .../Internal/Profiles/ProfilePluginEntry.cs | 6 +- Dalamud/Plugin/Internal/Types/LocalPlugin.cs | 6 +- .../Plugin/Internal/Types/PluginManifest.cs | 2 +- Dalamud/Plugin/Services/IClientState.cs | 10 +- Dalamud/Plugin/Services/ISigScanner.cs | 20 ++-- Dalamud/Plugin/Services/ITextureProvider.cs | 6 +- Dalamud/SafeMemory.cs | 14 +-- Dalamud/Storage/ReliableFileStorage.cs | 6 +- Dalamud/Support/BugBait.cs | 6 +- Dalamud/Utility/Signatures/NullabilityUtil.cs | 6 +- .../Wrappers/IFieldOrPropertyInfo.cs | 2 +- Dalamud/Utility/Timing/TimingHandle.cs | 2 +- Dalamud/Utility/Util.cs | 8 +- DalamudCrashHandler/miniz.h | 8 +- 59 files changed, 249 insertions(+), 249 deletions(-) diff --git a/Dalamud/Configuration/Internal/DalamudConfiguration.cs b/Dalamud/Configuration/Internal/DalamudConfiguration.cs index b22580b73..2766ba681 100644 --- a/Dalamud/Configuration/Internal/DalamudConfiguration.cs +++ b/Dalamud/Configuration/Internal/DalamudConfiguration.cs @@ -66,12 +66,12 @@ internal sealed class DalamudConfiguration : IInternalDisposableService public List? BadWords { get; set; } /// - /// Gets or sets a value indicating whether or not the taskbar should flash once a duty is found. + /// Gets or sets a value indicating whether the taskbar should flash once a duty is found. /// public bool DutyFinderTaskbarFlash { get; set; } = true; /// - /// Gets or sets a value indicating whether or not a message should be sent in chat once a duty is found. + /// Gets or sets a value indicating whether a message should be sent in chat once a duty is found. /// public bool DutyFinderChatMessage { get; set; } = true; @@ -101,7 +101,7 @@ internal sealed class DalamudConfiguration : IInternalDisposableService public XivChatType GeneralChatType { get; set; } = XivChatType.Debug; /// - /// Gets or sets a value indicating whether or not plugin testing builds should be shown. + /// Gets or sets a value indicating whether plugin testing builds should be shown. /// public bool DoPluginTest { get; set; } = false; @@ -116,7 +116,7 @@ internal sealed class DalamudConfiguration : IInternalDisposableService public List ThirdRepoList { get; set; } = new(); /// - /// Gets or sets a value indicating whether or not a disclaimer regarding third-party repos has been dismissed. + /// Gets or sets a value indicating whether a disclaimer regarding third-party repos has been dismissed. /// public bool? ThirdRepoSpeedbumpDismissed { get; set; } = null; @@ -174,38 +174,38 @@ internal sealed class DalamudConfiguration : IInternalDisposableService public float ImeStateIndicatorOpacity { get; set; } = 1f; /// - /// Gets or sets a value indicating whether or not plugin UI should be hidden. + /// Gets or sets a value indicating whether plugin UI should be hidden. /// public bool ToggleUiHide { get; set; } = true; /// - /// Gets or sets a value indicating whether or not plugin UI should be hidden during cutscenes. + /// Gets or sets a value indicating whether plugin UI should be hidden during cutscenes. /// public bool ToggleUiHideDuringCutscenes { get; set; } = true; /// - /// Gets or sets a value indicating whether or not plugin UI should be hidden during GPose. + /// Gets or sets a value indicating whether plugin UI should be hidden during GPose. /// public bool ToggleUiHideDuringGpose { get; set; } = true; /// - /// Gets or sets a value indicating whether or not a message containing Dalamud's current version and the number of loaded plugins should be sent at login. + /// Gets or sets a value indicating whether a message containing Dalamud's current version and the number of loaded plugins should be sent at login. /// public bool PrintDalamudWelcomeMsg { get; set; } = true; /// - /// Gets or sets a value indicating whether or not a message containing detailed plugin information should be sent at login. + /// Gets or sets a value indicating whether a message containing detailed plugin information should be sent at login. /// public bool PrintPluginsWelcomeMsg { get; set; } = true; /// - /// Gets or sets a value indicating whether or not plugins should be auto-updated. + /// Gets or sets a value indicating whether plugins should be auto-updated. /// [Obsolete("Use AutoUpdateBehavior instead.")] public bool AutoUpdatePlugins { get; set; } /// - /// Gets or sets a value indicating whether or not Dalamud should add buttons to the system menu. + /// Gets or sets a value indicating whether Dalamud should add buttons to the system menu. /// public bool DoButtonsSystemMenu { get; set; } = true; @@ -220,12 +220,12 @@ internal sealed class DalamudConfiguration : IInternalDisposableService public bool LogSynchronously { get; set; } = false; /// - /// Gets or sets a value indicating whether or not the debug log should scroll automatically. + /// Gets or sets a value indicating whether the debug log should scroll automatically. /// public bool LogAutoScroll { get; set; } = true; /// - /// Gets or sets a value indicating whether or not the debug log should open at startup. + /// Gets or sets a value indicating whether the debug log should open at startup. /// public bool LogOpenAtStartup { get; set; } @@ -240,29 +240,29 @@ internal sealed class DalamudConfiguration : IInternalDisposableService public List LogCommandHistory { get; set; } = new(); /// - /// Gets or sets a value indicating whether or not the dev bar should open at startup. + /// Gets or sets a value indicating whether the dev bar should open at startup. /// public bool DevBarOpenAtStartup { get; set; } /// - /// Gets or sets a value indicating whether or not ImGui asserts should be enabled at startup. + /// Gets or sets a value indicating whether ImGui asserts should be enabled at startup. /// public bool? ImGuiAssertsEnabledAtStartup { get; set; } /// - /// Gets or sets a value indicating whether or not docking should be globally enabled in ImGui. + /// Gets or sets a value indicating whether docking should be globally enabled in ImGui. /// public bool IsDocking { get; set; } /// - /// Gets or sets a value indicating whether or not plugin user interfaces should trigger sound effects. + /// Gets or sets a value indicating whether plugin user interfaces should trigger sound effects. /// This setting is effected by the in-game "System Sounds" option and volume. /// [SuppressMessage("ReSharper", "InconsistentNaming", Justification = "ABI")] public bool EnablePluginUISoundEffects { get; set; } /// - /// Gets or sets a value indicating whether or not an additional button allowing pinning and clickthrough options should be shown + /// Gets or sets a value indicating whether an additional button allowing pinning and clickthrough options should be shown /// on plugin title bars when using the Window System. /// public bool EnablePluginUiAdditionalOptions { get; set; } = true; @@ -273,17 +273,17 @@ internal sealed class DalamudConfiguration : IInternalDisposableService public bool IsDisableViewport { get; set; } = true; /// - /// Gets or sets a value indicating whether or not navigation via a gamepad should be globally enabled in ImGui. + /// Gets or sets a value indicating whether navigation via a gamepad should be globally enabled in ImGui. /// public bool IsGamepadNavigationEnabled { get; set; } = true; /// - /// Gets or sets a value indicating whether or not focus management is enabled. + /// Gets or sets a value indicating whether focus management is enabled. /// public bool IsFocusManagementEnabled { get; set; } = true; /// - /// Gets or sets a value indicating whether or not the anti-anti-debug check is enabled on startup. + /// Gets or sets a value indicating whether the anti-anti-debug check is enabled on startup. /// public bool IsAntiAntiDebugEnabled { get; set; } = false; @@ -298,7 +298,7 @@ internal sealed class DalamudConfiguration : IInternalDisposableService public string? DalamudBetaKind { get; set; } /// - /// Gets or sets a value indicating whether or not any plugin should be loaded when the game is started. + /// Gets or sets a value indicating whether any plugin should be loaded when the game is started. /// It is reset immediately when read. /// public bool PluginSafeMode { get; set; } @@ -310,7 +310,7 @@ internal sealed class DalamudConfiguration : IInternalDisposableService public int? PluginWaitBeforeFree { get; set; } /// - /// Gets or sets a value indicating whether or not crashes during shutdown should be reported. + /// Gets or sets a value indicating whether crashes during shutdown should be reported. /// public bool ReportShutdownCrashes { get; set; } @@ -342,12 +342,12 @@ internal sealed class DalamudConfiguration : IInternalDisposableService public ProfileModel? DefaultProfile { get; set; } /// - /// Gets or sets a value indicating whether or not profiles are enabled. + /// Gets or sets a value indicating whether profiles are enabled. /// public bool ProfilesEnabled { get; set; } = false; /// - /// Gets or sets a value indicating whether or not the user has seen the profiles tutorial. + /// Gets or sets a value indicating whether the user has seen the profiles tutorial. /// public bool ProfilesHasSeenTutorial { get; set; } = false; @@ -391,7 +391,7 @@ internal sealed class DalamudConfiguration : IInternalDisposableService public bool? ReduceMotions { get; set; } /// - /// Gets or sets a value indicating whether or not market board data should be uploaded. + /// Gets or sets a value indicating whether market board data should be uploaded. /// public bool IsMbCollect { get; set; } = true; @@ -427,7 +427,7 @@ internal sealed class DalamudConfiguration : IInternalDisposableService } /// - /// Gets or sets a value indicating whether or not to show info on dev bar. + /// Gets or sets a value indicating whether to show info on dev bar. /// public bool ShowDevBarInfo { get; set; } = true; diff --git a/Dalamud/Configuration/Internal/EnvironmentConfiguration.cs b/Dalamud/Configuration/Internal/EnvironmentConfiguration.cs index 11a8d3567..4b7e6dd3d 100644 --- a/Dalamud/Configuration/Internal/EnvironmentConfiguration.cs +++ b/Dalamud/Configuration/Internal/EnvironmentConfiguration.cs @@ -21,7 +21,7 @@ internal class EnvironmentConfiguration public static bool DalamudForceMinHook { get; } = GetEnvironmentVariable("DALAMUD_FORCE_MINHOOK"); /// - /// Gets a value indicating whether or not Dalamud context menus should be disabled. + /// Gets a value indicating whether Dalamud context menus should be disabled. /// public static bool DalamudDoContextMenu { get; } = GetEnvironmentVariable("DALAMUD_ENABLE_CONTEXTMENU"); diff --git a/Dalamud/Console/ConsoleEntry.cs b/Dalamud/Console/ConsoleEntry.cs index 93f250228..407411c6b 100644 --- a/Dalamud/Console/ConsoleEntry.cs +++ b/Dalamud/Console/ConsoleEntry.cs @@ -11,13 +11,13 @@ public interface IConsoleEntry /// Gets the name of the entry. /// public string Name { get; } - + /// /// Gets the description of the entry. /// public string Description { get; } } - + /// /// Interface representing a command in the console. /// @@ -27,7 +27,7 @@ public interface IConsoleCommand : IConsoleEntry /// Execute this command. /// /// Arguments to invoke the entry with. - /// Whether or not execution succeeded. + /// Whether execution succeeded. public bool Invoke(IEnumerable arguments); } diff --git a/Dalamud/Console/ConsoleManager.cs b/Dalamud/Console/ConsoleManager.cs index 4112cde2a..c79a104e1 100644 --- a/Dalamud/Console/ConsoleManager.cs +++ b/Dalamud/Console/ConsoleManager.cs @@ -18,9 +18,9 @@ namespace Dalamud.Console; internal partial class ConsoleManager : IServiceType { private static readonly ModuleLog Log = new("CON"); - + private Dictionary entries = new(); - + /// /// Initializes a new instance of the class. /// @@ -29,17 +29,17 @@ internal partial class ConsoleManager : IServiceType { this.AddCommand("toggle", "Toggle a boolean variable.", this.OnToggleVariable); } - + /// /// Event that is triggered when a command is processed. Return true to stop the command from being processed any further. /// public event Func? Invoke; - + /// /// Gets a read-only dictionary of console entries. /// public IReadOnlyDictionary Entries => this.entries; - + /// /// Add a command to the console. /// @@ -53,13 +53,13 @@ internal partial class ConsoleManager : IServiceType ArgumentNullException.ThrowIfNull(name); ArgumentNullException.ThrowIfNull(description); ArgumentNullException.ThrowIfNull(func); - + if (this.FindEntry(name) != null) throw new InvalidOperationException($"Entry '{name}' already exists."); var command = new ConsoleCommand(name, description, func); this.entries.Add(name, command); - + return command; } @@ -77,14 +77,14 @@ internal partial class ConsoleManager : IServiceType ArgumentNullException.ThrowIfNull(name); ArgumentNullException.ThrowIfNull(description); Traits.ThrowIfTIsNullableAndNull(defaultValue); - + if (this.FindEntry(name) != null) throw new InvalidOperationException($"Entry '{name}' already exists."); var variable = new ConsoleVariable(name, description); variable.Value = defaultValue; this.entries.Add(name, variable); - + return variable; } @@ -98,11 +98,11 @@ internal partial class ConsoleManager : IServiceType { ArgumentNullException.ThrowIfNull(name); ArgumentNullException.ThrowIfNull(alias); - + var target = this.FindEntry(name); if (target == null) throw new EntryNotFoundException(name); - + if (this.FindEntry(alias) != null) throw new InvalidOperationException($"Entry '{alias}' already exists."); @@ -135,21 +135,21 @@ internal partial class ConsoleManager : IServiceType public T GetVariable(string name) { ArgumentNullException.ThrowIfNull(name); - + var entry = this.FindEntry(name); - + if (entry is ConsoleVariable variable) return variable.Value; - + if (entry is ConsoleVariable) throw new InvalidOperationException($"Variable '{name}' is not of type {typeof(T).Name}."); - + if (entry is null) throw new EntryNotFoundException(name); - + throw new InvalidOperationException($"Command '{name}' is not a variable."); } - + /// /// Set the value of a variable. /// @@ -162,18 +162,18 @@ internal partial class ConsoleManager : IServiceType { ArgumentNullException.ThrowIfNull(name); Traits.ThrowIfTIsNullableAndNull(value); - + var entry = this.FindEntry(name); - + if (entry is ConsoleVariable variable) variable.Value = value; - + if (entry is ConsoleVariable) throw new InvalidOperationException($"Variable '{name}' is not of type {typeof(T).Name}."); if (entry is null) - throw new EntryNotFoundException(name); - + throw new EntryNotFoundException(name); + throw new InvalidOperationException($"Command '{name}' is not a variable."); } @@ -181,16 +181,16 @@ internal partial class ConsoleManager : IServiceType /// Process a console command. /// /// The command to process. - /// Whether or not the command was successfully processed. + /// Whether the command was successfully processed. public bool ProcessCommand(string command) { if (this.Invoke?.Invoke(command) == true) return true; - + var matches = GetCommandParsingRegex().Matches(command); if (matches.Count == 0) return false; - + var entryName = matches[0].Value; if (string.IsNullOrEmpty(entryName) || entryName.Any(char.IsWhiteSpace)) { @@ -204,7 +204,7 @@ internal partial class ConsoleManager : IServiceType Log.Error("Command {CommandName} not found", entryName); return false; } - + var parsedArguments = new List(); if (entry.ValidArguments != null) @@ -217,13 +217,13 @@ internal partial class ConsoleManager : IServiceType PrintUsage(entry); return false; } - + var argumentToMatch = entry.ValidArguments[i - 1]; - + var group = matches[i]; if (!group.Success) continue; - + var value = group.Value; if (string.IsNullOrEmpty(value)) continue; @@ -262,15 +262,15 @@ internal partial class ConsoleManager : IServiceType throw new Exception("Unhandled argument type."); } } - + if (parsedArguments.Count != entry.ValidArguments.Count) { // Either fill in the default values or error out - + for (var i = parsedArguments.Count; i < entry.ValidArguments.Count; i++) { var argument = entry.ValidArguments[i]; - + // If the default value is DBNull, we need to error out as that means it was not specified if (argument.DefaultValue == DBNull.Value) { @@ -281,7 +281,7 @@ internal partial class ConsoleManager : IServiceType parsedArguments.Add(argument.DefaultValue); } - + if (parsedArguments.Count != entry.ValidArguments.Count) { Log.Error("Too many arguments for command {CommandName}", entryName); @@ -302,20 +302,20 @@ internal partial class ConsoleManager : IServiceType return entry.Invoke(parsedArguments); } - + [GeneratedRegex("""("[^"]+"|[^\s"]+)""", RegexOptions.Compiled)] private static partial Regex GetCommandParsingRegex(); - + private static void PrintUsage(ConsoleEntry entry, bool error = true) { Log.WriteLog( - error ? LogEventLevel.Error : LogEventLevel.Information, + error ? LogEventLevel.Error : LogEventLevel.Information, "Usage: {CommandName} {Arguments}", null, entry.Name, string.Join(" ", entry.ValidArguments?.Select(x => $"<{x.Type.ToString().ToLowerInvariant()}>") ?? Enumerable.Empty())); } - + private ConsoleEntry? FindEntry(string name) { return this.entries.TryGetValue(name, out var entry) ? entry as ConsoleEntry : null; @@ -333,7 +333,7 @@ internal partial class ConsoleManager : IServiceType return true; } - + private static class Traits { public static void ThrowIfTIsNullableAndNull(T? argument, [CallerArgumentExpression("argument")] string? paramName = null) @@ -364,17 +364,17 @@ internal partial class ConsoleManager : IServiceType /// public string Description { get; } - + /// /// Gets or sets a list of valid argument types for this console entry. /// public IReadOnlyList? ValidArguments { get; protected set; } - + /// /// Execute this command. /// /// Arguments to invoke the entry with. - /// Whether or not execution succeeded. + /// Whether execution succeeded. public abstract bool Invoke(IEnumerable arguments); /// @@ -388,19 +388,19 @@ internal partial class ConsoleManager : IServiceType { if (type == typeof(string)) return new ArgumentInfo(ConsoleArgumentType.String, defaultValue); - + if (type == typeof(int)) return new ArgumentInfo(ConsoleArgumentType.Integer, defaultValue); - + if (type == typeof(float)) return new ArgumentInfo(ConsoleArgumentType.Float, defaultValue); - + if (type == typeof(bool)) return new ArgumentInfo(ConsoleArgumentType.Bool, defaultValue); - + throw new ArgumentException($"Invalid argument type: {type.Name}"); } - + public record ArgumentInfo(ConsoleArgumentType Type, object? DefaultValue); } @@ -436,7 +436,7 @@ internal partial class ConsoleManager : IServiceType private class ConsoleCommand : ConsoleEntry, IConsoleCommand { private readonly Delegate func; - + /// /// Initializes a new instance of the class. /// @@ -447,17 +447,17 @@ internal partial class ConsoleManager : IServiceType : base(name, description) { this.func = func; - + if (func.Method.ReturnType != typeof(bool)) throw new ArgumentException("Console command functions must return a boolean indicating success."); - + var validArguments = new List(); foreach (var parameterInfo in func.Method.GetParameters()) { var paraT = parameterInfo.ParameterType; validArguments.Add(TypeToArgument(paraT, parameterInfo.DefaultValue)); } - + this.ValidArguments = validArguments; } @@ -491,7 +491,7 @@ internal partial class ConsoleManager : IServiceType { this.ValidArguments = new List { TypeToArgument(typeof(T), null) }; } - + /// public T Value { get; set; } @@ -507,16 +507,16 @@ internal partial class ConsoleManager : IServiceType { this.Value = (T)(object)!boolValue; } - + Log.WriteLog(LogEventLevel.Information, "{VariableName} = {VariableValue}", null, this.Name, this.Value); return true; } - + if (first.GetType() != typeof(T)) throw new ArgumentException($"Console variable must be set with an argument of type {typeof(T).Name}."); this.Value = (T)first; - + return true; } } diff --git a/Dalamud/Game/Addon/Lifecycle/AddonSetupHook.cs b/Dalamud/Game/Addon/Lifecycle/AddonSetupHook.cs index aa684a644..297323b8f 100644 --- a/Dalamud/Game/Addon/Lifecycle/AddonSetupHook.cs +++ b/Dalamud/Game/Addon/Lifecycle/AddonSetupHook.cs @@ -11,7 +11,7 @@ namespace Dalamud.Game.Addon.Lifecycle; internal class AddonSetupHook : IDisposable where T : Delegate { private readonly Reloaded.Hooks.AsmHook asmHook; - + private T? detour; private bool activated; @@ -30,22 +30,22 @@ internal class AddonSetupHook : IDisposable where T : Delegate "use64", $"mov r9, 0x{detourPtr:X8}", }; - + var opt = new AsmHookOptions { PreferRelativeJump = true, Behaviour = Reloaded.Hooks.Definitions.Enums.AsmHookBehaviour.DoNotExecuteOriginal, MaxOpcodeSize = 5, }; - + this.asmHook = new Reloaded.Hooks.AsmHook(code, (nuint)address, opt); } /// - /// Gets a value indicating whether or not the hook is enabled. + /// Gets a value indicating whether the hook is enabled. /// public bool IsEnabled => this.asmHook.IsEnabled; - + /// /// Starts intercepting a call to the function. /// @@ -57,7 +57,7 @@ internal class AddonSetupHook : IDisposable where T : Delegate this.asmHook.Activate(); return; } - + this.asmHook.Enable(); } diff --git a/Dalamud/Game/ChatHandlers.cs b/Dalamud/Game/ChatHandlers.cs index 064667596..61cd88a05 100644 --- a/Dalamud/Game/ChatHandlers.cs +++ b/Dalamud/Game/ChatHandlers.cs @@ -43,7 +43,7 @@ internal partial class ChatHandlers : IServiceType public string? LastLink { get; private set; } /// - /// Gets a value indicating whether or not auto-updates have already completed this session. + /// Gets a value indicating whether auto-updates have already completed this session. /// public bool IsAutoUpdateComplete { get; private set; } diff --git a/Dalamud/Game/ClientState/Fates/Fate.cs b/Dalamud/Game/ClientState/Fates/Fate.cs index b81373144..de17478a0 100644 --- a/Dalamud/Game/ClientState/Fates/Fate.cs +++ b/Dalamud/Game/ClientState/Fates/Fate.cs @@ -70,13 +70,13 @@ public interface IFate : IEquatable byte Progress { get; } /// - /// Gets a value indicating whether or not this has a EXP bonus. + /// Gets a value indicating whether this has a EXP bonus. /// [Obsolete($"Use {nameof(HasBonus)} instead")] bool HasExpBonus { get; } /// - /// Gets a value indicating whether or not this has a bonus. + /// Gets a value indicating whether this has a bonus. /// bool HasBonus { get; } diff --git a/Dalamud/Game/ClientState/JobGauge/Types/BLMGauge.cs b/Dalamud/Game/ClientState/JobGauge/Types/BLMGauge.cs index c4058132a..ad0cdd9e1 100644 --- a/Dalamud/Game/ClientState/JobGauge/Types/BLMGauge.cs +++ b/Dalamud/Game/ClientState/JobGauge/Types/BLMGauge.cs @@ -45,19 +45,19 @@ public unsafe class BLMGauge : JobGaugeBase this.Struct->AstralSoulStacks; /// - /// Gets a value indicating whether or not the player is in Umbral Ice. + /// Gets a value indicating whether the player is in Umbral Ice. /// /// true or false. public bool InUmbralIce => this.Struct->ElementStance < 0; /// - /// Gets a value indicating whether or not the player is in Astral fire. + /// Gets a value indicating whether the player is in Astral fire. /// /// true or false. public bool InAstralFire => this.Struct->ElementStance > 0; /// - /// Gets a value indicating whether or not Enochian is active. + /// Gets a value indicating whether Enochian is active. /// /// true or false. public bool IsEnochianActive => this.Struct->EnochianActive; diff --git a/Dalamud/Game/ClientState/JobGauge/Types/PCTGauge.cs b/Dalamud/Game/ClientState/JobGauge/Types/PCTGauge.cs index db9d51dc4..d31a22702 100644 --- a/Dalamud/Game/ClientState/JobGauge/Types/PCTGauge.cs +++ b/Dalamud/Game/ClientState/JobGauge/Types/PCTGauge.cs @@ -14,7 +14,7 @@ public unsafe class PCTGauge : JobGaugeBase /// Initializes a new instance of the class. /// /// Address of the job gauge. - internal PCTGauge(IntPtr address) + internal PCTGauge(IntPtr address) : base(address) { } @@ -28,29 +28,29 @@ public unsafe class PCTGauge : JobGaugeBase /// Gets the amount of paint the player has. /// public byte Paint => Struct->Paint; - + /// - /// Gets a value indicating whether or not a creature motif is drawn. + /// Gets a value indicating whether a creature motif is drawn. /// public bool CreatureMotifDrawn => Struct->CreatureMotifDrawn; /// - /// Gets a value indicating whether or not a weapon motif is drawn. + /// Gets a value indicating whether a weapon motif is drawn. /// public bool WeaponMotifDrawn => Struct->WeaponMotifDrawn; /// - /// Gets a value indicating whether or not a landscape motif is drawn. + /// Gets a value indicating whether a landscape motif is drawn. /// public bool LandscapeMotifDrawn => Struct->LandscapeMotifDrawn; /// - /// Gets a value indicating whether or not a moogle portrait is ready. + /// Gets a value indicating whether a moogle portrait is ready. /// public bool MooglePortraitReady => Struct->MooglePortraitReady; - + /// - /// Gets a value indicating whether or not a madeen portrait is ready. + /// Gets a value indicating whether a madeen portrait is ready. /// public bool MadeenPortraitReady => Struct->MadeenPortraitReady; diff --git a/Dalamud/Game/ClientState/Objects/Enums/CustomizeIndex.cs b/Dalamud/Game/ClientState/Objects/Enums/CustomizeIndex.cs index 299583fd3..534ee6347 100644 --- a/Dalamud/Game/ClientState/Objects/Enums/CustomizeIndex.cs +++ b/Dalamud/Game/ClientState/Objects/Enums/CustomizeIndex.cs @@ -42,7 +42,7 @@ public enum CustomizeIndex HairStyle = 0x06, /// - /// Whether or not the character has hair highlights. + /// Whether the character has hair highlights. /// HasHighlights = 0x07, // negative to enable, positive to disable diff --git a/Dalamud/Game/Gui/Dtr/DtrBar.cs b/Dalamud/Game/Gui/Dtr/DtrBar.cs index c6208fb2f..6f3f9a8dd 100644 --- a/Dalamud/Game/Gui/Dtr/DtrBar.cs +++ b/Dalamud/Game/Gui/Dtr/DtrBar.cs @@ -269,7 +269,7 @@ internal sealed unsafe class DtrBar : IInternalDisposableService, IDtrBar /// Check whether an entry with the specified title exists. /// /// The title to check for. - /// Whether or not an entry with that title is registered. + /// Whether an entry with that title is registered. internal bool HasEntry(string title) { var found = false; diff --git a/Dalamud/Game/Gui/Dtr/DtrBarEntry.cs b/Dalamud/Game/Gui/Dtr/DtrBarEntry.cs index dc5f5f048..26708eb4c 100644 --- a/Dalamud/Game/Gui/Dtr/DtrBarEntry.cs +++ b/Dalamud/Game/Gui/Dtr/DtrBarEntry.cs @@ -39,7 +39,7 @@ public interface IReadOnlyDtrBarEntry public bool Shown { get; } /// - /// Gets a value indicating whether or not the user has hidden this entry from view through the Dalamud settings. + /// Gets a value indicating whether the user has hidden this entry from view through the Dalamud settings. /// public bool UserHidden { get; } diff --git a/Dalamud/Game/Gui/GameGui.cs b/Dalamud/Game/Gui/GameGui.cs index d3fe444ea..ada9021c4 100644 --- a/Dalamud/Game/Gui/GameGui.cs +++ b/Dalamud/Game/Gui/GameGui.cs @@ -75,7 +75,7 @@ internal sealed unsafe class GameGui : IInternalDisposableService, IGameGui } // Hooked delegates - + [UnmanagedFunctionPointer(CallingConvention.ThisCall)] private delegate char HandleImmDelegate(IntPtr framework, char a2, byte a3); @@ -259,7 +259,7 @@ internal sealed unsafe class GameGui : IInternalDisposableService, IGameGui /// /// Indicates if the game is in the lobby scene (title screen, chara select, chara make, aesthetician etc.). /// - /// A value indicating whether or not the game is in the lobby scene. + /// A value indicating whether the game is in the lobby scene. internal bool IsInLobby() => RaptureAtkModule.Instance()->CurrentUIScene.StartsWith("LobbyMain"u8); /// diff --git a/Dalamud/Game/Gui/NamePlate/NamePlateQuotedParts.cs b/Dalamud/Game/Gui/NamePlate/NamePlateQuotedParts.cs index a721015bb..0093a1b40 100644 --- a/Dalamud/Game/Gui/NamePlate/NamePlateQuotedParts.cs +++ b/Dalamud/Game/Gui/NamePlate/NamePlateQuotedParts.cs @@ -6,7 +6,7 @@ namespace Dalamud.Game.Gui.NamePlate; /// A part builder for constructing and setting quoted nameplate fields (i.e. free company tag and title). /// /// The field type which should be set. -/// Whether or not this is a Free Company part. +/// Whether this is a Free Company part. /// /// This class works as a lazy writer initialized with empty parts, where an empty part signifies no change should be /// performed. Only after all handler processing is complete does it write out any parts which were set to the diff --git a/Dalamud/Game/Network/Internal/MarketBoardUploaders/MarketBoardItemRequest.cs b/Dalamud/Game/Network/Internal/MarketBoardUploaders/MarketBoardItemRequest.cs index a32a92b13..9c566687a 100644 --- a/Dalamud/Game/Network/Internal/MarketBoardUploaders/MarketBoardItemRequest.cs +++ b/Dalamud/Game/Network/Internal/MarketBoardUploaders/MarketBoardItemRequest.cs @@ -21,7 +21,7 @@ internal class MarketBoardItemRequest public uint Status { get; private set; } /// - /// Gets a value indicating whether or not this request was successful. + /// Gets a value indicating whether this request was successful. /// public bool Ok => this.Status == 0; diff --git a/Dalamud/Game/Network/Internal/NetworkHandlers.cs b/Dalamud/Game/Network/Internal/NetworkHandlers.cs index c0929fa84..7d6304655 100644 --- a/Dalamud/Game/Network/Internal/NetworkHandlers.cs +++ b/Dalamud/Game/Network/Internal/NetworkHandlers.cs @@ -248,7 +248,7 @@ internal unsafe class NetworkHandlers : IInternalDisposableService /// /// Disposes of managed and unmanaged resources. /// - /// Whether or not to execute the disposal. + /// Whether to execute the disposal. protected void Dispose(bool shouldDispose) { if (!shouldDispose) diff --git a/Dalamud/Game/SigScanner.cs b/Dalamud/Game/SigScanner.cs index 3422848f3..5aaf17f12 100644 --- a/Dalamud/Game/SigScanner.cs +++ b/Dalamud/Game/SigScanner.cs @@ -31,7 +31,7 @@ public class SigScanner : IDisposable, ISigScanner /// /// Initializes a new instance of the class using the main module of the current process. /// - /// Whether or not to copy the module upon initialization for search operations to use, as to not get disturbed by possible hooks. + /// Whether to copy the module upon initialization for search operations to use, as to not get disturbed by possible hooks. /// File used to cached signatures. public SigScanner(bool doCopy = false, FileInfo? cacheFile = null) : this(Process.GetCurrentProcess().MainModule!, doCopy, cacheFile) @@ -42,7 +42,7 @@ public class SigScanner : IDisposable, ISigScanner /// Initializes a new instance of the class. /// /// The ProcessModule to be used for scanning. - /// Whether or not to copy the module upon initialization for search operations to use, as to not get disturbed by possible hooks. + /// Whether to copy the module upon initialization for search operations to use, as to not get disturbed by possible hooks. /// File used to cached signatures. public SigScanner(ProcessModule module, bool doCopy = false, FileInfo? cacheFile = null) { diff --git a/Dalamud/Game/TargetSigScanner.cs b/Dalamud/Game/TargetSigScanner.cs index 5c93fb4d4..f60c32d9a 100644 --- a/Dalamud/Game/TargetSigScanner.cs +++ b/Dalamud/Game/TargetSigScanner.cs @@ -19,7 +19,7 @@ internal class TargetSigScanner : SigScanner, IPublicDisposableService /// /// Initializes a new instance of the class. /// - /// Whether or not to copy the module upon initialization for search operations to use, as to not get disturbed by possible hooks. + /// Whether to copy the module upon initialization for search operations to use, as to not get disturbed by possible hooks. /// File used to cached signatures. public TargetSigScanner(bool doCopy = false, FileInfo? cacheFile = null) : base(Process.GetCurrentProcess().MainModule!, doCopy, cacheFile) diff --git a/Dalamud/Game/Text/SeStringHandling/Payloads/ItemPayload.cs b/Dalamud/Game/Text/SeStringHandling/Payloads/ItemPayload.cs index 56372e0f9..25cdf7f9f 100644 --- a/Dalamud/Game/Text/SeStringHandling/Payloads/ItemPayload.cs +++ b/Dalamud/Game/Text/SeStringHandling/Payloads/ItemPayload.cs @@ -31,7 +31,7 @@ public class ItemPayload : Payload /// Creates a payload representing an interactable item link for the specified item. /// /// The id of the item. - /// Whether or not the link should be for the high-quality variant of the item. + /// Whether the link should be for the high-quality variant of the item. /// An optional name to include in the item link. Typically this should /// be left as null, or set to the normal item name. Actual overrides are better done with the subsequent /// TextPayload that is a part of a full item link in chat. @@ -142,7 +142,7 @@ public class ItemPayload : Payload : (RowRef)LuminaUtils.CreateRef(this.ItemId); /// - /// Gets a value indicating whether or not this item link is for a high-quality version of the item. + /// Gets a value indicating whether this item link is for a high-quality version of the item. /// [JsonProperty] public bool IsHQ => this.Kind == ItemKind.Hq; diff --git a/Dalamud/Game/Text/SeStringHandling/Payloads/UIForegroundPayload.cs b/Dalamud/Game/Text/SeStringHandling/Payloads/UIForegroundPayload.cs index 8443e06ce..bf360ce34 100644 --- a/Dalamud/Game/Text/SeStringHandling/Payloads/UIForegroundPayload.cs +++ b/Dalamud/Game/Text/SeStringHandling/Payloads/UIForegroundPayload.cs @@ -46,7 +46,7 @@ public class UIForegroundPayload : Payload public override PayloadType Type => PayloadType.UIForeground; /// - /// Gets a value indicating whether or not this payload represents applying a foreground color, or disabling one. + /// Gets a value indicating whether this payload represents applying a foreground color, or disabling one. /// public bool IsEnabled => this.ColorKey != 0; diff --git a/Dalamud/Game/Text/SeStringHandling/Payloads/UIGlowPayload.cs b/Dalamud/Game/Text/SeStringHandling/Payloads/UIGlowPayload.cs index d22318378..e54427073 100644 --- a/Dalamud/Game/Text/SeStringHandling/Payloads/UIGlowPayload.cs +++ b/Dalamud/Game/Text/SeStringHandling/Payloads/UIGlowPayload.cs @@ -64,7 +64,7 @@ public class UIGlowPayload : Payload } /// - /// Gets a value indicating whether or not this payload represents applying a glow color, or disabling one. + /// Gets a value indicating whether this payload represents applying a glow color, or disabling one. /// public bool IsEnabled => this.ColorKey != 0; diff --git a/Dalamud/Game/Text/SeStringHandling/SeStringBuilder.cs b/Dalamud/Game/Text/SeStringHandling/SeStringBuilder.cs index e78ac2de8..d5080e6e8 100644 --- a/Dalamud/Game/Text/SeStringHandling/SeStringBuilder.cs +++ b/Dalamud/Game/Text/SeStringHandling/SeStringBuilder.cs @@ -113,7 +113,7 @@ public class SeStringBuilder /// Add an item link to the builder. /// /// The item ID. - /// Whether or not the item is high quality. + /// Whether the item is high quality. /// Override for the item's name. /// The current builder. public SeStringBuilder AddItemLink(uint itemId, bool isHq, string? itemNameOverride = null) => diff --git a/Dalamud/Hooking/AsmHook.cs b/Dalamud/Hooking/AsmHook.cs index f1ed7fd11..09ae336dc 100644 --- a/Dalamud/Hooking/AsmHook.cs +++ b/Dalamud/Hooking/AsmHook.cs @@ -20,7 +20,7 @@ public sealed class AsmHook : IDisposable, IDalamudHook private bool isEnabled = false; private DynamicMethod statsMethod; - + private Guid hookId = Guid.NewGuid(); /// @@ -89,7 +89,7 @@ public sealed class AsmHook : IDisposable, IDalamudHook } /// - /// Gets a value indicating whether or not the hook is enabled. + /// Gets a value indicating whether the hook is enabled. /// public bool IsEnabled { @@ -101,7 +101,7 @@ public sealed class AsmHook : IDisposable, IDalamudHook } /// - /// Gets a value indicating whether or not the hook has been disposed. + /// Gets a value indicating whether the hook has been disposed. /// public bool IsDisposed { get; private set; } diff --git a/Dalamud/Hooking/Hook.cs b/Dalamud/Hooking/Hook.cs index 20796bbf0..1a492146f 100644 --- a/Dalamud/Hooking/Hook.cs +++ b/Dalamud/Hooking/Hook.cs @@ -59,23 +59,23 @@ public abstract class Hook : IDalamudHook where T : Delegate => this.IsDisposed ? Marshal.GetDelegateForFunctionPointer(this.address) : this.Original; /// - /// Gets a value indicating whether or not the hook is enabled. + /// Gets a value indicating whether the hook is enabled. /// public virtual bool IsEnabled => throw new NotImplementedException(); /// - /// Gets a value indicating whether or not the hook has been disposed. + /// Gets a value indicating whether the hook has been disposed. /// public bool IsDisposed { get; private set; } /// public virtual string BackendName => throw new NotImplementedException(); - + /// /// Gets the unique GUID for this hook. /// protected Guid HookId { get; } = Guid.NewGuid(); - + /// /// Remove a hook from the current process. /// diff --git a/Dalamud/Hooking/IDalamudHook.cs b/Dalamud/Hooking/IDalamudHook.cs index bffca242e..5ced572c0 100644 --- a/Dalamud/Hooking/IDalamudHook.cs +++ b/Dalamud/Hooking/IDalamudHook.cs @@ -11,12 +11,12 @@ public interface IDalamudHook : IDisposable public IntPtr Address { get; } /// - /// Gets a value indicating whether or not the hook is enabled. + /// Gets a value indicating whether the hook is enabled. /// public bool IsEnabled { get; } /// - /// Gets a value indicating whether or not the hook is disposed. + /// Gets a value indicating whether the hook is disposed. /// public bool IsDisposed { get; } diff --git a/Dalamud/Hooking/Internal/CallHook.cs b/Dalamud/Hooking/Internal/CallHook.cs index 5b438b5a8..92bc6e31a 100644 --- a/Dalamud/Hooking/Internal/CallHook.cs +++ b/Dalamud/Hooking/Internal/CallHook.cs @@ -53,7 +53,7 @@ internal class CallHook : IDalamudHook where T : Delegate } /// - /// Gets a value indicating whether or not the hook is enabled. + /// Gets a value indicating whether the hook is enabled. /// public bool IsEnabled => this.asmHook.IsEnabled; diff --git a/Dalamud/Interface/Animation/Easing.cs b/Dalamud/Interface/Animation/Easing.cs index 8191487f4..0d2057b3b 100644 --- a/Dalamud/Interface/Animation/Easing.cs +++ b/Dalamud/Interface/Animation/Easing.cs @@ -85,12 +85,12 @@ public abstract class Easing public TimeSpan Duration { get; set; } /// - /// Gets a value indicating whether or not the animation is running. + /// Gets a value indicating whether the animation is running. /// public bool IsRunning => this.animationTimer.IsRunning; /// - /// Gets a value indicating whether or not the animation is done. + /// Gets a value indicating whether the animation is done. /// public bool IsDone => this.animationTimer.ElapsedMilliseconds > this.Duration.TotalMilliseconds; diff --git a/Dalamud/Interface/ImGuiFileDialog/DriveListLoader.cs b/Dalamud/Interface/ImGuiFileDialog/DriveListLoader.cs index 487a08132..6998e2ef0 100644 --- a/Dalamud/Interface/ImGuiFileDialog/DriveListLoader.cs +++ b/Dalamud/Interface/ImGuiFileDialog/DriveListLoader.cs @@ -23,7 +23,7 @@ internal class DriveListLoader public IReadOnlyList Drives { get; private set; } /// - /// Gets a value indicating whether or not the loader is loading. + /// Gets a value indicating whether the loader is loading. /// public bool Loading { get; private set; } diff --git a/Dalamud/Interface/Internal/DalamudInterface.cs b/Dalamud/Interface/Internal/DalamudInterface.cs index f010e3496..8ba579d17 100644 --- a/Dalamud/Interface/Internal/DalamudInterface.cs +++ b/Dalamud/Interface/Internal/DalamudInterface.cs @@ -521,7 +521,7 @@ internal class DalamudInterface : IInternalDisposableService /// /// Toggle the screen darkening effect used for the credits. /// - /// Whether or not to turn the effect on. + /// Whether to turn the effect on. public void SetCreditsDarkeningAnimation(bool status) { this.isCreditsDarkening = status; diff --git a/Dalamud/Interface/Internal/InterfaceManager.cs b/Dalamud/Interface/Internal/InterfaceManager.cs index 786bc4589..ec175c5aa 100644 --- a/Dalamud/Interface/Internal/InterfaceManager.cs +++ b/Dalamud/Interface/Internal/InterfaceManager.cs @@ -212,7 +212,7 @@ internal partial class InterfaceManager : IInternalDisposableService public IntPtr WindowHandlePtr => this.scene?.WindowHandlePtr ?? IntPtr.Zero; /// - /// Gets or sets a value indicating whether or not the game's cursor should be overridden with the ImGui cursor. + /// Gets or sets a value indicating whether the game's cursor should be overridden with the ImGui cursor. /// public bool OverrideGameCursor { @@ -231,7 +231,7 @@ internal partial class InterfaceManager : IInternalDisposableService public bool IsReady => this.scene != null; /// - /// Gets or sets a value indicating whether or not Draw events should be dispatched. + /// Gets or sets a value indicating whether Draw events should be dispatched. /// public bool IsDispatchingEvents { get; set; } = true; diff --git a/Dalamud/Interface/Internal/Windows/SelfTest/Steps/LuminaSelfTestStep.cs b/Dalamud/Interface/Internal/Windows/SelfTest/Steps/LuminaSelfTestStep.cs index 3fbc4361f..ff9649a14 100644 --- a/Dalamud/Interface/Internal/Windows/SelfTest/Steps/LuminaSelfTestStep.cs +++ b/Dalamud/Interface/Internal/Windows/SelfTest/Steps/LuminaSelfTestStep.cs @@ -8,7 +8,7 @@ namespace Dalamud.Interface.Internal.Windows.SelfTest.Steps; /// Test setup for Lumina. /// /// ExcelRow to run test on. -/// Whether or not the sheet is large. If it is large, the self test will iterate through the full sheet in one frame and benchmark the time taken. +/// Whether the sheet is large. If it is large, the self test will iterate through the full sheet in one frame and benchmark the time taken. internal class LuminaSelfTestStep(bool isLargeSheet) : ISelfTestStep where T : struct, IExcelRow { diff --git a/Dalamud/Interface/Internal/Windows/Settings/SettingsEntry.cs b/Dalamud/Interface/Internal/Windows/Settings/SettingsEntry.cs index 46013b72c..4cb239da3 100644 --- a/Dalamud/Interface/Internal/Windows/Settings/SettingsEntry.cs +++ b/Dalamud/Interface/Internal/Windows/Settings/SettingsEntry.cs @@ -11,12 +11,12 @@ public abstract class SettingsEntry public string? Name { get; protected set; } /// - /// Gets or sets a value indicating whether or not this entry is valid. + /// Gets or sets a value indicating whether this entry is valid. /// public virtual bool IsValid { get; protected set; } = true; /// - /// Gets or sets a value indicating whether or not this entry is visible. + /// Gets or sets a value indicating whether this entry is visible. /// public virtual bool IsVisible { get; protected set; } = true; @@ -54,7 +54,7 @@ public abstract class SettingsEntry { // ignored } - + /// /// Function to be called when the tab is closed. /// diff --git a/Dalamud/Interface/TitleScreenMenu/TitleScreenMenuEntry.cs b/Dalamud/Interface/TitleScreenMenu/TitleScreenMenuEntry.cs index a98d32770..1596db447 100644 --- a/Dalamud/Interface/TitleScreenMenu/TitleScreenMenuEntry.cs +++ b/Dalamud/Interface/TitleScreenMenu/TitleScreenMenuEntry.cs @@ -14,7 +14,7 @@ namespace Dalamud.Interface; public interface ITitleScreenMenuEntry : IReadOnlyTitleScreenMenuEntry, IComparable { /// - /// Gets or sets a value indicating whether or not this entry is internal. + /// Gets or sets a value indicating whether this entry is internal. /// bool IsInternal { get; set; } diff --git a/Dalamud/Interface/UiBuilder.cs b/Dalamud/Interface/UiBuilder.cs index 2fc8c83b1..abe6bd87b 100644 --- a/Dalamud/Interface/UiBuilder.cs +++ b/Dalamud/Interface/UiBuilder.cs @@ -147,7 +147,7 @@ public interface IUiBuilder bool DisableGposeUiHide { get; set; } /// - /// Gets or sets a value indicating whether or not the game's cursor should be overridden with the ImGui cursor. + /// Gets or sets a value indicating whether the game's cursor should be overridden with the ImGui cursor. /// bool OverrideGameCursor { get; set; } @@ -157,7 +157,7 @@ public interface IUiBuilder ulong FrameCount { get; } /// - /// Gets a value indicating whether or not a cutscene is playing. + /// Gets a value indicating whether a cutscene is playing. /// bool CutsceneActive { get; } @@ -177,7 +177,7 @@ public interface IUiBuilder IFontAtlas FontAtlas { get; } /// - /// Gets a value indicating whether or not to use "reduced motion". This usually means that you should use less + /// Gets a value indicating whether to use "reduced motion". This usually means that you should use less /// intrusive animations, or disable them entirely. /// bool ShouldUseReducedMotion { get; } @@ -445,7 +445,7 @@ public sealed class UiBuilder : IDisposable, IUiBuilder public bool DisableGposeUiHide { get; set; } = false; /// - /// Gets or sets a value indicating whether or not the game's cursor should be overridden with the ImGui cursor. + /// Gets or sets a value indicating whether the game's cursor should be overridden with the ImGui cursor. /// public bool OverrideGameCursor { @@ -459,7 +459,7 @@ public sealed class UiBuilder : IDisposable, IUiBuilder public ulong FrameCount { get; private set; } = 0; /// - /// Gets a value indicating whether or not a cutscene is playing. + /// Gets a value indicating whether a cutscene is playing. /// public bool CutsceneActive { @@ -489,7 +489,7 @@ public sealed class UiBuilder : IDisposable, IUiBuilder public IFontAtlas FontAtlas { get; } /// - /// Gets a value indicating whether or not to use "reduced motion". This usually means that you should use less + /// Gets a value indicating whether to use "reduced motion". This usually means that you should use less /// intrusive animations, or disable them entirely. /// public bool ShouldUseReducedMotion => Service.Get().ReduceMotions ?? false; diff --git a/Dalamud/Interface/Windowing/Window.cs b/Dalamud/Interface/Windowing/Window.cs index b3a505c1d..7779100b0 100644 --- a/Dalamud/Interface/Windowing/Window.cs +++ b/Dalamud/Interface/Windowing/Window.cs @@ -150,7 +150,7 @@ public abstract class Window public WindowSizeConstraints? SizeConstraints { get; set; } /// - /// Gets or sets a value indicating whether or not this window is collapsed. + /// Gets or sets a value indicating whether this window is collapsed. /// public bool? Collapsed { get; set; } @@ -165,7 +165,7 @@ public abstract class Window public ImGuiWindowFlags Flags { get; set; } /// - /// Gets or sets a value indicating whether or not this ImGui window will be forced to stay inside the main game window. + /// Gets or sets a value indicating whether this ImGui window will be forced to stay inside the main game window. /// public bool ForceMainWindow { get; set; } @@ -175,17 +175,17 @@ public abstract class Window public float? BgAlpha { get; set; } /// - /// Gets or sets a value indicating whether or not this ImGui window should display a close button in the title bar. + /// Gets or sets a value indicating whether this ImGui window should display a close button in the title bar. /// public bool ShowCloseButton { get; set; } = true; /// - /// Gets or sets a value indicating whether or not this window should offer to be pinned via the window's titlebar context menu. + /// Gets or sets a value indicating whether this window should offer to be pinned via the window's titlebar context menu. /// public bool AllowPinning { get; set; } = true; /// - /// Gets or sets a value indicating whether or not this window should offer to be made click-through via the window's titlebar context menu. + /// Gets or sets a value indicating whether this window should offer to be made click-through via the window's titlebar context menu. /// public bool AllowClickthrough { get; set; } = true; @@ -199,7 +199,7 @@ public abstract class Window public List TitleBarButtons { get; set; } = new(); /// - /// Gets or sets a value indicating whether or not this window will stay open. + /// Gets or sets a value indicating whether this window will stay open. /// public bool IsOpen { @@ -804,7 +804,7 @@ public abstract class Window public int Priority { get; set; } /// - /// Gets or sets a value indicating whether or not the button shall be clickable + /// Gets or sets a value indicating whether the button shall be clickable /// when the respective window is set to clickthrough. /// public bool AvailableClickthrough { get; set; } diff --git a/Dalamud/Logging/Internal/TaskTracker.cs b/Dalamud/Logging/Internal/TaskTracker.cs index b45ed82d6..cb9a0db6d 100644 --- a/Dalamud/Logging/Internal/TaskTracker.cs +++ b/Dalamud/Logging/Internal/TaskTracker.cs @@ -200,22 +200,22 @@ internal class TaskTracker : IInternalDisposableService public StackTrace? StackTrace { get; set; } /// - /// Gets or sets a value indicating whether or not the task was completed. + /// Gets or sets a value indicating whether the task was completed. /// public bool IsCompleted { get; set; } /// - /// Gets or sets a value indicating whether or not the task faulted. + /// Gets or sets a value indicating whether the task faulted. /// public bool IsFaulted { get; set; } /// - /// Gets or sets a value indicating whether or not the task was canceled. + /// Gets or sets a value indicating whether the task was canceled. /// public bool IsCanceled { get; set; } /// - /// Gets or sets a value indicating whether or not the task was completed successfully. + /// Gets or sets a value indicating whether the task was completed successfully. /// public bool IsCompletedSuccessfully { get; set; } diff --git a/Dalamud/NativeFunctions.cs b/Dalamud/NativeFunctions.cs index 32ab99372..c9382bd17 100644 --- a/Dalamud/NativeFunctions.cs +++ b/Dalamud/NativeFunctions.cs @@ -835,7 +835,7 @@ internal static partial class NativeFunctions SPI_GETCLIENTAREAANIMATION = 0x1042, #pragma warning restore SA1602 } - + /// /// Retrieves or sets the value of one of the system-wide parameters. This function can also update the user profile while setting a parameter. /// @@ -1428,18 +1428,18 @@ internal static partial class NativeFunctions /// created with this option cannot be locked. /// NoSerialize = 0x00000001, - + /// /// The system raises an exception to indicate failure (for example, an out-of-memory condition) for calls to /// HeapAlloc and HeapReAlloc instead of returning NULL. /// GenerateExceptions = 0x00000004, - + /// /// The allocated memory will be initialized to zero. Otherwise, the memory is not initialized to zero. /// ZeroMemory = 0x00000008, - + /// /// All memory blocks that are allocated from this heap allow code execution, if the hardware enforces data /// execution prevention. Use this flag heap in applications that run code from the heap. If @@ -1701,7 +1701,7 @@ internal static partial class NativeFunctions /// /// This value determines the initial amount of memory that is committed for the heap. /// The value is rounded up to a multiple of the system page size. The value must be smaller than dwMaximumSize. - /// + /// /// If this parameter is 0, the function commits one page. To determine the size of a page on the host computer, /// use the GetSystemInfo function. /// @@ -1710,12 +1710,12 @@ internal static partial class NativeFunctions /// system page size and then reserves a block of that size in the process's virtual address space for the heap. /// If allocation requests made by the HeapAlloc or HeapReAlloc functions exceed the size specified by /// dwInitialSize, the system commits additional pages of memory for the heap, up to the heap's maximum size. - /// + /// /// If dwMaximumSize is not zero, the heap size is fixed and cannot grow beyond the maximum size. Also, the largest /// memory block that can be allocated from the heap is slightly less than 512 KB for a 32-bit process and slightly /// less than 1,024 KB for a 64-bit process. Requests to allocate larger blocks fail, even if the maximum size of /// the heap is large enough to contain the block. - /// + /// /// If dwMaximumSize is 0, the heap can grow in size. The heap's size is limited only by the available memory. /// Requests to allocate memory blocks larger than the limit for a fixed-size heap do not automatically fail; /// instead, the system calls the VirtualAlloc function to obtain the memory that is needed for large blocks. @@ -1723,12 +1723,12 @@ internal static partial class NativeFunctions /// /// /// If the function succeeds, the return value is a handle to the newly created heap. - /// + /// /// If the function fails, the return value is NULL. To get extended error information, call GetLastError. /// [DllImport("kernel32.dll", SetLastError = true)] public static extern nint HeapCreate(HeapOptions flOptions, nuint dwInitialSize, nuint dwMaximumSize); - + /// /// Allocates a block of memory from a heap. The allocated memory is not movable. /// @@ -1756,7 +1756,7 @@ internal static partial class NativeFunctions /// [DllImport("kernel32.dll", SetLastError=false)] public static extern nint HeapAlloc(nint hHeap, HeapOptions dwFlags, nuint dwBytes); - + /// /// See https://docs.microsoft.com/en-us/windows/win32/api/memoryapi/nf-memoryapi-virtualalloc. /// Reserves, commits, or changes the state of a region of pages in the virtual address space of the calling process. @@ -1987,7 +1987,7 @@ internal static partial class NativeFunctions /// /// If this value is , enumerates the loaded modules for the process and effectively calls the SymLoadModule64 function for each module. /// - /// Whether or not the function succeeded. + /// Whether the function succeeded. [DllImport("dbghelp.dll", SetLastError = true, CharSet = CharSet.Auto)] public static extern bool SymInitialize(IntPtr hProcess, string userSearchPath, bool fInvadeProcess); @@ -1995,7 +1995,7 @@ internal static partial class NativeFunctions /// Deallocates all resources associated with the process handle. /// /// A handle to the process that was originally passed to the function. - /// Whether or not the function succeeded. + /// Whether the function succeeded. [DllImport("dbghelp.dll", SetLastError = true, CharSet = CharSet.Auto)] public static extern bool SymCleanup(IntPtr hProcess); @@ -2009,7 +2009,7 @@ internal static partial class NativeFunctions /// Exception information. /// User information. /// Callback. - /// Whether or not the minidump succeeded. + /// Whether the minidump succeeded. [DllImport("dbghelp.dll")] public static extern bool MiniDumpWriteDump(IntPtr hProcess, uint processId, IntPtr hFile, int dumpType, ref MinidumpExceptionInformation exceptionInfo, IntPtr userStreamParam, IntPtr callback); diff --git a/Dalamud/Plugin/DalamudPluginInterface.cs b/Dalamud/Plugin/DalamudPluginInterface.cs index d5cf360af..5dac85164 100644 --- a/Dalamud/Plugin/DalamudPluginInterface.cs +++ b/Dalamud/Plugin/DalamudPluginInterface.cs @@ -100,7 +100,7 @@ internal sealed class DalamudPluginInterface : IDalamudPluginInterface, IDisposa public PluginLoadReason Reason { get; } /// - /// Gets a value indicating whether or not auto-updates have already completed this session. + /// Gets a value indicating whether auto-updates have already completed this session. /// public bool IsAutoUpdateComplete => Service.Get().IsAutoUpdateComplete; diff --git a/Dalamud/Plugin/IDalamudPluginInterface.cs b/Dalamud/Plugin/IDalamudPluginInterface.cs index 100d4570e..5b7c3836e 100644 --- a/Dalamud/Plugin/IDalamudPluginInterface.cs +++ b/Dalamud/Plugin/IDalamudPluginInterface.cs @@ -35,7 +35,7 @@ public interface IDalamudPluginInterface /// What action caused this event to be fired. /// If this plugin was affected by the change. public delegate void ActivePluginsChangedDelegate(PluginListInvalidationKind kind, bool affectedThisPlugin); - + /// /// Event that gets fired when loc is changed /// @@ -52,7 +52,7 @@ public interface IDalamudPluginInterface PluginLoadReason Reason { get; } /// - /// Gets a value indicating whether or not auto-updates have already completed this session. + /// Gets a value indicating whether auto-updates have already completed this session. /// bool IsAutoUpdateComplete { get; } diff --git a/Dalamud/Plugin/InstalledPluginState.cs b/Dalamud/Plugin/InstalledPluginState.cs index 64c8e40a5..1c79e33f0 100644 --- a/Dalamud/Plugin/InstalledPluginState.cs +++ b/Dalamud/Plugin/InstalledPluginState.cs @@ -34,12 +34,12 @@ public interface IExposedPlugin bool IsTesting { get; } /// - /// Gets a value indicating whether or not this plugin is orphaned(belongs to a repo) or not. + /// Gets a value indicating whether this plugin is orphaned(belongs to a repo) or not. /// bool IsOrphaned { get; } /// - /// Gets a value indicating whether or not this plugin is serviced(repo still exists, but plugin no longer does). + /// Gets a value indicating whether this plugin is serviced(repo still exists, but plugin no longer does). /// bool IsDecommissioned { get; } diff --git a/Dalamud/Plugin/Internal/AutoUpdate/AutoUpdateManager.cs b/Dalamud/Plugin/Internal/AutoUpdate/AutoUpdateManager.cs index d40184a76..adec4f73d 100644 --- a/Dalamud/Plugin/Internal/AutoUpdate/AutoUpdateManager.cs +++ b/Dalamud/Plugin/Internal/AutoUpdate/AutoUpdateManager.cs @@ -131,7 +131,7 @@ internal class AutoUpdateManager : IServiceType } /// - /// Gets a value indicating whether or not auto-updates have already completed this session. + /// Gets a value indicating whether auto-updates have already completed this session. /// public bool IsAutoUpdateComplete { get; private set; } diff --git a/Dalamud/Plugin/Internal/PluginManager.cs b/Dalamud/Plugin/Internal/PluginManager.cs index 28fc1fcb1..e8283dd8f 100644 --- a/Dalamud/Plugin/Internal/PluginManager.cs +++ b/Dalamud/Plugin/Internal/PluginManager.cs @@ -284,7 +284,7 @@ internal class PluginManager : IInternalDisposableService /// Check if a manifest even has an available testing version. /// /// The manifest to test. - /// Whether or not a testing version is available. + /// Whether a testing version is available. public static bool HasTestingVersion(IPluginManifest manifest) { var av = manifest.AssemblyVersion; @@ -1037,7 +1037,7 @@ internal class PluginManager : IInternalDisposableService /// /// The available plugin update. /// Whether to notify that installed plugins have changed afterwards. - /// Whether or not to actually perform the update, or just indicate success. + /// Whether to actually perform the update, or just indicate success. /// The status of the update. public async Task UpdateSinglePluginAsync(AvailablePluginUpdate metadata, bool notify, bool dryRun) { diff --git a/Dalamud/Plugin/Internal/Profiles/Profile.cs b/Dalamud/Plugin/Internal/Profiles/Profile.cs index 9039004ab..edbeabfac 100644 --- a/Dalamud/Plugin/Internal/Profiles/Profile.cs +++ b/Dalamud/Plugin/Internal/Profiles/Profile.cs @@ -24,8 +24,8 @@ internal class Profile /// /// The manager this profile belongs to. /// The model this profile is tied to. - /// Whether or not this profile is the default profile. - /// Whether or not this profile was initialized during bootup. + /// Whether this profile is the default profile. + /// Whether this profile was initialized during bootup. public Profile(ProfileManager manager, ProfileModel model, bool isDefaultProfile, bool isBoot) { this.manager = manager; @@ -108,12 +108,12 @@ internal class Profile public Guid Guid => this.modelV1.Guid; /// - /// Gets a value indicating whether or not this profile is currently enabled. + /// Gets a value indicating whether this profile is currently enabled. /// public bool IsEnabled { get; private set; } /// - /// Gets a value indicating whether or not this profile is the default profile. + /// Gets a value indicating whether this profile is the default profile. /// public bool IsDefaultProfile { get; } @@ -139,8 +139,8 @@ internal class Profile /// Set this profile's state. This cannot be called for the default profile. /// This will block until all states have been applied. /// - /// Whether or not the profile is enabled. - /// Whether or not the current state should immediately be applied. + /// Whether the profile is enabled. + /// Whether the current state should immediately be applied. /// Thrown when an untoggleable profile is toggled. /// A representing the asynchronous operation. public async Task SetStateAsync(bool enabled, bool apply = true) @@ -178,8 +178,8 @@ internal class Profile /// /// The ID of the plugin. /// The internal name of the plugin, if available. - /// Whether or not the plugin should be enabled. - /// Whether or not the current state should immediately be applied. + /// Whether the plugin should be enabled. + /// Whether the current state should immediately be applied. /// A representing the asynchronous operation. public async Task AddOrUpdateAsync(Guid workingPluginId, string? internalName, bool state, bool apply = true) { @@ -223,9 +223,9 @@ internal class Profile /// This will block until all states have been applied. /// /// The ID of the plugin. - /// Whether or not the current state should immediately be applied. + /// Whether the current state should immediately be applied. /// - /// Whether or not to throw when a plugin is removed from the default profile, without being in another profile. + /// Whether to throw when a plugin is removed from the default profile, without being in another profile. /// Used to prevent orphan plugins, but can be ignored when cleaning up old entries. /// /// A representing the asynchronous operation. diff --git a/Dalamud/Plugin/Internal/Profiles/ProfileManager.cs b/Dalamud/Plugin/Internal/Profiles/ProfileManager.cs index 8a1711b0d..82c72ebef 100644 --- a/Dalamud/Plugin/Internal/Profiles/ProfileManager.cs +++ b/Dalamud/Plugin/Internal/Profiles/ProfileManager.cs @@ -54,7 +54,7 @@ internal class ProfileManager : IServiceType public IEnumerable Profiles => this.profiles; /// - /// Gets a value indicating whether or not the profile manager is busy enabling/disabling plugins. + /// Gets a value indicating whether the profile manager is busy enabling/disabling plugins. /// public bool IsBusy => this.isBusy; @@ -71,8 +71,8 @@ internal class ProfileManager : IServiceType /// The ID of the plugin. /// The internal name of the plugin, if available. /// The state the plugin shall be in, if it needs to be added. - /// Whether or not the plugin should be added to the default preset, if it's not present in any preset. - /// Whether or not the plugin shall be enabled. + /// Whether the plugin should be added to the default preset, if it's not present in any preset. + /// Whether the plugin shall be enabled. public async Task GetWantStateAsync(Guid workingPluginId, string? internalName, bool defaultState, bool addIfNotDeclared = true) { var want = false; @@ -106,7 +106,7 @@ internal class ProfileManager : IServiceType /// Check whether a plugin is declared in any profile. /// /// The ID of the plugin. - /// Whether or not the plugin is in any profile. + /// Whether the plugin is in any profile. public bool IsInAnyProfile(Guid workingPluginId) { lock (this.profiles) @@ -118,7 +118,7 @@ internal class ProfileManager : IServiceType /// A plugin can never be in the default profile if it is in any other profile. /// /// The ID of the plugin. - /// Whether or not the plugin is in the default profile. + /// Whether the plugin is in the default profile. public bool IsInDefaultProfile(Guid workingPluginId) => this.DefaultProfile.WantsPlugin(workingPluginId) != null; diff --git a/Dalamud/Plugin/Internal/Profiles/ProfileModelV1.cs b/Dalamud/Plugin/Internal/Profiles/ProfileModelV1.cs index 62d0de70c..a1a327c1d 100644 --- a/Dalamud/Plugin/Internal/Profiles/ProfileModelV1.cs +++ b/Dalamud/Plugin/Internal/Profiles/ProfileModelV1.cs @@ -36,7 +36,7 @@ public class ProfileModelV1 : ProfileModel public static string SerializedPrefix => "DP1"; /// - /// Gets or sets a value indicating whether or not this profile should always be enabled at boot. + /// Gets or sets a value indicating whether this profile should always be enabled at boot. /// [JsonProperty("b")] [Obsolete("Superseded by StartupPolicy")] @@ -49,7 +49,7 @@ public class ProfileModelV1 : ProfileModel public ProfileStartupPolicy? StartupPolicy { get; set; } /// - /// Gets or sets a value indicating whether or not this profile is currently enabled. + /// Gets or sets a value indicating whether this profile is currently enabled. /// [JsonProperty("e")] public bool IsEnabled { get; set; } = false; @@ -81,7 +81,7 @@ public class ProfileModelV1 : ProfileModel public Guid WorkingPluginId { get; set; } /// - /// Gets or sets a value indicating whether or not this entry is enabled. + /// Gets or sets a value indicating whether this entry is enabled. /// public bool IsEnabled { get; set; } } diff --git a/Dalamud/Plugin/Internal/Profiles/ProfilePluginEntry.cs b/Dalamud/Plugin/Internal/Profiles/ProfilePluginEntry.cs index 7909981bc..a2805ff6e 100644 --- a/Dalamud/Plugin/Internal/Profiles/ProfilePluginEntry.cs +++ b/Dalamud/Plugin/Internal/Profiles/ProfilePluginEntry.cs @@ -10,7 +10,7 @@ internal class ProfilePluginEntry /// /// The internal name of the plugin. /// The ID of the plugin. - /// A value indicating whether or not this entry is enabled. + /// A value indicating whether this entry is enabled. public ProfilePluginEntry(string internalName, Guid workingPluginId, bool state) { this.InternalName = internalName; @@ -22,14 +22,14 @@ internal class ProfilePluginEntry /// Gets the internal name of the plugin. /// public string InternalName { get; } - + /// /// Gets or sets an ID uniquely identifying this specific instance of a plugin. /// public Guid WorkingPluginId { get; set; } /// - /// Gets a value indicating whether or not this entry is enabled. + /// Gets a value indicating whether this entry is enabled. /// public bool IsEnabled { get; } } diff --git a/Dalamud/Plugin/Internal/Types/LocalPlugin.cs b/Dalamud/Plugin/Internal/Types/LocalPlugin.cs index 144e09b47..6478a5bb5 100644 --- a/Dalamud/Plugin/Internal/Types/LocalPlugin.cs +++ b/Dalamud/Plugin/Internal/Types/LocalPlugin.cs @@ -178,13 +178,13 @@ internal class LocalPlugin : IAsyncDisposable public bool IsTesting => this.manifest.IsTestingExclusive || this.manifest.Testing; /// - /// Gets a value indicating whether or not this plugin is orphaned(belongs to a repo) or not. + /// Gets a value indicating whether this plugin is orphaned(belongs to a repo) or not. /// public bool IsOrphaned => !this.IsDev && this.GetSourceRepository() == null; /// - /// Gets a value indicating whether or not this plugin is serviced(repo still exists, but plugin no longer does). + /// Gets a value indicating whether this plugin is serviced(repo still exists, but plugin no longer does). /// public bool IsDecommissioned => !this.IsDev && this.GetSourceRepository()?.State == PluginRepositoryState.Success && @@ -499,7 +499,7 @@ internal class LocalPlugin : IAsyncDisposable /// /// Check if anything forbids this plugin from loading. /// - /// Whether or not this plugin shouldn't load. + /// Whether this plugin shouldn't load. public bool CheckPolicy() { var startInfo = Service.Get().StartInfo; diff --git a/Dalamud/Plugin/Internal/Types/PluginManifest.cs b/Dalamud/Plugin/Internal/Types/PluginManifest.cs index 01951c8a6..c9c231b4d 100644 --- a/Dalamud/Plugin/Internal/Types/PluginManifest.cs +++ b/Dalamud/Plugin/Internal/Types/PluginManifest.cs @@ -42,7 +42,7 @@ internal record PluginManifest : IPluginManifest public List? CategoryTags { get; init; } /// - /// Gets or sets a value indicating whether or not the plugin is hidden in the plugin installer. + /// Gets or sets a value indicating whether the plugin is hidden in the plugin installer. /// This value comes from the plugin master and is in addition to the list of hidden names kept by Dalamud. /// [JsonProperty] diff --git a/Dalamud/Plugin/Services/IClientState.cs b/Dalamud/Plugin/Services/IClientState.cs index bac2b3e3f..60d8a17e2 100644 --- a/Dalamud/Plugin/Services/IClientState.cs +++ b/Dalamud/Plugin/Services/IClientState.cs @@ -79,7 +79,7 @@ public interface IClientState /// Gets the current Territory the player resides in. /// public ushort TerritoryType { get; } - + /// /// Gets the current Map the player resides in. /// @@ -101,17 +101,17 @@ public interface IClientState public bool IsLoggedIn { get; } /// - /// Gets a value indicating whether or not the user is playing PvP. + /// Gets a value indicating whether the user is playing PvP. /// public bool IsPvP { get; } /// - /// Gets a value indicating whether or not the user is playing PvP, excluding the Wolves' Den. + /// Gets a value indicating whether the user is playing PvP, excluding the Wolves' Den. /// public bool IsPvPExcludingDen { get; } - + /// - /// Gets a value indicating whether the client is currently in Group Pose (GPose) mode. + /// Gets a value indicating whether the client is currently in Group Pose (GPose) mode. /// public bool IsGPosing { get; } diff --git a/Dalamud/Plugin/Services/ISigScanner.cs b/Dalamud/Plugin/Services/ISigScanner.cs index c0ebd9310..ac0f2c55f 100644 --- a/Dalamud/Plugin/Services/ISigScanner.cs +++ b/Dalamud/Plugin/Services/ISigScanner.cs @@ -10,12 +10,12 @@ namespace Dalamud.Game; public interface ISigScanner { /// - /// Gets a value indicating whether or not the search on this module is performed on a copy. + /// Gets a value indicating whether the search on this module is performed on a copy. /// public bool IsCopy { get; } /// - /// Gets a value indicating whether or not the ProcessModule is 32-bit. + /// Gets a value indicating whether the ProcessModule is 32-bit. /// public bool Is32BitProcess { get; } @@ -84,7 +84,7 @@ public interface ISigScanner /// The offset from function start of the instruction using the data. /// An IntPtr to the static memory location. public nint GetStaticAddressFromSig(string signature, int offset = 0); - + /// /// Try scanning for a .data address using a .text function. /// This is intended to be used with IDA sigs. @@ -95,14 +95,14 @@ public interface ISigScanner /// The offset from function start of the instruction using the data. /// true if the signature was found. public bool TryGetStaticAddressFromSig(string signature, out nint result, int offset = 0); - + /// /// Scan for a byte signature in the .data section. /// /// The signature. /// The real offset of the found signature. public nint ScanData(string signature); - + /// /// Try scanning for a byte signature in the .data section. /// @@ -110,14 +110,14 @@ public interface ISigScanner /// The real offset of the signature, if found. /// true if the signature was found. public bool TryScanData(string signature, out nint result); - + /// /// Scan for a byte signature in the whole module search area. /// /// The signature. /// The real offset of the found signature. public nint ScanModule(string signature); - + /// /// Try scanning for a byte signature in the whole module search area. /// @@ -125,7 +125,7 @@ public interface ISigScanner /// The real offset of the signature, if found. /// true if the signature was found. public bool TryScanModule(string signature, out nint result); - + /// /// Resolve a RVA address. /// @@ -133,14 +133,14 @@ public interface ISigScanner /// The relative offset. /// The calculated offset. public nint ResolveRelativeAddress(nint nextInstAddr, int relOffset); - + /// /// Scan for a byte signature in the .text section. /// /// The signature. /// The real offset of the found signature. public nint ScanText(string signature); - + /// /// Try scanning for a byte signature in the .text section. /// diff --git a/Dalamud/Plugin/Services/ITextureProvider.cs b/Dalamud/Plugin/Services/ITextureProvider.cs index ff13f11f1..201e2b803 100644 --- a/Dalamud/Plugin/Services/ITextureProvider.cs +++ b/Dalamud/Plugin/Services/ITextureProvider.cs @@ -191,7 +191,7 @@ public interface ITextureProvider /// Caching the returned object is not recommended. Performance benefit will be minimal. /// ISharedImmediateTexture GetFromGameIcon(in GameIconLookup lookup); - + /// Gets a shared texture corresponding to the given game resource icon specifier. /// /// This function does not throw exceptions. @@ -200,7 +200,7 @@ public interface ITextureProvider /// /// A game icon specifier. /// The resulting . - /// Whether or not the lookup succeeded. + /// Whether the lookup succeeded. bool TryGetFromGameIcon(in GameIconLookup lookup, [NotNullWhen(true)] out ISharedImmediateTexture? texture); /// Gets a shared texture corresponding to the given path to a game resource. @@ -221,7 +221,7 @@ public interface ITextureProvider /// Caching the returned object is not recommended. Performance benefit will be minimal. /// ISharedImmediateTexture GetFromFile(string path); - + /// Gets a shared texture corresponding to the given file on the filesystem. /// The file on the filesystem to load. /// The shared texture that you may use to obtain the loaded texture wrap and load states. diff --git a/Dalamud/SafeMemory.cs b/Dalamud/SafeMemory.cs index 3365ff118..8d9c62c30 100644 --- a/Dalamud/SafeMemory.cs +++ b/Dalamud/SafeMemory.cs @@ -25,7 +25,7 @@ public static class SafeMemory /// The address to read from. /// The amount of bytes to read. /// The result buffer. - /// Whether or not the read succeeded. + /// Whether the read succeeded. public static bool ReadBytes(IntPtr address, int count, out byte[] buffer) { buffer = new byte[count <= 0 ? 0 : count]; @@ -37,7 +37,7 @@ public static class SafeMemory /// /// The address to write to. /// The buffer to write. - /// Whether or not the write succeeded. + /// Whether the write succeeded. public static bool WriteBytes(IntPtr address, byte[] buffer) { return Imports.WriteProcessMemory(Handle, address, buffer, buffer.Length, out _); @@ -49,7 +49,7 @@ public static class SafeMemory /// The type of the struct. /// The address to read from. /// The resulting object. - /// Whether or not the read succeeded. + /// Whether the read succeeded. public static bool Read(IntPtr address, out T result) where T : struct { if (!ReadBytes(address, SizeCache.Size, out var buffer)) @@ -91,7 +91,7 @@ public static class SafeMemory /// The type of the struct. /// The address to write to. /// The object to write. - /// Whether or not the write succeeded. + /// Whether the write succeeded. public static bool Write(IntPtr address, T obj) where T : struct { using var mem = new LocalMemory(SizeCache.Size); @@ -105,7 +105,7 @@ public static class SafeMemory /// The type of the structs. /// The address to write to. /// The array to write. - /// Whether or not the write succeeded. + /// Whether the write succeeded. public static bool Write(IntPtr address, T[] objArray) where T : struct { if (objArray == null || objArray.Length == 0) @@ -164,7 +164,7 @@ public static class SafeMemory /// /// The address to write to. /// The string to write. - /// Whether or not the write succeeded. + /// Whether the write succeeded. public static bool WriteString(IntPtr address, string str) { return WriteString(address, str, Encoding.UTF8); @@ -181,7 +181,7 @@ public static class SafeMemory /// The address to write to. /// The string to write. /// The encoding to use. - /// Whether or not the write succeeded. + /// Whether the write succeeded. public static bool WriteString(IntPtr address, string str, Encoding encoding) { if (string.IsNullOrEmpty(str)) diff --git a/Dalamud/Storage/ReliableFileStorage.cs b/Dalamud/Storage/ReliableFileStorage.cs index 9b87a71a0..9791b9e45 100644 --- a/Dalamud/Storage/ReliableFileStorage.cs +++ b/Dalamud/Storage/ReliableFileStorage.cs @@ -157,7 +157,7 @@ internal class ReliableFileStorage : IInternalDisposableService /// automatically written back to disk, however. /// /// The path to read from. - /// Whether or not the backup of the file should take priority. + /// Whether the backup of the file should take priority. /// The container to read from. /// All text stored in this file. /// Thrown if the file does not exist on the filesystem or in the backup. @@ -171,7 +171,7 @@ internal class ReliableFileStorage : IInternalDisposableService /// /// The path to read from. /// The encoding to read with. - /// Whether or not the backup of the file should take priority. + /// Whether the backup of the file should take priority. /// The container to read from. /// All text stored in this file. /// Thrown if the file does not exist on the filesystem or in the backup. @@ -249,7 +249,7 @@ internal class ReliableFileStorage : IInternalDisposableService /// automatically written back to disk, however. /// /// The path to read from. - /// Whether or not the backup of the file should take priority. + /// Whether the backup of the file should take priority. /// The container to read from. /// All bytes stored in this file. /// Thrown if the file does not exist on the filesystem or in the backup. diff --git a/Dalamud/Support/BugBait.cs b/Dalamud/Support/BugBait.cs index c82e5e652..8dbf2e429 100644 --- a/Dalamud/Support/BugBait.cs +++ b/Dalamud/Support/BugBait.cs @@ -20,10 +20,10 @@ internal static class BugBait /// Send feedback to Discord. /// /// The plugin to send feedback about. - /// Whether or not the plugin is a testing plugin. + /// Whether the plugin is a testing plugin. /// The content of the feedback. /// The reporter name. - /// Whether or not the most recent exception to occur should be included in the report. + /// Whether the most recent exception to occur should be included in the report. /// A representing the asynchronous operation. public static async Task SendFeedback(IPluginManifest plugin, bool isTesting, string content, string reporter, bool includeException) { @@ -43,7 +43,7 @@ internal static class BugBait { model.Exception = Troubleshooting.LastException == null ? "Was included, but none happened" : Troubleshooting.LastException?.ToString(); } - + var httpClient = Service.Get().SharedHttpClient; var postContent = new StringContent(JsonConvert.SerializeObject(model), Encoding.UTF8, "application/json"); diff --git a/Dalamud/Utility/Signatures/NullabilityUtil.cs b/Dalamud/Utility/Signatures/NullabilityUtil.cs index da4b24db6..da45db197 100755 --- a/Dalamud/Utility/Signatures/NullabilityUtil.cs +++ b/Dalamud/Utility/Signatures/NullabilityUtil.cs @@ -14,21 +14,21 @@ internal static class NullabilityUtil /// Check if the provided property is nullable. /// /// The property to check. - /// Whether or not the property is nullable. + /// Whether the property is nullable. internal static bool IsNullable(PropertyInfo property) => IsNullableHelper(property.PropertyType, property.DeclaringType, property.CustomAttributes); /// /// Check if the provided field is nullable. /// /// The field to check. - /// Whether or not the field is nullable. + /// Whether the field is nullable. internal static bool IsNullable(FieldInfo field) => IsNullableHelper(field.FieldType, field.DeclaringType, field.CustomAttributes); /// /// Check if the provided parameter is nullable. /// /// The parameter to check. - /// Whether or not the parameter is nullable. + /// Whether the parameter is nullable. internal static bool IsNullable(ParameterInfo parameter) => IsNullableHelper(parameter.ParameterType, parameter.Member, parameter.CustomAttributes); private static bool IsNullableHelper(Type memberType, MemberInfo? declaringType, IEnumerable customAttributes) diff --git a/Dalamud/Utility/Signatures/Wrappers/IFieldOrPropertyInfo.cs b/Dalamud/Utility/Signatures/Wrappers/IFieldOrPropertyInfo.cs index 76e32da28..a660164c1 100755 --- a/Dalamud/Utility/Signatures/Wrappers/IFieldOrPropertyInfo.cs +++ b/Dalamud/Utility/Signatures/Wrappers/IFieldOrPropertyInfo.cs @@ -16,7 +16,7 @@ internal interface IFieldOrPropertyInfo Type ActualType { get; } /// - /// Gets a value indicating whether or not the field or property is nullable. + /// Gets a value indicating whether the field or property is nullable. /// bool IsNullable { get; } diff --git a/Dalamud/Utility/Timing/TimingHandle.cs b/Dalamud/Utility/Timing/TimingHandle.cs index d73a9c2d3..e334908b1 100644 --- a/Dalamud/Utility/Timing/TimingHandle.cs +++ b/Dalamud/Utility/Timing/TimingHandle.cs @@ -67,7 +67,7 @@ public sealed class TimingHandle : TimingEvent, IDisposable, IComparable - /// Gets a value indicating whether or not this timing was started on the main thread. + /// Gets a value indicating whether this timing was started on the main thread. /// public bool IsMainThread { get; private set; } diff --git a/Dalamud/Utility/Util.cs b/Dalamud/Utility/Util.cs index 966fa1e11..4959fafb2 100644 --- a/Dalamud/Utility/Util.cs +++ b/Dalamud/Utility/Util.cs @@ -308,7 +308,7 @@ public static class Util /// /// The structure to show. /// The address to the structure. - /// Whether or not this structure should start out expanded. + /// Whether this structure should start out expanded. /// The already followed path. public static void ShowStruct(object obj, ulong addr, bool autoExpand = false, IEnumerable? path = null) => ShowStructInternal(obj, addr, autoExpand, path); @@ -318,7 +318,7 @@ public static class Util /// /// The type of the structure. /// The pointer to the structure. - /// Whether or not this structure should start out expanded. + /// Whether this structure should start out expanded. public static unsafe void ShowStruct(T* obj, bool autoExpand = false) where T : unmanaged { ShowStruct(*obj, (ulong)&obj, autoExpand); @@ -328,7 +328,7 @@ public static class Util /// Show a GameObject's internal data in an ImGui-context. /// /// The GameObject to show. - /// Whether or not the struct should start as expanded. + /// Whether the struct should start as expanded. public static unsafe void ShowGameObjectStruct(IGameObject go, bool autoExpand = true) { switch (go) @@ -1031,7 +1031,7 @@ public static class Util /// /// The structure to show. /// The address to the structure. - /// Whether or not this structure should start out expanded. + /// Whether this structure should start out expanded. /// The already followed path. /// Do not print addresses. Use when displaying a copied value. private static void ShowStructInternal(object obj, ulong addr, bool autoExpand = false, IEnumerable? path = null, bool hideAddress = false) diff --git a/DalamudCrashHandler/miniz.h b/DalamudCrashHandler/miniz.h index 6cc398c92..0c12a3ccb 100644 --- a/DalamudCrashHandler/miniz.h +++ b/DalamudCrashHandler/miniz.h @@ -115,7 +115,7 @@ -/* Defines to completely disable specific portions of miniz.c: +/* Defines to completely disable specific portions of miniz.c: If all macros here are defined the only functionality remaining will be CRC-32, adler-32, tinfl, and tdefl. */ /* Define MINIZ_NO_STDIO to disable all usage and any functions which rely on stdio for file I/O. */ @@ -138,7 +138,7 @@ /* Define MINIZ_NO_ZLIB_COMPATIBLE_NAME to disable zlib names, to prevent conflicts against stock zlib. */ /*#define MINIZ_NO_ZLIB_COMPATIBLE_NAMES */ -/* Define MINIZ_NO_MALLOC to disable all calls to malloc, free, and realloc. +/* Define MINIZ_NO_MALLOC to disable all calls to malloc, free, and realloc. Note if MINIZ_NO_MALLOC is defined then the user must always provide custom user alloc/free/realloc callbacks to the zlib and archive API's, and a few stand-alone helper API's which don't provide custom user functions (such as tdefl_compress_mem_to_heap() and tinfl_decompress_mem_to_heap()) won't work. */ @@ -360,7 +360,7 @@ MINIZ_EXPORT mz_ulong mz_compressBound(mz_ulong source_len); /* Initializes a decompressor. */ MINIZ_EXPORT int mz_inflateInit(mz_streamp pStream); -/* mz_inflateInit2() is like mz_inflateInit() with an additional option that controls the window size and whether or not the stream has been wrapped with a zlib header/footer: */ +/* mz_inflateInit2() is like mz_inflateInit() with an additional option that controls the window size and whether the stream has been wrapped with a zlib header/footer: */ /* window_bits must be MZ_DEFAULT_WINDOW_BITS (to parse zlib header/footer) or -MZ_DEFAULT_WINDOW_BITS (raw deflate). */ MINIZ_EXPORT int mz_inflateInit2(mz_streamp pStream, int window_bits); @@ -908,7 +908,7 @@ struct tinfl_decompressor_tag #ifdef __cplusplus } #endif - + #pragma once