diff --git a/MiraAPI/Events/MiraEventManager.cs b/MiraAPI/Events/MiraEventManager.cs index 592fb2c..005415b 100644 --- a/MiraAPI/Events/MiraEventManager.cs +++ b/MiraAPI/Events/MiraEventManager.cs @@ -17,7 +17,7 @@ public static class MiraEventManager /// /// The instance. /// Type of Event. - /// If there was an event handler invoked for this event, return true. Otherwise, return false. + /// If there was an event handler invoked for this event, return . Otherwise, return . public static bool InvokeEvent(T eventInstance) where T : MiraEvent { EventWrappers.TryGetValue(typeof(T), out var handlers); @@ -46,7 +46,7 @@ public static class MiraEventManager /// /// The instance. /// The type to use for handler lookup. - /// If there was an event handler invoked for this event, return true. Otherwise, return false. + /// If there was an event handler invoked for this event, return . Otherwise, return . public static bool InvokeEvent(MiraEvent eventInstance, Type type) { EventWrappers.TryGetValue(type, out var handlers); @@ -130,7 +130,7 @@ public static class MiraEventManager /// Unregister a handler using the . /// /// A handle to the event. - /// True if the event was unregistered successfully, false otherwise. + /// if the event was unregistered successfully, otherwise. public static bool UnregisterEventHandler(MiraEventHandle eventHandle) { if (!EventWrappers.TryGetValue(eventHandle.EventType, out var handlers)) diff --git a/MiraAPI/Events/Vanilla/Meeting/ReportBodyEvent.cs b/MiraAPI/Events/Vanilla/Meeting/ReportBodyEvent.cs index dc93d96..fb085b6 100644 --- a/MiraAPI/Events/Vanilla/Meeting/ReportBodyEvent.cs +++ b/MiraAPI/Events/Vanilla/Meeting/ReportBodyEvent.cs @@ -12,12 +12,12 @@ public class ReportBodyEvent : MiraCancelableEvent public PlayerControl Reporter { get; } /// - /// Gets the player that is being reported. Will be null for emergency meeting. + /// Gets the player that is being reported. Will be for emergency meeting. /// public NetworkedPlayerInfo? Target { get; } /// - /// Gets the that is being reported. Will be null for emergency meeting. + /// Gets the that is being reported. Will be for emergency meeting. /// public DeadBody? Body { get; } diff --git a/MiraAPI/Events/Vanilla/Meeting/Voting/CheckForEndVotingEvent.cs b/MiraAPI/Events/Vanilla/Meeting/Voting/CheckForEndVotingEvent.cs index b0bdae5..a9b2d8e 100644 --- a/MiraAPI/Events/Vanilla/Meeting/Voting/CheckForEndVotingEvent.cs +++ b/MiraAPI/Events/Vanilla/Meeting/Voting/CheckForEndVotingEvent.cs @@ -18,7 +18,7 @@ public class CheckForEndVotingEvent : MiraCancelableEvent /// /// Initializes a new instance of the class. /// - /// >True if voting is complete, false otherwise. + /// > if voting is complete, otherwise. public CheckForEndVotingEvent(bool isVotingComplete) { IsVotingComplete = isVotingComplete; diff --git a/MiraAPI/Events/Vanilla/Meeting/Voting/ProcessVotesEvent.cs b/MiraAPI/Events/Vanilla/Meeting/Voting/ProcessVotesEvent.cs index 0dbd585..e35d1b4 100644 --- a/MiraAPI/Events/Vanilla/Meeting/Voting/ProcessVotesEvent.cs +++ b/MiraAPI/Events/Vanilla/Meeting/Voting/ProcessVotesEvent.cs @@ -11,7 +11,7 @@ namespace MiraAPI.Events.Vanilla.Meeting.Voting; /// Initializes a new instance of the class. /// /// >The list of s that are being processed. -/// The player to be exiled. Will be null if no player is to be exiled. +/// The player to be exiled. Will be if no player is to be exiled. public class ProcessVotesEvent(List votes, NetworkedPlayerInfo? exiledPlayer = null) : MiraEvent { private readonly List _originalVotes = [.. votes]; @@ -34,7 +34,7 @@ public class ProcessVotesEvent(List votes, NetworkedPlayerInfo? exil public List Votes { get; } = votes; /// - /// Gets or sets the player to be exiled. Will be null if no player is to be exiled. + /// Gets or sets the player to be exiled. Will be if no player is to be exiled. /// public NetworkedPlayerInfo? ExiledPlayer { diff --git a/MiraAPI/GameEnd/CustomGameOver.cs b/MiraAPI/GameEnd/CustomGameOver.cs index 885504e..bb9e23b 100644 --- a/MiraAPI/GameEnd/CustomGameOver.cs +++ b/MiraAPI/GameEnd/CustomGameOver.cs @@ -19,7 +19,7 @@ public abstract class CustomGameOver /// /// The that requested the Game Over. /// The collection of winners. - /// True if the condition is met, otherwise false. + /// if the condition is met, otherwise . public virtual bool VerifyCondition(PlayerControl playerControl, NetworkedPlayerInfo[] winners) { return true; @@ -29,7 +29,7 @@ public abstract class CustomGameOver /// Runs before the base game calls . /// /// The instance. - /// Return True to use the run the original method, return False to skip it. + /// Return to use the run the original method, return to skip it. public virtual bool BeforeEndGameSetup(EndGameManager endGameManager) { return true; diff --git a/MiraAPI/GameEnd/GameOverManager.cs b/MiraAPI/GameEnd/GameOverManager.cs index ac4fef8..c0a144d 100644 --- a/MiraAPI/GameEnd/GameOverManager.cs +++ b/MiraAPI/GameEnd/GameOverManager.cs @@ -20,7 +20,7 @@ public static class GameOverManager /// /// Type of the . /// Thrown when the type is not a subclass of , is abstract, or does not have a parameterless constructor. - /// >True if the game over was registered successfully, false otherwise. + /// > if the game over was registered successfully, otherwise. public static bool RegisterGameOver(Type gameOverType) { if (!typeof(CustomGameOver).IsAssignableFrom(gameOverType)) diff --git a/MiraAPI/GameModes/CustomGameMode.cs b/MiraAPI/GameModes/CustomGameMode.cs index 58d9e58..f4dc43d 100644 --- a/MiraAPI/GameModes/CustomGameMode.cs +++ b/MiraAPI/GameModes/CustomGameMode.cs @@ -88,60 +88,60 @@ public abstract class CustomGameMode /// /// Should Roles Settings be available when this gamemode is selected. /// - /// True if Role Settings are enabled in this game mode. + /// if Role Settings are enabled in this game mode. public virtual bool AreRoleSettingsEnabled() => true; /// /// Should Game Settings be available when this gamemode is selected. /// - /// True if Game Settings are enabled in this mode. + /// if Game Settings are enabled in this mode. public virtual bool AreGameSettingsEnabled() => true; /// /// Custom winner selection. /// - /// List of winners or null. + /// List of winners or . public virtual List? CalculateWinners() => null; /// /// Show gamemode in . /// - /// True if the game mode should be shown in the intro cutscene. + /// if the game mode should be shown in the intro cutscene. public virtual bool ShowGameModeIntroCutscene() => false; /// /// Can Admin be used in this gamemode. /// /// Admin Console. - /// True if Admin console is enabled. + /// if Admin console is enabled. public virtual bool CanUseMapConsole(MapConsole console) => true; /// /// Can a be reported in this gamemode. /// /// Target for reporting. - /// True if s can be reported. + /// if s can be reported. public virtual bool CanReport(DeadBody body) => true; /// /// Can s be used in this gamemode. /// /// System Console. - /// True if s are enabled in this mode. + /// if s are enabled in this mode. public virtual bool CanUseSystemConsole(SystemConsole console) => true; /// /// Can tasks be interacted with in this gamemode. /// /// Task console. - /// True if tasks are enabled in this mode. + /// if tasks are enabled in this mode. public virtual bool CanUseTasks(Console console) => true; /// /// Should the sabotage map be used when attempting to open sabotage overlay. /// /// object. - /// True if the sabotage map should be shown. + /// if the sabotage map should be shown. public virtual bool ShouldShowSabotageMap(MapBehaviour map) => true; /// @@ -149,6 +149,6 @@ public abstract class CustomGameMode /// /// Target vent. /// Player attempting to vent. - /// True if venting is enabled in this mode. + /// if venting is enabled in this mode. public virtual bool CanVent(Vent vent, NetworkedPlayerInfo playerInfo) => true; } diff --git a/MiraAPI/GameOptions/ModdedOptionsManager.cs b/MiraAPI/GameOptions/ModdedOptionsManager.cs index 4ff527b..3e6e04e 100644 --- a/MiraAPI/GameOptions/ModdedOptionsManager.cs +++ b/MiraAPI/GameOptions/ModdedOptionsManager.cs @@ -192,7 +192,7 @@ public static class ModdedOptionsManager /// /// The original getter method. /// The result of the property getter. - /// False so the original getter gets skipped. + /// so the original getter gets skipped. #pragma warning disable CA1707 [SuppressMessage("ReSharper", "InconsistentNaming", Justification = "Harmony naming convention")] public static bool PropertyGetterPatch(MethodBase __originalMethod, ref object __result) diff --git a/MiraAPI/GameOptions/OptionTypes/ModdedPlayerOption.cs b/MiraAPI/GameOptions/OptionTypes/ModdedPlayerOption.cs index 1b30d16..f6516cd 100644 --- a/MiraAPI/GameOptions/OptionTypes/ModdedPlayerOption.cs +++ b/MiraAPI/GameOptions/OptionTypes/ModdedPlayerOption.cs @@ -91,9 +91,9 @@ public class ModdedPlayerOption : ModdedOption } /// - /// Returns a player from the value. If is enabled and none is enabled this will return null. + /// Returns a player from the value. If is enabled and none is enabled this will return . /// - /// A player or null if chosen none. + /// A player or if chosen none. public NetworkedPlayerInfo? GetPlayerValue() { return Value < 0 ? null : Values[Value]; diff --git a/MiraAPI/Hud/CustomActionButton.cs b/MiraAPI/Hud/CustomActionButton.cs index 4cac55e..f5cf521 100644 --- a/MiraAPI/Hud/CustomActionButton.cs +++ b/MiraAPI/Hud/CustomActionButton.cs @@ -54,7 +54,7 @@ public abstract class CustomActionButton public virtual string CooldownTimerFormatString => "0"; /// - /// Gets a value indicating whether the button has an effect ability. By default true if is greater than 0. + /// Gets a value indicating whether the button has an effect ability. By default if is greater than 0. /// public virtual bool HasEffect => EffectDuration > 0; @@ -79,7 +79,7 @@ public abstract class CustomActionButton public virtual ButtonUsesMode UsesMode => ButtonUsesMode.PerGame; /// - /// Gets the keybind for this button. If null, no keybind will be added. + /// Gets the keybind for this button. If , no keybind will be added. /// public virtual BaseKeybind? Keybind => null; @@ -429,10 +429,10 @@ public abstract class CustomActionButton /// /// This method determines if the button should be active or not. - /// True means the button is active, false means the button is disabled. + /// means the button is active, means the button is disabled. /// /// The of the local player. - /// True if the button is enabled, false otherwise. + /// if the button is enabled, otherwise. public abstract bool Enabled(RoleBehaviour? role); /// @@ -445,7 +445,7 @@ public abstract class CustomActionButton /// /// Returns a value indicating whether the effect can be ended early by the player. - /// Always false by default. + /// Always by default. /// /// Can the effect be canceled. public virtual bool IsEffectCancellable() => false; @@ -474,7 +474,7 @@ public abstract class CustomActionButton /// /// This method is called on the method. It determines whether the button should be visible or not. - /// The default behavior is to show the button if the parameter and the method return true. + /// The default behavior is to show the button if the parameter and the method return . /// It can be overridden for custom behavior. /// /// Passed in from , should hud be active. @@ -599,7 +599,7 @@ public abstract class CustomActionButton : CustomActionButton where T : MonoB /// Determines if the target is valid. /// /// The target being checked. - /// True if the target is valid, false otherwise. + /// if the target is valid, otherwise. public virtual bool IsTargetValid(T? target) { return target != null; @@ -608,7 +608,7 @@ public abstract class CustomActionButton : CustomActionButton where T : MonoB /// /// The method used to get the target . /// - /// The target or null if it isn't found. + /// The target or if it isn't found. public abstract T? GetTarget(); /// diff --git a/MiraAPI/ModCompatibility.cs b/MiraAPI/ModCompatibility.cs index 23744ab..073453b 100644 --- a/MiraAPI/ModCompatibility.cs +++ b/MiraAPI/ModCompatibility.cs @@ -17,8 +17,8 @@ public static class ModCompatibility /// /// Checks if the Submerged mod is loaded. /// - /// Submerged mod assembly if loaded, null otherwise. - /// True if the Submerged mod is loaded, false otherwise. + /// Submerged mod assembly if loaded, otherwise. + /// if the Submerged mod is loaded, otherwise. public static bool SubmergedLoaded([NotNullWhen(true)] out Assembly? submergedAssembly) { var result = IL2CPPChainloader.Instance.Plugins.TryGetValue(SubmergedId, out var plugin); diff --git a/MiraAPI/Modifiers/BaseModifier.cs b/MiraAPI/Modifiers/BaseModifier.cs index dd4ac9f..930cc29 100644 --- a/MiraAPI/Modifiers/BaseModifier.cs +++ b/MiraAPI/Modifiers/BaseModifier.cs @@ -50,7 +50,7 @@ public abstract class BaseModifier : IOptionable public abstract string ModifierName { get; } /// - /// Gets the modifier icon. Useless if is true. + /// Gets the modifier icon. Useless if is . /// public virtual LoadableAsset? ModifierIcon => null; @@ -70,12 +70,12 @@ public abstract class BaseModifier : IOptionable public virtual Color FreeplayFileColor => Color.gray; /// - /// Gets a value indicating whether the modifier is unique. If true, the player can only have one instance of this modifier. + /// Gets a value indicating whether the modifier is unique. If , the player can only have one instance of this modifier. /// public virtual bool Unique => true; /// - /// Gets the HUD description for this modifier. Does nothing if is true. Required to be visible on UI. + /// Gets the HUD description for this modifier. Does nothing if is . Required to be visible on UI. /// /// The description string for the HUD. public virtual string GetDescription() => string.Empty; @@ -126,6 +126,6 @@ public abstract class BaseModifier : IOptionable /// /// Determines whether the player can vent. /// - /// True if the player can vent, false otherwise. Null for no effect. + /// if the player can vent, otherwise. for no effect. public virtual bool? CanVent() => null; } diff --git a/MiraAPI/Modifiers/ModifierComponent.cs b/MiraAPI/Modifiers/ModifierComponent.cs index e8a7de3..09e411a 100644 --- a/MiraAPI/Modifiers/ModifierComponent.cs +++ b/MiraAPI/Modifiers/ModifierComponent.cs @@ -206,10 +206,10 @@ public class ModifierComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr) /// /// Tries to get a . /// - /// The or null. + /// The or . /// The predicate to check the by. /// The Type of the . - /// True if the was found, false otherwise. + /// if the was found, otherwise. [HideFromIl2Cpp] public bool TryGetModifier([NotNullWhen(true)] out T? modifier, Func? predicate = null) where T : BaseModifier { @@ -221,9 +221,9 @@ public class ModifierComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr) /// Tries to get a by its type. /// /// The modifier type. - /// The or null. + /// The or . /// The predicate to check the by. - /// True if the was found, false otherwise. + /// if the was found, otherwise. [HideFromIl2Cpp] public bool TryGetModifier(Type type, [NotNullWhen(true)] out BaseModifier? modifier, Func? predicate = null) { @@ -235,9 +235,9 @@ public class ModifierComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr) /// Tries to get a by its type ID. /// /// The 's type ID. - /// The or null. + /// The or . /// The predicate to check the by. - /// True if the was found, false otherwise. + /// if the was found, otherwise. [HideFromIl2Cpp] public bool TryGetModifier(uint id, [NotNullWhen(true)] out BaseModifier? modifier, Func? predicate = null) { @@ -249,8 +249,8 @@ public class ModifierComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr) /// Tries to get a by its unique ID. /// /// The 's unique ID. - /// The or null. - /// True if the was found, false otherwise. + /// The or . + /// if the was found, otherwise. [HideFromIl2Cpp] public bool TryGetModifier(Guid modifierGuid, [NotNullWhen(true)] out BaseModifier? modifier) { @@ -263,7 +263,7 @@ public class ModifierComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr) /// /// The predicate to check the by. /// The Type of the . - /// The if it is found, null otherwise. + /// The if it is found, otherwise. [HideFromIl2Cpp] public T? GetModifier(Func? predicate = null) where T : BaseModifier { @@ -275,7 +275,7 @@ public class ModifierComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr) /// /// The modifier type. /// The predicate to check the by. - /// The if it is found, null otherwise. + /// The if it is found, otherwise. [HideFromIl2Cpp] public BaseModifier? GetModifier(Type type, Func? predicate = null) { @@ -287,7 +287,7 @@ public class ModifierComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr) /// /// The ID. /// The predicate to check the by. - /// The if it is found, null otherwise. + /// The if it is found, otherwise. [HideFromIl2Cpp] public BaseModifier? GetModifier(uint id, Func? predicate = null) { @@ -301,7 +301,7 @@ public class ModifierComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr) /// Gets a by unique ID. /// /// The 's unique ID. - /// The if it is found, or null. + /// The if it is found, or . [HideFromIl2Cpp] public BaseModifier? GetModifier(Guid modifierGuid) { @@ -469,7 +469,7 @@ public class ModifierComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr) /// /// The ID of the . /// The arguments to initialize the with. - /// The if it was created, or null if it failed. + /// The if it was created, or if it failed. [HideFromIl2Cpp] public BaseModifier? AddModifier(uint id, params object[] args) { @@ -484,7 +484,7 @@ public class ModifierComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr) /// /// The predicate to check the . /// The Type of the . - /// True if the is present, false otherwise. + /// if the is present, otherwise. [HideFromIl2Cpp] public bool HasModifier(Func? predicate=null) where T : BaseModifier { @@ -496,7 +496,7 @@ public class ModifierComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr) /// /// The modifier type. /// The predicate to check the . - /// True if the is present, false otherwise. + /// if the is present, otherwise. [HideFromIl2Cpp] public bool HasModifier(Type type, Func? predicate=null) { @@ -508,7 +508,7 @@ public class ModifierComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr) /// /// The 's type ID. /// The predicate to check the . - /// True if the is present, false otherwise. + /// if the is present, otherwise. [HideFromIl2Cpp] public bool HasModifier(uint id, Func? predicate=null) { @@ -522,7 +522,7 @@ public class ModifierComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr) /// Checks if a player has an active by its unique ID. /// /// The 's guid. - /// True if the is present, false otherwise. + /// if the is present, otherwise. [HideFromIl2Cpp] public bool HasModifier(Guid id) { @@ -535,7 +535,7 @@ public class ModifierComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr) /// Whether to check inactive s (those pending to be added). /// The predicate to check the . /// The Type of the . - /// True if the is present, false otherwise. + /// if the is present, otherwise. [HideFromIl2Cpp] public bool HasModifier(bool checkInactive, Func? predicate=null) where T : BaseModifier { @@ -549,7 +549,7 @@ public class ModifierComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr) /// The modifier type. /// Whether to check inactive s (those pending to be added). /// The predicate to check the . - /// True if the is present, false otherwise. + /// if the is present, otherwise. [HideFromIl2Cpp] public bool HasModifier(Type type, bool checkInactive, Func? predicate=null) { @@ -563,7 +563,7 @@ public class ModifierComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr) /// The 's type ID. /// Whether to check inactive s (those pending to be added). /// The predicate to check the . - /// True if the is present, false otherwise. + /// if the is present, otherwise. [HideFromIl2Cpp] public bool HasModifier(uint id, bool checkInactive, Func? predicate=null) { @@ -578,7 +578,7 @@ public class ModifierComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr) /// /// The 's guid. /// Whether to check inactive s (those pending to be added). - /// True if the is present, false otherwise. + /// if the is present, otherwise. [HideFromIl2Cpp] public bool HasModifier(Guid id, bool checkInactive) { diff --git a/MiraAPI/Modifiers/ModifierExtensions.cs b/MiraAPI/Modifiers/ModifierExtensions.cs index ad10adb..20f08be 100644 --- a/MiraAPI/Modifiers/ModifierExtensions.cs +++ b/MiraAPI/Modifiers/ModifierExtensions.cs @@ -123,7 +123,7 @@ public static class ModifierExtensions /// Gets the for a . /// /// The object. - /// A if there is one, null otherwise. + /// A if there is one, otherwise. public static ModifierComponent GetModifierComponent(this PlayerControl player) { if (ModifierComponents.TryGetValue(player, out var component)) @@ -147,7 +147,7 @@ public static class ModifierExtensions /// The type of the . /// The instance. /// Optional predicate to filter the s. - /// True if the has the , false otherwise. + /// if the has the , otherwise. public static bool HasModifier(this PlayerControl player, Func? predicate = null) where T : BaseModifier { return player.GetModifierComponent().HasModifier(predicate); @@ -159,7 +159,7 @@ public static class ModifierExtensions /// The instance. /// The type of the modifier. /// Optional predicate to filter the s. - /// True if the has the , false otherwise. + /// if the has the , otherwise. public static bool HasModifier(this PlayerControl player, Type type, Func? predicate = null) { return player.GetModifierComponent().HasModifier(type, predicate); @@ -171,7 +171,7 @@ public static class ModifierExtensions /// The instance. /// The type ID of the . /// Optional predicate to filter the s. - /// True if the has the , false otherwise. + /// if the has the , otherwise. public static bool HasModifier( this PlayerControl player, uint typeId, @@ -185,7 +185,7 @@ public static class ModifierExtensions /// /// The instance. /// The unique ID of the . - /// True if the has the , false otherwise. + /// if the has the , otherwise. public static bool HasModifier(this PlayerControl player, Guid uniqueId) { return player.GetModifierComponent().HasModifier(uniqueId); @@ -219,10 +219,10 @@ public static class ModifierExtensions /// Tries to get a . /// /// The instance. - /// The or null. + /// The or . /// The predicate to check the by. /// The Type of the . - /// True if the was found, false otherwise. + /// if the was found, otherwise. public static bool TryGetModifier(this PlayerControl player, [NotNullWhen(true)] out T? modifier, Func? predicate = null) where T : BaseModifier { return player.GetModifierComponent().TryGetModifier(out modifier, predicate); @@ -233,9 +233,9 @@ public static class ModifierExtensions /// /// The instance. /// The modifier type. - /// The or null. + /// The or . /// The predicate to check the by. - /// True if the was found, false otherwise. + /// if the was found, otherwise. public static bool TryGetModifier(this PlayerControl player, Type type, [NotNullWhen(true)] out BaseModifier? modifier, Func? predicate = null) { return player.GetModifierComponent().TryGetModifier(type, out modifier, predicate); @@ -246,9 +246,9 @@ public static class ModifierExtensions /// /// The instance. /// The type ID. - /// The or null. + /// The or . /// The predicate to check the by. - /// True if the was found, false otherwise. + /// if the was found, otherwise. public static bool TryGetModifier(this PlayerControl player, uint id, [NotNullWhen(true)] out BaseModifier? modifier, Func? predicate = null) { return player.GetModifierComponent().TryGetModifier(id, out modifier, predicate); @@ -259,8 +259,8 @@ public static class ModifierExtensions /// /// The instance. /// The unique ID. - /// The or null. - /// True if the was found, false otherwise. + /// The or . + /// if the was found, otherwise. public static bool TryGetModifier(this PlayerControl player, Guid modifierGuid, [NotNullWhen(true)] out BaseModifier? modifier) { return player.GetModifierComponent().TryGetModifier(modifierGuid, out modifier); @@ -272,7 +272,7 @@ public static class ModifierExtensions /// The type of the . /// The instance. /// Optional predicate to filter the s. - /// The if found, null otherwise. + /// The if found, otherwise. public static T? GetModifier(this PlayerControl player, Func? predicate = null) where T : BaseModifier { return player.GetModifierComponent().GetModifier(predicate); @@ -284,7 +284,7 @@ public static class ModifierExtensions /// The instance. /// The type of the modifier. /// Optional predicate to filter the s. - /// The if found, null otherwise. + /// The if found, otherwise. public static BaseModifier? GetModifier( this PlayerControl player, Type type, @@ -299,7 +299,7 @@ public static class ModifierExtensions /// The instance. /// The type ID of the . /// Optional predicate to filter the s. - /// The if found, null otherwise. + /// The if found, otherwise. public static BaseModifier? GetModifier( this PlayerControl player, uint typeId, @@ -313,7 +313,7 @@ public static class ModifierExtensions /// /// The instance. /// The GUID of the . - /// The if found, null otherwise. + /// The if found, otherwise. public static BaseModifier? GetModifier( this PlayerControl player, Guid uniqueId) diff --git a/MiraAPI/Modifiers/Types/GameModifier.cs b/MiraAPI/Modifiers/Types/GameModifier.cs index 83680b7..b58f8e0 100644 --- a/MiraAPI/Modifiers/Types/GameModifier.cs +++ b/MiraAPI/Modifiers/Types/GameModifier.cs @@ -30,19 +30,19 @@ public abstract class GameModifier : BaseModifier /// Determines whether the modifier is valid on a role. /// /// The role to be checked. - /// True if the modifier is valid on the role, otherwise false. + /// if the modifier is valid on the role, otherwise . public virtual bool IsModifierValidOn(RoleBehaviour role) => true; /// /// Determines whether the player won the game with this modifier. The modifier with the highest priority will override other modifiers. /// /// The reason why the game ended. - /// True if the player won, false if they lost. Return null to use the player's default win condition. + /// if the player won, if they lost. Return to use the player's default win condition. public virtual bool? DidWin(GameOverReason reason) => null; /// /// Determines whether the modifier can spawn in general, accounting for gamemodes and everything else. /// - /// True if the modifier is able to spawn, otherwise false. + /// if the modifier is able to spawn, otherwise . public virtual bool CanSpawnOnCurrentMode() => !GameManager.Instance.IsHideAndSeek(); } diff --git a/MiraAPI/Patches/Options/SettingPatches.cs b/MiraAPI/Patches/Options/SettingPatches.cs index d740349..59b956c 100644 --- a/MiraAPI/Patches/Options/SettingPatches.cs +++ b/MiraAPI/Patches/Options/SettingPatches.cs @@ -20,7 +20,7 @@ public static class SettingPatches /// The instance. /// The result of the method. /// The value. - /// False to skip original method. + /// to skip original method. [HarmonyPrefix] [HarmonyPatch(typeof(FloatGameSetting), nameof(FloatGameSetting.GetValueString))] public static bool ValueStringPatch( diff --git a/MiraAPI/Patches/Roles/RoleOptionsCollectionPatch.cs b/MiraAPI/Patches/Roles/RoleOptionsCollectionPatch.cs index 18a380c..ff57b37 100644 --- a/MiraAPI/Patches/Roles/RoleOptionsCollectionPatch.cs +++ b/MiraAPI/Patches/Roles/RoleOptionsCollectionPatch.cs @@ -32,7 +32,7 @@ public static class RoleOptionsCollectionPatch /// /// Set the role chance for custom Launchpad roles based on config. /// - /// Return false to skip original method, true to not. + /// Return to skip original method, to not. [HarmonyPrefix] [HarmonyPatch(nameof(RoleOptionsCollectionV10.GetChancePerGame))] public static bool GetChancePrefix(RoleTypes role, ref int __result) @@ -62,7 +62,7 @@ public static class RoleOptionsCollectionPatch /// /// Set the amount for custom Launchpad roles based on config. /// - /// Return false to skip original method, true to not. + /// Return to skip original method, to not. [HarmonyPrefix] [HarmonyPatch(nameof(RoleOptionsCollectionV10.GetNumPerGame))] public static bool GetNumPrefix(RoleTypes role, ref int __result) diff --git a/MiraAPI/Roles/CustomRoleConfiguration.cs b/MiraAPI/Roles/CustomRoleConfiguration.cs index 3ba3170..819eb1c 100644 --- a/MiraAPI/Roles/CustomRoleConfiguration.cs +++ b/MiraAPI/Roles/CustomRoleConfiguration.cs @@ -144,7 +144,7 @@ public record struct CustomRoleConfiguration public string FreeplayFolder { get; set; } /// - /// Gets or sets the outline for the if is true. + /// Gets or sets the outline for the if is . /// public Color KillButtonOutlineColor { get; set; } diff --git a/MiraAPI/Roles/CustomRoleManager.cs b/MiraAPI/Roles/CustomRoleManager.cs index 5da309e..9e6540f 100644 --- a/MiraAPI/Roles/CustomRoleManager.cs +++ b/MiraAPI/Roles/CustomRoleManager.cs @@ -207,7 +207,7 @@ public static class CustomRoleManager /// /// The . /// The result. - /// True if the role was found. + /// if the role was found. public static bool GetCustomRoleBehaviour(RoleTypes roleType, out ICustomRole? result) { CustomRoles.TryGetValue((ushort)roleType, out var temp); diff --git a/MiraAPI/Roles/CustomRoleUtils.cs b/MiraAPI/Roles/CustomRoleUtils.cs index af8c5d4..1a2b9b5 100644 --- a/MiraAPI/Roles/CustomRoleUtils.cs +++ b/MiraAPI/Roles/CustomRoleUtils.cs @@ -18,7 +18,7 @@ public static class CustomRoleUtils /// Determines whether the specified can spawn in general, accounting for gamemodes and everything else. /// /// The you would like to check for. - /// True if the is able to spawn, otherwise false. + /// if the is able to spawn, otherwise . public static bool CanSpawnOnCurrentMode(RoleBehaviour role) { if (role is ICustomRole custom) @@ -125,7 +125,7 @@ public static class CustomRoleUtils /// Determines if a is a custom role or not. /// /// The to check. - /// True if the is a custom role, false otherwise. + /// if the is a custom role, otherwise. public static bool IsCustomRole(this RoleBehaviour role) { return CustomRoleManager.CustomRoles.ContainsKey((ushort)role.Role); diff --git a/MiraAPI/Roles/ICustomRole.cs b/MiraAPI/Roles/ICustomRole.cs index 944eb46..5b72650 100644 --- a/MiraAPI/Roles/ICustomRole.cs +++ b/MiraAPI/Roles/ICustomRole.cs @@ -200,7 +200,7 @@ public interface ICustomRole : IOptionable /// /// The intro cutscene instance. /// The reference to the list of player in the team. - /// True to use the original team intro code, false to skip. + /// to use the original team intro code, to skip. public virtual bool SetupIntroTeam(IntroCutscene instance, ref Il2CppSystem.Collections.Generic.List yourTeam) { if (Team == ModdedRoleTeams.Custom) @@ -216,10 +216,10 @@ public interface ICustomRole : IOptionable } /// - /// Gets a custom ejection message for the role. Return null to use the default message. + /// Gets a custom ejection message for the role. Return to use the default message. /// /// The NetworkedPlayerInfo object for this player. - /// A string with a custom ejection message or null. + /// A string with a custom ejection message or . string? GetCustomEjectionMessage(NetworkedPlayerInfo player) { return Team == ModdedRoleTeams.Impostor ? $"{player.PlayerName} was The {RoleName}" : null; @@ -235,7 +235,7 @@ public interface ICustomRole : IOptionable /// Determine whether a given can be applied to this role. /// /// The modifier to be tested. - /// True if the is valid on this role, false otherwise. + /// if the is valid on this role, otherwise. bool IsModifierApplicable(BaseModifier modifier) { return true; @@ -244,7 +244,7 @@ public interface ICustomRole : IOptionable /// /// Determines whether the role can spawn in general, accounting for gamemodes and everything else. /// - /// True if the role is able to spawn, otherwise false. + /// if the role is able to spawn, otherwise . public virtual bool CanSpawnOnCurrentMode() => !GameManager.Instance.IsHideAndSeek(); /// diff --git a/MiraAPI/Utilities/Extensions.cs b/MiraAPI/Utilities/Extensions.cs index 3b67e5d..7364e44 100644 --- a/MiraAPI/Utilities/Extensions.cs +++ b/MiraAPI/Utilities/Extensions.cs @@ -175,7 +175,7 @@ public static class Extensions /// Checks if a is the game's host. /// /// The you're checking for. - /// If the player is the host, true, else false. + /// If the player is the host, , else . public static bool IsHost(this PlayerControl playerControl) { return TutorialManager.InstanceExists || AmongUsClient.Instance.HostId == playerControl.OwnerId; @@ -185,7 +185,7 @@ public static class Extensions /// Checks if a is protected by a Guardian Angel. /// /// The you're checking for. - /// If the player is protected, true, else false. + /// If the player is protected, , else . public static bool ProtectedByGa(this PlayerControl playerControl) { return playerControl.protectedByGuardianId > -1; @@ -213,7 +213,7 @@ public static class Extensions /// Determines if a is an integer. /// /// The number. - /// True if the is an integer, false otherwise. + /// if the is an integer, otherwise. public static bool IsInteger(this float number) { return Mathf.Approximately(number, Mathf.Round(number)); @@ -228,7 +228,7 @@ public static class Extensions /// Gets the of a . /// /// The object. - /// A if there is one, null otherwise. + /// A if there is one, otherwise. public static PlayerVoteData GetVoteData(this PlayerControl player) { if (VoteDataComponents.TryGetValue(player, out var component)) @@ -379,7 +379,7 @@ public static class Extensions /// Checks if a type is static. /// /// The type being checked. - /// True if the type is static, false otherwise. + /// if the type is static, otherwise. public static bool IsStatic(this Type type) { return type is { IsClass: true, IsAbstract: true, IsSealed: true }; @@ -460,7 +460,7 @@ public static class Extensions /// Determines if a given is for a custom option. /// /// The to be tested. - /// True if the is for a custom options, false otherwise. + /// if the is for a custom options, otherwise. public static bool IsCustom(this OptionBehaviour optionBehaviour) { return ModdedOptionsManager.ModdedOptions.Values.Any( @@ -514,7 +514,7 @@ public static class Extensions /// /// The object. /// The radius to search within. - /// The if it is found, or null there is none within the radius. + /// The if it is found, or there is none within the radius. public static DeadBody? GetNearestDeadBody(this PlayerControl playerControl, float radius) { return Helpers @@ -531,7 +531,7 @@ public static class Extensions /// An optional collider tag. /// Optional predicate to test if the is valid. /// The type of the object. - /// The if it was found, or null if there is none within the radius. + /// The if it was found, or if there is none within the radius. public static T? GetNearestObjectOfType( this PlayerControl playerControl, float radius, @@ -552,7 +552,7 @@ public static class Extensions /// Whether colliders should be ignored when searching. /// Determines if Ghosts are included. /// Optional predicate to test if the is valid. - /// The closest if there is one, false otherwise. + /// The closest if there is one, otherwise. public static PlayerControl? GetClosestPlayer( this PlayerControl playerControl, bool includeImpostors, diff --git a/MiraAPI/Utilities/Helpers.cs b/MiraAPI/Utilities/Helpers.cs index cd08d8a..b58d395 100644 --- a/MiraAPI/Utilities/Helpers.cs +++ b/MiraAPI/Utilities/Helpers.cs @@ -129,7 +129,7 @@ public static class Helpers /// Determines whether a given probability check succeeds. /// /// An integer value representing the success probability (0-100). - /// True if the number falls in the range, false if not. + /// if the number falls in the range, if not. public static bool CheckChance(int probability) { switch (probability) @@ -459,7 +459,7 @@ public static class Helpers /// Gets a by its parent ID. /// /// The player ID. - /// A or null if its not found. + /// A or if its not found. public static DeadBody? GetBodyById(byte id) { return Object.FindObjectsOfType().FirstOrDefault(body => body.ParentId == id); diff --git a/MiraAPI/Voting/PlayerVoteData.cs b/MiraAPI/Voting/PlayerVoteData.cs index 6e102ee..0e52078 100644 --- a/MiraAPI/Voting/PlayerVoteData.cs +++ b/MiraAPI/Voting/PlayerVoteData.cs @@ -48,7 +48,7 @@ public class PlayerVoteData(nint cppPtr) : MonoBehaviour(cppPtr) /// Returns whether the owner has voted for the specified player. /// /// The target's playerId. - /// True if the owner voted for the specified player, false otherwise. + /// if the owner voted for the specified player, otherwise. public bool VotedFor(byte playerId) { return Votes.Exists(x => x.Suspect == playerId); diff --git a/MiraAPI/Voting/VotingUtils.cs b/MiraAPI/Voting/VotingUtils.cs index 069157d..dbdf74c 100644 --- a/MiraAPI/Voting/VotingUtils.cs +++ b/MiraAPI/Voting/VotingUtils.cs @@ -17,11 +17,11 @@ public static class VotingUtils private const byte SkipVoteId = 253; /// - /// Gets the exiled player from the list of s. Returns null if no player is to be exiled. + /// Gets the exiled player from the list of s. Returns if no player is to be exiled. /// /// >The list of s to check. /// Whether the vote is a tie. - /// The player to be exiled. Will be null if no player is to be exiled. + /// The player to be exiled. Will be if no player is to be exiled. public static NetworkedPlayerInfo? GetExiled(List votes, out bool isTie) { var max = CalculateNumVotes(votes).MaxPair(out var tie);