diff --git a/Exiled.API/Enums/EffectType.cs b/Exiled.API/Enums/EffectType.cs index bfd2278d2a..f9b6be3836 100644 --- a/Exiled.API/Enums/EffectType.cs +++ b/Exiled.API/Enums/EffectType.cs @@ -5,11 +5,16 @@ // // ----------------------------------------------------------------------- + namespace Exiled.API.Enums { using System; using Exiled.API.Extensions; + using Exiled.API.Features.Items; + using Exiled.API.Features.Roles; + + using InventorySystem.Items.Usables; /// /// Status effects as enum. @@ -19,122 +24,129 @@ namespace Exiled.API.Enums public enum EffectType { /// - /// This EffectType do not exist it's only use when not found or error. + /// This enum member is used when there is no effect, similar to . /// None, /// - /// The player isn't able to open their inventory or reload a weapon. + /// Prevents the player from opening their inventory, reloading weapons, and using certain items. + /// Caused by . /// AmnesiaItems, /// - /// The player isn't able to see properly. + /// Prevents the player from seeing SCP-939. + /// Caused by /// AmnesiaVision, /// - /// Drains the player's stamina and then health. + /// Every 0.5s drains 5% of the player's stamina, or deals 2 damage if stamina is drained. /// Asphyxiated, /// - /// Damages the player over time. + /// Deals damage every 5 seconds, starting at 20 and halving each time down to a minimum of 2. /// Bleeding, /// - /// Blurs the player's screen. + /// Blurs player's screen. /// Blinded, /// - /// Increases damage the player receives. Does not apply any standalone damage. + /// Increases damage the player receives by 20%. Does not cause any damage by itself. /// Burned, /// - /// Blurs the player's screen while rotating. + /// Blurs player's screen when rotating. /// Concussed, /// - /// Effect given to player after being hurt by SCP-106. + /// Slowly drains stamina and health. Allows SCP-106 to teleport the player to pocket dimension. + /// Caused by . /// Corroding, /// - /// Deafens the player. + /// Muffles player's hearing. /// Deafened, /// - /// Removes 10% of the player's health per second. + /// Every second deals damage equal to 10% of player role's maximum health. Custom values are ignored by this effect. /// Decontaminating, /// - /// Slows down the player's movement. + /// Reduces movement speed by 20%. /// Disabled, /// - /// Prevents the player from moving. + /// Completely prevents the player from moving. /// Ensnared, /// - /// Halves the player's maximum stamina and stamina regeneration rate. + /// Halves stamina maximum value and regeneration rate. /// Exhausted, /// - /// Flashes the player. + /// Flashes the player, making them completely unable to see. + /// /// Flashed, /// - /// Drains the player's health while sprinting. + /// Deals 2 damage every second while sprinting. /// Hemorrhage, /// - /// Reduces the player's FOV, gives infinite stamina and gives the effect of underwater sound. + /// Reduces FOV, gives infinite stamina and muffled hearing effect. /// Invigorated, /// - /// Reduces damage taken by body shots. + /// Reduces damage taken from body shots. /// BodyshotReduction, /// - /// Damages the player every 5 seconds, starting low and increasing over time. + /// Deals damage every 5 seconds, starting at 2 and doubling each time up to a maximum of 20. /// Poisoned, /// - /// Increases the speed of the player while also draining health. + /// Increases the movement speed at the cost of draining health based on how fast the player is moving. /// Scp207, /// - /// Makes the player invisible. + /// Makes invisible with SCP-268 purple vignette effect. /// + /// + /// You can also hide a player using . or + /// Invisible, /// - /// Slows down the player's movement with the SCP-106 sinkhole effect. + /// Reduces movement speed with the SCP-106 sinkhole effect. /// SinkHole, /// - /// Reduces overall damage taken. + /// Reduces damage taken by 0.5% for each intensity level. /// DamageReduction, /// - /// Increases movement speed. + /// Increases movement speed by 1% for each intensity level. /// MovementBoost, @@ -144,12 +156,12 @@ public enum EffectType RainbowTaste, /// - /// Drops the player's current item, disables interaction with objects, and deals damage while effect is active. + /// Drops current item, disables interaction with objects, and deals damage while effect is active. /// SeveredHands, /// - /// Prevents the player from sprinting and reduces movement speed by 20%. + /// Prevents from sprinting and reduces movement speed by 20%. /// Stained, @@ -159,17 +171,18 @@ public enum EffectType Vitality, /// - /// Cause the player to slowly take damage, reduces bullet accuracy, and increases item pickup time. + /// Slowly deals damage, reduces bullet accuracy, and increases item pickup time. /// Hypothermia, /// - /// Increases the player's motor function, causing the player to reduce the weapon draw time, reload spead, item pickup speed, and medical item usage. + /// Reduce the weapon draw time, increases the speed of reloading, item pickup, and consumable use. /// Scp1853, /// - /// Effect given to player after being hurt by SCP-049. + /// Drain the player's health at a rate of 8 per second, and allows SCP-049 to one-shot the player. + /// Caused SCP-049. /// CardiacArrest, @@ -179,42 +192,43 @@ public enum EffectType InsufficientLighting, /// - /// Disable ambient sound. + /// Disables ambient sound. /// SoundtrackMute, /// - /// Protects players from enemy damage if the config is enabled. + /// Protects from enemy damage if spawn protection is enabled in configs. /// SpawnProtected, /// - /// Make Scp106 able to see you when he is in the ground (stalking), causes the player's screens to become monochromatic when seeing Scp106, and instantly killed if attacked by Scp106. + /// Makes SCP-106 able to see the player when he is in the ground (stalking), causes player's screen to become monochromatic when seeing SCP-106, and instantly die if attacked by Scp106. /// Traumatized, /// - /// It slows down the player, providing a passive health regeneration and saving the player from death once. + /// Reduces movement speed, regenerates health, and prevents the player from dying once. /// AntiScp207, /// - /// The effect that SCP-079 gives the scanned player with the Breach Scanner. + /// Makes SCP-079 able to see the player on the map. + /// Caused by SCP-079's Breach Scanner ability. /// Scanned, /// - /// Teleports the player to the pocket dimension and drains health until the player escapes or is killed. The amount of damage recieved increases the longer the effect is applied. + /// Teleports to the pocket dimension and deals increasing damage player's health until they escape or die. /// PocketCorroding, /// - /// Reduces walking sound by 10%. + /// Reduces walking sound by 10% for each intensity level. /// SilentWalk, /// - /// Makes you a marshmallow guy. + /// Turns the player into a marshmallow guy. /// [Obsolete("Not functional in-game")] Marshmallow, @@ -230,13 +244,14 @@ public enum EffectType Ghostly, /// - /// Manipulate wish Fog player will have. - /// You can choose fog with and putting it on intensity. + /// Modifies which type of fog the player sees. + /// You can choose the and put it in intensity. /// FogControl, /// - /// . + /// Reduces movement speed by 1% for each intensity level. + /// Can make the player move backwards if the intensity is over 100. /// Slowness, } diff --git a/Exiled.API/Extensions/DamageTypeExtensions.cs b/Exiled.API/Extensions/DamageTypeExtensions.cs index 3f58d449e3..1f9caf7aca 100644 --- a/Exiled.API/Extensions/DamageTypeExtensions.cs +++ b/Exiled.API/Extensions/DamageTypeExtensions.cs @@ -90,8 +90,8 @@ public static class DamageTypeExtensions /// Check if a damage type is caused by a weapon. /// /// The damage type to be checked. - /// Indicates whether or not the MicroHid damage type should be taken into account. - /// Returns whether or not the is caused by weapon. + /// Indicates whether the MicroHid damage type should be taken into account. + /// Returns whether the is caused by weapon. public static bool IsWeapon(this DamageType type, bool checkMicro = true) => type switch { DamageType.Crossvec or DamageType.Logicer or DamageType.Revolver or DamageType.Shotgun or DamageType.AK or DamageType.Com15 or DamageType.Com18 or DamageType.E11Sr or DamageType.Fsp9 or DamageType.ParticleDisruptor or DamageType.Com45 or DamageType.Frmg0 or DamageType.A7 => true, @@ -103,8 +103,8 @@ public static class DamageTypeExtensions /// Check if a damage type is caused by a SCP. /// /// The damage type to be checked. - /// Indicates whether or not the SCP-items damage types should be taken into account. - /// Returns whether or not the is caused by SCP. + /// Indicates whether the SCP-items damage types should be taken into account. + /// Returns whether the is caused by SCP. public static bool IsScp(this DamageType type, bool checkItems = true) => type switch { DamageType.Scp or DamageType.Scp049 or DamageType.Scp096 or DamageType.Scp106 or DamageType.Scp173 or DamageType.Scp939 or DamageType.Scp0492 or DamageType.Scp3114 => true, @@ -116,7 +116,7 @@ public static class DamageTypeExtensions /// Check if a damage type is caused by a status effect. /// /// The damage type to be checked. - /// Returns whether or not the is caused by status effect. + /// Returns whether the is caused by status effect. public static bool IsStatusEffect(this DamageType type) => type is DamageType.Asphyxiation or DamageType.Poison or DamageType.Bleeding or DamageType.Scp207 or DamageType.Hypothermia or DamageType.Strangled; /// diff --git a/Exiled.API/Extensions/DangerTypeExtensions.cs b/Exiled.API/Extensions/DangerTypeExtensions.cs index e9b35e6da1..ab2e7b1f4e 100644 --- a/Exiled.API/Extensions/DangerTypeExtensions.cs +++ b/Exiled.API/Extensions/DangerTypeExtensions.cs @@ -53,7 +53,7 @@ public static Type Type(this DangerType danger) /// /// The enum. /// The type found with the corresponding DangerType. - /// Whether or not the type has been found. + /// Whether the type has been found. public static bool TryGetType(this DangerType danger, out Type type) => DangerTypeToType.TryGetValue(danger, out type); @@ -70,7 +70,7 @@ public static DangerType GetDangerType(this DangerStackBase dangerStackBase) /// /// The enum. /// The danger type found. - /// Whether or not the danger has been found. + /// Whether the danger has been found. public static bool TryGetDangerType(this DangerStackBase dangerStackBase, out DangerType danger) { if (dangerStackBase == null || !TypeToDangerType.TryGetValue(dangerStackBase.GetType(), out danger)) diff --git a/Exiled.API/Extensions/EffectTypeExtension.cs b/Exiled.API/Extensions/EffectTypeExtension.cs index 0c39f1cf28..59f20d8786 100644 --- a/Exiled.API/Extensions/EffectTypeExtension.cs +++ b/Exiled.API/Extensions/EffectTypeExtension.cs @@ -95,7 +95,7 @@ public static Type Type(this EffectType effect) /// /// The enum. /// The type found with the corresponding EffecType. - /// Whether or not the effectType has been found. + /// Whether the effectType has been found. public static bool TryGetType(this EffectType effect, out Type type) => EffectTypeToType.TryGetValue(effect, out type); @@ -112,7 +112,7 @@ public static EffectType GetEffectType(this StatusEffectBase statusEffectBase) /// /// The enum. /// The effect found. - /// Whether or not the effect has been found. + /// Whether the effect has been found. public static bool TryGetEffectType(this StatusEffectBase statusEffectBase, out EffectType effect) { if (statusEffectBase == null || !TypeToEffectType.TryGetValue(statusEffectBase.GetType(), out effect)) @@ -132,51 +132,51 @@ public static bool TryGetEffectType(this StatusEffectBase statusEffectBase, out public static void SetFogType(this FogControl fogControl, FogType fogType) => fogControl.Intensity = (byte)(fogType + 1); /// - /// Returns whether or not the provided drains health over time. + /// Returns whether the provided drains health over time. /// /// The . - /// Whether or not the effect drains health over time. + /// Whether the effect drains health over time. /// public static bool IsHarmful(this EffectType effect) => effect is EffectType.Asphyxiated or EffectType.Bleeding or EffectType.Corroding or EffectType.Decontaminating or EffectType.Hemorrhage or EffectType.Hypothermia or EffectType.Poisoned or EffectType.Scp207 or EffectType.SeveredHands or EffectType.Strangled; /// - /// Returns whether or not the provided heals a player. + /// Returns whether the provided heals a player. /// /// The . - /// Whether or not the effect heals. + /// Whether the effect heals. /// public static bool IsHealing(this EffectType effect) => effect.TryGetType(out Type type) && typeof(IHealablePlayerEffect).IsAssignableFrom(type); /// - /// Returns whether or not the provided is a negative effect. + /// Returns whether the provided is a negative effect. /// /// The . - /// Whether or not the effect is a negative effect. + /// Whether the effect is a negative effect. /// public static bool IsNegative(this EffectType effect) => IsHarmful(effect) || GetEffectBase(effect)?.Classification is StatusEffectBase.EffectClassification.Negative; /// - /// Returns whether or not the provided is a positive effect. + /// Returns whether the provided is a positive effect. /// /// The . - /// Whether or not the effect is a positive effect. + /// Whether the effect is a positive effect. /// public static bool IsPositive(this EffectType effect) => GetEffectBase(effect)?.Classification == StatusEffectBase.EffectClassification.Positive; /// - /// Returns whether or not the provided affects the player's movement speed. + /// Returns whether the provided affects the player's movement speed. /// /// The . - /// Whether or not the effect modifies the player's movement speed. + /// Whether the effect modifies the player's movement speed. public static bool IsMovement(this EffectType effect) => effect.TryGetType(out Type type) && typeof(IMovementSpeedModifier).IsAssignableFrom(type); /// - /// Returns whether or not the provided is displayed to spectators as text. + /// Returns whether the provided is displayed to spectators as text. /// /// The . - /// Whether or not the effect is displayed to spectators as text. + /// Whether the effect is displayed to spectators as text. public static bool IsDisplayed(this EffectType effect) => effect.TryGetType(out Type type) && typeof(ISpectatorDataPlayerEffect).IsAssignableFrom(type); /// diff --git a/Exiled.API/Extensions/ItemExtensions.cs b/Exiled.API/Extensions/ItemExtensions.cs index f55754b835..0b84a6572f 100644 --- a/Exiled.API/Extensions/ItemExtensions.cs +++ b/Exiled.API/Extensions/ItemExtensions.cs @@ -44,42 +44,42 @@ public static class ItemExtensions /// Check if an item is an SCP. /// /// The item to be checked. - /// Returns whether or not the is an SCP. + /// Returns whether the is an SCP. public static bool IsScp(this ItemType type) => GetCategory(type) == ItemCategory.SCPItem; /// /// Check if an item is a throwable item. /// /// The item to be checked. - /// Returns whether or not the is a throwable item. + /// Returns whether the is a throwable item. public static bool IsThrowable(this ItemType type) => GetItemBase(type) != null; /// /// Check if an item is a medical item. /// /// The item to be checked. - /// Returns whether or not the is a medical item. + /// Returns whether the is a medical item. public static bool IsMedical(this ItemType type) => GetCategory(type) == ItemCategory.Medical; /// /// Check if an item is a utility item. /// /// The item to be checked. - /// Returns whether or not the is an utilty item. + /// Returns whether the is an utilty item. public static bool IsUtility(this ItemType type) => type is ItemType.Flashlight or ItemType.Radio; /// /// Check if a is an armor item. /// /// The item to be checked. - /// Returns whether or not the is an armor. + /// Returns whether the is an armor. public static bool IsArmor(this ItemType type) => GetCategory(type) == ItemCategory.Armor; /// /// Check if an item is a keycard. /// /// The item to be checked. - /// Returns whether or not the is a keycard. + /// Returns whether the is a keycard. public static bool IsKeycard(this ItemType type) => GetCategory(type) == ItemCategory.Keycard; /// diff --git a/Exiled.API/Extensions/MirrorExtensions.cs b/Exiled.API/Extensions/MirrorExtensions.cs index d0bdc27796..ee9e80f726 100644 --- a/Exiled.API/Extensions/MirrorExtensions.cs +++ b/Exiled.API/Extensions/MirrorExtensions.cs @@ -210,7 +210,7 @@ public static void SetName(this Player target, Player player, string name) /// /// Player to change. /// Model type. - /// Whether or not to skip the little jump that works around an invisibility issue. + /// Whether to skip the little jump that works around an invisibility issue. /// The UnitNameId to use for the player's new role, if the player's new role uses unit names. (is NTF). public static void ChangeAppearance(this Player player, RoleTypeId type, bool skipJump = false, byte unitId = 0) => ChangeAppearance(player, type, Player.List.Where(x => x != player), skipJump, unitId); @@ -221,7 +221,7 @@ public static void SetName(this Player target, Player player, string name) /// Player to change. /// Model type. /// The players who should see the changed appearance. - /// Whether or not to skip the little jump that works around an invisibility issue. + /// Whether to skip the little jump that works around an invisibility issue. /// The UnitNameId to use for the player's new role, if the player's new role uses unit names. (is NTF). public static void ChangeAppearance(this Player player, RoleTypeId type, IEnumerable playersToAffect, bool skipJump = false, byte unitId = 0) { diff --git a/Exiled.API/Features/Attributes/Validators/GreaterThanAttribute.cs b/Exiled.API/Features/Attributes/Validators/GreaterThanAttribute.cs index 2cbae79360..450dd7c606 100644 --- a/Exiled.API/Features/Attributes/Validators/GreaterThanAttribute.cs +++ b/Exiled.API/Features/Attributes/Validators/GreaterThanAttribute.cs @@ -21,7 +21,7 @@ public sealed class GreaterThanAttribute : Attribute, IValidator /// Initializes a new instance of the class. /// /// The number the marked property should be greater than. - /// Whether or not the comparison in inclusive (includes as a valid value for the marked property). + /// Whether the comparison in inclusive (includes as a valid value for the marked property). public GreaterThanAttribute(object number, bool isIncluded = false) { Number = (IComparable)number; @@ -34,7 +34,7 @@ public GreaterThanAttribute(object number, bool isIncluded = false) public IComparable Number { get; } /// - /// Gets a value indicating whether or not the comparison is inclusive. + /// Gets a value indicating whether the comparison is inclusive. /// If this returns true, is a valid value for the marked property. /// public bool IsIncluded { get; } diff --git a/Exiled.API/Features/Attributes/Validators/LessThanAttribute.cs b/Exiled.API/Features/Attributes/Validators/LessThanAttribute.cs index af8b511e8b..3a21ecdd01 100644 --- a/Exiled.API/Features/Attributes/Validators/LessThanAttribute.cs +++ b/Exiled.API/Features/Attributes/Validators/LessThanAttribute.cs @@ -21,7 +21,7 @@ public sealed class LessThanAttribute : Attribute, IValidator /// Initializes a new instance of the class. /// /// The number the marked property should be less than. - /// Whether or not the comparison in inclusive (includes as a valid value for the marked property). + /// Whether the comparison in inclusive (includes as a valid value for the marked property). public LessThanAttribute(object number, bool isIncluded = false) { Number = (IComparable)number; @@ -34,7 +34,7 @@ public LessThanAttribute(object number, bool isIncluded = false) public IComparable Number { get; } /// - /// Gets a value indicating whether or not the comparison is inclusive. + /// Gets a value indicating whether the comparison is inclusive. /// If this returns true, is a valid value for the marked property. /// public bool IsIncluded { get; } diff --git a/Exiled.API/Features/Badge.cs b/Exiled.API/Features/Badge.cs index 3367d612a9..30227ce0c7 100644 --- a/Exiled.API/Features/Badge.cs +++ b/Exiled.API/Features/Badge.cs @@ -44,11 +44,11 @@ public Badge(string text, string color, bool isGlobal = false) public bool IsGlobal { get; } /// - /// Gets whether or not the provided hex color code can be used in badges. + /// Checks if the provided hex color can be used in badges. /// /// The hex color code, including the #. /// If the method returns , this will be an enum representing the hex code. If the method returns , this will be . - /// Whether or not the provided hex color code can be used in badges. + /// Whether the provided hex color code can be used in badges. public static bool IsValidColor(string hex, out Misc.PlayerInfoColorTypes? colorType) { foreach (KeyValuePair option in Misc.AllowedColors) diff --git a/Exiled.API/Features/Broadcast.cs b/Exiled.API/Features/Broadcast.cs index d1648176e5..a8218319cb 100644 --- a/Exiled.API/Features/Broadcast.cs +++ b/Exiled.API/Features/Broadcast.cs @@ -32,7 +32,7 @@ public Broadcast() /// /// The content of the broadcast>. /// The duration of the broadcast, in seconds. - /// Whether or not the broadcast should be shown. + /// Whether the broadcast should be shown. /// The type of the broadcast. public Broadcast(string content, ushort duration = 10, bool show = true, BroadcastFlags type = BroadcastFlags.Normal) { diff --git a/Exiled.API/Features/Camera.cs b/Exiled.API/Features/Camera.cs index 6b0017ab05..c24ba8fc4f 100644 --- a/Exiled.API/Features/Camera.cs +++ b/Exiled.API/Features/Camera.cs @@ -202,7 +202,7 @@ internal Camera(Scp079Camera camera079) public float Zoom => Base.ZoomAxis.CurrentZoom; /// - /// Gets or sets a value indicating whether or not this camera is being used by SCP-079. + /// Gets or sets a value indicating whether this camera is being used by SCP-079. /// public bool IsBeingUsed { diff --git a/Exiled.API/Features/Cassie.cs b/Exiled.API/Features/Cassie.cs index 1e545161b8..c77d044cbb 100644 --- a/Exiled.API/Features/Cassie.cs +++ b/Exiled.API/Features/Cassie.cs @@ -38,7 +38,7 @@ public static class Cassie public static NineTailedFoxAnnouncer Announcer => NineTailedFoxAnnouncer.singleton; /// - /// Gets a value indicating whether or not C.A.S.S.I.E is currently announcing. Does not include decontamination or Alpha Warhead Messages. + /// Gets a value indicating whether the C.A.S.S.I.E is currently announcing. Does not include decontamination or Alpha Warhead Messages. /// public static bool IsSpeaking => Announcer.queue.Count != 0; @@ -172,14 +172,14 @@ public static void CustomScpTermination(string scpName, CustomHandlerBase info) public static void Clear() => RespawnEffectsController.ClearQueue(); /// - /// Gets a value indicating whether or not the given word is a valid C.A.S.S.I.E word. + /// Gets a value indicating whether the given word is a valid C.A.S.S.I.E word. /// /// The word to check. /// if the word is valid; otherwise, . public static bool IsValid(string word) => Announcer.voiceLines.Any(line => line.apiName.ToUpper() == word.ToUpper()); /// - /// Gets a value indicating whether or not the given sentence is all valid C.A.S.S.I.E word. + /// Gets a value indicating whether the given sentence is all valid C.A.S.S.I.E word. /// /// The sentence to check. /// if the sentence is valid; otherwise, . diff --git a/Exiled.API/Features/Components/FakeConnection.cs b/Exiled.API/Features/Components/FakeConnection.cs index 638a28caed..4243d12bcb 100644 --- a/Exiled.API/Features/Components/FakeConnection.cs +++ b/Exiled.API/Features/Components/FakeConnection.cs @@ -12,7 +12,7 @@ namespace Exiled.API.Features.Components using Mirror; /// - /// A fake network connection. + /// A fake network connection used for . /// public class FakeConnection : NetworkConnectionToClient { diff --git a/Exiled.API/Features/Core/Interfaces/IEntity.cs b/Exiled.API/Features/Core/Interfaces/IEntity.cs index aee4dadee8..f62aae37c1 100644 --- a/Exiled.API/Features/Core/Interfaces/IEntity.cs +++ b/Exiled.API/Features/Core/Interfaces/IEntity.cs @@ -254,7 +254,7 @@ public abstract bool TryGetComponent(Type type, out T component) /// Checks if the has an active component. /// /// The to look for. - /// A value indicating whether or not subclasses should be considered. + /// A value indicating whether subclasses should be considered. /// if the component was found; otherwise, . public abstract bool HasComponent(bool depthInheritance = false); @@ -262,7 +262,7 @@ public abstract bool TryGetComponent(Type type, out T component) /// Checks if the has an active component. /// /// The to look for. - /// A value indicating whether or not subclasses should be considered. + /// A value indicating whether subclasses should be considered. /// if the component was found; otherwise, . public abstract bool HasComponent(Type type, bool depthInheritance = false); } diff --git a/Exiled.API/Features/Doors/AirlockController.cs b/Exiled.API/Features/Doors/AirlockController.cs index eceda5f311..6171f6b24f 100644 --- a/Exiled.API/Features/Doors/AirlockController.cs +++ b/Exiled.API/Features/Doors/AirlockController.cs @@ -54,7 +54,7 @@ public AirlockController(BaseController controller) public Door DoorB => Door.Get(Base._doorB); /// - /// Gets or sets a value indicating whether or not both subdoors are locked. + /// Gets or sets a value indicating whether both subdoors are locked. /// public bool DoorsLocked { diff --git a/Exiled.API/Features/Doors/BreakableDoor.cs b/Exiled.API/Features/Doors/BreakableDoor.cs index a6b30617d3..0f0efe38de 100644 --- a/Exiled.API/Features/Doors/BreakableDoor.cs +++ b/Exiled.API/Features/Doors/BreakableDoor.cs @@ -47,7 +47,7 @@ public float MaxHealth } /// - /// Gets or sets a value indicating whether or not door is destroyed. + /// Gets or sets a value indicating whether door is destroyed. /// public bool IsDestroyed { @@ -56,7 +56,7 @@ public bool IsDestroyed } /// - /// Gets a value indicating whether or not this door is breakable. + /// Gets a value indicating whether this door is breakable. /// public bool IsBreakable => !IsDestroyed; diff --git a/Exiled.API/Features/Doors/Door.cs b/Exiled.API/Features/Doors/Door.cs index 244f176b0a..89fcf8ba5b 100644 --- a/Exiled.API/Features/Doors/Door.cs +++ b/Exiled.API/Features/Doors/Door.cs @@ -91,7 +91,7 @@ internal Door(DoorVariant door, List rooms) public IReadOnlyCollection Rooms { get; } /// - /// Gets a value indicating whether or not the door is fully closed. + /// Gets a value indicating whether the door is fully closed. /// public virtual bool IsFullyClosed => ExactState is 0; @@ -101,7 +101,7 @@ internal Door(DoorVariant door, List rooms) public virtual bool IsFullyOpen => ExactState is 1; /// - /// Gets a value indicating whether or not the door is currently moving. + /// Gets a value indicating whether the door is currently moving. /// public virtual bool IsMoving => !(IsFullyOpen || IsFullyClosed); @@ -134,32 +134,32 @@ public bool IsClosed } /// - /// Gets a value indicating whether or not this door is a gate. + /// Gets a value indicating whether this door is a gate. /// public bool IsGate => this is Gate; /// - /// Gets a value indicating whether or not this door is a checkpoint door. + /// Gets a value indicating whether this door is a checkpoint door. /// public bool IsCheckpoint => this is Checkpoint; /// - /// Gets a value indicating whether or not this door is an elevator door. + /// Gets a value indicating whether this door is an elevator door. /// public bool IsElevator => this is Elevator; /// - /// Gets a value indicating whether or not this door can be damaged. + /// Gets a value indicating whether this door can be damaged. /// public bool IsDamageable => this is Interfaces.IDamageableDoor; /// - /// Gets a value indicating whether or not this door is non-interactable. + /// Gets a value indicating whether this door is non-interactable. /// public bool IsNonInteractable => this is Interfaces.INonInteractableDoor; /// - /// Gets a value indicating whether or not this door is subdoor belonging to a checkpoint. + /// Gets a value indicating whether this door is subdoor belonging to a checkpoint. /// public bool IsPartOfCheckpoint => ParentCheckpointDoor is not null; @@ -169,7 +169,7 @@ public bool IsClosed public Door ParentCheckpointDoor { get; } /// - /// Gets a value indicating whether or not this door requires a keycard to open. + /// Gets a value indicating whether this door requires a keycard to open. /// /// /// This value is if is equal to . @@ -203,11 +203,11 @@ public override Vector3 Position } /// - /// Gets or sets a value indicating whether or not SCP-106 can walk through the door. + /// Gets or sets a value indicating whether SCP-106 can walk through the door. /// public bool AllowsScp106 { - get => Base is IScp106PassableDoor door && door.IsScp106Passable; + get => Base is IScp106PassableDoor { IsScp106Passable: true }; set { if (Base is IScp106PassableDoor door) @@ -216,7 +216,7 @@ public bool AllowsScp106 } /// - /// Gets a value indicating whether or not the door is locked. + /// Gets a value indicating whether the door is locked. /// public bool IsLocked => LockType > 0; diff --git a/Exiled.API/Features/Doors/Gate.cs b/Exiled.API/Features/Doors/Gate.cs index 20679cf582..29f8e987f5 100644 --- a/Exiled.API/Features/Doors/Gate.cs +++ b/Exiled.API/Features/Doors/Gate.cs @@ -41,7 +41,7 @@ public Gate(PryableDoor door, List room) public IEnumerable PryPositions => Base.PryPositions; /// - /// Gets a value indicating whether or not the door is fully closed. + /// Gets a value indicating whether the door is fully closed. /// public override bool IsFullyClosed => base.IsFullyClosed && RemainingPryCooldown <= 0; @@ -51,7 +51,7 @@ public Gate(PryableDoor door, List room) public override bool IsFullyOpen => base.IsFullyOpen || (Base is Timed173PryableDoor && ExactState is 0.5845918f); /// - /// Gets a value indicating whether or not the door is currently moving. + /// Gets a value indicating whether the door is currently moving. /// public override bool IsMoving => base.IsMoving || RemainingPryCooldown > 0; diff --git a/Exiled.API/Features/Effect.cs b/Exiled.API/Features/Effect.cs index 5e8ecd887e..6a9f7ff1b3 100644 --- a/Exiled.API/Features/Effect.cs +++ b/Exiled.API/Features/Effect.cs @@ -42,7 +42,7 @@ public Effect(StatusEffectBase statusEffectBase) /// The duration of the effect, in seconds. /// The intensity of the effect. /// Whether the effect will add duration onto the effect if already active or not. - /// Whether or not the effect should be enabled. + /// Whether the effect should be enabled. public Effect(EffectType type, float duration, byte intensity = 1, bool addDurationIfActive = false, bool isEnabled = true) { Type = type; diff --git a/Exiled.API/Features/Generator.cs b/Exiled.API/Features/Generator.cs index 79f6450835..a65b9a35f0 100644 --- a/Exiled.API/Features/Generator.cs +++ b/Exiled.API/Features/Generator.cs @@ -288,7 +288,7 @@ public static IEnumerable Get(GeneratorState state) /// /// The instance. /// A or if not found. - /// Whether or not a generator was found. + /// Whether a generator was found. public static bool TryGet(Scp079Generator scp079Generator, out Generator generator) { generator = Get(scp079Generator); @@ -300,7 +300,7 @@ public static bool TryGet(Scp079Generator scp079Generator, out Generator generat /// /// The to search for. /// A of matching the . - /// Whether or not at least one generator was found. + /// Whether at least one generator was found. public static bool TryGet(GeneratorState state, out IEnumerable generators) { generators = Get(state); @@ -312,7 +312,7 @@ public static bool TryGet(GeneratorState state, out IEnumerable gener /// /// The condition to satisfy. /// A of which contains elements that satisfy the condition. - /// Whether or not at least one generator was found. + /// Whether at least one generator was found. public static bool TryGet(Func predicate, out IEnumerable generators) { generators = Get(predicate); diff --git a/Exiled.API/Features/Hazards/AmnesticCloudHazard.cs b/Exiled.API/Features/Hazards/AmnesticCloudHazard.cs index 9ad815c6ca..814db0daee 100644 --- a/Exiled.API/Features/Hazards/AmnesticCloudHazard.cs +++ b/Exiled.API/Features/Hazards/AmnesticCloudHazard.cs @@ -104,7 +104,7 @@ public float MaxHoldTime } /// - /// Gets or sets a value indicating whether or not hazard is active or not. + /// Gets or sets a value indicating whether hazard is active or not. /// public bool TargetState { diff --git a/Exiled.API/Features/Hazards/Hazard.cs b/Exiled.API/Features/Hazards/Hazard.cs index 5949b3c250..24eca91a1d 100644 --- a/Exiled.API/Features/Hazards/Hazard.cs +++ b/Exiled.API/Features/Hazards/Hazard.cs @@ -87,7 +87,7 @@ public float MaxHeightDistance } /// - /// Gets a value indicating whether or not hazard is active. + /// Gets a value indicating whether hazard is active. /// public bool IsActive => Base.IsActive; diff --git a/Exiled.API/Features/Hazards/TantrumHazard.cs b/Exiled.API/Features/Hazards/TantrumHazard.cs index 0e9138d702..787cbed5d4 100644 --- a/Exiled.API/Features/Hazards/TantrumHazard.cs +++ b/Exiled.API/Features/Hazards/TantrumHazard.cs @@ -54,7 +54,7 @@ public TantrumHazard(TantrumEnvironmentalHazard hazard) public override HazardType Type { get; } = HazardType.Tantrum; /// - /// Gets or sets a value indicating whether or not sizzle should be played. + /// Gets or sets a value indicating whether sizzle should be played. /// public bool PlaySizzle { @@ -84,7 +84,7 @@ public Transform CorrectPosition /// Places a Tantrum (SCP-173's ability) in the indicated position. /// /// The position where you want to spawn the Tantrum. - /// Whether or not the tantrum will apply the effect. + /// Whether the tantrum will apply the effect. /// If is , the tantrum is moved slightly up from its original position. Otherwise, the collision will not be detected and the slowness will not work. /// The instance. public static TantrumHazard CreateAndSpawn(Vector3 position, bool isActive = true) diff --git a/Exiled.API/Features/Hazards/TemporaryHazard.cs b/Exiled.API/Features/Hazards/TemporaryHazard.cs index e4afa3dcae..c048359b05 100644 --- a/Exiled.API/Features/Hazards/TemporaryHazard.cs +++ b/Exiled.API/Features/Hazards/TemporaryHazard.cs @@ -30,7 +30,7 @@ public TemporaryHazard(BaseHazard hazard) public new BaseHazard Base { get; } /// - /// Gets or sets a value indicating whether or not hazard is destroyed. + /// Gets or sets a value indicating whether hazard is destroyed. /// public bool IsDestroyed { diff --git a/Exiled.API/Features/Hint.cs b/Exiled.API/Features/Hint.cs index 38a6b8f230..361aadd339 100644 --- a/Exiled.API/Features/Hint.cs +++ b/Exiled.API/Features/Hint.cs @@ -36,7 +36,7 @@ public Hint() /// The duration of the hint, in seconds. /// The hint parameters. /// The hint effects. - /// Whether or not the hint should be shown. + /// Whether the hint should be shown. public Hint(string content, float duration = 3, bool show = true, HintParameter[] parameters = null, HintEffect[] effects = null) { Content = content; diff --git a/Exiled.API/Features/Intercom.cs b/Exiled.API/Features/Intercom.cs index 5dbee72414..32469d74ab 100644 --- a/Exiled.API/Features/Intercom.cs +++ b/Exiled.API/Features/Intercom.cs @@ -54,7 +54,7 @@ public static IntercomState State public static Transform Transform => GameIntercom._singleton.transform; /// - /// Gets a value indicating whether or not the intercom is currently being used. + /// Gets a value indicating whether the intercom is currently being used. /// public static bool InUse => State is IntercomState.InUse or IntercomState.Starting; @@ -85,7 +85,7 @@ public static float SpeechRemainingTime /// /// Plays the intercom's sound. /// - /// Sets a value indicating whether or not the sound is the intercom's start speaking sound. + /// Whether the sound is the intercom's start or end sound. public static void PlaySound(bool isStarting) => GameIntercom._singleton.RpcPlayClip(isStarting); /// diff --git a/Exiled.API/Features/Items/Armor.cs b/Exiled.API/Features/Items/Armor.cs index 7f6dcbe9f0..416b254966 100644 --- a/Exiled.API/Features/Items/Armor.cs +++ b/Exiled.API/Features/Items/Armor.cs @@ -59,7 +59,7 @@ internal Armor(ItemType type) public bool Holsterable => Base.AllowHolster; /// - /// Gets a value indicating whether or not this is a worn item. + /// Gets a value indicating whether this is a worn item. /// [EProperty(readOnly: true, category: nameof(Armor))] public bool IsWorn => Base.IsWorn; @@ -75,7 +75,7 @@ public override float Weight } /// - /// Gets or sets a value indicating whether or not excess ammo should be removed when the armor is dropped. + /// Gets or sets a value indicating whether excess ammo should be removed when the armor is dropped. /// [EProperty(category: nameof(Armor))] public bool RemoveExcessOnDrop diff --git a/Exiled.API/Features/Items/Firearm.cs b/Exiled.API/Features/Items/Firearm.cs index f498cfe410..ff52445835 100644 --- a/Exiled.API/Features/Items/Firearm.cs +++ b/Exiled.API/Features/Items/Firearm.cs @@ -189,7 +189,7 @@ public AmmoType AmmoType public bool CanSeeThroughDark => FlashlightEnabled || NightVisionEnabled; /// - /// Gets a value indicating whether or not the firearm is automatic. + /// Gets a value indicating whether the firearm is automatic. /// [EProperty(readOnly: true, category: nameof(Firearm))] public bool IsAutomatic => Base is AutomaticFirearm; @@ -610,7 +610,7 @@ public void RemoveAttachment(IEnumerable attachmentSlots) /// /// The to check. /// The corresponding . - /// A value indicating whether or not the firearm has the specified . + /// a value indicating whether the firearm has the specified . public bool TryGetAttachment(AttachmentIdentifier identifier, out Attachment firearmAttachment) { firearmAttachment = default; @@ -628,7 +628,7 @@ public bool TryGetAttachment(AttachmentIdentifier identifier, out Attachment fir /// /// The to check. /// The corresponding . - /// A value indicating whether or not the firearm has the specified . + /// a value indicating whether the firearm has the specified . public bool TryGetAttachment(AttachmentName attachmentName, out Attachment firearmAttachment) { firearmAttachment = default; diff --git a/Exiled.API/Features/Items/Item.cs b/Exiled.API/Features/Items/Item.cs index 03efd8aa14..2430909070 100644 --- a/Exiled.API/Features/Items/Item.cs +++ b/Exiled.API/Features/Items/Item.cs @@ -139,61 +139,61 @@ public virtual float Weight } /// - /// Gets a value indicating whether or not this item is ammunition. + /// Gets a value indicating whether this item is ammunition. /// [EProperty(readOnly: true, category: nameof(Item))] public bool IsAmmo => this is Ammo; /// - /// Gets a value indicating whether or not this item is armor. + /// Gets a value indicating whether this item is armor. /// [EProperty(readOnly: true, category: nameof(Item))] public bool IsArmor => this is Armor; /// - /// Gets a value indicating whether or not this item is a keycard. + /// Gets a value indicating whether this item is a keycard. /// [EProperty(readOnly: true, category: nameof(Item))] public bool IsKeycard => this is Keycard; /// - /// Gets a value indicating whether or not this item will be destroy when being used. + /// Gets a value indicating whether this item will be destroy when being used. /// [EProperty(readOnly: true, category: nameof(Item))] public bool IsConsumable => this is Consumable; /// - /// Gets a value indicating whether or not this item is a throwable item. + /// Gets a value indicating whether this item is a throwable item. /// [EProperty(readOnly: true, category: nameof(Item))] public bool IsThrowable => this is Throwable; /// - /// Gets a value indicating whether or not this item can be used by a player. + /// Gets a value indicating whether this item can be used by a player. /// [EProperty(readOnly: true, category: nameof(Item))] public bool IsUsable => this is Usable; /// - /// Gets a value indicating whether or not this item is a weapon. + /// Gets a value indicating whether this item is a weapon. /// [EProperty(readOnly: true, category: nameof(Item))] public bool IsWeapon => this is Firearm; /// - /// Gets a value indicating whether or not this item emits light. + /// Gets a value indicating whether this item emits light. /// [EProperty(readOnly: true, category: nameof(Item))] public bool CanEmitLight => this is Firearm firearm ? firearm.HasFlashlight : Base is ILightEmittingItem; /// - /// Gets a value indicating whether or not this item is currently imitating light. + /// Gets a value indicating whether this item is currently imitating light. /// [EProperty(readOnly: true, category: nameof(Item))] public bool IsEmittingLight => Base is ILightEmittingItem light && light.IsEmittingLight; /// - /// Gets a value indicating whether or not this item can be used to disarm players. + /// Gets a value indicating whether this item can be used to disarm players. /// [EProperty(readOnly: true, category: nameof(Item))] public bool IsDisarmer => Base is IDisarmingItem; diff --git a/Exiled.API/Features/Items/Radio.cs b/Exiled.API/Features/Items/Radio.cs index e56f1afe7e..8999c218f4 100644 --- a/Exiled.API/Features/Items/Radio.cs +++ b/Exiled.API/Features/Items/Radio.cs @@ -98,7 +98,7 @@ public bool IsEnabled } /// - /// Gets a value indicating whether or not the radio is transmitting. + /// Gets a value indicating whether the radio is transmitting. /// [EProperty(readOnly: true, category: nameof(Radio))] public bool IsTransmitting => PersonalRadioPlayback.IsTransmitting(Owner.ReferenceHub); diff --git a/Exiled.API/Features/Items/Scp244.cs b/Exiled.API/Features/Items/Scp244.cs index 9ff535cefa..986c705702 100644 --- a/Exiled.API/Features/Items/Scp244.cs +++ b/Exiled.API/Features/Items/Scp244.cs @@ -53,7 +53,7 @@ internal Scp244(ItemType scp244Type) public new Scp244Item Base { get; } /// - /// Gets or sets a value indicating whether or not SCP-244 will spawn primed. + /// Gets or sets a value indicating whether SCP-244 will spawn primed. /// [EProperty(category: nameof(Scp244))] public bool Primed diff --git a/Exiled.API/Features/Items/Scp330.cs b/Exiled.API/Features/Items/Scp330.cs index 3d48ac51b1..0a36f9f407 100644 --- a/Exiled.API/Features/Items/Scp330.cs +++ b/Exiled.API/Features/Items/Scp330.cs @@ -162,7 +162,7 @@ public int AddCandy(IEnumerable candies, out CandyAddStatus status) /// Removes a specific candy from the bag. /// /// The to be removed. - /// Whether or not to only remove all matching candy. (If , all candies of the given type are removed). + /// Whether to only remove all matching candy. (If , all candies of the given type are removed). /// The total amount of candies that were removed from the bag. public int RemoveCandy(CandyKindID type, bool removeAll = false) { @@ -201,8 +201,8 @@ public int RemoveAllCandy() /// Drops candies from the bag. /// /// The of candies to drop. - /// Whether or not to drop all candies matching the given type, or just one. - /// Whether or not to drop all candies individually, or as a bag, when dropping more than one candy. + /// Whether to drop all candies matching the given type, or just one. + /// Whether to drop all candies individually, or as a bag, when dropping more than one candy. /// The to use, if the override is set to true. /// a of s generated by this method. *Can be empty!*. public IEnumerable DropCandy(CandyKindID type, bool dropAll = false, bool dropIndividual = false, CandyKindID exposedType = CandyKindID.None) diff --git a/Exiled.API/Features/Lift.cs b/Exiled.API/Features/Lift.cs index bcf9a3c5e1..d3d5b3b3e1 100644 --- a/Exiled.API/Features/Lift.cs +++ b/Exiled.API/Features/Lift.cs @@ -378,7 +378,7 @@ public void Lock(DoorLockType lockReason = DoorLockType.Isolation) public void ChangeLock(DoorLockType lockReason) => Doors.ForEach(x => x.ChangeLock(lockReason)); /// - /// Returns whether or not the provided position is inside the lift. + /// Returns whether the provided position is inside the lift. /// /// The position. /// if the point is inside the elevator. Otherwise, . diff --git a/Exiled.API/Features/Lockers/Chamber.cs b/Exiled.API/Features/Lockers/Chamber.cs index f4142a692c..ea343974f2 100644 --- a/Exiled.API/Features/Lockers/Chamber.cs +++ b/Exiled.API/Features/Lockers/Chamber.cs @@ -135,7 +135,7 @@ public Transform Spawnpoint } /// - /// Gets or sets a value indicating whether or not items should be spawned as soon as they are initialized. + /// Gets or sets a value indicating whether items should be spawned as soon as they are initialized. /// public bool InitiallySpawn { diff --git a/Exiled.API/Features/Pickups/BodyArmorPickup.cs b/Exiled.API/Features/Pickups/BodyArmorPickup.cs index deea9290c9..a77b71173a 100644 --- a/Exiled.API/Features/Pickups/BodyArmorPickup.cs +++ b/Exiled.API/Features/Pickups/BodyArmorPickup.cs @@ -66,13 +66,13 @@ internal BodyArmorPickup(ItemType type) public bool Holsterable { get; } = false; /// - /// Gets a value indicating whether or not this is a worn item. + /// Gets a value indicating whether this is a worn item. /// [EProperty(readOnly: true, category: nameof(BodyArmorPickup))] public bool IsWorn { get; } = true; /// - /// Gets or sets a value indicating whether or not excess ammo should be removed when the armor is dropped. + /// Gets or sets a value indicating whether excess ammo should be removed when the armor is dropped. /// public bool RemoveExcessOnDrop { get; set; } diff --git a/Exiled.API/Features/Pickups/Projectiles/Scp018Projectile.cs b/Exiled.API/Features/Pickups/Projectiles/Scp018Projectile.cs index cc69e83bc2..b964de91db 100644 --- a/Exiled.API/Features/Pickups/Projectiles/Scp018Projectile.cs +++ b/Exiled.API/Features/Pickups/Projectiles/Scp018Projectile.cs @@ -77,7 +77,7 @@ public float VelocityPerBounce } /// - /// Gets a value indicating whether or not SCP-018 can injure teammates. + /// Gets a value indicating whether SCP-018 can injure teammates. /// [EProperty(readOnly: true, category: nameof(Scp018Projectile))] public bool IgnoreFriendlyFire => Base.IgnoreFriendlyFire; diff --git a/Exiled.API/Features/Pickups/Projectiles/Scp2176Projectile.cs b/Exiled.API/Features/Pickups/Projectiles/Scp2176Projectile.cs index 195c94276b..23528d1a7d 100644 --- a/Exiled.API/Features/Pickups/Projectiles/Scp2176Projectile.cs +++ b/Exiled.API/Features/Pickups/Projectiles/Scp2176Projectile.cs @@ -44,7 +44,7 @@ internal Scp2176Projectile() public new BaseScp2176Projectile Base { get; } /// - /// Gets a value indicating whether or not SCP-2176 has shattered. + /// Gets a value indicating whether SCP-2176 has shattered. /// [EProperty(category: nameof(Scp2176Projectile))] public bool IsAlreadyTriggered => Base._hasTriggered; diff --git a/Exiled.API/Features/Pickups/Scp244Pickup.cs b/Exiled.API/Features/Pickups/Scp244Pickup.cs index 21ad5f88a1..3f061b5ebb 100644 --- a/Exiled.API/Features/Pickups/Scp244Pickup.cs +++ b/Exiled.API/Features/Pickups/Scp244Pickup.cs @@ -103,13 +103,13 @@ public float Health } /// - /// Gets a value indicating whether or not this Scp244 is breakable. + /// Gets a value indicating whether this Scp244 is breakable. /// [EProperty(readOnly: true, category: nameof(Scp244Pickup))] public bool IsBreakable => Base.State is Scp244State.Idle or Scp244State.Active; /// - /// Gets a value indicating whether or not this Scp244 is broken. + /// Gets a value indicating whether this Scp244 is broken. /// [EProperty(readOnly: true, category: nameof(Scp244Pickup))] public bool IsBroken => Base.State is Scp244State.Destroyed; diff --git a/Exiled.API/Features/Player.cs b/Exiled.API/Features/Player.cs index e49a74ad67..190eca396f 100644 --- a/Exiled.API/Features/Player.cs +++ b/Exiled.API/Features/Player.cs @@ -264,7 +264,7 @@ private set public Hint CurrentHint { get; internal set; } /// - /// Gets a value indicating whether or not the player is viewing a hint. + /// Gets a value indicating whether the player is viewing a hint. /// [EProperty(readOnly: true, category: HINTS_CATEGORY)] public bool HasHint => CurrentHint != null; @@ -353,7 +353,7 @@ public AuthenticationType AuthenticationType } /// - /// Gets a value indicating whether or not the player is verified. + /// Gets a value indicating whether the player is verified. /// /// /// This is always if online_mode is set to . @@ -361,12 +361,12 @@ public AuthenticationType AuthenticationType public bool IsVerified { get; internal set; } /// - /// Gets or sets a value indicating whether or not the player is a NPC. + /// Gets or sets a value indicating whether the player is a NPC. /// public bool IsNPC { get; set; } /// - /// Gets a value indicating whether or not the player has an active CustomName. + /// Gets a value indicating whether the player has an active CustomName. /// public bool HasCustomName => ReferenceHub.nicknameSync.HasCustomName; @@ -476,7 +476,7 @@ public float InfoViewRange public Dictionary SessionVariables { get; } = DictionaryPool.Pool.Get(); /// - /// Gets a value indicating whether or not the player has Do Not Track (DNT) enabled. If this value is , data about the player unrelated to server security shouldn't be stored. + /// Gets a value indicating whether the player has Do Not Track (DNT) enabled. If this value is , data about the player unrelated to server security shouldn't be stored. /// public bool DoNotTrack => ReferenceHub.authManager.DoNotTrack; @@ -486,14 +486,14 @@ public float InfoViewRange public bool IsConnected => GameObject != null; /// - /// Gets a value indicating whether or not the player has a reserved slot. + /// Gets a value indicating whether the player has a reserved slot. /// /// /// public bool HasReservedSlot => ReservedSlot.HasReservedSlot(UserId, out _); /// - /// Gets a value indicating whether or not the player is in whitelist. + /// Gets a value indicating whether the player is in whitelist. /// /// It will always return if a whitelist is disabled on the server. /// @@ -501,12 +501,12 @@ public float InfoViewRange public bool IsWhitelisted => WhiteList.IsWhitelisted(UserId); /// - /// Gets a value indicating whether or not the player has Remote Admin access. + /// Gets a value indicating whether the player has Remote Admin access. /// public bool RemoteAdminAccess => ReferenceHub.serverRoles.RemoteAdmin; /// - /// Gets a value indicating whether or not the player has Admin Chat access. + /// Gets a value indicating whether the player has Admin Chat access. /// public bool AdminChatAccess => ReferenceHub.serverRoles.AdminChatPerms; @@ -516,7 +516,7 @@ public float InfoViewRange public byte KickPower => ReferenceHub.serverRoles.KickPower; /// - /// Gets or sets a value indicating whether or not the player's overwatch is enabled. + /// Gets or sets a value indicating whether the player's overwatch is enabled. /// [EProperty(category: ROLES_CATEGORY)] public bool IsOverwatchEnabled @@ -526,7 +526,7 @@ public bool IsOverwatchEnabled } /// - /// Gets or sets a value indicating whether or not the player is allowed to enter noclip mode. + /// Gets or sets a value indicating whether the player is allowed to enter noclip mode. /// /// For forcing the player into noclip mode, see . /// @@ -544,7 +544,7 @@ public bool IsNoclipPermitted } /// - /// Gets or sets a value indicating whether or not the player has noclip enabled. + /// Gets or sets a value indicating whether the player has noclip enabled. /// /// indicating status. /// For permitting a player to enter and exit noclip freely, see . @@ -688,28 +688,28 @@ public ScpSpawnPreferences.SpawnPreferences ScpPreferences } /// - /// Gets a value indicating whether or not the player is cuffed. + /// Gets a value indicating whether the player is cuffed. /// /// Players can be cuffed without another player being the cuffer. public bool IsCuffed => Inventory.IsDisarmed(); /// - /// Gets a value indicating whether or not the player is reloading a weapon. + /// Gets a value indicating whether the player is reloading a weapon. /// public bool IsReloading => CurrentItem is Firearm firearm && !firearm.Base.AmmoManagerModule.Standby; /// - /// Gets a value indicating whether or not the player is aiming with a weapon. + /// Gets a value indicating whether the player is aiming with a weapon. /// public bool IsAimingDownWeapon => CurrentItem is Firearm firearm && firearm.Aiming; /// - /// Gets a value indicating whether or not the player has enabled weapon's flashlight module. + /// Gets a value indicating whether the player has enabled weapon's flashlight module. /// public bool HasFlashlightModuleEnabled => CurrentItem is Firearm firearm && firearm.FlashlightEnabled; /// - /// Gets a value indicating whether or not the player is jumping. + /// Gets a value indicating whether the player is jumping. /// public bool IsJumping => Role is FpcRole fpc && fpc.FirstPersonController.FpcModule.Motor.IsJumping; @@ -739,57 +739,57 @@ public ScpSpawnPreferences.SpawnPreferences ScpPreferences public uint NetId => ReferenceHub.netId; /// - /// Gets a value indicating whether or not the player is the host. + /// Gets a value indicating whether the player is the host. /// public bool IsHost => ReferenceHub.isLocalPlayer; /// - /// Gets a value indicating whether or not the player is alive. + /// Gets a value indicating whether the player is alive. /// [EProperty(readOnly: true, category: ROLES_CATEGORY)] public bool IsAlive => !IsDead; /// - /// Gets a value indicating whether or not the player is dead. + /// Gets a value indicating whether the player is dead. /// [EProperty(readOnly: true, category: ROLES_CATEGORY)] public bool IsDead => Role?.IsDead ?? false; /// - /// Gets a value indicating whether or not the player's is any NTF rank. + /// Gets a value indicating whether the player's is any NTF rank. /// Equivalent to checking the player's . /// [EProperty(readOnly: true, category: ROLES_CATEGORY)] public bool IsNTF => Role?.Team is Team.FoundationForces; /// - /// Gets a value indicating whether or not the player's is any Chaos rank. + /// Gets a value indicating whether the player's is any Chaos rank. /// Equivalent to checking the player's . /// [EProperty(readOnly: true, category: ROLES_CATEGORY)] public bool IsCHI => Role?.Team is Team.ChaosInsurgency; /// - /// Gets a value indicating whether or not the player's is any SCP. + /// Gets a value indicating whether the player's is any SCP. /// Equivalent to checking the player's . /// [EProperty(readOnly: true, category: ROLES_CATEGORY)] public bool IsScp => Role?.Team is Team.SCPs; /// - /// Gets a value indicating whether or not the player's is any human rank. + /// Gets a value indicating whether the player's is any human rank. /// [EProperty(readOnly: true, category: ROLES_CATEGORY)] public bool IsHuman => Role is not null && Role.Is(out HumanRole _); /// - /// Gets a value indicating whether or not the player's is equal to . + /// Gets a value indicating whether the player's is equal to . /// [EProperty(readOnly: true, category: ROLES_CATEGORY)] public bool IsTutorial => Role?.Type is RoleTypeId.Tutorial; /// - /// Gets a value indicating whether or not the player's friendly fire is enabled. + /// Gets a value indicating whether the player's friendly fire is enabled. ///
This property only determines if this player can deal damage to players on the same team;
///
This player can be damaged by other players on their own team even if this property is .
/// @@ -823,7 +823,7 @@ public Vector3 Scale } /// - /// Gets or sets a value indicating whether or not the player's bypass mode is enabled. + /// Gets or sets a value indicating whether the player's bypass mode is enabled. /// [EProperty(category: ROLES_CATEGORY)] public bool IsBypassModeEnabled @@ -833,7 +833,7 @@ public bool IsBypassModeEnabled } /// - /// Gets or sets a value indicating whether or not the player is muted. + /// Gets or sets a value indicating whether the player is muted. /// /// This property will NOT persistently mute and unmute the player. For persistent mutes, see and . [EProperty(category: INFO_CATEGORY)] @@ -844,7 +844,7 @@ public bool IsMuted } /// - /// Gets or sets a value indicating whether or not the player is global muted. + /// Gets or sets a value indicating whether the player is global muted. /// /// This property will NOT persistently mute and unmute the player. For persistent mutes, see and . [EProperty(category: INFO_CATEGORY)] @@ -855,7 +855,7 @@ public bool IsGlobalMuted } /// - /// Gets or sets a value indicating whether or not the player is intercom muted. + /// Gets or sets a value indicating whether the player is intercom muted. /// /// This property will NOT persistently mute and unmute the player. For persistent mutes, see and . [EProperty(category: INFO_CATEGORY)] @@ -866,7 +866,7 @@ public bool IsIntercomMuted } /// - /// Gets a value indicating whether or not the player is speaking. + /// Gets a value indicating whether the player is speaking. /// public bool IsSpeaking => VoiceModule != null && VoiceModule.IsSpeaking; @@ -899,12 +899,12 @@ public VoiceChatChannel VoiceChannel } /// - /// Gets a value indicating whether or not the player is transmitting on a Radio. + /// Gets a value indicating whether the player is transmitting on a Radio. /// public bool IsTransmitting => PersonalRadioPlayback.IsTransmitting(ReferenceHub); /// - /// Gets or sets a value indicating whether or not the player has godmode enabled. + /// Gets or sets a value indicating whether the player has godmode enabled. /// [EProperty(category: ROLES_CATEGORY)] public bool IsGodModeEnabled @@ -1092,7 +1092,7 @@ public float MaxStamina } /// - /// Gets a value indicating whether or not the staff bypass is enabled. + /// Gets a value indicating whether the staff bypass is enabled. /// public bool IsStaffBypassEnabled => ReferenceHub.authManager.BypassBansFlagSet; @@ -1190,7 +1190,7 @@ public Badge? GlobalBadge } /// - /// Gets or sets a value indicating whether or not the player's badge is hidden. + /// Gets or sets a value indicating whether the player's badge is hidden. /// [EProperty(category: INFO_CATEGORY)] public bool BadgeHidden @@ -1206,23 +1206,23 @@ public bool BadgeHidden } /// - /// Gets a value indicating whether or not the player is Northwood staff. + /// Gets a value indicating whether the player is Northwood staff. /// public bool IsNorthwoodStaff => ReferenceHub.authManager.NorthwoodStaff; /// - /// Gets a value indicating whether or not the player is a global moderator. + /// Gets a value indicating whether the player is a global moderator. /// public bool IsGlobalModerator => ReferenceHub.authManager.RemoteAdminGlobalAccess; /// - /// Gets a value indicating whether or not the player is in the pocket dimension. + /// Gets a value indicating whether the player is in the pocket dimension. /// [EProperty(readOnly: true, category: WORLDSPACE_CATEGORY)] public bool IsInPocketDimension => CurrentRoom && CurrentRoom.Type is RoomType.Pocket; /// - /// Gets or sets a value indicating whether or not the player should use stamina system. + /// Gets or sets a value indicating whether the player should use stamina system. /// [EProperty(category: STATS_CATEGORY)] public bool IsUsingStamina { get; set; } = true; @@ -1239,13 +1239,13 @@ public bool BadgeHidden public IReadOnlyCollection Items { get; } /// - /// Gets a value indicating whether or not the player's inventory is empty. + /// Gets a value indicating whether the player's inventory is empty. /// [EProperty(readOnly: true, category: INVENTORY_CATEGORY)] public bool IsInventoryEmpty => Items.Count is 0; /// - /// Gets a value indicating whether or not the player's inventory is full. + /// Gets a value indicating whether the player's inventory is full. /// [EProperty(readOnly: true, category: INVENTORY_CATEGORY)] public bool IsInventoryFull => Items.Count >= Inventory.MaxSlots; @@ -1270,12 +1270,12 @@ public bool BadgeHidden public bool IsScp173Observer => Player.List.Any(x => x.Role is Roles.Scp173Role scp173Role && scp173Role.ObservingPlayers.Contains(x)); /// - /// Gets a value indicating whether or not the player has agreed to microphone recording. + /// Gets a value indicating whether the player has agreed to microphone recording. /// public bool AgreedToRecording => VoiceChatPrivacySettings.CheckUserFlags(ReferenceHub, VcPrivacyFlags.SettingsSelected | VcPrivacyFlags.AllowRecording | VcPrivacyFlags.AllowMicCapture); /// - /// Gets or sets a value indicating whether or not player will be affected by a flashbang. + /// Gets or sets a value indicating whether player will be affected by a flashbang. /// [EProperty(category: EFFECTS_CATEGORY)] public bool FlashImmune { get; set; } = false; @@ -1296,7 +1296,7 @@ public bool BadgeHidden public Footprint Footprint => new(ReferenceHub); /// - /// Gets or sets a value indicating whether or not the player is spawn protected. + /// Gets or sets a value indicating whether the player is spawn protected. /// [EProperty(category: INFO_CATEGORY)] public bool IsSpawnProtected @@ -1557,7 +1557,7 @@ public static Player Get(string args) /// /// The . /// The player that matches the given , or if no player is found. - /// A boolean indicating whether or not a player was found. + /// A boolean indicating whether a player was found. public static bool TryGet(CommandSystem.ICommandSender sender, out Player player) => (player = Get(sender)) is not null; /// @@ -1565,7 +1565,7 @@ public static Player Get(string args) /// /// The . /// The player that matches the given , or if no player is found. - /// A boolean indicating whether or not a player was found. + /// A boolean indicating whether a player was found. public static bool TryGet(Footprint footprint, out Player player) => (player = Get(footprint)) is not null; /// @@ -1573,7 +1573,7 @@ public static Player Get(string args) /// /// The . /// The player that matches the given , or if no player is found. - /// A boolean indicating whether or not a player was found. + /// A boolean indicating whether a player was found. public static bool TryGet(CommandSender sender, out Player player) => (player = Get(sender)) is not null; /// @@ -1581,7 +1581,7 @@ public static Player Get(string args) /// /// The . /// The player that matches the given , or if no player is found. - /// A boolean indicating whether or not a player was found. + /// A boolean indicating whether a player was found. public static bool TryGet(ReferenceHub referenceHub, out Player player) => (player = Get(referenceHub)) is not null; /// @@ -1589,7 +1589,7 @@ public static Player Get(string args) /// /// The network ID. /// The player that matches the given net ID, or if no player is found. - /// A boolean indicating whether or not a player was found. + /// A boolean indicating whether a player was found. public static bool TryGet(uint netId, out Player player) => (player = Get(netId)) is not null; /// @@ -1597,7 +1597,7 @@ public static Player Get(string args) /// /// The . /// The player that matches the given , or if no player is found. - /// A boolean indicating whether or not a player was found. + /// A boolean indicating whether a player was found. public static bool TryGet(NetworkIdentity netIdentity, out Player player) => (player = Get(netIdentity)) is not null; /// @@ -1605,7 +1605,7 @@ public static Player Get(string args) /// /// The . /// The player that matches the given , or if no player is found. - /// A boolean indicating whether or not a player was found. + /// A boolean indicating whether a player was found. public static bool TryGet(NetworkConnection conn, out Player player) => (player = Get(conn)) is not null; /// @@ -1613,7 +1613,7 @@ public static Player Get(string args) /// /// The . /// The player that matches the given , or if no player is found. - /// A boolean indicating whether or not a player was found. + /// A boolean indicating whether a player was found. public static bool TryGet(GameObject gameObject, out Player player) => (player = Get(gameObject)) is not null; /// @@ -1621,7 +1621,7 @@ public static Player Get(string args) /// /// The user ID. /// The player that matches the given ID, or if no player is found. - /// A boolean indicating whether or not a player was found. + /// A boolean indicating whether a player was found. public static bool TryGet(int id, out Player player) => (player = Get(id)) is not null; /// @@ -1629,7 +1629,7 @@ public static Player Get(string args) /// /// The player's nickname, ID, steamID64 or Discord ID. /// The player found or if not found. - /// A boolean indicating whether or not a player was found. + /// A boolean indicating whether a player was found. public static bool TryGet(string args, out Player player) => (player = Get(args)) is not null; /// @@ -1637,7 +1637,7 @@ public static Player Get(string args) /// /// The class. /// The player found or if not found. - /// A boolean indicating whether or not a player was found. + /// A boolean indicating whether a player was found. public static bool TryGet(PluginAPI.Core.Player apiPlayer, out Player player) => (player = Get(apiPlayer)) is not null; /// @@ -1645,7 +1645,7 @@ public static Player Get(string args) /// /// The . /// The player found or if not found. - /// A boolean indicating whether or not a player was found. + /// A boolean indicating whether a player was found. public static bool TryGet(Collider collider, out Player player) => (player = Get(collider)) is not null; /// @@ -1670,7 +1670,7 @@ public static Player Get(string args) /// Adds a player's UserId to the list of reserved slots. /// /// The UserId of the player to add. - /// Whether or not to add a permanently. It will write a to UserIDReservedSlots.txt file. + /// Whether to add a permanently. It will write a to UserIDReservedSlots.txt file. /// if the slot was successfully added, or if the provided UserId already has a reserved slot. /// public static bool AddReservedSlot(string userId, bool isPermanent) @@ -1691,7 +1691,7 @@ public static bool AddReservedSlot(string userId, bool isPermanent) /// Adds a player's UserId to the whitelist. /// /// The UserId of the player to add. - /// Whether or not to add a permanently. It will write a to UserIDWhitelist.txt file. + /// Whether to add a permanently. It will write a to UserIDWhitelist.txt file. /// if the record was successfully added, or if the provided UserId already is in whitelist. /// public static bool AddToWhitelist(string userId, bool isPermanent) @@ -1721,7 +1721,7 @@ public static bool AddToWhitelist(string userId, bool isPermanent) /// /// Adds a player's UserId to the list of reserved slots. /// - /// Whether or not to add a player's UserId permanently. It will write a player's UserId to UserIDReservedSlots.txt file. + /// Whether to add a player's UserId permanently. It will write a player's UserId to UserIDReservedSlots.txt file. /// if the slot was successfully added, or if the provided UserId already has a reserved slot. /// public bool GiveReservedSlot(bool isPermanent) => AddReservedSlot(UserId, isPermanent); @@ -1729,7 +1729,7 @@ public static bool AddToWhitelist(string userId, bool isPermanent) /// /// Adds a player's UserId to the whitelist. /// - /// Whether or not to add a player's UserId permanently. It will write a player's UserId to UserIDWhitelist.txt file. + /// Whether to add a player's UserId permanently. It will write a player's UserId to UserIDWhitelist.txt file. /// if the record was successfully added, or if the provided UserId already is in whitelist. /// public bool GrantWhitelist(bool isPermanent) => AddToWhitelist(UserId, isPermanent); @@ -1795,7 +1795,7 @@ public VisionInformation GetVisionInformation(Vector3 target, float radius = 0f, /// /// Role to add. /// Friendly fire multiplier. - /// Whether or not the item was able to be added. + /// Whether the item was able to be added. public bool TryAddFriendlyFire(RoleTypeId roleToAdd, float ffMult) { if (FriendlyFireMultiplier.ContainsKey(roleToAdd)) @@ -1809,15 +1809,15 @@ public bool TryAddFriendlyFire(RoleTypeId roleToAdd, float ffMult) /// Tries to add to FriendlyFire rules. /// /// Role FF multiplier to add. - /// Whether or not the item was able to be added. + /// Whether the item was able to be added. public bool TryAddFriendlyFire(KeyValuePair pairedRoleFF) => TryAddFriendlyFire(pairedRoleFF.Key, pairedRoleFF.Value); /// /// Tries to add to FriendlyFire rules. /// /// Roles to add with friendly fire values. - /// Whether or not to overwrite current values if they exist. - /// Whether or not the item was able to be added. + /// Whether to overwrite current values if they exist. + /// Whether the item was able to be added. public bool TryAddFriendlyFire(Dictionary ffRules, bool overwrite = false) { Dictionary temporaryFriendlyFireRules = DictionaryPool.Pool.Get(); @@ -1881,7 +1881,7 @@ public void SetCustomRoleFriendlyFire(string roleTypeId, RoleTypeId roleToAdd, f /// /// Role associated for CustomFF. /// Role to add and FF multiplier. - /// Whether or not the item was able to be added. + /// Whether the item was able to be added. public bool TryAddCustomRoleFriendlyFire(string roleTypeId, KeyValuePair roleFf) => TryAddCustomRoleFriendlyFire(roleTypeId, roleFf.Key, roleFf.Value); /// @@ -1890,7 +1890,7 @@ public void SetCustomRoleFriendlyFire(string roleTypeId, RoleTypeId roleToAdd, f /// Role associated for CustomFF. /// Role to add. /// Friendly fire multiplier. - /// Whether or not the item was able to be added. + /// Whether the item was able to be added. public bool TryAddCustomRoleFriendlyFire(string roleTypeId, RoleTypeId roleToAdd, float ffMult) { if (CustomRoleFriendlyFireMultiplier.TryGetValue(roleTypeId, out Dictionary currentPairedData)) @@ -1914,7 +1914,7 @@ public bool TryAddCustomRoleFriendlyFire(string roleTypeId, RoleTypeId roleToAdd /// Role associated for CustomFF. /// Roles to add with friendly fire values. /// Whether to overwrite current values if they exist - does NOT delete previous entries if they are not in provided rules. - /// Whether or not the item was able to be added. + /// Whether the item was able to be added. public bool TryAddCustomRoleFriendlyFire(string customRoleName, Dictionary ffRules, bool overwrite = false) { Dictionary temporaryFriendlyFireRules = DictionaryPool.Pool.Get(); @@ -1981,21 +1981,21 @@ public void TrySetCustomRoleFriendlyFire(string roleTypeId, Dictionary from FriendlyFire rules. /// /// Role to add. - /// Whether or not the item was able to be added. + /// Whether the item was able to be added. public bool TryRemoveFriendlyFire(RoleTypeId role) => FriendlyFireMultiplier.Remove(role); /// /// Tries to remove a of from FriendlyFire rules. /// /// The of to remove. - /// Whether or not all roles were removed from FriendlyFire rules successfully. + /// Whether all roles were removed from FriendlyFire rules successfully. public bool TryRemoveFriendlyFire(List roles) => roles.All(role => TryRemoveFriendlyFire(role)); /// /// Tries to remove from FriendlyFire rules. /// /// Role to add. - /// Whether or not the item was able to be added. + /// Whether the item was able to be added. public bool TryRemoveCustomRoleFriendlyFire(string role) => CustomRoleFriendlyFireMultiplier.Remove(role); /// @@ -2167,14 +2167,14 @@ public Pickup DropHeldItem() } /// - /// Indicates whether or not the player has an item. + /// Indicates whether the player has an item. /// /// The item to search for. /// , if the player has it; otherwise, . public bool HasItem(Item item) => Items.Contains(item); /// - /// Indicates whether or not the player has an item type. + /// Indicates whether the player has an item type. /// /// The type to search for. /// , if the player has it; otherwise, . @@ -2214,8 +2214,8 @@ public Pickup DropHeldItem() /// Removes an from the player's inventory. /// /// The to remove. - /// Whether or not to destroy the item. - /// A value indicating whether or not the was removed. + /// Whether to destroy the item. + /// a value indicating whether the was removed. public bool RemoveItem(Item item, bool destroy = true) { if (!ItemsValue.Contains(item)) @@ -2256,16 +2256,16 @@ public bool RemoveItem(Item item, bool destroy = true) /// Removes an from the player's inventory. /// /// The serial to remove. - /// Whether or not to destroy the item. - /// A value indicating whether or not the was removed. + /// Whether to destroy the item. + /// a value indicating whether the was removed. public bool RemoveItem(ushort serial, bool destroy = true) => Items.SingleOrDefault(item => item.Serial == serial) is Item item && RemoveItem(item, destroy); /// /// Removes an from the player's inventory. /// /// The of the . - /// Whether or not to destroy the item. - /// Whether or not to remove all items of the specified . + /// Whether to destroy the item. + /// Whether to remove all items of the specified . public void RemoveItem(ItemType itemType, bool destroy = true, bool removeAll = false) { bool RemoveIfExisting(Item item) => item.Type == itemType && RemoveItem(item, destroy); @@ -2289,7 +2289,7 @@ public void RemoveItem(ItemType itemType, bool destroy = true, bool removeAll = /// Removes all 's that satisfy the condition from the player's inventory. /// /// The condition to satisfy. - /// Whether or not to destroy the items. + /// Whether to destroy the items. /// Count of a successfully removed 's. public int RemoveItem(Func predicate, bool destroy = true) { @@ -2309,8 +2309,8 @@ public int RemoveItem(Func predicate, bool destroy = true) /// /// Removes the held from the player's inventory. /// - /// Whether or not to destroy the item. - /// Returns a value indicating whether or not the was removed. + /// Whether to destroy the item. + /// Returns a value indicating whether the was removed. public bool RemoveHeldItem(bool destroy = true) => RemoveItem(CurrentItem, destroy); /// @@ -2410,7 +2410,7 @@ public void Hurt(float damage, string damageReason, string cassieAnnouncement = /// Heals the player. /// /// The amount of health to heal. - /// Whether or not healing should exceed their max health. + /// Whether healing should exceed their max health. public void Heal(float amount, bool overrideMaxHealth = false) { if (overrideMaxHealth) @@ -2511,13 +2511,13 @@ public void Ban(int duration, string reason, Player issuer = null) /// /// Persistently mutes the player. For temporary mutes, see and . /// - /// Whether or not this mute is for the intercom only. + /// Whether this mute is for the intercom only. public void Mute(bool isIntercom = false) => VoiceChatMutes.IssueLocalMute(UserId, isIntercom); /// /// Revokes a persistent mute. For temporary mutes, see and . /// - /// Whether or not this un-mute is for the intercom only. + /// Whether this un-mute is for the intercom only. public void UnMute(bool isIntercom = false) => VoiceChatMutes.RevokeLocalMute(UserId, isIntercom); /// @@ -2539,7 +2539,7 @@ public IEnumerator BlinkTag() /// Sends a message to the player's Remote Admin console. /// /// The message to be sent. - /// Indicates whether or not the message should be highlighted as success. + /// Indicates whether the message should be highlighted as success. /// The plugin name. public void RemoteAdminMessage(string message, bool success = true, string pluginName = null) => Sender.RaReply((pluginName ?? Assembly.GetCallingAssembly().GetName().Name) + "#" + message, success, true, string.Empty); @@ -2548,7 +2548,7 @@ public void RemoteAdminMessage(string message, bool success = true, string plugi /// Sends a message to the player's Remote Admin Chat. /// /// The message to be sent. - /// Indicates whether or not the message should be highlighted as success. + /// Indicates whether the message should be highlighted as success. /// if message was send; otherwise, . public bool SendStaffMessage(string message, EncryptedChannelManager.EncryptedChannel channel = EncryptedChannelManager.EncryptedChannel.AdminChat) => ReferenceHub.encryptedChannelManager.TrySendMessageToClient("!" + NetId + message, channel); @@ -2557,7 +2557,7 @@ public bool SendStaffMessage(string message, EncryptedChannelManager.EncryptedCh /// Sends a message to the player's Remote Admin Chat. /// /// The message to be sent. - /// Indicates whether or not the message should be highlighted as success. + /// Indicates whether the message should be highlighted as success. /// if message was send; otherwise, . public bool SendStaffPing(string message, EncryptedChannelManager.EncryptedChannel channel = EncryptedChannelManager.EncryptedChannel.AdminChat) => ReferenceHub.encryptedChannelManager.TrySendMessageToClient("!0" + message, channel); @@ -2659,7 +2659,7 @@ public void SetAmmo(AmmoType ammoType, ushort amount) /// /// The that will be dropped. /// The amount of ammo that will be dropped. - /// Whether or not ammo limits will be taken into consideration. + /// Whether ammo limits will be taken into consideration. /// if ammo was dropped; otherwise, . public bool DropAmmo(AmmoType ammoType, ushort amount, bool checkMinimals = false) => Inventory.ServerDropAmmo(ammoType.GetItemType(), amount, checkMinimals).Any(); @@ -3158,7 +3158,7 @@ public void ResetInventory(InventoryRoleInfo inventory) /// /// Clears the player's inventory, including all ammo and items. /// - /// Whether or not to fully destroy the old items. + /// Whether to fully destroy the old items. /// /// /// @@ -3171,7 +3171,7 @@ public void ClearInventory(bool destroy = true) /// /// Clears the player's items. /// - /// Whether or not to fully destroy the old items. + /// Whether to fully destroy the old items. /// /// /// @@ -3302,10 +3302,10 @@ public T GetModule() => ReferenceHub.playerStats.GetModule(); /// - /// Gets a describing whether or not the given status effect is currently enabled. + /// Gets a describing whether the given status effect is currently enabled. /// /// The to check. - /// A determining whether or not the player effect is active. + /// A determining whether the player effect is active. public bool IsEffectActive() where T : StatusEffectBase { @@ -3375,7 +3375,7 @@ public void DisableEffects(IEnumerable effects) /// The to enable. /// The amount of time the effect will be active for. /// If the effect is already active, setting to will add this duration onto the effect. - /// A bool indicating whether or not the effect was valid and successfully enabled. + /// A bool indicating whether the effect was valid and successfully enabled. public bool EnableEffect(float duration = 0f, bool addDurationIfActive = false) where T : StatusEffectBase => EnableEffect(1, duration, addDurationIfActive); @@ -3386,7 +3386,7 @@ public bool EnableEffect(float duration = 0f, bool addDurationIfActive = fals /// The intensity of the effect will be active for. /// The amount of time the effect will be active for. /// If the effect is already active, setting to will add this duration onto the effect. - /// A bool indicating whether or not the effect was valid and successfully enabled. + /// A bool indicating whether the effect was valid and successfully enabled. public bool EnableEffect(byte intensity, float duration = 0f, bool addDurationIfActive = false) where T : StatusEffectBase => ReferenceHub.playerEffectsController.ChangeState(intensity, duration, addDurationIfActive); @@ -3396,7 +3396,7 @@ public bool EnableEffect(byte intensity, float duration = 0f, bool addDuratio /// The name of the to enable. /// The amount of time the effect will be active for. /// If the effect is already active, setting to will add this duration onto the effect. - /// A bool indicating whether or not the effect was valid and successfully enabled. + /// A bool indicating whether the effect was valid and successfully enabled. public bool EnableEffect(StatusEffectBase statusEffect, float duration = 0f, bool addDurationIfActive = false) => EnableEffect(statusEffect, 1, duration, addDurationIfActive); @@ -3407,7 +3407,7 @@ public bool EnableEffect(StatusEffectBase statusEffect, float duration = 0f, boo /// The intensity of the effect will be active for. /// The amount of time the effect will be active for. /// If the effect is already active, setting to will add this duration onto the effect. - /// A bool indicating whether or not the effect was valid and successfully enabled. + /// A bool indicating whether the effect was valid and successfully enabled. public bool EnableEffect(StatusEffectBase statusEffect, byte intensity, float duration = 0f, bool addDurationIfActive = false) { if (statusEffect is null) @@ -3542,7 +3542,7 @@ public StatusEffectBase GetEffect(EffectType effectType) /// /// The . /// The . - /// A bool indicating whether or not the was successfully gotten. + /// A bool indicating whether the was successfully gotten. public bool TryGetEffect(EffectType type, out StatusEffectBase statusEffect) { statusEffect = GetEffect(type); @@ -3555,7 +3555,7 @@ public bool TryGetEffect(EffectType type, out StatusEffectBase statusEffect) /// /// The . /// The to get. - /// A bool indicating whether or not the was successfully gotten. + /// A bool indicating whether the was successfully gotten. public bool TryGetEffect(out T statusEffect) where T : StatusEffectBase => ReferenceHub.playerEffectsController.TryGetEffect(out statusEffect); @@ -3581,7 +3581,7 @@ public byte GetEffectIntensity() /// The to change the intensity of. /// The intensity of the effect. /// The new duration to add to the effect. - /// Whether or not to add the duration.. + /// Whether to add the duration.. public void ChangeEffectIntensity(byte intensity, float duration = 0, bool addDuration = false) where T : StatusEffectBase { @@ -3598,7 +3598,7 @@ public void ChangeEffectIntensity(byte intensity, float duration = 0, bool ad /// The to change. /// The new intensity to use. /// The new duration to add to the effect. - /// Whether or not to add the duration.. + /// Whether to add the duration.. public void ChangeEffectIntensity(EffectType type, byte intensity, float duration = 0, bool addDuration = false) { if (TryGetEffect(type, out StatusEffectBase statusEffect)) @@ -3613,7 +3613,7 @@ public void ChangeEffectIntensity(EffectType type, byte intensity, float duratio /// /// The intensity to add. /// The duration. - /// Whether or not to add the duration on top. + /// Whether to add the duration on top. /// The to increase intensity of. public void AddEffectIntensity(byte intensity, float duration = 0, bool addDuration = true) where T : StatusEffectBase @@ -3633,7 +3633,7 @@ public void AddEffectIntensity(byte intensity, float duration = 0, bool addDu /// The to increase intensity of. /// The intensity to add. /// The duration. - /// Whether or not to add the duration on top. + /// Whether to add the duration on top. public void AddEffectIntensity(EffectType type, byte intensity, float duration = 0, bool addDuration = true) { if (TryGetEffect(type, out StatusEffectBase statusEffect)) @@ -3669,7 +3669,7 @@ public void ChangeEffectIntensity(string effectName, byte intensity, float durat /// /// The . /// The . - /// A bool indicating whether or not the was successfully gotten. + /// A bool indicating whether the was successfully gotten. public bool TryGetDanger(DangerType type, out DangerStackBase danger) => (danger = GetDanger(type)) is not null; /// @@ -3681,7 +3681,7 @@ public void ChangeEffectIntensity(string effectName, byte intensity, float durat /// /// Places a Tantrum (SCP-173's ability) under the player. /// - /// Whether or not the tantrum will apply the effect. + /// Whether the tantrum will apply the effect. /// If is , the tantrum is moved slightly up from its original position. Otherwise, the collision will not be detected and the slowness will not work. /// The instance.. public TantrumHazard PlaceTantrum(bool isActive = true) => TantrumHazard.CreateAndSpawn(Position, isActive); @@ -3694,7 +3694,7 @@ public void ChangeEffectIntensity(string effectName, byte intensity, float durat /// How much value is lost per second. /// Percent of incoming damage absorbed by this stat. /// The number of seconds to delay the start of the decay. - /// Whether or not the process is removed when the value hits 0. + /// Whether the process is removed when the value hits 0. /// The that was added. public AhpStat.AhpProcess AddAhp(float amount, float limit = 75f, float decay = 1.2f, float efficacy = 0.7f, float sustain = 0f, bool persistant = false) => AhpStat.ServerAddProcess(amount, limit, decay, efficacy, sustain, persistant); @@ -3704,7 +3704,7 @@ public AhpStat.AhpProcess AddAhp(float amount, float limit = 75f, float decay = /// /// New port. /// Player reconnection delay. - /// Whether or not player should be reconnected. + /// Whether player should be reconnected. /// Type of round restart. public void Reconnect(ushort newPort = 0, float delay = 5, bool reconnect = true, RoundRestartType roundRestartType = RoundRestartType.FullRestart) { diff --git a/Exiled.API/Features/Ragdoll.cs b/Exiled.API/Features/Ragdoll.cs index 2c9f816b99..94b84b6784 100644 --- a/Exiled.API/Features/Ragdoll.cs +++ b/Exiled.API/Features/Ragdoll.cs @@ -70,7 +70,7 @@ public static int FreezeTime public static Ragdoll Random => List.Random(); /// - /// Gets a value indicating whether or not the clean up event can be executed. + /// Gets a value indicating whether the clean up event can be executed. /// [EProperty(readOnly: true, category: nameof(Ragdoll))] public bool AllowCleanUp => NetworkInfo.ExistenceTime < FreezeTime; @@ -110,13 +110,13 @@ public DamageHandlerBase DamageHandler public DeathAnimation[] DeathAnimations => Base.AllDeathAnimations; /// - /// Gets a value indicating whether or not the ragdoll has been already cleaned up. + /// Gets a value indicating whether the ragdoll has been already cleaned up. /// [EProperty(readOnly: true, category: nameof(Ragdoll))] public bool IsFrozen => Base._frozen; /// - /// Gets or sets a value indicating whether or not the ragdoll can be cleaned up. + /// Gets or sets a value indicating whether the ragdoll can be cleaned up. /// [EProperty(category: nameof(Ragdoll))] public bool CanBeCleanedUp @@ -187,14 +187,14 @@ public RoleTypeId Role } /// - /// Gets a value indicating whether or not the ragdoll has expired and SCP-049 is unable to revive it if was not being targets. + /// Gets a value indicating whether the ragdoll has expired and SCP-049 is unable to revive it if was not being targets. /// /// [EProperty(readOnly: true, category: nameof(Ragdoll))] public bool IsExpired => NetworkInfo.ExistenceTime > PlayerRoles.PlayableScps.Scp049.Scp049ResurrectAbility.HumanCorpseDuration; /// - /// Gets or sets a value indicating whether or not this ragdoll has been consumed by an SCP-049-2. + /// Gets or sets a value indicating whether this ragdoll has been consumed by an SCP-049-2. /// [EProperty(category: nameof(Ragdoll))] public bool IsConsumed diff --git a/Exiled.API/Features/Respawn.cs b/Exiled.API/Features/Respawn.cs index 59f4e0207b..6fcf724481 100644 --- a/Exiled.API/Features/Respawn.cs +++ b/Exiled.API/Features/Respawn.cs @@ -83,7 +83,7 @@ public static float TimeUntilNextPhase public static DateTime NextTeamTime => DateTime.UtcNow.AddSeconds(TimeUntilSpawnWave.TotalSeconds); /// - /// Gets a value indicating whether or not a team is currently being spawned or the animations are playing for a team. + /// Gets a value indicating whether a team is currently being spawned or the animations are playing for a team. /// public static bool IsSpawning => RespawnManager.Singleton._curSequence is RespawnManager.RespawnSequencePhase.PlayingEntryAnimations or RespawnManager.RespawnSequencePhase.SpawningSelectedTeam; @@ -108,7 +108,7 @@ public static float NtfTickets } /// - /// Gets or sets a value indicating whether or not spawn protection is enabled. + /// Gets or sets a value indicating whether spawn protection is enabled. /// public static bool ProtectionEnabled { @@ -126,7 +126,7 @@ public static float ProtectionTime } /// - /// Gets or sets a value indicating whether or not spawn protected players can shoot. + /// Gets or sets a value indicating whether spawn protected players can shoot. /// public static bool ProtectedCanShoot { @@ -203,7 +203,7 @@ public static void PlayEffects(byte[] effects) /// /// Summons the van. /// - /// Whether or not to play the Chaos Insurgency spawn music. + /// Whether to play the Chaos Insurgency spawn music. public static void SummonChaosInsurgencyVan(bool playMusic = true) { PlayEffects(playMusic ? new[] @@ -242,7 +242,7 @@ public static void SummonChaosInsurgencyVan(bool playMusic = true) /// Forces a spawn of the given . /// /// The to spawn. - /// Whether or not effects will be played with the spawn. + /// Whether effects will be played with the spawn. public static void ForceWave(SpawnableTeamType team, bool playEffects = false) { if (playEffects) diff --git a/Exiled.API/Features/Roles/FpcRole.cs b/Exiled.API/Features/Roles/FpcRole.cs index 020efd254d..2a98fe8b92 100644 --- a/Exiled.API/Features/Roles/FpcRole.cs +++ b/Exiled.API/Features/Roles/FpcRole.cs @@ -173,19 +173,19 @@ public bool MovementDetected } /// - /// Gets a value indicating whether or not the player can send inputs. + /// Gets a value indicating whether the player can send inputs. /// [EProperty(readOnly: true, category: nameof(FpcRole))] public bool CanSendInputs => FirstPersonController.FpcModule.LockMovement; /// - /// Gets or sets a value indicating whether or not the player is invisible. + /// Gets or sets a value indicating whether the player is invisible. /// [EProperty(category: nameof(FpcRole))] public bool IsInvisible { get; set; } /// - /// Gets or sets a value indicating whether or not the player should use stamina system. Resets on death. + /// Gets or sets a value indicating whether the player should use stamina system. Resets on death. /// [EProperty(category: nameof(FpcRole))] public bool IsUsingStamina @@ -233,7 +233,7 @@ public PlayerMovementState MoveState public bool IsCrouching => FirstPersonController.FpcModule.StateProcessor.CrouchPercent > 0; /// - /// Gets a value indicating whether or not the player is on the ground. + /// Gets a value indicating whether the player is on the ground. /// [EProperty(readOnly: true, category: nameof(FpcRole))] public bool IsGrounded => FirstPersonController.FpcModule.IsGrounded; @@ -245,7 +245,7 @@ public PlayerMovementState MoveState public virtual float MovementSpeed => FirstPersonController.FpcModule.VelocityForState(MoveState, IsCrouching); /// - /// Gets a value indicating whether or not the is in darkness. + /// Gets a value indicating whether the is in darkness. /// [EProperty(readOnly: true, category: nameof(FpcRole))] public bool IsInDarkness => FirstPersonController.InDarkness; @@ -263,13 +263,13 @@ public PlayerMovementState MoveState public float HorizontalRotation => FirstPersonController.HorizontalRotation; /// - /// Gets a value indicating whether or not the is AFK. + /// Gets a value indicating whether the is AFK. /// [EProperty(readOnly: true, category: nameof(FpcRole))] public bool IsAfk => FirstPersonController.IsAFK; /// - /// Gets a value indicating whether or not this role is protected by a hume shield. + /// Gets a value indicating whether this role is protected by a hume shield. /// [EProperty(readOnly: true, category: nameof(FpcRole))] public bool IsHumeShieldedRole => this is IHumeShieldRole; diff --git a/Exiled.API/Features/Roles/Role.cs b/Exiled.API/Features/Roles/Role.cs index 459ea7b1a7..f146484e24 100644 --- a/Exiled.API/Features/Roles/Role.cs +++ b/Exiled.API/Features/Roles/Role.cs @@ -153,19 +153,19 @@ protected Role(PlayerRoleBase baseRole) public TimeSpan ActiveTime => TimeSpan.FromSeconds(Base.ActiveTime); /// - /// Gets a value indicating whether or not this role represents a dead role. + /// Gets a value indicating whether this role represents a dead role. /// [EProperty(readOnly: true, category: nameof(Role))] public bool IsDead => Team is Team.Dead; /// - /// Gets a value indicating whether or not this role represents a living role. + /// Gets a value indicating whether this role represents a living role. /// [EProperty(readOnly: true, category: nameof(Role))] public bool IsAlive => !IsDead; /// - /// Gets a value indicating whether or not this role is still valid. This will only ever be if the Role is stored and accessed at a later date. + /// Gets a value indicating whether this role is still valid. This will only ever be if the Role is stored and accessed at a later date. /// [EProperty(readOnly: true, category: nameof(Role))] public bool IsValid => Owner != null && Owner.IsConnected && Base == Owner.RoleManager.CurrentRole; @@ -183,7 +183,7 @@ protected Role(PlayerRoleBase baseRole) public static implicit operator RoleTypeId(Role role) => role?.Type ?? RoleTypeId.None; /// - /// Returns whether or not 2 roles are the same. + /// Returns whether 2 roles are the same. /// /// The role. /// The other role. @@ -191,7 +191,7 @@ protected Role(PlayerRoleBase baseRole) public static bool operator ==(Role left, Role right) => left?.Equals(right) ?? right is null; /// - /// Returns whether or not the two roles are different. + /// Returns whether the two roles are different. /// /// The role. /// The other role. @@ -199,7 +199,7 @@ protected Role(PlayerRoleBase baseRole) public static bool operator !=(Role left, Role right) => !(left == right); /// - /// Returns whether or not the role has the same RoleTypeId as the given . + /// Returns whether the role has the same RoleTypeId as the given . /// /// The . /// The . @@ -207,7 +207,7 @@ protected Role(PlayerRoleBase baseRole) public static bool operator ==(Role role, RoleTypeId typeId) => role?.Type == typeId; /// - /// Returns whether or not the role has a different RoleTypeId as the given . + /// Returns whether the role has a different RoleTypeId as the given . /// /// The . /// The . @@ -215,7 +215,7 @@ protected Role(PlayerRoleBase baseRole) public static bool operator !=(Role role, RoleTypeId typeId) => !(role == typeId); /// - /// Returns whether or not the role has the same RoleTypeId as the given . + /// Returns whether the role has the same RoleTypeId as the given . /// /// The . /// The . @@ -223,7 +223,7 @@ protected Role(PlayerRoleBase baseRole) public static bool operator ==(RoleTypeId type, Role role) => role == type; /// - /// Returns whether or not the role has a different RoleTypeId as the given . + /// Returns whether the role has a different RoleTypeId as the given . /// /// The . /// The . diff --git a/Exiled.API/Features/Roles/Scp0492Role.cs b/Exiled.API/Features/Roles/Scp0492Role.cs index 433f4cb867..9c7abb744e 100644 --- a/Exiled.API/Features/Roles/Scp0492Role.cs +++ b/Exiled.API/Features/Roles/Scp0492Role.cs @@ -108,13 +108,13 @@ public float SimulatedStare } /// - /// Gets a value indicating whether or not SCP-049-2 is currently pursuing a target (Bloodlust ability). + /// Gets a value indicating whether SCP-049-2 is currently pursuing a target (Bloodlust ability). /// [EProperty(readOnly: true, category: nameof(Scp0492Role))] public bool BloodlustActive => BloodlustAbility.LookingAtTarget; /// - /// Gets a value indicating whether or not SCP-049-2 is consuming a ragdoll. + /// Gets a value indicating whether SCP-049-2 is consuming a ragdoll. /// [EProperty(readOnly: true, category: nameof(Scp0492Role))] public bool IsConsuming => ConsumeAbility.IsInProgress; @@ -131,17 +131,17 @@ public float SimulatedStare public float AttackCooldown => AttackAbility.BaseCooldown; /// - /// Returns a indicating whether or not SCP-049-2 is close enough to a ragdoll to consume it. + /// Returns a indicating whether SCP-049-2 is close enough to a ragdoll to consume it. /// - /// This method only returns whether or not SCP-049-2 is close enough to the body to consume it; the body may have been consumed previously. Make sure to check to ensure the body can be consumed. + /// This method only returns whether SCP-049-2 is close enough to the body to consume it; the body may have been consumed previously. Make sure to check to ensure the body can be consumed. /// The ragdoll to check. /// if close enough to consume the body; otherwise, . public bool IsInConsumeRange(BasicRagdoll ragdoll) => ragdoll != null && ConsumeAbility.IsCloseEnough(Owner.Position, ragdoll.transform.position); /// - /// Returns a indicating whether or not SCP-049-2 is close enough to a ragdoll to consume it. + /// Returns a indicating whether SCP-049-2 is close enough to a ragdoll to consume it. /// - /// This method only returns whether or not SCP-049-2 is close enough to the body to consume it; the body may have been consumed previously. Make sure to check to ensure the body can be consumed. + /// This method only returns whether SCP-049-2 is close enough to the body to consume it; the body may have been consumed previously. Make sure to check to ensure the body can be consumed. /// The ragdoll to check. /// if close enough to consume the body; otherwise, . public bool IsInConsumeRange(Ragdoll ragdoll) => ragdoll is not null && IsInConsumeRange(ragdoll.Base); diff --git a/Exiled.API/Features/Roles/Scp049Role.cs b/Exiled.API/Features/Roles/Scp049Role.cs index 31e14657b7..be450a3a40 100644 --- a/Exiled.API/Features/Roles/Scp049Role.cs +++ b/Exiled.API/Features/Roles/Scp049Role.cs @@ -105,13 +105,13 @@ internal Scp049Role(Scp049GameRole baseRole) public Scp049SenseAbility SenseAbility { get; } /// - /// Gets a value indicating whether or not SCP-049 is currently reviving a player. + /// Gets a value indicating whether SCP-049 is currently reviving a player. /// [EProperty(readOnly: true, category: nameof(Scp049Role))] public bool IsRecalling => ResurrectAbility.IsInProgress; /// - /// Gets a value indicating whether or not SCP-049's "Doctor's Call" ability is currently active. + /// Gets a value indicating whether SCP-049's "Doctor's Call" ability is currently active. /// [EProperty(readOnly: true, category: nameof(Scp049Role))] public bool IsCallActive => CallAbility.IsMarkerShown; @@ -390,31 +390,31 @@ public void Sense(Player player) public int GetResurrectionCount(Player player) => player is not null ? Scp049ResurrectAbility.GetResurrectionsNumber(player.ReferenceHub) : 0; /// - /// Returns a indicating whether or not the ragdoll can be resurrected by SCP-049. + /// Returns a indicating whether the ragdoll can be resurrected by SCP-049. /// /// The ragdoll to check. /// if the body can be revived; otherwise, . public bool CanResurrect(BasicRagdoll ragdoll) => ragdoll != null && ResurrectAbility.CheckRagdoll(ragdoll); /// - /// Returns a indicating whether or not the ragdoll can be resurrected by SCP-049. + /// Returns a indicating whether the ragdoll can be resurrected by SCP-049. /// /// The ragdoll to check. /// if the body can be revived; otherwise, . public bool CanResurrect(Ragdoll ragdoll) => ragdoll is not null && ResurrectAbility.CheckRagdoll(ragdoll.Base); /// - /// Returns a indicating whether or not SCP-049 is close enough to a ragdoll to revive it. + /// Returns a indicating whether SCP-049 is close enough to a ragdoll to revive it. /// - /// This method only returns whether or not SCP-049 is close enough to the body to revive it; the body may have expired. Make sure to check to ensure the body can be revived. + /// This method only returns whether SCP-049 is close enough to the body to revive it; the body may have expired. Make sure to check to ensure the body can be revived. /// The ragdoll to check. /// if close enough to revive the body; otherwise, . public bool IsInRecallRange(BasicRagdoll ragdoll) => ragdoll != null && ResurrectAbility.IsCloseEnough(Owner.Position, ragdoll.transform.position); /// - /// Returns a indicating whether or not SCP-049 is close enough to a ragdoll to revive it. + /// Returns a indicating whether SCP-049 is close enough to a ragdoll to revive it. /// - /// This method only returns whether or not SCP-049 is close enough to the body to revive it; the body may have expired. Make sure to check to ensure the body can be revived. + /// This method only returns whether SCP-049 is close enough to the body to revive it; the body may have expired. Make sure to check to ensure the body can be revived. /// The ragdoll to check. /// if close enough to revive the body; otherwise, . public bool IsInRecallRange(Ragdoll ragdoll) => ragdoll is not null && IsInRecallRange(ragdoll.Base); diff --git a/Exiled.API/Features/Roles/Scp079Role.cs b/Exiled.API/Features/Roles/Scp079Role.cs index ee81c6c801..58bc3e3713 100644 --- a/Exiled.API/Features/Roles/Scp079Role.cs +++ b/Exiled.API/Features/Roles/Scp079Role.cs @@ -320,7 +320,7 @@ public int ElevatorCost } /// - /// Gets a value indicating whether or not SCP-079 can transmit its voice to a speaker. + /// Gets a value indicating whether SCP-079 can transmit its voice to a speaker. /// [EProperty(readOnly: true, category: nameof(Scp079Role))] public bool CanTransmit => SpeakerAbility.CanTransmit; @@ -490,7 +490,7 @@ public float Scp2176LostTime public float RollRotation => Base.RollRotation; /// - /// Gets a value indicating whether or not SCP-079's signal is lost due to SCP-2176. + /// Gets a value indicating whether SCP-079's signal is lost due to SCP-2176. /// [EProperty(readOnly: true, category: nameof(Scp079Role))] public bool IsLost => LostSignalHandler.Lost; diff --git a/Exiled.API/Features/Roles/Scp096Role.cs b/Exiled.API/Features/Roles/Scp096Role.cs index e11fa02a2c..3b1cb418ce 100644 --- a/Exiled.API/Features/Roles/Scp096Role.cs +++ b/Exiled.API/Features/Roles/Scp096Role.cs @@ -134,13 +134,13 @@ protected internal Scp096Role(GameObject gameObject) public Scp096RageState RageState => Base.StateController.RageState; /// - /// Gets a value indicating whether or not SCP-096 can receive targets. + /// Gets a value indicating whether SCP-096 can receive targets. /// [EProperty(readOnly: true, category: nameof(Scp096Role))] public bool CanReceiveTargets => RageCycleAbility._targetsTracker.CanReceiveTargets; /// - /// Gets a value indicating whether or not SCP-096 can attack. + /// Gets a value indicating whether SCP-096 can attack. /// [EProperty(readOnly: true, category: nameof(Scp096Role))] public bool AttackPossible => AttackAbility.AttackPossible; @@ -266,21 +266,21 @@ public bool TryNotToCryActive /// /// Ends SCP-096's enrage cycle. /// - /// Whether or not to clear the remaining enrage time. + /// Whether to clear the remaining enrage time. public void Calm(bool clearTime = true) => RageManager.ServerEndEnrage(clearTime); /// - /// Returns whether or not the provided is a target of SCP-096. + /// Returns whether the provided is a target of SCP-096. /// /// The player to check. - /// Whether or not the player is a target of SCP-096. + /// Whether the player is a target of SCP-096. public bool HasTarget(Player player) => player is not null && TargetsTracker.HasTarget(player.ReferenceHub); /// - /// Returns whether or not the provided is observed by SCP-096. + /// Returns whether the provided is observed by SCP-096. /// /// The player to check. - /// Whether or not the player is observed. + /// Whether the player is observed. public bool IsObserved(Player player) => player is not null && TargetsTracker.IsObservedBy(player.ReferenceHub); /// diff --git a/Exiled.API/Features/Roles/Scp106Role.cs b/Exiled.API/Features/Roles/Scp106Role.cs index ffda53fbae..27d0580e6e 100644 --- a/Exiled.API/Features/Roles/Scp106Role.cs +++ b/Exiled.API/Features/Roles/Scp106Role.cs @@ -132,7 +132,7 @@ public float Vigor } /// - /// Gets or sets a value indicating whether or not SCP-106 is currently submerged. + /// Gets or sets a value indicating whether SCP-106 is currently submerged. /// [EProperty(category: nameof(Scp106Role))] public bool IsSubmerged @@ -142,7 +142,7 @@ public bool IsSubmerged } /// - /// Gets a value indicating whether or not SCP-106 can activate teslas. + /// Gets a value indicating whether SCP-106 can activate teslas. /// [EProperty(readOnly: true, category: nameof(Scp106Role))] public bool CanActivateTesla => Base.CanActivateShock; @@ -154,7 +154,7 @@ public bool IsSubmerged public bool CanStopStalk => StalkAbility.CanBeCleared; /// - /// Gets a value indicating whether or not SCP-106 is currently slow down by a door. + /// Gets a value indicating whether SCP-106 is currently slow down by a door. /// [EProperty(readOnly: true, category: nameof(Scp106Role))] public bool IsSlowdown => MovementModule._slowndownTarget is < 1; @@ -172,13 +172,13 @@ public bool IsSubmerged public float SinkholeNormalizedState => SinkholeController.NormalizedState; /// - /// Gets a value indicating whether or not SCP-106 is currently in the middle of an animation. + /// Gets a value indicating whether SCP-106 is currently in the middle of an animation. /// [EProperty(readOnly: true, category: nameof(Scp106Role))] public bool IsDuringAnimation => SinkholeController.IsDuringAnimation; /// - /// Gets a value indicating whether or not SCP-106 sinkhole is hidden. + /// Gets a value indicating whether SCP-106 sinkhole is hidden. /// [EProperty(readOnly: true, category: nameof(Scp106Role))] public bool IsSinkholeHidden => SinkholeController.IsHidden; @@ -317,7 +317,7 @@ public float RemainingSinkholeCooldown } /// - /// Gets or sets a value indicating whether or not SCP-106 will enter his stalking mode. + /// Gets or sets a value indicating whether SCP-106 will enter his stalking mode. /// [EProperty(category: nameof(Scp106Role))] public bool IsStalking diff --git a/Exiled.API/Features/Roles/Scp173Role.cs b/Exiled.API/Features/Roles/Scp173Role.cs index f9b30e7847..a72b8afd1e 100644 --- a/Exiled.API/Features/Roles/Scp173Role.cs +++ b/Exiled.API/Features/Roles/Scp173Role.cs @@ -158,7 +158,7 @@ public float RemainingTantrumCooldown } /// - /// Gets a value indicating whether or not SCP-173 is currently being viewed by one or more players. + /// Gets a value indicating whether SCP-173 is currently being viewed by one or more players. /// [EProperty(readOnly: true, category: nameof(Scp173Role))] public bool IsObserved => ObserversTracker.IsObserved; @@ -191,7 +191,7 @@ public float SimulatedStare } /// - /// Gets or sets a value indicating whether or not SCP-173 is able to blink. + /// Gets or sets a value indicating whether SCP-173 is able to blink. /// [EProperty(category: nameof(Scp173Role))] public bool BlinkReady @@ -237,7 +237,7 @@ public float BlinkCooldown public float BlinkDistance => TeleportAbility.EffectiveBlinkDistance; /// - /// Gets or sets a value indicating whether or not SCP-173's breakneck speed is active. + /// Gets or sets a value indicating whether SCP-173's breakneck speed is active. /// [EProperty(category: nameof(Scp173Role))] public bool BreakneckActive @@ -254,7 +254,7 @@ public bool BreakneckActive /// /// Places a Tantrum (SCP-173's ability) under the player. /// - /// Whether or not to place the tantrum if SCP-173 is currently being viewed. + /// Whether to place the tantrum if SCP-173 is currently being viewed. /// The cooldown until SCP-173 can place a tantrum again. Set to 0 to not affect the cooldown. /// The instance, or if it cannot be placed. public TantrumHazard PlaceTantrum(bool failIfObserved = false, float cooldown = 0) diff --git a/Exiled.API/Features/Roles/Scp939Role.cs b/Exiled.API/Features/Roles/Scp939Role.cs index 2225074060..402ce474ad 100644 --- a/Exiled.API/Features/Roles/Scp939Role.cs +++ b/Exiled.API/Features/Roles/Scp939Role.cs @@ -168,13 +168,13 @@ public float AttackCooldown } /// - /// Gets a value indicating whether or not SCP-939 is currently using its focus ability. + /// Gets a value indicating whether SCP-939 is currently using its focus ability. /// [EProperty(readOnly: true, category: nameof(Scp939Role))] public bool IsFocused => FocusAbility.TargetState; /// - /// Gets a value indicating whether or not SCP-939 is currently lunging. + /// Gets a value indicating whether SCP-939 is currently lunging. /// [EProperty(readOnly: true, category: nameof(Scp939Role))] public bool IsLunging => LungeAbility.State is not Scp939LungeState.None; @@ -234,7 +234,7 @@ public float MimicryCooldown public int SavedVoices => MimicryRecorder.SavedVoices.Count; /// - /// Gets a value indicating whether or not SCP-939 has a placed mimic point. + /// Gets a value indicating whether SCP-939 has a placed mimic point. /// [EProperty(readOnly: true, category: nameof(Scp939Role))] public bool MimicryPointActive => MimicPointController.Active; diff --git a/Exiled.API/Features/Room.cs b/Exiled.API/Features/Room.cs index 4ccd72b48a..ae3d1b099a 100644 --- a/Exiled.API/Features/Room.cs +++ b/Exiled.API/Features/Room.cs @@ -183,7 +183,7 @@ public Color Color } /// - /// Gets or sets a value indicating whether or not the lights in this room are currently off. + /// Gets or sets a value indicating whether the lights in this room are currently off. /// public bool AreLightsOff { diff --git a/Exiled.API/Features/Round.cs b/Exiled.API/Features/Round.cs index c32b863e38..6ff741bfb2 100644 --- a/Exiled.API/Features/Round.cs +++ b/Exiled.API/Features/Round.cs @@ -205,7 +205,7 @@ public static int TargetOffset /// Restarts the round with custom settings. /// /// - /// Indicates whether or not it'll be a fast restart. + /// Indicates whether it'll be a fast restart. /// If it's a fast restart, then players won't be reconnected from /// the server; otherwise, they will. /// @@ -245,9 +245,9 @@ public static void Restart(bool fastRestart = true, bool overrideRestartAction = /// Forces the round to end, regardless of which factions are alive. /// /// - /// Indicates whether or not it'll force the restart with no check if it's locked. + /// Indicates whether it'll force the restart with no check if it's locked. /// - /// A describing whether or not the round was successfully ended. + /// A describing whether the round was successfully ended. public static bool EndRound(bool forceEnd = false) { if (RoundSummary.singleton.KeepRoundOnOne && Player.Dictionary.Count < 2 && !forceEnd) diff --git a/Exiled.API/Features/Scp3114Ragdoll.cs b/Exiled.API/Features/Scp3114Ragdoll.cs index d9be9b2f3c..177d344ee4 100644 --- a/Exiled.API/Features/Scp3114Ragdoll.cs +++ b/Exiled.API/Features/Scp3114Ragdoll.cs @@ -73,7 +73,7 @@ public float RevealElapsed } /// - /// Gets or sets a value indicating whether or not this corpse will trigger animation. + /// Gets or sets a value indicating whether this corpse will trigger animation. /// [EProperty(category: nameof(Scp3114Ragdoll))] public bool IsPlayingAnimation diff --git a/Exiled.API/Features/Scp914Processors/FirearmProcessor.cs b/Exiled.API/Features/Scp914Processors/FirearmProcessor.cs index 58d71f9dd1..200de63bf7 100644 --- a/Exiled.API/Features/Scp914Processors/FirearmProcessor.cs +++ b/Exiled.API/Features/Scp914Processors/FirearmProcessor.cs @@ -34,7 +34,7 @@ public FirearmProcessor(FirearmItemProcessor scp914ItemProcessor) public new FirearmItemProcessor Base { get; } /// - /// Gets or sets a value indicating whether or not magazine should be refilled. + /// Gets or sets a value indicating whether magazine should be refilled. /// public bool RefillAmmo { diff --git a/Exiled.API/Features/Scp914Processors/StandardProcessor.cs b/Exiled.API/Features/Scp914Processors/StandardProcessor.cs index a834627422..e2f9f19cd2 100644 --- a/Exiled.API/Features/Scp914Processors/StandardProcessor.cs +++ b/Exiled.API/Features/Scp914Processors/StandardProcessor.cs @@ -80,7 +80,7 @@ public IEnumerable VeryFineOutputs } /// - /// Gets or sets a value indicating whether or not item which has will execute method for updating. + /// Gets or sets a value indicating whether item which has will execute method for updating. /// public bool FireTrigger { diff --git a/Exiled.API/Features/Server.cs b/Exiled.API/Features/Server.cs index 72b53b28d3..3e8262f2d2 100644 --- a/Exiled.API/Features/Server.cs +++ b/Exiled.API/Features/Server.cs @@ -65,12 +65,12 @@ public static string Name public static string Version => GameCore.Version.VersionString; /// - /// Gets a value indicating whether or not streaming of this version is allowed. + /// Gets a value indicating whether streaming of this version is allowed. /// public static bool StreamingAllowed => GameCore.Version.StreamingAllowed; /// - /// Gets a value indicating whether or not this server is on a beta version of SCP:SL. + /// Gets a value indicating whether this server is on a beta version of SCP:SL. /// public static bool IsBeta => GameCore.Version.PublicBeta || GameCore.Version.PrivateBeta; @@ -90,7 +90,7 @@ public static string Name public static string IpAddress => ServerConsole.Ip; /// - /// Gets a value indicating whether or not this server is a dedicated server. + /// Gets a value indicating whether this server is a dedicated server. /// public static bool IsDedicated => ServerStatic.IsDedicated; @@ -119,7 +119,7 @@ public static short MaxTps public static double Frametime => Math.Round(1f / Time.deltaTime); /// - /// Gets or sets a value indicating whether or not friendly fire is enabled. + /// Gets or sets a value indicating whether friendly fire is enabled. /// /// public static bool FriendlyFire @@ -150,7 +150,7 @@ public static int MaxPlayerCount } /// - /// Gets a value indicating whether or not late join is enabled. + /// Gets a value indicating whether late join is enabled. /// public static bool LateJoinEnabled => LateJoinTime > 0; @@ -172,7 +172,7 @@ public static bool IsHeavilyModded } /// - /// Gets or sets a value indicating whether or not this server has the whitelist enabled. + /// Gets or sets a value indicating whether this server has the whitelist enabled. /// public static bool IsWhitelisted { @@ -181,12 +181,12 @@ public static bool IsWhitelisted } /// - /// Gets a value indicating whether or not this server is verified. + /// Gets a value indicating whether this server is verified. /// public static bool IsVerified => CustomNetworkManager.IsVerified; /// - /// Gets or sets a value indicating whether or not idle mode is enabled. + /// Gets or sets a value indicating whether idle mode is enabled. /// public static bool IsIdleModeEnabled { diff --git a/Exiled.API/Features/TeslaGate.cs b/Exiled.API/Features/TeslaGate.cs index 2958136792..7b4ab111ff 100644 --- a/Exiled.API/Features/TeslaGate.cs +++ b/Exiled.API/Features/TeslaGate.cs @@ -91,12 +91,12 @@ internal TeslaGate(BaseTeslaGate baseTeslaGate, Room room) public override Quaternion Rotation => Quaternion.Euler(Base.localRotation); /// - /// Gets the tesla gate's which is located in. + /// Gets the where this tesla gate is located. /// public Room Room { get; } /// - /// Gets a value indicating whether or not the tesla gate's shock burst is in progess. + /// Gets a value indicating whether the tesla gate's shock burst is in progess. /// public bool IsShocking => Base.InProgress; @@ -170,7 +170,7 @@ public bool IsIdling } /// - /// Gets or sets a value indicating whether or not the tesla gate's next burst should be treated as instant burst. + /// Gets or sets a value indicating whether the tesla gate's next burst should be treated as instant burst. /// The instant burst ignores the standard cooldown time, reducing it to the cooldown time used for bursts triggered by SCP-079. /// public bool UseInstantBurst @@ -220,7 +220,7 @@ public static TeslaGate Get(BaseTeslaGate baseTeslaGate) => BaseTeslaGateToTesla /// /// The instance. /// A or if not found. - /// Whether or not the tesla gate was found. + /// Whether the tesla gate was found. public static bool TryGet(BaseTeslaGate baseTeslaGate, out TeslaGate gate) { gate = Get(baseTeslaGate); @@ -232,7 +232,7 @@ public static bool TryGet(BaseTeslaGate baseTeslaGate, out TeslaGate gate) /// /// The condition to satisfy. /// A of which contains elements that satisfy the condition. - /// Whether or not at least one tesla gate was found. + /// Whether at least one tesla gate was found. public static bool TryGet(Func predicate, out IEnumerable gates) { gates = Get(predicate); diff --git a/Exiled.API/Features/TextDisplay.cs b/Exiled.API/Features/TextDisplay.cs index 0e9a417b82..f7a0ebbe11 100644 --- a/Exiled.API/Features/TextDisplay.cs +++ b/Exiled.API/Features/TextDisplay.cs @@ -36,7 +36,7 @@ public TextDisplay() /// /// The content of the text display. /// The duration of the text display, in seconds. - /// Whether or not the text display should be displayed. + /// Whether the text display should be displayed. /// The text channel to be used to display the content. public TextDisplay(string content, ushort duration = 10, bool canBeDisplayed = true, TextChannelType channel = TextChannelType.None) { diff --git a/Exiled.API/Features/Toys/AdminToy.cs b/Exiled.API/Features/Toys/AdminToy.cs index 08ec644cf0..6c1bebe723 100644 --- a/Exiled.API/Features/Toys/AdminToy.cs +++ b/Exiled.API/Features/Toys/AdminToy.cs @@ -48,7 +48,7 @@ internal AdminToy(AdminToyBase toyAdminToyBase, AdminToyType type) public AdminToyType ToyType { get; } /// - /// Gets or sets who spawn the Primitive AdminToy. + /// Gets or sets the who spawned the toy. /// public Player Player { @@ -66,7 +66,7 @@ public Footprint Footprint } /// - /// Gets or sets the position of the . + /// Gets or sets the position of the toy. /// public new Vector3 Position { @@ -84,11 +84,9 @@ public Vector3 Scale } /// - /// Gets or sets the movement smoothing value of the toy. - /// - /// Higher values reflect smoother movements. - ///
- 60 is an ideal value. - /// + /// Gets or sets the movement smoothing of toy transform updates. + /// Higher values reflect smoother transitions. + /// 60 is the ideal value. /// public byte MovementSmoothing { @@ -97,7 +95,8 @@ public byte MovementSmoothing } /// - /// Gets or sets a value indicating whether IsStatic. + /// Gets or sets a value indicating whether the toy is static. + /// Setting this value to true will skip network position updates, which helps to improve performance at the cost of not being able to move the toy. /// public bool IsStatic { @@ -113,12 +112,12 @@ public bool IsStatic public static AdminToy Get(AdminToyBase adminToyBase) => Map.Toys.FirstOrDefault(x => x.AdminToyBase == adminToyBase); /// - /// Spawns the toy into the game. Use to remove it. + /// Spawns the toy into the game. Use or to remove it. /// public void Spawn() => NetworkServer.Spawn(AdminToyBase.gameObject); /// - /// Removes the toy from the game. Use to bring it back. + /// Removes the toy without destroying it. Use to spawn it back. /// public void UnSpawn() => NetworkServer.UnSpawn(AdminToyBase.gameObject); diff --git a/Exiled.API/Features/Toys/Primitive.cs b/Exiled.API/Features/Toys/Primitive.cs index a34296b336..c02948b70e 100644 --- a/Exiled.API/Features/Toys/Primitive.cs +++ b/Exiled.API/Features/Toys/Primitive.cs @@ -55,7 +55,7 @@ public PrimitiveType Type } /// - /// Gets or sets the material color of the primitive. + /// Gets or sets the color of the primitive. /// public Color Color { @@ -83,6 +83,7 @@ public bool Visible /// /// Gets or sets the primitive flags. + /// Same as and . /// public PrimitiveFlags Flags { @@ -99,8 +100,9 @@ public PrimitiveFlags Flags /// The position. /// The rotation. /// The size of the primitive. - /// Whether or not the primitive is static. - /// Whether or not the primitive should be spawned. + /// Whether the primitive should be static. + /// Whether the primitive should be spawned. + /// /// The newly created . public static Primitive Create(PrimitiveType primitiveType, PrimitiveFlags flags = default, Color? color = null, Vector3? position = null, Quaternion? rotation = null, Vector3? scale = null, bool isStatic = false, bool spawn = true) => Create(new(primitiveType, color, position, flags, rotation, scale, isStatic, spawn)); @@ -112,15 +114,15 @@ public static Primitive Create(PrimitiveType primitiveType, PrimitiveFlags flags /// The new . public static Primitive Create(PrimitiveSettings primitiveSettings) { - Primitive primitive = new(Object.Instantiate(PrefabObject.GetComponent())) - { - Type = primitiveSettings.PrimitiveType, - Position = primitiveSettings.Position, - Rotation = primitiveSettings.Rotation, - Scale = primitiveSettings.Scale, - Flags = primitiveSettings.Flags, - Color = primitiveSettings.Color, - IsStatic = primitiveSettings.IsStatic, + Primitive primitive = new(Object.Instantiate(PrefabObject.GetComponent())) + { + Type = primitiveSettings.PrimitiveType, + Position = primitiveSettings.Position, + Rotation = primitiveSettings.Rotation, + Scale = primitiveSettings.Scale, + Flags = primitiveSettings.Flags, + Color = primitiveSettings.Color, + IsStatic = primitiveSettings.IsStatic, }; if (primitiveSettings.ShouldSpawn) diff --git a/Exiled.API/Features/Toys/ShootingTargetToy.cs b/Exiled.API/Features/Toys/ShootingTargetToy.cs index 8a6f60efda..4ec482c21c 100644 --- a/Exiled.API/Features/Toys/ShootingTargetToy.cs +++ b/Exiled.API/Features/Toys/ShootingTargetToy.cs @@ -160,7 +160,7 @@ public int AutoResetTime } /// - /// Gets or sets a value indicating whether or not the target is in sync mode. + /// Gets or sets a value indicating whether the target is in sync mode. /// public bool IsSynced { @@ -224,7 +224,7 @@ public static ShootingTargetToy Get(ShootingTarget shootingTarget) /// The damage to be dealt. /// The dealing the damage. /// The exact location of the hit. - /// Whether or not the damage was sent. + /// Whether the damage was sent. public bool Damage(float damage, DamageHandlerBase damageHandler, Vector3 exactHit) => Base.Damage(damage, damageHandler, exactHit); } } \ No newline at end of file diff --git a/Exiled.API/Features/Warhead.cs b/Exiled.API/Features/Warhead.cs index 2438f223a7..40fd17a341 100644 --- a/Exiled.API/Features/Warhead.cs +++ b/Exiled.API/Features/Warhead.cs @@ -43,7 +43,7 @@ public static class Warhead public static GameObject Lever => SitePanel.lever.gameObject; /// - /// Gets or sets a value indicating whether or not automatic detonation is enabled. + /// Gets or sets a value indicating whether automatic detonation is enabled. /// public static bool AutoDetonate { @@ -61,7 +61,7 @@ public static float AutoDetonateTime } /// - /// Gets or sets a value indicating whether or not doors will be opened when the warhead activates. + /// Gets or sets a value indicating whether doors will be opened when the warhead activates. /// public static bool OpenDoors { @@ -75,7 +75,7 @@ public static bool OpenDoors public static IReadOnlyCollection BlastDoors => BlastDoor.Instances; /// - /// Gets or sets a value indicating whether or not the warhead lever is enabled. + /// Gets or sets a value indicating whether the warhead lever is enabled. /// public static bool LeverStatus { @@ -84,7 +84,7 @@ public static bool LeverStatus } /// - /// Gets or sets a value indicating whether or not the warhead's outside panel has been opened. + /// Gets or sets a value indicating whether the warhead's outside panel has been opened. /// public static bool IsKeycardActivated { @@ -120,12 +120,12 @@ public static WarheadStatus Status } /// - /// Gets a value indicating whether or not the warhead has already been detonated. + /// Gets a value indicating whether the warhead has already been detonated. /// public static bool IsDetonated => Controller._alreadyDetonated; /// - /// Gets a value indicating whether or not the warhead detonation is in progress. + /// Gets a value indicating whether the warhead detonation is in progress. /// public static bool IsInProgress => Controller.Info.InProgress; @@ -162,7 +162,7 @@ public static int Kills } /// - /// Gets a value indicating whether or not the warhead can be started. + /// Gets a value indicating whether the warhead can be started. /// public static bool CanBeStarted => !IsInProgress && !IsDetonated && Controller.CooldownEndTime <= NetworkTime.time; @@ -206,11 +206,11 @@ public static void Start() public static void Shake() => Controller.RpcShake(false); /// - /// Gets whether or not the provided position will be detonated by the alpha warhead. + /// Gets whether the provided position will be detonated by the alpha warhead. /// /// The position to check. /// If , only lifts will be checked. - /// Whether or not the given position is prone to being detonated. + /// Whether the given position is prone to being detonated. public static bool CanBeDetonated(Vector3 pos, bool includeOnlyLifts = false) => AlphaWarheadController.CanBeDetonated(pos, includeOnlyLifts); } } diff --git a/Exiled.API/Features/Window.cs b/Exiled.API/Features/Window.cs index 896de4e148..71b453d51a 100644 --- a/Exiled.API/Features/Window.cs +++ b/Exiled.API/Features/Window.cs @@ -48,7 +48,7 @@ internal Window(BreakableWindow window, Room room) } /// - /// Gets a of which contains all the instances. + /// Gets all instances. /// public static new IReadOnlyCollection List => BreakableWindowToWindow.Values; @@ -84,12 +84,12 @@ internal Window(BreakableWindow window, Room room) public ZoneType Zone => Room.Zone; /// - /// Gets a value indicating whether or not this window is breakable. + /// Gets a value indicating whether this window is breakable. /// public bool IsBreakable => !Base.isBroken; /// - /// Gets or sets a value indicating whether or not this window is broken. + /// Gets or sets a value indicating whether this window is broken. /// public bool IsBroken { @@ -107,7 +107,7 @@ public float Health } /// - /// Gets or sets a value indicating whether or not this window can be broken by SCP. + /// Gets or sets a value indicating whether this window can be broken by SCP. /// public bool DisableScpDamage { @@ -116,7 +116,7 @@ public bool DisableScpDamage } /// - /// Gets or sets a value indicating whether or not this window is broken. + /// Gets or sets a value indicating whether this window is broken. /// public BreakableWindow.BreakableWindowStatus SyncStatus { @@ -154,7 +154,7 @@ public static Window Get(BreakableWindow breakableWindow) => BreakableWindowToWi /// /// The instance. /// A or if not found. - /// Whether or not a window was found. + /// Whether a window was found. public static bool TryGet(BreakableWindow breakableWindow, out Window window) { window = Get(breakableWindow); @@ -166,7 +166,7 @@ public static bool TryGet(BreakableWindow breakableWindow, out Window window) /// /// The condition to satisfy. /// A of which contains elements that satisfy the condition. - /// Whether or not at least one window was found. + /// Whether at least one window was found. public static bool TryGet(Func predicate, out IEnumerable windows) { windows = Get(predicate); @@ -189,7 +189,7 @@ public static bool TryGet(Func predicate, out IEnumerable /// /// The amount of damage to deal. /// The handler of damage. - /// Whether or not the Window get Damage. + /// Whether the window got damaged. public bool Damage(float amount, DamageHandlerBase handler) => Base.Damage(amount, handler, Vector3.zero); /// diff --git a/Exiled.API/Interfaces/IDamageableDoor.cs b/Exiled.API/Interfaces/IDamageableDoor.cs index 6a4e60ec87..b4c99016bf 100644 --- a/Exiled.API/Interfaces/IDamageableDoor.cs +++ b/Exiled.API/Interfaces/IDamageableDoor.cs @@ -25,12 +25,12 @@ public interface IDamageableDoor public float MaxHealth { get; set; } /// - /// Gets or sets a value indicating whether or not door is destroyed. + /// Gets or sets a value indicating whether door is destroyed. /// public bool IsDestroyed { get; set; } /// - /// Gets a value indicating whether or not this door is breakable. + /// Gets a value indicating whether this door is breakable. /// public bool IsBreakable { get; } diff --git a/Exiled.API/Interfaces/INonInteractableDoor.cs b/Exiled.API/Interfaces/INonInteractableDoor.cs index 1f2433d261..23f188e4b1 100644 --- a/Exiled.API/Interfaces/INonInteractableDoor.cs +++ b/Exiled.API/Interfaces/INonInteractableDoor.cs @@ -13,12 +13,12 @@ namespace Exiled.API.Interfaces public interface INonInteractableDoor { /// - /// Gets or sets a value indicating whether or not door should ignore lockdowns. + /// Gets or sets a value indicating whether door should ignore lockdowns. /// public bool IgnoreLockdowns { get; set; } /// - /// Gets or sets a value indicating whether or not door should ignore RA requests. + /// Gets or sets a value indicating whether door should ignore RA requests. /// public bool IgnoreRemoteAdmin { get; set; } } diff --git a/Exiled.API/Interfaces/IValidator.cs b/Exiled.API/Interfaces/IValidator.cs index 51965cb874..6a5516417b 100644 --- a/Exiled.API/Interfaces/IValidator.cs +++ b/Exiled.API/Interfaces/IValidator.cs @@ -16,7 +16,7 @@ public interface IValidator /// Validates a config value. /// /// A value to validate. - /// Returns whether or not config value is correct. + /// Returns whether config value is correct. bool Validate(object value); } } \ No newline at end of file diff --git a/Exiled.API/Structs/PrimitiveSettings.cs b/Exiled.API/Structs/PrimitiveSettings.cs index ef11c63575..1235ddf211 100644 --- a/Exiled.API/Structs/PrimitiveSettings.cs +++ b/Exiled.API/Structs/PrimitiveSettings.cs @@ -25,8 +25,8 @@ public struct PrimitiveSettings /// The position of the primitive. /// The rotation of the primitive. /// The scale of the primitive. - /// Whether or not the primitive should be spawned. - /// Whether or not the primitive should be static. + /// Whether the primitive should be spawned. + /// Whether the primitive should be static. public PrimitiveSettings(PrimitiveType primitiveType, Color? color, Vector3? position, PrimitiveFlags flags = PrimitiveFlags.Visible | PrimitiveFlags.Collidable, Quaternion? rotation = null, Vector3? scale = null, bool isStatic = false, bool spawn = true) { PrimitiveType = primitiveType; @@ -85,13 +85,11 @@ public PrimitiveSettings(Primitive primitive) /// public Vector3 Scale { get; set; } - /// - /// Gets or sets a value indicating whether or not the primitive should be spawned. - /// + /// public bool IsStatic { get; set; } /// - /// Gets or sets a value indicating whether or not the primitive should be spawned. + /// Gets or sets a value indicating whether the primitive should be spawned. /// public bool ShouldSpawn { get; set; } } diff --git a/Exiled.CreditTags/Features/ThreadSafeRequest.cs b/Exiled.CreditTags/Features/ThreadSafeRequest.cs index 92e93745bf..7be899cc1a 100644 --- a/Exiled.CreditTags/Features/ThreadSafeRequest.cs +++ b/Exiled.CreditTags/Features/ThreadSafeRequest.cs @@ -29,7 +29,7 @@ internal sealed class ThreadSafeRequest public string Result { get; private set; } /// - /// Gets a value indicating whether or not it was successful. + /// Gets a value indicating whether it was successful. /// public bool Success { get; private set; } @@ -39,7 +39,7 @@ internal sealed class ThreadSafeRequest public HttpStatusCode Code { get; private set; } /// - /// Gets a value indicating whether or not the request was successful. + /// Gets a value indicating whether the request was successful. /// public bool Done => done; diff --git a/Exiled.CustomModules/API/Features/CustomEscapes/EscapeSettings.cs b/Exiled.CustomModules/API/Features/CustomEscapes/EscapeSettings.cs index 0b86d38bfa..f3e2de7f37 100644 --- a/Exiled.CustomModules/API/Features/CustomEscapes/EscapeSettings.cs +++ b/Exiled.CustomModules/API/Features/CustomEscapes/EscapeSettings.cs @@ -78,12 +78,13 @@ public EscapeSettings( } /// - /// Gets or sets a value indicating whether escaping is allowed. + /// Gets or sets a value indicating whether the specific settings are enabled. /// public bool IsAllowed { get; set; } /// /// Gets or sets the role to be given when escaping. + /// Will override the if set. /// public RoleTypeId Role { get; set; } @@ -93,12 +94,12 @@ public EscapeSettings( public CustomRole CustomRole { get; set; } /// - /// Gets or sets the escape position. + /// Gets or sets the position where the specific settings will be triggered. /// public Vector3 Position { get; set; } /// - /// Gets or sets the maximum allowable distance for applying the specified settings. + /// Gets or sets the distance threshold from the to trigger the settings. /// public float DistanceThreshold { get; set; } } diff --git a/Exiled.CustomModules/API/Features/CustomItems/CustomItem.cs b/Exiled.CustomModules/API/Features/CustomItems/CustomItem.cs index e11ddc297d..b94c52961f 100644 --- a/Exiled.CustomModules/API/Features/CustomItems/CustomItem.cs +++ b/Exiled.CustomModules/API/Features/CustomItems/CustomItem.cs @@ -27,7 +27,7 @@ namespace Exiled.CustomModules.API.Features.CustomItems using UnityEngine; /// - /// A class to easily manage item behavior. + /// A class to customize item behaviour. /// public abstract class CustomItem : CustomModule, IAdditiveBehaviour { @@ -47,27 +47,27 @@ public abstract class CustomItem : CustomModule, IAdditiveBehaviour #pragma warning restore SA1202 // Elements should be ordered by access /// - /// Gets a which contains all registered 's. + /// Gets all registered s. /// public static IEnumerable List => Registered; /// - /// Gets all Items and their respective . + /// Gets all custom items and their respective instance. /// public static IReadOnlyDictionary ItemManager => ItemsValue; /// - /// Gets all Pickups and their respective . + /// Gets all custom pickups and their respective instance. /// public static IReadOnlyDictionary PickupManager => PickupValue; /// - /// Gets all pickups belonging to a . + /// Gets all pickups that are s. /// public static IEnumerable CustomPickups => PickupManager.Keys; /// - /// Gets all items belonging to a . + /// Gets all items that are s. /// public static IEnumerable CustomItems => ItemManager.Keys; @@ -92,7 +92,7 @@ public abstract class CustomItem : CustomModule, IAdditiveBehaviour public override bool IsEnabled { get; } /// - /// Gets the 's description. + /// Gets the description. It can then be used in .. /// public virtual string Description { get; } @@ -117,12 +117,12 @@ public abstract class CustomItem : CustomModule, IAdditiveBehaviour public virtual bool IsRegistered => Registered.Contains(this); /// - /// Gets a of containing all pickup owning this . + /// Gets all instances of this . /// public IEnumerable Pickups => PickupManager.Where(x => x.Value.Id == Id).Select(x => x.Key); /// - /// Gets a of containing all item owning this . + /// Gets all instances of this . /// public IEnumerable Items => ItemsValue.Where(x => x.Value.Id == Id).Select(x => x.Key); @@ -134,33 +134,33 @@ public abstract class CustomItem : CustomModule, IAdditiveBehaviour public static CustomItem Get(object id) => id is uint or UUCustomItemType ? Get((uint)id) : null; /// - /// Retrieves a instance based on the specified custom item id. + /// Gets a instance based on the specified custom item id. /// - /// The custom item id to retrieve. - /// The retrieved instance if found and enabled; otherwise, . + /// The id of the custom item to get. + /// The instance if found and enabled; otherwise, . public static CustomItem Get(uint id) => IdLookupTable[id]; /// - /// Retrieves a instance based on the specified item name. + /// Gets a instance based on the specified item name. /// - /// The name of the custom item to retrieve. - /// The retrieved instance if found; otherwise, . + /// The name of the custom item to get. + /// The instance if found; otherwise, . public static CustomItem Get(string name) => NameLookupTable[name]; /// - /// Retrieves a instance based on the specified type. + /// Gets a instance based on the specified type. /// - /// The type to retrieve the custom item for. - /// The retrieved instance if found and enabled; otherwise, . + /// The type to get the custom item for. + /// The instance if found and enabled; otherwise, . public static CustomItem Get(Type type) => typeof(CustomItem).IsAssignableFrom(type) ? TypeLookupTable[type] : typeof(ItemBehaviour).IsAssignableFrom(type) ? BehaviourLookupTable[type] : null; /// - /// Retrieves a instance based on the specified instance. + /// Gets a instance based on the specified instance. /// - /// The instance to retrieve the custom item from. - /// The retrieved instance if found; otherwise, . + /// The instance to get the custom item from. + /// The instance if found; otherwise, . public static CustomItem Get(Item item) { CustomItem customItem = default; @@ -177,17 +177,17 @@ public static CustomItem Get(Item item) } /// - /// Retrieves a instance based on the specified instance. + /// Gets a instance based on the specified instance. /// - /// The instance to retrieve the custom item from. - /// The retrieved instance if found; otherwise, . - public static CustomItem Get(Pickup item) + /// The instance to get the custom item from. + /// The instance if found; otherwise, . + public static CustomItem Get(Pickup pickup) { CustomItem customItem = default; foreach (KeyValuePair kvp in PickupManager) { - if (kvp.Key != item) + if (kvp.Key != pickup) continue; customItem = kvp.Value; @@ -197,7 +197,7 @@ public static CustomItem Get(Pickup item) } /// - /// Attempts to retrieve a based on the provided id or . + /// Attempts to get a based on the provided id or . /// /// The id or of the custom item. /// When this method returns, contains the associated with the specified id, if the id was found; otherwise, . @@ -205,42 +205,42 @@ public static CustomItem Get(Pickup item) public static bool TryGet(object id, out CustomItem customItem) => customItem = Get(id); /// - /// Tries to retrieve a instance based on the specified custom item id. + /// Tries to get a instance based on the specified custom item id. /// - /// The custom item id to retrieve. - /// The retrieved instance, if successful; otherwise, . - /// if the retrieval is successful; otherwise, . + /// The id of the custom item to get. + /// The instance, if successful; otherwise, . + /// if successful; otherwise, . public static bool TryGet(uint id, out CustomItem customItem) => customItem = Get(id); /// - /// Tries to retrieve a instance based on the specified item name. + /// Tries to get a instance based on the specified item name. /// - /// The name of the custom item to retrieve. - /// The retrieved instance, if successful; otherwise, . - /// if the retrieval is successful; otherwise, . + /// The name of the custom item to get. + /// The instance, if successful; otherwise, . + /// if successful; otherwise, . public static bool TryGet(string name, out CustomItem customItem) => customItem = Get(name); /// - /// Tries to retrieve a instance based on the specified instance. + /// Tries to get a instance based on the specified instance. /// - /// The instance to retrieve the custom item for. - /// The retrieved instance, if successful; otherwise, . - /// if the retrieval is successful; otherwise, . + /// The instance to get the custom item from. + /// The instance, if successful; otherwise, . + /// if successful; otherwise, . public static bool TryGet(Item item, out CustomItem customItem) => customItem = Get(item); /// - /// Tries to retrieve a instance based on the specified instance. + /// Tries to get a instance based on the specified instance. /// - /// The instance to retrieve the custom item for. - /// The retrieved instance, if successful; otherwise, . - /// if the retrieval is successful; otherwise, . + /// The instance to get the custom item from. + /// The instance, if successful; otherwise, . + /// if successful; otherwise, . public static bool TryGet(Pickup pickup, out CustomItem customItem) => customItem = Get(pickup); /// - /// Tries to retrieve a instance based on the specified type. + /// Tries to get a instance based on the specified type. /// - /// The type to retrieve the custom item for. - /// The retrieved instance, if successful; otherwise, . + /// The type to get the custom item for. + /// The instance, if successful; otherwise, . /// if the retrieval is successful; otherwise, . public static bool TryGet(Type type, out CustomItem customItem) => customItem = Get(type); @@ -370,7 +370,7 @@ public static bool TryGive(Player player, Type type, bool displayMessage = true) /// /// The assembly to enable the items from. /// - /// A of containing all the enabled custom items. + /// A of all the enabled custom items. /// /// /// This method dynamically enables all custom items found in the calling assembly. Custom items @@ -408,7 +408,7 @@ public static List EnableAll(Assembly assembly) /// Disables all the custom items present in the assembly. /// /// - /// A of containing all the disabled custom items. + /// A of all the disabled custom items. /// /// /// This method dynamically disables all custom items found in the calling assembly that were diff --git a/Exiled.CustomModules/API/Features/CustomItems/Items/Explosives/GrenadeBehaviour.cs b/Exiled.CustomModules/API/Features/CustomItems/Items/Explosives/GrenadeBehaviour.cs index 73091af733..7d691beb90 100644 --- a/Exiled.CustomModules/API/Features/CustomItems/Items/Explosives/GrenadeBehaviour.cs +++ b/Exiled.CustomModules/API/Features/CustomItems/Items/Explosives/GrenadeBehaviour.cs @@ -34,7 +34,7 @@ namespace Exiled.CustomModules.API.Features.CustomItems.Items.Explosives /// public abstract class GrenadeBehaviour : ItemBehaviour { - /// . + /// public GrenadeSettings GrenadeSettings => Settings.Cast(); /// @@ -43,13 +43,13 @@ public abstract class GrenadeBehaviour : ItemBehaviour /// /// Throw the custom grenade object. /// - /// The position to throw at. + /// The position to throw from. /// The amount of force to throw with. /// The weight of the Grenade. /// The fuse time of the grenade. /// The of the grenade to spawn. /// The to count as the thrower of the grenade. - /// The spawned . + /// The spawned grenade . public virtual Pickup Throw(Vector3 position, float force, float weight, float fuseTime = 3f, ItemType grenadeType = ItemType.GrenadeHE, Player player = null) { if (!player) @@ -129,7 +129,7 @@ protected override void UnsubscribeEvents() } /// - /// Handles tracking thrown requests by custom grenades. + /// Fired before receiving a throwing request with a custom grenade. /// /// . protected virtual void OnThrowingRequest(ThrowingRequestEventArgs ev) @@ -137,7 +137,7 @@ protected virtual void OnThrowingRequest(ThrowingRequestEventArgs ev) } /// - /// Handles tracking thrown custom grenades. + /// Fired after a custom grenade is thrown. /// /// . protected virtual void OnThrownProjectile(ThrownProjectileEventArgs ev) @@ -145,7 +145,7 @@ protected virtual void OnThrownProjectile(ThrownProjectileEventArgs ev) } /// - /// Handles tracking exploded custom grenades. + /// Fired before a custom grenade explodes. /// /// . protected virtual void OnExploding(ExplodingGrenadeEventArgs ev) @@ -153,7 +153,7 @@ protected virtual void OnExploding(ExplodingGrenadeEventArgs ev) } /// - /// Handles the tracking of custom grenade pickups that are changed into live grenades by a frag grenade explosion. + /// Fired after a custom was changed into a live grenade by an explosion. /// /// . protected virtual void OnChangedIntoGrenade(ChangedIntoGrenadeEventArgs ev) diff --git a/Exiled.CustomModules/API/Features/CustomItems/Items/Explosives/GrenadeSettings.cs b/Exiled.CustomModules/API/Features/CustomItems/Items/Explosives/GrenadeSettings.cs index 1831e3babf..b944d2acaf 100644 --- a/Exiled.CustomModules/API/Features/CustomItems/Items/Explosives/GrenadeSettings.cs +++ b/Exiled.CustomModules/API/Features/CustomItems/Items/Explosives/GrenadeSettings.cs @@ -36,7 +36,7 @@ public override ItemType ItemType public virtual bool ExplodeOnCollision { get; set; } /// - /// Gets or sets a value indicating how long the grenade's fuse time should be. + /// Gets or sets a value indicating the length of grenade's fuse in seconds. /// public virtual float FuseTime { get; set; } } diff --git a/Exiled.CustomModules/API/Features/CustomItems/Items/ItemSettings.cs b/Exiled.CustomModules/API/Features/CustomItems/Items/ItemSettings.cs index 88fc18a341..0394194f1e 100644 --- a/Exiled.CustomModules/API/Features/CustomItems/Items/ItemSettings.cs +++ b/Exiled.CustomModules/API/Features/CustomItems/Items/ItemSettings.cs @@ -45,7 +45,7 @@ public class ItemSettings : Settings public override Vector3 Scale { get; set; } = Vector3.one; /// - /// Gets or sets a value indicating whether or not this item causes things to happen that may be considered hacks, and thus be shown to global moderators as being present in a player's inventory when they gban them. + /// Gets or sets a value indicating whether this item causes things to happen that may be considered hacks, and thus be shown to global moderators as being present in a player's inventory when they gban them. /// public virtual bool ShouldMessageOnGban { get; set; } diff --git a/Exiled.CustomModules/API/Features/Pawn.cs b/Exiled.CustomModules/API/Features/Pawn.cs index 388e138e4b..3c8d19df01 100644 --- a/Exiled.CustomModules/API/Features/Pawn.cs +++ b/Exiled.CustomModules/API/Features/Pawn.cs @@ -30,16 +30,13 @@ namespace Exiled.CustomModules.API.Features using UnityEngine; /// - /// Represents an in-game player by encapsulating a , providing an extended feature set through the class. + /// version of with additional features. + /// Can be obtained by casting a object: Pawn pawn = player.As]]>(). /// - /// The class enhances the functionality of the base class, introducing additional features and capabilities. - ///
This class is designed to be used seamlessly alongside existing methods that expect a as a parameter, allowing for compatibility with the existing codebase.
- /// The use of nullable context is enabled to prevent users from inadvertently passing or interacting with references. + /// The class adds new functionality to the base class, while still being compatible with existing methods that expect a as a parameter, + /// allowing for compatibility with the existing codebase. /// - /// - /// Developers can leverage the enhanced functionality provided by the class while benefiting from the familiar interface of the class. - ///
It serves as a comprehensive representation of an in-game entity, encapsulating the associated with an expanded set of features.
- /// + /// The use of nullable context is enabled to prevent users from inadvertently passing or interacting with references. /// [DefaultPlayerClass(enforceAuthority: false)] public class Pawn : Player @@ -165,16 +162,16 @@ public Pawn(GameObject gameObject) } /// - /// Gets the global role of the pawn. + /// Gets the or of the pawn. /// - /// It will return a if available, or the if null. + /// if available; otherwise, the standard /// public object GlobalRole => CustomRole ? CustomRole : Role; /// - /// Gets the global items associated with the pawn. + /// Gets the s and s associated with the pawn. /// - /// It will return a combination of standard s and s. + /// A combination of s and s /// public IEnumerable GlobalItems => Items.Cast().Concat(CustomItems); @@ -221,14 +218,14 @@ public object GlobalCurrentItem } /// - /// Gets a value indicating whether the pawn is any custom SCP. + /// Gets a value indicating whether the pawn is a custom SCP. /// public bool IsCustomScp => CustomRole && CustomRole.IsScp; /// - /// Gets a of containing all custom items in the pawn's inventory. + /// Gets a of all s in the pawn's inventory. /// - /// A of which contains all found custom items. + /// A of all s in the pawn's inventory. public IEnumerable CustomItems { get @@ -244,13 +241,13 @@ public IEnumerable CustomItems } /// - /// Gets a of . + /// Gets a of all s. /// - /// A of . + /// A of all s. public IEnumerable EffectTypes { get; } = EnumExtensions.QueryValues(); /// - /// Gets a value indicating whether the pawn has the of the specified type. + /// Gets a value indicating whether the pawn has a of the specified type. /// /// The type of the . /// if a of the specified type was found; otherwise, . @@ -258,7 +255,7 @@ public bool HasCustomItem() where T : CustomItem => CustomItems.Any(item => item.GetType() == typeof(T)); /// - /// Gets a value indicating whether the pawn has the of the specified type. + /// Gets a value indicating whether the pawn has a of the specified type. /// /// The type of the . /// if a of the specified type was found; otherwise, . @@ -266,10 +263,10 @@ public bool HasCustomAbility() where T : PlayerAbility => CustomAbilities.Any(ability => ability.GetType() == typeof(T)); /// - /// Tries to get the first of the specified type from the collection of custom items. + /// Tries to get the first of the specified type from the pawn's inventory. /// - /// The type of the to retrieve. - /// The output parameter that will contain the retrieved , if found. + /// The type of the to get. + /// The output parameter that will contain the , if found. /// if a of the specified type was found; otherwise, . public bool TryGetCustomItem(out T customItem) where T : CustomItem => customItem = CustomItems.FirstOrDefault(item => item.GetType() == typeof(T))?.Cast(); @@ -277,17 +274,17 @@ public bool TryGetCustomItem(out T customItem) /// /// Tries to get the of the specified type from the . /// - /// The type of the to retrieve. + /// The type of the . /// The output parameter that will contain the retrieved , if found. /// if a of the specified type was found; otherwise, . public bool TryGetCustomRole(out T customRole) where T : CustomRole => CustomRole.Is(out customRole); /// - /// Tries to get the of the specified type from the player's abilities. + /// Tries to get the of the specified type from the pawn's abilities. /// - /// The type of the to retrieve. - /// The output parameter that will contain the retrieved , if found. + /// The type of the to get. + /// The output parameter that will contain the , if found. /// if a of the specified type was found; otherwise, . public bool TryGetCustomAbility(out T customAbility) where T : PlayerAbility => CustomAbilities.FirstOrDefault(ability => ability.GetType() == typeof(T)).Is(out customAbility); @@ -295,7 +292,7 @@ public bool TryGetCustomAbility(out T customAbility) /// /// Add an or of the specified type to the pawn's inventory. /// - /// The item to be added. + /// The item to add. Can be an , , , as well as 's , or . /// if the item has been given to the pawn; otherwise, . public bool AddItem(object item) { @@ -330,9 +327,10 @@ public bool AddItem(object item) } /// - /// Adds a of containing all the custom items to the pawn's inventory. + /// Adds a collection of and to the pawn's inventory. /// - /// The custom items to be added. + /// The custom items to add. + /// public void AddItem(IEnumerable customItems) { foreach (object customItemType in customItems) @@ -345,7 +343,7 @@ public void AddItem(IEnumerable customItems) /// /// Sets the pawn's role. /// - /// The role to be set. + /// The role to set. Can be a or a representing a custom role's . /// A value indicating whether the should be spawned in the same position. /// The to be set. /// The to be set. @@ -371,10 +369,7 @@ public void SetRole(object role, bool preservePlayerPosition = false, SpawnReaso } } - /// - /// Safely drops an item. - /// - /// The item to be dropped. + /// public new void DropItem(Item item) { if (TryGetCustomItem(out CustomItem customItem)) @@ -388,17 +383,17 @@ public void SetRole(object role, bool preservePlayerPosition = false, SpawnReaso } /// - /// Gets the ammo count of a specified custom ammo in a pawn's inventory. + /// Gets the amount of a specified custom ammo in a pawn's ammo box. /// /// The custom ammo to be searched for in the pawn's inventory. - /// The specified custom ammo count. + /// The amount of the specified custom ammo in the pawn's inventory. public ushort GetAmmo(uint customAmmoType) => (ushort)(customAmmoBox.TryGetValue(customAmmoType, out ushort amount) ? amount : 0); /// - /// Adds an amount of custom ammo to the pawn's ammo box. + /// Adds custom ammo to the pawn's ammo box. /// /// The type of the custom ammo. - /// The amount to be added. + /// The amount to add. /// if the specified amount of ammo was given entirely or partially; otherwise, . public bool AddAmmo(uint id, ushort amount) { @@ -432,10 +427,10 @@ public bool AddAmmo(uint id, ushort amount) } /// - /// Removes an amount of custom ammo from the pawn's ammo box. + /// Removes custom ammo from the pawn's ammo box. /// /// The type of the custom ammo. - /// The amount to be removed. + /// The amount to remove. /// if the specified amount of ammo was removed entirely or partially; otherwise, . public bool RemoveAmmo(uint id, ushort amount) { @@ -459,10 +454,10 @@ public bool RemoveAmmo(uint id, ushort amount) } /// - /// Sets the amount of a specified custom ammo to the pawn's inventory. + /// Sets the amount of a specified custom ammo in the pawn's ammo box. /// /// The type of the custom ammo. - /// The amount of ammo to be set. + /// The amount to set. public void SetAmmo(uint id, ushort amount) { if (customAmmoBox.TryAdd(id, amount)) diff --git a/Exiled.Events/EventArgs/Cassie/SendingCassieMessageEventArgs.cs b/Exiled.Events/EventArgs/Cassie/SendingCassieMessageEventArgs.cs index c21f7c9f6b..71d51de24b 100644 --- a/Exiled.Events/EventArgs/Cassie/SendingCassieMessageEventArgs.cs +++ b/Exiled.Events/EventArgs/Cassie/SendingCassieMessageEventArgs.cs @@ -10,7 +10,7 @@ namespace Exiled.Events.EventArgs.Cassie using Interfaces; /// - /// Contains all the information after sending a C.A.S.S.I.E. message. + /// Contains all the information before sending a C.A.S.S.I.E. message. /// public class SendingCassieMessageEventArgs : IDeniableEvent { @@ -41,17 +41,17 @@ public SendingCassieMessageEventArgs(string words, bool makeHold, bool makeNoise public string Words { get; set; } /// - /// Gets or sets a value indicating whether or not the message should be held. + /// Gets or sets a value indicating whether the message should be held. /// public bool MakeHold { get; set; } /// - /// Gets or sets a value indicating whether or not the message should make noise. + /// Gets or sets a value indicating whether the message should have background noise and begin with a bell ring sound. /// public bool MakeNoise { get; set; } /// - /// Gets or sets a value indicating whether or not the message can be sent. + /// Gets or sets a value indicating whether the message can be sent. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Interfaces/IDeniableEvent.cs b/Exiled.Events/EventArgs/Interfaces/IDeniableEvent.cs index 41a4e78eac..4625adedbf 100644 --- a/Exiled.Events/EventArgs/Interfaces/IDeniableEvent.cs +++ b/Exiled.Events/EventArgs/Interfaces/IDeniableEvent.cs @@ -13,7 +13,7 @@ namespace Exiled.Events.EventArgs.Interfaces public interface IDeniableEvent : IExiledEvent { /// - /// Gets or sets a value indicating whether or not the event is allowed to continue. + /// Gets or sets a value indicating whether the event is allowed to continue. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Item/BreakingJailbirdEventArgs.cs b/Exiled.Events/EventArgs/Item/BreakingJailbirdEventArgs.cs index 7c5118fd6c..fd35fe09ca 100644 --- a/Exiled.Events/EventArgs/Item/BreakingJailbirdEventArgs.cs +++ b/Exiled.Events/EventArgs/Item/BreakingJailbirdEventArgs.cs @@ -12,7 +12,7 @@ namespace Exiled.Events.EventArgs.Item using InventorySystem.Items.Jailbird; /// - /// Contains all information before jailbird breaks. + /// Contains all information before a jailbird breaks. /// public class BreakingJailbirdEventArgs : IItemEvent, IDeniableEvent { diff --git a/Exiled.Events/EventArgs/Item/ChangedAttachmentsEventArgs.cs b/Exiled.Events/EventArgs/Item/ChangedAttachmentsEventArgs.cs index 2c5c00dc74..a447a79194 100644 --- a/Exiled.Events/EventArgs/Item/ChangedAttachmentsEventArgs.cs +++ b/Exiled.Events/EventArgs/Item/ChangedAttachmentsEventArgs.cs @@ -22,7 +22,7 @@ namespace Exiled.Events.EventArgs.Item using Firearm = API.Features.Items.Firearm; /// - /// Contains all information after changing item attachments. + /// Contains all information after attachments were changed. /// public class ChangedAttachmentsEventArgs : IPlayerEvent, IFirearmEvent { diff --git a/Exiled.Events/EventArgs/Item/ChangingAmmoEventArgs.cs b/Exiled.Events/EventArgs/Item/ChangingAmmoEventArgs.cs index c79cb7115e..8771c3f00a 100644 --- a/Exiled.Events/EventArgs/Item/ChangingAmmoEventArgs.cs +++ b/Exiled.Events/EventArgs/Item/ChangingAmmoEventArgs.cs @@ -23,13 +23,13 @@ public class ChangingAmmoEventArgs : IPlayerEvent, IFirearmEvent, IDeniableEvent /// /// Initializes a new instance of the class. /// - /// + /// /// /// /// - public ChangingAmmoEventArgs(BaseFirearm basefirearm, FirearmStatus oldStatus, FirearmStatus newStatus, bool isAllowed = true) + public ChangingAmmoEventArgs(BaseFirearm baseFirearm, FirearmStatus oldStatus, FirearmStatus newStatus, bool isAllowed = true) { - Firearm = Item.Get(basefirearm).As(); + Firearm = Item.Get(baseFirearm).As(); Player = Firearm.Owner; OldStatus = oldStatus; NewStatus = newStatus; @@ -42,7 +42,7 @@ public ChangingAmmoEventArgs(BaseFirearm basefirearm, FirearmStatus oldStatus, F public Player Player { get; } /// - /// Gets the the ammo type is being changed to. + /// Gets the whose ammo is being changed. /// public Firearm Firearm { get; } @@ -50,22 +50,22 @@ public ChangingAmmoEventArgs(BaseFirearm basefirearm, FirearmStatus oldStatus, F public Item Item => Firearm; /// - /// Gets the old status. + /// Gets the old firearm status. /// public FirearmStatus OldStatus { get; } /// - /// Gets the old ammo. + /// Gets the old ammo count of the firearm. /// public byte OldAmmo => OldStatus.Ammo; /// - /// Gets or sets the new status to be used by the firearm. + /// Gets or sets the new status that will be used by the firearm. /// public FirearmStatus NewStatus { get; set; } /// - /// Gets or sets the new ammo to be used by the firearm. + /// Gets or sets the new ammo count of the firearm. /// public byte NewAmmo { @@ -74,7 +74,7 @@ public byte NewAmmo } /// - /// Gets or sets a value indicating whether or not the ammo can be changed. + /// Gets or sets a value indicating whether the ammo can be changed. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Item/ChangingAttachmentsEventArgs.cs b/Exiled.Events/EventArgs/Item/ChangingAttachmentsEventArgs.cs index 1f9459649b..e167a9cd9b 100644 --- a/Exiled.Events/EventArgs/Item/ChangingAttachmentsEventArgs.cs +++ b/Exiled.Events/EventArgs/Item/ChangingAttachmentsEventArgs.cs @@ -21,7 +21,7 @@ namespace Exiled.Events.EventArgs.Item using InventorySystem.Items.Firearms.Attachments; /// - /// Contains all information before changing item attachments. + /// Contains all information before attachments are changed. /// public class ChangingAttachmentsEventArgs : IPlayerEvent, IDeniableEvent, IFirearmEvent { @@ -70,7 +70,7 @@ public uint NewAttachmentsCode } /// - /// Gets or sets a value indicating whether or not the attachments can be changed. + /// Gets or sets a value indicating whether the attachments can be changed. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Item/ChargingJailbirdEventArgs.cs b/Exiled.Events/EventArgs/Item/ChargingJailbirdEventArgs.cs index 1b17a1bb0a..30204b56d7 100644 --- a/Exiled.Events/EventArgs/Item/ChargingJailbirdEventArgs.cs +++ b/Exiled.Events/EventArgs/Item/ChargingJailbirdEventArgs.cs @@ -12,7 +12,7 @@ namespace Exiled.Events.EventArgs.Item using Exiled.Events.EventArgs.Interfaces; /// - /// Contains all information before a player charges a . + /// Contains all information before a charged attack. /// public class ChargingJailbirdEventArgs : IPlayerEvent, IItemEvent, IDeniableEvent { @@ -40,7 +40,7 @@ public ChargingJailbirdEventArgs(ReferenceHub player, InventorySystem.Items.Item public Item Item { get; } /// - /// Gets or sets a value indicating whether or not the Jailbird can be charged. + /// Gets or sets a value indicating whether the Jailbird can be charged. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Item/KeycardInteractingEventArgs.cs b/Exiled.Events/EventArgs/Item/KeycardInteractingEventArgs.cs index 65f7a95c79..5c77e202a6 100644 --- a/Exiled.Events/EventArgs/Item/KeycardInteractingEventArgs.cs +++ b/Exiled.Events/EventArgs/Item/KeycardInteractingEventArgs.cs @@ -16,7 +16,7 @@ namespace Exiled.Events.EventArgs.Item using BaseKeycardPickup = InventorySystem.Items.Keycards.KeycardPickup; /// - /// Contains all information before a keycard interacts with a door. + /// Contains all information before a thrown interacts with a door. /// public class KeycardInteractingEventArgs : IPlayerEvent, IDeniableEvent, IDoorEvent, IPickupEvent { @@ -51,7 +51,7 @@ public KeycardInteractingEventArgs(BaseKeycardPickup pickup, Player player, Door public Door Door { get; } /// - /// Gets or sets a value indicating whether or not the keycard can interact with the door. + /// Gets or sets a value indicating whether the keycard can interact with the door. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Item/ReceivingPreferenceEventArgs.cs b/Exiled.Events/EventArgs/Item/ReceivingPreferenceEventArgs.cs index 72e04e534a..2b07ab0fbd 100644 --- a/Exiled.Events/EventArgs/Item/ReceivingPreferenceEventArgs.cs +++ b/Exiled.Events/EventArgs/Item/ReceivingPreferenceEventArgs.cs @@ -19,7 +19,8 @@ namespace Exiled.Events.EventArgs.Item using Interfaces; /// - /// Contains all information before receiving a preference. + /// Contains all information before receiving firearm attachment preferences from a player. + /// Preferences are used as a default value when player receives a newly created firearm, for example, when spawning. /// public class ReceivingPreferenceEventArgs : IPlayerEvent, IDeniableEvent { @@ -81,7 +82,7 @@ public uint NewCode } /// - /// Gets or sets a value indicating whether or not the attachments preference is allowed. + /// Gets or sets a value indicating whether the attachments preference is allowed. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Item/SwingingEventArgs.cs b/Exiled.Events/EventArgs/Item/SwingingEventArgs.cs index 17c0319b03..6972b2f0ac 100644 --- a/Exiled.Events/EventArgs/Item/SwingingEventArgs.cs +++ b/Exiled.Events/EventArgs/Item/SwingingEventArgs.cs @@ -40,7 +40,7 @@ public SwingingEventArgs(ReferenceHub player, InventorySystem.Items.ItemBase swi public Item Item { get; } /// - /// Gets or sets a value indicating whether or not the item can be swung. + /// Gets or sets a value indicating whether the item can be swung. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Item/UsingRadioPickupBatteryEventArgs.cs b/Exiled.Events/EventArgs/Item/UsingRadioPickupBatteryEventArgs.cs index 5367b43630..0286ce6a1d 100644 --- a/Exiled.Events/EventArgs/Item/UsingRadioPickupBatteryEventArgs.cs +++ b/Exiled.Events/EventArgs/Item/UsingRadioPickupBatteryEventArgs.cs @@ -11,7 +11,7 @@ namespace Exiled.Events.EventArgs.Item using Exiled.Events.EventArgs.Interfaces; /// - /// Contains all information before radio pickup battery drains. + /// Invoked before draining a 's battery. /// public class UsingRadioPickupBatteryEventArgs : IDeniableEvent, IPickupEvent { diff --git a/Exiled.Events/EventArgs/Map/AnnouncingNtfEntranceEventArgs.cs b/Exiled.Events/EventArgs/Map/AnnouncingNtfEntranceEventArgs.cs index 7f701de084..c853fe607b 100644 --- a/Exiled.Events/EventArgs/Map/AnnouncingNtfEntranceEventArgs.cs +++ b/Exiled.Events/EventArgs/Map/AnnouncingNtfEntranceEventArgs.cs @@ -53,7 +53,7 @@ public AnnouncingNtfEntranceEventArgs(int scpsLeft, string unitName, int unitNum public int UnitNumber { get; set; } /// - /// Gets or sets a value indicating whether or not the NTF spawn will be announced by C.A.S.S.I.E. + /// Gets or sets a value indicating whether the NTF spawn will be announced by C.A.S.S.I.E. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Map/AnnouncingScpTerminationEventArgs.cs b/Exiled.Events/EventArgs/Map/AnnouncingScpTerminationEventArgs.cs index 9029d442a5..79b82ee7b8 100644 --- a/Exiled.Events/EventArgs/Map/AnnouncingScpTerminationEventArgs.cs +++ b/Exiled.Events/EventArgs/Map/AnnouncingScpTerminationEventArgs.cs @@ -69,7 +69,7 @@ public AnnouncingScpTerminationEventArgs(Player scp, DamageHandlerBase damageHan public CustomDamageHandler DamageHandler { get; set; } /// - /// Gets or sets a value indicating whether or not the SCP termination will be announced by C.A.S.S.I.E. + /// Gets or sets a value indicating whether the SCP termination will be announced by C.A.S.S.I.E. /// public bool IsAllowed { get; set; } = true; } diff --git a/Exiled.Events/EventArgs/Map/ChangedIntoGrenadeEventArgs.cs b/Exiled.Events/EventArgs/Map/ChangedIntoGrenadeEventArgs.cs index 23ee6876bb..48113b8f01 100644 --- a/Exiled.Events/EventArgs/Map/ChangedIntoGrenadeEventArgs.cs +++ b/Exiled.Events/EventArgs/Map/ChangedIntoGrenadeEventArgs.cs @@ -15,7 +15,7 @@ namespace Exiled.Events.EventArgs.Map using InventorySystem.Items.ThrowableProjectiles; /// - /// Contains all information for when the server is turned a pickup into a live grenade. + /// Contains all information after a was changed into a live grenade by an explosion. /// public class ChangedIntoGrenadeEventArgs : IExiledEvent { @@ -31,12 +31,12 @@ public ChangedIntoGrenadeEventArgs(TimedGrenadePickup pickup, ThrownProjectile p } /// - /// Gets a value indicating the pickup that changed into a grenade. + /// Gets a value indicating the pickup that was changed into a grenade. /// public GrenadePickup Pickup { get; } /// - /// Gets a value indicating the projectile that spawned. + /// Gets a value indicating the projectile that was spawned. /// public Projectile Projectile { get; } } diff --git a/Exiled.Events/EventArgs/Map/ChangingIntoGrenadeEventArgs.cs b/Exiled.Events/EventArgs/Map/ChangingIntoGrenadeEventArgs.cs index 765d38f61b..64b2e77771 100644 --- a/Exiled.Events/EventArgs/Map/ChangingIntoGrenadeEventArgs.cs +++ b/Exiled.Events/EventArgs/Map/ChangingIntoGrenadeEventArgs.cs @@ -14,7 +14,7 @@ namespace Exiled.Events.EventArgs.Map using InventorySystem.Items.ThrowableProjectiles; /// - /// Contains all information for when the server is turning a pickup into a live grenade. + /// Contains all information before a is changed into a live grenade by an explosion. /// public class ChangingIntoGrenadeEventArgs : IDeniableEvent, IPickupEvent { diff --git a/Exiled.Events/EventArgs/Map/DamagingDoorEventArgs.cs b/Exiled.Events/EventArgs/Map/DamagingDoorEventArgs.cs index 7e92bf8eff..d972ee8dec 100644 --- a/Exiled.Events/EventArgs/Map/DamagingDoorEventArgs.cs +++ b/Exiled.Events/EventArgs/Map/DamagingDoorEventArgs.cs @@ -40,7 +40,7 @@ public DamagingDoorEventArgs(DoorVariant doorVariant, float damageAmount, DoorDa } /// - /// Gets or sets a value indicating whether or not the door can take damage. + /// Gets or sets a value indicating whether the door can take damage. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Map/DecontaminatingEventArgs.cs b/Exiled.Events/EventArgs/Map/DecontaminatingEventArgs.cs index 6bce5e7801..42664dc902 100644 --- a/Exiled.Events/EventArgs/Map/DecontaminatingEventArgs.cs +++ b/Exiled.Events/EventArgs/Map/DecontaminatingEventArgs.cs @@ -26,7 +26,7 @@ public DecontaminatingEventArgs(bool isAllowed = true) } /// - /// Gets or sets a value indicating whether or not light containment zone decontamination can begin. + /// Gets or sets a value indicating whether light containment zone decontamination can begin. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Map/ExplodingGrenadeEventArgs.cs b/Exiled.Events/EventArgs/Map/ExplodingGrenadeEventArgs.cs index d05aa3b709..09c55f7c39 100644 --- a/Exiled.Events/EventArgs/Map/ExplodingGrenadeEventArgs.cs +++ b/Exiled.Events/EventArgs/Map/ExplodingGrenadeEventArgs.cs @@ -127,7 +127,7 @@ public ExplodingGrenadeEventArgs(Player thrower, EffectGrenade grenade, List - /// Gets or sets a value indicating whether or not the grenade can be thrown. + /// Gets or sets a value indicating whether the grenade can be thrown. /// public bool IsAllowed { get; set; } = true; diff --git a/Exiled.Events/EventArgs/Map/FillingLockerEventArgs.cs b/Exiled.Events/EventArgs/Map/FillingLockerEventArgs.cs index 00fa6b64df..20e6b31d77 100644 --- a/Exiled.Events/EventArgs/Map/FillingLockerEventArgs.cs +++ b/Exiled.Events/EventArgs/Map/FillingLockerEventArgs.cs @@ -46,7 +46,7 @@ public FillingLockerEventArgs(ItemPickupBase pickupBase, LockerChamber lockerCha public Chamber Chamber { get; } /// - /// Gets or sets a value indicating whether or not the item can be spawned. + /// Gets or sets a value indicating whether the item can be spawned. /// public bool IsAllowed { get; set; } = true; } diff --git a/Exiled.Events/EventArgs/Map/PlacingBloodEventArgs.cs b/Exiled.Events/EventArgs/Map/PlacingBloodEventArgs.cs index 58a06aeaf4..0c3c4685da 100644 --- a/Exiled.Events/EventArgs/Map/PlacingBloodEventArgs.cs +++ b/Exiled.Events/EventArgs/Map/PlacingBloodEventArgs.cs @@ -57,7 +57,7 @@ public PlacingBloodEventArgs(Player player, Player target, RaycastHit hit, bool public Vector3 Position { get; set; } /// - /// Gets or sets a value indicating whether or not the blood can be placed. + /// Gets or sets a value indicating whether the blood can be placed. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Map/PlacingBulletHoleEventArgs.cs b/Exiled.Events/EventArgs/Map/PlacingBulletHoleEventArgs.cs index 8e237af27e..3544247b6d 100644 --- a/Exiled.Events/EventArgs/Map/PlacingBulletHoleEventArgs.cs +++ b/Exiled.Events/EventArgs/Map/PlacingBulletHoleEventArgs.cs @@ -45,7 +45,7 @@ public PlacingBulletHoleEventArgs(Player owner, RaycastHit hit) public Quaternion Rotation { get; set; } /// - /// Gets or sets a value indicating whether or not the decal can be placed. + /// Gets or sets a value indicating whether the decal can be placed. /// public bool IsAllowed { get; set; } = true; diff --git a/Exiled.Events/EventArgs/Map/Scp244SpawningEventArgs.cs b/Exiled.Events/EventArgs/Map/Scp244SpawningEventArgs.cs index b70dc40d96..fb30713a47 100644 --- a/Exiled.Events/EventArgs/Map/Scp244SpawningEventArgs.cs +++ b/Exiled.Events/EventArgs/Map/Scp244SpawningEventArgs.cs @@ -46,7 +46,7 @@ public Scp244SpawningEventArgs(Room room, Pickup scp244Pickup) public Scp244Pickup Scp244Pickup { get; } /// - /// Gets or sets a value indicating whether or not the item can be spawning. + /// Gets or sets a value indicating whether the item can be spawning. /// public bool IsAllowed { get; set; } = true; } diff --git a/Exiled.Events/EventArgs/Map/SpawningItemEventArgs.cs b/Exiled.Events/EventArgs/Map/SpawningItemEventArgs.cs index 7e1ef1cf66..6fa4012270 100644 --- a/Exiled.Events/EventArgs/Map/SpawningItemEventArgs.cs +++ b/Exiled.Events/EventArgs/Map/SpawningItemEventArgs.cs @@ -43,7 +43,7 @@ public SpawningItemEventArgs(ItemPickupBase pickupBase, bool shouldInitiallySpaw public Pickup Pickup { get; } /// - /// Gets or sets a value indicating whether or not the item will be initially spawned. + /// Gets or sets a value indicating whether the item will be initially spawned. /// public bool ShouldInitiallySpawn { get; set; } @@ -57,7 +57,7 @@ public SpawningItemEventArgs(ItemPickupBase pickupBase, bool shouldInitiallySpaw public Door TriggerDoor { get; set; } /// - /// Gets or sets a value indicating whether or not the item can be spawned. + /// Gets or sets a value indicating whether the item can be spawned. /// public bool IsAllowed { get; set; } = true; } diff --git a/Exiled.Events/EventArgs/Map/SpawningTeamVehicleEventArgs.cs b/Exiled.Events/EventArgs/Map/SpawningTeamVehicleEventArgs.cs index 6cc821d7ac..291af911b4 100644 --- a/Exiled.Events/EventArgs/Map/SpawningTeamVehicleEventArgs.cs +++ b/Exiled.Events/EventArgs/Map/SpawningTeamVehicleEventArgs.cs @@ -36,7 +36,7 @@ public SpawningTeamVehicleEventArgs(SpawnableTeamType team, bool isAllowed = tru public SpawnableTeamType Team { get; set; } /// - /// Gets or sets a value indicating whether or not the vehicle can be spawned. + /// Gets or sets a value indicating whether the vehicle can be spawned. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Player/ActivatingGeneratorEventArgs.cs b/Exiled.Events/EventArgs/Player/ActivatingGeneratorEventArgs.cs index b3ca6d9ccb..4bc7daab7a 100644 --- a/Exiled.Events/EventArgs/Player/ActivatingGeneratorEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/ActivatingGeneratorEventArgs.cs @@ -38,7 +38,7 @@ public ActivatingGeneratorEventArgs(Player player, Scp079Generator generator, bo } /// - /// Gets or sets a value indicating whether or not the switch can be flipped. + /// Gets or sets a value indicating whether the switch can be flipped. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/ActivatingWarheadPanelEventArgs.cs b/Exiled.Events/EventArgs/Player/ActivatingWarheadPanelEventArgs.cs index 535dc0ad11..57b3963e47 100644 --- a/Exiled.Events/EventArgs/Player/ActivatingWarheadPanelEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/ActivatingWarheadPanelEventArgs.cs @@ -32,7 +32,7 @@ public ActivatingWarheadPanelEventArgs(Player player, bool isAllowed = true) } /// - /// Gets or sets a value indicating whether or not the warhead can be activated. + /// Gets or sets a value indicating whether the warhead can be activated. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/ActivatingWorkstationEventArgs.cs b/Exiled.Events/EventArgs/Player/ActivatingWorkstationEventArgs.cs index 7ef3ebba93..d154b0a490 100644 --- a/Exiled.Events/EventArgs/Player/ActivatingWorkstationEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/ActivatingWorkstationEventArgs.cs @@ -47,7 +47,7 @@ public ActivatingWorkstationEventArgs(Player player, WorkstationController contr public WorkstationStatus NewStatus { get; set; } = WorkstationStatus.PoweringUp; /// - /// Gets or sets a value indicating whether or not the workstation can be activated. + /// Gets or sets a value indicating whether the workstation can be activated. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/AimingDownSightEventArgs.cs b/Exiled.Events/EventArgs/Player/AimingDownSightEventArgs.cs index 9370ba42b5..ce342a74cd 100644 --- a/Exiled.Events/EventArgs/Player/AimingDownSightEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/AimingDownSightEventArgs.cs @@ -37,12 +37,12 @@ public AimingDownSightEventArgs(Player player, Firearm firearm, bool adsIn) } /// - /// Gets a value indicating whether or not the player is aiming down sight in. + /// Gets a value indicating whether the player is aiming down sight in. /// public bool AdsIn { get; } /// - /// Gets a value indicating whether or not the player is aiming down sight out. + /// Gets a value indicating whether the player is aiming down sight out. /// public bool AdsOut => !AdsIn; diff --git a/Exiled.Events/EventArgs/Player/CancellingItemUseEventArgs.cs b/Exiled.Events/EventArgs/Player/CancellingItemUseEventArgs.cs index ac07393e72..0766794a1b 100644 --- a/Exiled.Events/EventArgs/Player/CancellingItemUseEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/CancellingItemUseEventArgs.cs @@ -44,7 +44,7 @@ public CancellingItemUseEventArgs(Player player, UsableItem item) public Player Player { get; } /// - /// Gets or sets a value indicating whether or not the player can cancelling the use of item. + /// Gets or sets a value indicating whether the player can cancelling the use of item. /// public bool IsAllowed { get; set; } = true; } diff --git a/Exiled.Events/EventArgs/Player/ChangingDangerStateEventArgs.cs b/Exiled.Events/EventArgs/Player/ChangingDangerStateEventArgs.cs index 8b703014e0..15df42a025 100644 --- a/Exiled.Events/EventArgs/Player/ChangingDangerStateEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/ChangingDangerStateEventArgs.cs @@ -23,9 +23,9 @@ public class ChangingDangerStateEventArgs : IPlayerEvent, IDeniableEvent /// The player changing danger. /// The . /// The . - /// Whether or not the danger is being activated. If false it is ending. + /// Whether the danger is being activated. If false it is ending. /// The player that has been encountered if the danger is an encounter or null if it isn't. - /// Whether or not it is allowed to activate/deactivate. + /// Whether it is allowed to activate/deactivate. public ChangingDangerStateEventArgs(Player player, DangerStackBase danger, DangerType type, bool activating, Player encounteredPlayer = null, bool isAllowed = true) { Player = player; @@ -50,12 +50,12 @@ public ChangingDangerStateEventArgs(Player player, DangerStackBase danger, Dange public DangerType Type { get; } /// - /// Gets a value indicating whether or not the danger is being activated. + /// Gets a value indicating whether the danger is being activated. /// public bool IsActivating { get; } /// - /// Gets a value indicating whether or not the danger is ending. + /// Gets a value indicating whether the danger is ending. /// public bool IsEnding => !IsActivating; diff --git a/Exiled.Events/EventArgs/Player/ChangingGroupEventArgs.cs b/Exiled.Events/EventArgs/Player/ChangingGroupEventArgs.cs index 13ecb5c99e..2ca4a4d0c6 100644 --- a/Exiled.Events/EventArgs/Player/ChangingGroupEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/ChangingGroupEventArgs.cs @@ -41,7 +41,7 @@ public ChangingGroupEventArgs(Player player, UserGroup newGroup, bool isAllowed public UserGroup NewGroup { get; set; } /// - /// Gets or sets a value indicating whether or not the player can change groups. + /// Gets or sets a value indicating whether the player can change groups. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/ClosingGeneratorEventArgs.cs b/Exiled.Events/EventArgs/Player/ClosingGeneratorEventArgs.cs index 0adc72e3f8..3f4e75c574 100644 --- a/Exiled.Events/EventArgs/Player/ClosingGeneratorEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/ClosingGeneratorEventArgs.cs @@ -21,7 +21,7 @@ public class ClosingGeneratorEventArgs : IPlayerEvent, IDeniableEvent, IGenerato /// /// The player who's closing the generator. /// The instance. - /// Indicates whether or not the generator can be closed. + /// Indicates whether the generator can be closed. public ClosingGeneratorEventArgs(Player player, Scp079Generator generator, bool isAllowed = true) { Player = player; @@ -30,7 +30,7 @@ public ClosingGeneratorEventArgs(Player player, Scp079Generator generator, bool } /// - /// Gets or sets a value indicating whether or not the generator door can be closed. + /// Gets or sets a value indicating whether the generator door can be closed. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/DamagingShootingTargetEventArgs.cs b/Exiled.Events/EventArgs/Player/DamagingShootingTargetEventArgs.cs index c13dd5ba39..0742d3c5ae 100644 --- a/Exiled.Events/EventArgs/Player/DamagingShootingTargetEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/DamagingShootingTargetEventArgs.cs @@ -87,7 +87,7 @@ public DamagingShootingTargetEventArgs(Player player, float damage, float distan public float Distance { get; set; } /// - /// Gets or sets a value indicating whether or not the target can be damaged. + /// Gets or sets a value indicating whether the target can be damaged. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/DeactivatingWorkstationEventArgs.cs b/Exiled.Events/EventArgs/Player/DeactivatingWorkstationEventArgs.cs index df1fb497a0..8386d7881f 100644 --- a/Exiled.Events/EventArgs/Player/DeactivatingWorkstationEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/DeactivatingWorkstationEventArgs.cs @@ -49,7 +49,7 @@ public DeactivatingWorkstationEventArgs(WorkstationController controller, bool i public WorkstationStatus NewStatus { get; set; } = WorkstationStatus.PoweringDown; /// - /// Gets or sets a value indicating whether or not the workstation can be deactivated. + /// Gets or sets a value indicating whether the workstation can be deactivated. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Player/DroppedItemEventArgs.cs b/Exiled.Events/EventArgs/Player/DroppedItemEventArgs.cs index 14d298c843..d1b3198f7f 100644 --- a/Exiled.Events/EventArgs/Player/DroppedItemEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/DroppedItemEventArgs.cs @@ -36,7 +36,7 @@ public DroppedItemEventArgs(Player player, Pickup pickup, bool wasThrown) } /// - /// Gets or sets a value indicating whether or not the pickup was thrown. + /// Gets or sets a value indicating whether the pickup was thrown. /// public bool WasThrown { get; set; } diff --git a/Exiled.Events/EventArgs/Player/DroppingAmmoEventArgs.cs b/Exiled.Events/EventArgs/Player/DroppingAmmoEventArgs.cs index 3a0d0de97f..de00e34295 100644 --- a/Exiled.Events/EventArgs/Player/DroppingAmmoEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/DroppingAmmoEventArgs.cs @@ -55,7 +55,7 @@ public DroppingAmmoEventArgs(Player player, AmmoType ammoType, ushort amount, bo public ushort Amount { get; set; } /// - /// Gets or sets a value indicating whether or not the ammo can be dropped. + /// Gets or sets a value indicating whether the ammo can be dropped. /// public bool IsAllowed { diff --git a/Exiled.Events/EventArgs/Player/DroppingItemEventArgs.cs b/Exiled.Events/EventArgs/Player/DroppingItemEventArgs.cs index 2173163e7d..efca36612b 100644 --- a/Exiled.Events/EventArgs/Player/DroppingItemEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/DroppingItemEventArgs.cs @@ -47,12 +47,12 @@ public DroppingItemEventArgs(Player player, ItemBase item, bool isThrown, bool i } /// - /// Gets or sets a value indicating whether or not the item was thrown. + /// Gets or sets a value indicating whether the item was thrown. /// public bool IsThrown { get; set; } /// - /// Gets or sets a value indicating whether or not the item can be dropped. + /// Gets or sets a value indicating whether the item can be dropped. /// public bool IsAllowed { diff --git a/Exiled.Events/EventArgs/Player/DryfiringWeaponEventArgs.cs b/Exiled.Events/EventArgs/Player/DryfiringWeaponEventArgs.cs index 85ba867333..ff37311a50 100644 --- a/Exiled.Events/EventArgs/Player/DryfiringWeaponEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/DryfiringWeaponEventArgs.cs @@ -37,7 +37,7 @@ public DryfiringWeaponEventArgs(Player player, Firearm firearm, bool isAllowed = } /// - /// Gets or sets a value indicating whether or not the weapon can be dryfired. + /// Gets or sets a value indicating whether the weapon can be dryfired. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/DyingEventArgs.cs b/Exiled.Events/EventArgs/Player/DyingEventArgs.cs index fae5d10ffe..127506df46 100644 --- a/Exiled.Events/EventArgs/Player/DyingEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/DyingEventArgs.cs @@ -58,7 +58,7 @@ public DyingEventArgs(Player target, DamageHandlerBase damageHandler) public CustomDamageHandler DamageHandler { get; set; } /// - /// Gets or sets a value indicating whether or not the player can be killed. + /// Gets or sets a value indicating whether the player can be killed. /// public bool IsAllowed { get; set; } = true; diff --git a/Exiled.Events/EventArgs/Player/EnteringEnvironmentalHazardEventArgs.cs b/Exiled.Events/EventArgs/Player/EnteringEnvironmentalHazardEventArgs.cs index bc602b1d92..8ffefa3137 100644 --- a/Exiled.Events/EventArgs/Player/EnteringEnvironmentalHazardEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/EnteringEnvironmentalHazardEventArgs.cs @@ -38,7 +38,7 @@ public EnteringEnvironmentalHazardEventArgs(API.Features.Player player, Environm public Hazard Hazard { get; } /// - /// Gets or sets a value indicating whether or not the player should be affected by the environmental hazard. + /// Gets or sets a value indicating whether the player should be affected by the environmental hazard. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Player/EnteringKillerCollisionEventArgs.cs b/Exiled.Events/EventArgs/Player/EnteringKillerCollisionEventArgs.cs index fa109bf073..c0f0c08051 100644 --- a/Exiled.Events/EventArgs/Player/EnteringKillerCollisionEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/EnteringKillerCollisionEventArgs.cs @@ -33,7 +33,7 @@ public EnteringKillerCollisionEventArgs(Player player, bool isAllowed = true) public Player Player { get; } /// - /// Gets or sets a value indicating whether or not the player is killed by killer collision. + /// Gets or sets a value indicating whether the player is killed by killer collision. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Player/EnteringPocketDimensionEventArgs.cs b/Exiled.Events/EventArgs/Player/EnteringPocketDimensionEventArgs.cs index dc9aa207b6..09bb918038 100644 --- a/Exiled.Events/EventArgs/Player/EnteringPocketDimensionEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/EnteringPocketDimensionEventArgs.cs @@ -41,7 +41,7 @@ public EnteringPocketDimensionEventArgs(Player player, Player scp106, bool isAll public Player Scp106 { get; } /// - /// Gets or sets a value indicating whether or not the player can enter the pocket dimension. + /// Gets or sets a value indicating whether the player can enter the pocket dimension. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/EscapingEventArgs.cs b/Exiled.Events/EventArgs/Player/EscapingEventArgs.cs index b7ae474745..9270813d92 100644 --- a/Exiled.Events/EventArgs/Player/EscapingEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/EscapingEventArgs.cs @@ -112,7 +112,7 @@ public EscapingEventArgs(Player player, RoleTypeId newRole, EscapeScenarioType e public KeyValuePair RespawnTickets { get; set; } /// - /// Gets or sets a value indicating whether or not the player can escape. + /// Gets or sets a value indicating whether the player can escape. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Player/EscapingPocketDimensionEventArgs.cs b/Exiled.Events/EventArgs/Player/EscapingPocketDimensionEventArgs.cs index 4848107a6c..57ab31694d 100644 --- a/Exiled.Events/EventArgs/Player/EscapingPocketDimensionEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/EscapingPocketDimensionEventArgs.cs @@ -44,7 +44,7 @@ public EscapingPocketDimensionEventArgs(Player player, Vector3 position) public Vector3 TeleportPosition { get; set; } /// - /// Gets or sets a value indicating whether or not the player can successfully escape the pocket dimension. + /// Gets or sets a value indicating whether the player can successfully escape the pocket dimension. /// public bool IsAllowed { get; set; } = true; } diff --git a/Exiled.Events/EventArgs/Player/ExitingEnvironmentalHazardEventArgs.cs b/Exiled.Events/EventArgs/Player/ExitingEnvironmentalHazardEventArgs.cs index 7aecd1b3e8..daa199a225 100644 --- a/Exiled.Events/EventArgs/Player/ExitingEnvironmentalHazardEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/ExitingEnvironmentalHazardEventArgs.cs @@ -38,7 +38,7 @@ public ExitingEnvironmentalHazardEventArgs(API.Features.Player player, Environme public Hazard Hazard { get; } /// - /// Gets or sets a value indicating whether or not the player should be affected by the environmental hazard. + /// Gets or sets a value indicating whether the player should be affected by the environmental hazard. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Player/FailingEscapePocketDimensionEventArgs.cs b/Exiled.Events/EventArgs/Player/FailingEscapePocketDimensionEventArgs.cs index 602cf6fb6a..1bf968194d 100644 --- a/Exiled.Events/EventArgs/Player/FailingEscapePocketDimensionEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/FailingEscapePocketDimensionEventArgs.cs @@ -41,7 +41,7 @@ public FailingEscapePocketDimensionEventArgs(Player player, PocketDimensionTelep public PocketDimensionTeleport Teleporter { get; } /// - /// Gets or sets a value indicating whether or not the player dies by failing the pocket dimension escape. + /// Gets or sets a value indicating whether the player dies by failing the pocket dimension escape. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/FlippingCoinEventArgs.cs b/Exiled.Events/EventArgs/Player/FlippingCoinEventArgs.cs index 7622d71b5e..0e23da22bb 100644 --- a/Exiled.Events/EventArgs/Player/FlippingCoinEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/FlippingCoinEventArgs.cs @@ -45,12 +45,12 @@ public FlippingCoinEventArgs(Player player, Coin coin, bool isTails) public Item Item { get; } /// - /// Gets or sets a value indicating whether or not the coin is landing on tails. + /// Gets or sets a value indicating whether the coin is landing on tails. /// public bool IsTails { get; set; } /// - /// Gets or sets a value indicating whether or not the coin can be flipped. + /// Gets or sets a value indicating whether the coin can be flipped. /// public bool IsAllowed { get; set; } = true; } diff --git a/Exiled.Events/EventArgs/Player/HandcuffingEventArgs.cs b/Exiled.Events/EventArgs/Player/HandcuffingEventArgs.cs index 27a361cda2..cea57b6d47 100644 --- a/Exiled.Events/EventArgs/Player/HandcuffingEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/HandcuffingEventArgs.cs @@ -41,7 +41,7 @@ public HandcuffingEventArgs(Player cuffer, Player target, bool isAllowed = true) public Player Target { get; } /// - /// Gets or sets a value indicating whether or not the player can be handcuffed. + /// Gets or sets a value indicating whether the player can be handcuffed. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/InteractingDoorEventArgs.cs b/Exiled.Events/EventArgs/Player/InteractingDoorEventArgs.cs index d56c6c682c..f8a423667d 100644 --- a/Exiled.Events/EventArgs/Player/InteractingDoorEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/InteractingDoorEventArgs.cs @@ -37,7 +37,7 @@ public InteractingDoorEventArgs(Player player, DoorVariant door, bool isAllowed } /// - /// Gets or sets a value indicating whether or not the player can interact with the door. + /// Gets or sets a value indicating whether the player can interact with the door. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/InteractingElevatorEventArgs.cs b/Exiled.Events/EventArgs/Player/InteractingElevatorEventArgs.cs index 7df9b7476d..59960a9a7a 100644 --- a/Exiled.Events/EventArgs/Player/InteractingElevatorEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/InteractingElevatorEventArgs.cs @@ -50,7 +50,7 @@ public InteractingElevatorEventArgs(Player player, ElevatorChamber elevator, boo public Lift Lift { get; } /// - /// Gets or sets a value indicating whether or not the player can interact with the elevator. + /// Gets or sets a value indicating whether the player can interact with the elevator. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/InteractingLockerEventArgs.cs b/Exiled.Events/EventArgs/Player/InteractingLockerEventArgs.cs index d6dd2e4015..1d595a9199 100644 --- a/Exiled.Events/EventArgs/Player/InteractingLockerEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/InteractingLockerEventArgs.cs @@ -53,7 +53,7 @@ public InteractingLockerEventArgs(Player player, LockerChamber lockerChamber, by public byte ChamberId { get; } /// - /// Gets or sets a value indicating whether or not the player can interact with the locker. + /// Gets or sets a value indicating whether the player can interact with the locker. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/InteractingShootingTargetEventArgs.cs b/Exiled.Events/EventArgs/Player/InteractingShootingTargetEventArgs.cs index 6f42b451ef..1de0133c38 100644 --- a/Exiled.Events/EventArgs/Player/InteractingShootingTargetEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/InteractingShootingTargetEventArgs.cs @@ -97,7 +97,7 @@ public int NewAutoResetTime } /// - /// Gets or sets a value indicating whether or not the interaction is allowed. + /// Gets or sets a value indicating whether the interaction is allowed. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/IntercomSpeakingEventArgs.cs b/Exiled.Events/EventArgs/Player/IntercomSpeakingEventArgs.cs index 49b605ac05..ac7451f4fa 100644 --- a/Exiled.Events/EventArgs/Player/IntercomSpeakingEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/IntercomSpeakingEventArgs.cs @@ -37,7 +37,7 @@ public IntercomSpeakingEventArgs(Player player, bool isAllowed = true) public Player Player { get; } /// - /// Gets or sets a value indicating whether or not the player can speak on the intercom. + /// Gets or sets a value indicating whether the player can speak on the intercom. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Player/IssuingMuteEventArgs.cs b/Exiled.Events/EventArgs/Player/IssuingMuteEventArgs.cs index 19cf623e14..0abf4a2305 100644 --- a/Exiled.Events/EventArgs/Player/IssuingMuteEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/IssuingMuteEventArgs.cs @@ -46,7 +46,7 @@ public IssuingMuteEventArgs(Player player, bool isIntercom, bool isAllowed = tru public bool IsIntercom { get; set; } /// - /// Gets or sets a value indicating whether or not the player can be muted. + /// Gets or sets a value indicating whether the player can be muted. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Player/KickingEventArgs.cs b/Exiled.Events/EventArgs/Player/KickingEventArgs.cs index 3ce527cd11..20b1da8a65 100644 --- a/Exiled.Events/EventArgs/Player/KickingEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/KickingEventArgs.cs @@ -81,7 +81,7 @@ public Player Target public string FullMessage => startkickmessage + Reason; /// - /// Gets or sets a value indicating whether or not action is taken against the target. + /// Gets or sets a value indicating whether action is taken against the target. /// public bool IsAllowed { diff --git a/Exiled.Events/EventArgs/Player/OpeningGeneratorEventArgs.cs b/Exiled.Events/EventArgs/Player/OpeningGeneratorEventArgs.cs index d208132426..f134173b9c 100644 --- a/Exiled.Events/EventArgs/Player/OpeningGeneratorEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/OpeningGeneratorEventArgs.cs @@ -38,7 +38,7 @@ public OpeningGeneratorEventArgs(Player player, Scp079Generator generator, bool } /// - /// Gets or sets a value indicating whether or not the generator can be opened. + /// Gets or sets a value indicating whether the generator can be opened. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/ReceivingEffectEventArgs.cs b/Exiled.Events/EventArgs/Player/ReceivingEffectEventArgs.cs index 696f4ff0c1..f417914908 100644 --- a/Exiled.Events/EventArgs/Player/ReceivingEffectEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/ReceivingEffectEventArgs.cs @@ -74,7 +74,7 @@ public byte Intensity public byte CurrentIntensity { get; } /// - /// Gets or sets a value indicating whether or not the effect will be applied. + /// Gets or sets a value indicating whether the effect will be applied. /// public bool IsAllowed { get; set; } = true; } diff --git a/Exiled.Events/EventArgs/Player/ReloadingWeaponEventArgs.cs b/Exiled.Events/EventArgs/Player/ReloadingWeaponEventArgs.cs index 3fa8ba3ecb..112dbc4622 100644 --- a/Exiled.Events/EventArgs/Player/ReloadingWeaponEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/ReloadingWeaponEventArgs.cs @@ -37,7 +37,7 @@ public ReloadingWeaponEventArgs(Player player, Firearm firearm, bool isAllowed = } /// - /// Gets or sets a value indicating whether or not the weapon can be reloaded. + /// Gets or sets a value indicating whether the weapon can be reloaded. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/RemovingHandcuffsEventArgs.cs b/Exiled.Events/EventArgs/Player/RemovingHandcuffsEventArgs.cs index c6a90a8355..5f2e095151 100644 --- a/Exiled.Events/EventArgs/Player/RemovingHandcuffsEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/RemovingHandcuffsEventArgs.cs @@ -34,7 +34,7 @@ public RemovingHandcuffsEventArgs(Player cuffer, Player target, bool isAllowed = public Player Target { get; } /// - /// Gets or sets a value indicating whether or not the player can be handcuffed. + /// Gets or sets a value indicating whether the player can be handcuffed. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/RevokingMuteEventArgs.cs b/Exiled.Events/EventArgs/Player/RevokingMuteEventArgs.cs index 52dd71aef8..3e19aa8231 100644 --- a/Exiled.Events/EventArgs/Player/RevokingMuteEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/RevokingMuteEventArgs.cs @@ -24,7 +24,7 @@ public class RevokingMuteEventArgs : IssuingMuteEventArgs /// Indicates whether the player is being intercom unmuted or not. /// /// - /// Indicates whether or not the player can be unmuted. + /// Indicates whether the player can be unmuted. /// public RevokingMuteEventArgs(Player player, bool isIntercom, bool isAllowed = true) : base(player, isIntercom, isAllowed) diff --git a/Exiled.Events/EventArgs/Player/ShootingEventArgs.cs b/Exiled.Events/EventArgs/Player/ShootingEventArgs.cs index 9802b83304..ae6e2a2dd8 100644 --- a/Exiled.Events/EventArgs/Player/ShootingEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/ShootingEventArgs.cs @@ -106,7 +106,7 @@ public uint TargetNetId } /// - /// Gets or sets a value indicating whether or not the shot can be fired. + /// Gets or sets a value indicating whether the shot can be fired. /// public bool IsAllowed { get; set; } = true; } diff --git a/Exiled.Events/EventArgs/Player/ShotEventArgs.cs b/Exiled.Events/EventArgs/Player/ShotEventArgs.cs index 288d3c3f72..021c88e0fa 100644 --- a/Exiled.Events/EventArgs/Player/ShotEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/ShotEventArgs.cs @@ -94,7 +94,7 @@ public ShotEventArgs(Player shooter, Firearm firearm, RaycastHit hit, IDestructi public Player Target { get; } /// - /// Gets or sets a value indicating whether or not the shot can hurt the target. + /// Gets or sets a value indicating whether the shot can hurt the target. /// public bool CanHurt { get; set; } = true; } diff --git a/Exiled.Events/EventArgs/Player/SpawningRagdollEventArgs.cs b/Exiled.Events/EventArgs/Player/SpawningRagdollEventArgs.cs index 596a38d324..22aa650059 100644 --- a/Exiled.Events/EventArgs/Player/SpawningRagdollEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/SpawningRagdollEventArgs.cs @@ -103,7 +103,7 @@ public DamageHandler DamageHandlerBase } /// - /// Gets or sets a value indicating whether or not the ragdoll can be spawned. + /// Gets or sets a value indicating whether the ragdoll can be spawned. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/StoppingGeneratorEventArgs.cs b/Exiled.Events/EventArgs/Player/StoppingGeneratorEventArgs.cs index addeb79ad1..2fcbe2d046 100644 --- a/Exiled.Events/EventArgs/Player/StoppingGeneratorEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/StoppingGeneratorEventArgs.cs @@ -21,7 +21,7 @@ public class StoppingGeneratorEventArgs : IPlayerEvent, IGeneratorEvent, IDeniab /// /// The player who's flipping the switch. /// The instance. - /// Indicates whether or not the switch of the generator can be flipped. + /// Indicates whether the switch of the generator can be flipped. public StoppingGeneratorEventArgs(Player player, Scp079Generator generator, bool isAllowed = true) { Player = player; @@ -30,7 +30,7 @@ public StoppingGeneratorEventArgs(Player player, Scp079Generator generator, bool } /// - /// Gets or sets a value indicating whether or not the switch can be flipped. + /// Gets or sets a value indicating whether the switch can be flipped. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/ThrowingRequestEventArgs.cs b/Exiled.Events/EventArgs/Player/ThrowingRequestEventArgs.cs index 273763fdaa..ba4e09b870 100644 --- a/Exiled.Events/EventArgs/Player/ThrowingRequestEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/ThrowingRequestEventArgs.cs @@ -15,7 +15,7 @@ namespace Exiled.Events.EventArgs.Player using InventorySystem.Items.ThrowableProjectiles; /// - /// Contains all information before receving a throwing request. + /// Contains all information before receiving a throwing request. /// public class ThrowingRequestEventArgs : IPlayerEvent, IItemEvent { diff --git a/Exiled.Events/EventArgs/Player/TogglingFlashlightEventArgs.cs b/Exiled.Events/EventArgs/Player/TogglingFlashlightEventArgs.cs index b8990f85d7..76dca0f977 100644 --- a/Exiled.Events/EventArgs/Player/TogglingFlashlightEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/TogglingFlashlightEventArgs.cs @@ -49,12 +49,12 @@ public TogglingFlashlightEventArgs(ReferenceHub hub, ToggleableLightItemBase fla public Item Item => Flashlight; /// - /// Gets or sets a value indicating whether or not the flashlight should be on. + /// Gets or sets a value indicating whether the flashlight should be on. /// public bool NewState { get; set; } /// - /// Gets or sets a value indicating whether or not the player can toggle the flashlight. + /// Gets or sets a value indicating whether the player can toggle the flashlight. /// public bool IsAllowed { diff --git a/Exiled.Events/EventArgs/Player/TogglingNoClipEventArgs.cs b/Exiled.Events/EventArgs/Player/TogglingNoClipEventArgs.cs index f65222892f..7ede11f2c9 100644 --- a/Exiled.Events/EventArgs/Player/TogglingNoClipEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/TogglingNoClipEventArgs.cs @@ -41,12 +41,12 @@ public TogglingNoClipEventArgs(Player player, bool newValue, bool isAllowed = tr public Player Player { get; } /// - /// Gets a value indicating whether or not the noclip mode will be enabled or not. + /// Gets a value indicating whether the noclip mode will be enabled or not. /// public bool IsEnabled { get; } /// - /// Gets or sets a value indicating whether or not the player can toggle noclip. + /// Gets or sets a value indicating whether the player can toggle noclip. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Player/TogglingWeaponFlashlightEventArgs.cs b/Exiled.Events/EventArgs/Player/TogglingWeaponFlashlightEventArgs.cs index a49e64a653..d7282aec45 100644 --- a/Exiled.Events/EventArgs/Player/TogglingWeaponFlashlightEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/TogglingWeaponFlashlightEventArgs.cs @@ -46,7 +46,7 @@ public TogglingWeaponFlashlightEventArgs(Player player, Firearm firearm, bool ne public bool NewState { get; } /// - /// Gets or sets a value indicating whether or not the weapon's flashlight can be toggled. + /// Gets or sets a value indicating whether the weapon's flashlight can be toggled. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/TransmittingEventArgs.cs b/Exiled.Events/EventArgs/Player/TransmittingEventArgs.cs index abe74104a7..0cd4146a04 100644 --- a/Exiled.Events/EventArgs/Player/TransmittingEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/TransmittingEventArgs.cs @@ -49,7 +49,7 @@ public TransmittingEventArgs(Player player, VoiceModuleBase voiceModule, bool is public VoiceModuleBase VoiceModule { get; } /// - /// Gets or sets a value indicating whether or not the player can transmit. + /// Gets or sets a value indicating whether the player can transmit. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Player/TriggeringTeslaEventArgs.cs b/Exiled.Events/EventArgs/Player/TriggeringTeslaEventArgs.cs index ad71df8d1e..cf6853a513 100644 --- a/Exiled.Events/EventArgs/Player/TriggeringTeslaEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/TriggeringTeslaEventArgs.cs @@ -34,17 +34,17 @@ public TriggeringTeslaEventArgs(Player player, TeslaGate teslaGate) } /// - /// Gets or sets a value indicating whether or not the player is in hurting range. + /// Gets or sets a value indicating whether the player is in hurting range. /// public bool IsInHurtingRange { get; set; } /// - /// Gets or sets a value indicating whether or not the player will cause the tesla going to be idle. + /// Gets or sets a value indicating whether the player will cause the tesla going to be idle. /// public bool IsInIdleRange { get; set; } = true; /// - /// Gets or sets a value indicating whether or not the player will cause the tesla going to be activated. + /// Gets or sets a value indicating whether the player will cause the tesla going to be activated. /// public bool IsTriggerable { get; set; } @@ -59,12 +59,12 @@ public TriggeringTeslaEventArgs(Player player, TeslaGate teslaGate) public TeslaGate Tesla { get; } /// - /// Gets or sets a value indicating whether or not the player will be detected by the tesla. + /// Gets or sets a value indicating whether the player will be detected by the tesla. /// public bool IsAllowed { get; set; } = true; /// - /// Gets or sets a value indicating whether or not the tesla will be deactivated. + /// Gets or sets a value indicating whether the tesla will be deactivated. /// public bool DisableTesla { get; set; } } diff --git a/Exiled.Events/EventArgs/Player/UnloadingWeaponEventArgs.cs b/Exiled.Events/EventArgs/Player/UnloadingWeaponEventArgs.cs index c16b1131f0..99d9c4c077 100644 --- a/Exiled.Events/EventArgs/Player/UnloadingWeaponEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/UnloadingWeaponEventArgs.cs @@ -37,7 +37,7 @@ public UnloadingWeaponEventArgs(Player player, Firearm firearm, bool isAllowed = } /// - /// Gets or sets a value indicating whether or not the weapon can be unloaded. + /// Gets or sets a value indicating whether the weapon can be unloaded. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/UnlockingGeneratorEventArgs.cs b/Exiled.Events/EventArgs/Player/UnlockingGeneratorEventArgs.cs index 5a42e30140..68e888870e 100644 --- a/Exiled.Events/EventArgs/Player/UnlockingGeneratorEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/UnlockingGeneratorEventArgs.cs @@ -38,7 +38,7 @@ public UnlockingGeneratorEventArgs(Player player, Scp079Generator generator, boo } /// - /// Gets or sets a value indicating whether or not the generator can be unlocked. + /// Gets or sets a value indicating whether the generator can be unlocked. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Player/UsingConsumableEventArgs.cs b/Exiled.Events/EventArgs/Player/UsingConsumableEventArgs.cs index 72888eb512..6f5128bff1 100644 --- a/Exiled.Events/EventArgs/Player/UsingConsumableEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/UsingConsumableEventArgs.cs @@ -45,7 +45,7 @@ public UsingConsumableEventArgs(Player player, UsableItem item) public Player Player { get; } /// - /// Gets or sets a value indicating whether or not the player can use the item. + /// Gets or sets a value indicating whether the player can use the item. /// public bool IsAllowed { get; set; } = true; } diff --git a/Exiled.Events/EventArgs/Player/UsingItemEventArgs.cs b/Exiled.Events/EventArgs/Player/UsingItemEventArgs.cs index 708a58f8a9..4b34368451 100644 --- a/Exiled.Events/EventArgs/Player/UsingItemEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/UsingItemEventArgs.cs @@ -54,7 +54,7 @@ public UsingItemEventArgs(Player player, UsableItem item, float cooldown) public float Cooldown { get; set; } /// - /// Gets or sets a value indicating whether or not the player can use the item. + /// Gets or sets a value indicating whether the player can use the item. /// public bool IsAllowed { get; set; } = true; } diff --git a/Exiled.Events/EventArgs/Player/VoiceChattingEventArgs.cs b/Exiled.Events/EventArgs/Player/VoiceChattingEventArgs.cs index 3b0e90bb8c..71468fcf72 100644 --- a/Exiled.Events/EventArgs/Player/VoiceChattingEventArgs.cs +++ b/Exiled.Events/EventArgs/Player/VoiceChattingEventArgs.cs @@ -58,7 +58,7 @@ public VoiceChattingEventArgs(Player player, VoiceMessage voiceMessage, VoiceMod public VoiceModuleBase VoiceModule { get; } /// - /// Gets or sets a value indicating whether or not the player can voicechat. + /// Gets or sets a value indicating whether the player can voicechat. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Scp049/ActivatingSenseEventArgs.cs b/Exiled.Events/EventArgs/Scp049/ActivatingSenseEventArgs.cs index 8e772e7101..20c348ae89 100644 --- a/Exiled.Events/EventArgs/Scp049/ActivatingSenseEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp049/ActivatingSenseEventArgs.cs @@ -59,7 +59,7 @@ public ActivatingSenseEventArgs(Player player, Player target, bool isAllowed = t public float Duration { get; set; } /// - /// Gets or sets a value indicating whether or not the server will send 049 information on the recall. + /// Gets or sets a value indicating whether the server will send 049 information on the recall. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Scp049/AttackingEventArgs.cs b/Exiled.Events/EventArgs/Scp049/AttackingEventArgs.cs index b7ed8dde09..0fa25f569b 100644 --- a/Exiled.Events/EventArgs/Scp049/AttackingEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp049/AttackingEventArgs.cs @@ -44,7 +44,7 @@ public AttackingEventArgs(Player player, Player target, bool isAllowed = true) public Player Target { get; } /// - /// Gets or sets a value indicating whether or not target can be attacked. + /// Gets or sets a value indicating whether target can be attacked. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Scp049/FinishingRecallEventArgs.cs b/Exiled.Events/EventArgs/Scp049/FinishingRecallEventArgs.cs index e2c2c0728c..dab5fa9b3f 100644 --- a/Exiled.Events/EventArgs/Scp049/FinishingRecallEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp049/FinishingRecallEventArgs.cs @@ -60,7 +60,7 @@ public FinishingRecallEventArgs(Player target, Player scp049, BasicRagdoll ragdo public Ragdoll Ragdoll { get; } /// - /// Gets or sets a value indicating whether or not the player can be revived. + /// Gets or sets a value indicating whether the player can be revived. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Scp049/SendingCallEventArgs.cs b/Exiled.Events/EventArgs/Scp049/SendingCallEventArgs.cs index cd882d151d..495b0bcf15 100644 --- a/Exiled.Events/EventArgs/Scp049/SendingCallEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp049/SendingCallEventArgs.cs @@ -43,7 +43,7 @@ public SendingCallEventArgs(Player player, bool isAllowed = true) public float Duration { get; set; } /// - /// Gets or sets a value indicating whether or not the server will send 049 information on the call. + /// Gets or sets a value indicating whether the server will send 049 information on the call. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Scp079/ChangingCameraEventArgs.cs b/Exiled.Events/EventArgs/Scp079/ChangingCameraEventArgs.cs index 88e1542430..b3b686765b 100644 --- a/Exiled.Events/EventArgs/Scp079/ChangingCameraEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp079/ChangingCameraEventArgs.cs @@ -58,8 +58,8 @@ public ChangingCameraEventArgs(Player player, Scp079Camera camera, float auxilia public Camera Camera { get; set; } /// - /// Gets or sets a value indicating whether or not SCP-079 can switch cameras. - /// Defaults to a value describing whether or not SCP-079 has enough auxiliary power to switch. + /// Gets or sets a value indicating whether SCP-079 can switch cameras. + /// Defaults to a value describing whether SCP-079 has enough auxiliary power to switch. ///
Can be set to to allow a switch regardless of SCP-079's auxiliary power amount.
/// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Scp079/ElevatorTeleportingEventArgs.cs b/Exiled.Events/EventArgs/Scp079/ElevatorTeleportingEventArgs.cs index e10c39a2aa..93a6377ba1 100644 --- a/Exiled.Events/EventArgs/Scp079/ElevatorTeleportingEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp079/ElevatorTeleportingEventArgs.cs @@ -75,8 +75,8 @@ public ElevatorTeleportingEventArgs(Player player, RoomIdentifier room, Interact public Door Door => ElevatorDoor; /// - /// Gets or sets a value indicating whether or not SCP-079 can teleport. - /// Defaults to a describing whether or not SCP-079 has enough auxiliary power to teleport. + /// Gets or sets a value indicating whether SCP-079 can teleport. + /// Defaults to a describing whether SCP-079 has enough auxiliary power to teleport. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Scp079/GainingExperienceEventArgs.cs b/Exiled.Events/EventArgs/Scp079/GainingExperienceEventArgs.cs index 3fca9ca711..6d493c592c 100644 --- a/Exiled.Events/EventArgs/Scp079/GainingExperienceEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp079/GainingExperienceEventArgs.cs @@ -62,7 +62,7 @@ public GainingExperienceEventArgs(Player player, Scp079HudTranslation gainType, public int Amount { get; set; } /// - /// Gets or sets a value indicating whether or not the experience is successfully granted. + /// Gets or sets a value indicating whether the experience is successfully granted. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Scp079/GainingLevelEventArgs.cs b/Exiled.Events/EventArgs/Scp079/GainingLevelEventArgs.cs index 8548052b87..b2a4557420 100644 --- a/Exiled.Events/EventArgs/Scp079/GainingLevelEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp079/GainingLevelEventArgs.cs @@ -42,7 +42,7 @@ public GainingLevelEventArgs(Player player, int newLevel, bool isAllowed = true) public int NewLevel { get; set; } /// - /// Gets or sets a value indicating whether or not the level is successfully granted. + /// Gets or sets a value indicating whether the level is successfully granted. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Scp079/InteractingTeslaEventArgs.cs b/Exiled.Events/EventArgs/Scp079/InteractingTeslaEventArgs.cs index a22f2d04ab..6e820e9349 100644 --- a/Exiled.Events/EventArgs/Scp079/InteractingTeslaEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp079/InteractingTeslaEventArgs.cs @@ -58,7 +58,7 @@ public InteractingTeslaEventArgs(Player player, TeslaGate teslaGate, float auxil public float AuxiliaryPowerCost { get; set; } /// - /// Gets or sets a value indicating whether or not SCP-079 can interact with the tesla gate. + /// Gets or sets a value indicating whether SCP-079 can interact with the tesla gate. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Scp079/LockingDownEventArgs.cs b/Exiled.Events/EventArgs/Scp079/LockingDownEventArgs.cs index 151b3fd46e..edb57f8cf7 100644 --- a/Exiled.Events/EventArgs/Scp079/LockingDownEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp079/LockingDownEventArgs.cs @@ -58,7 +58,7 @@ public LockingDownEventArgs(Player player, RoomIdentifier roomIdentifier, float public float AuxiliaryPowerCost { get; set; } /// - /// Gets or sets a value indicating whether or not SCP-079 can lockdown a room. + /// Gets or sets a value indicating whether SCP-079 can lockdown a room. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Scp079/LosingSignalEventArgs.cs b/Exiled.Events/EventArgs/Scp079/LosingSignalEventArgs.cs index 774d916b0f..2e7c6a6fd2 100644 --- a/Exiled.Events/EventArgs/Scp079/LosingSignalEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp079/LosingSignalEventArgs.cs @@ -46,7 +46,7 @@ public LosingSignalEventArgs(ReferenceHub hub, float duration) public float Duration { get; set; } /// - /// Gets or sets a value indicating whether or not SCP-079 is allowed to lose its signal here. + /// Gets or sets a value indicating whether SCP-079 is allowed to lose its signal here. /// public bool IsAllowed { get; set; } = true; } diff --git a/Exiled.Events/EventArgs/Scp079/PingingEventArgs.cs b/Exiled.Events/EventArgs/Scp079/PingingEventArgs.cs index 50b4b39357..07926a7130 100644 --- a/Exiled.Events/EventArgs/Scp079/PingingEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp079/PingingEventArgs.cs @@ -61,7 +61,7 @@ public PingingEventArgs(ReferenceHub hub, RelativePosition position, int powerCo public Vector3 SyncNormal { get; } /// - /// Gets or sets a value indicating whether or not the event is allowed to continue. + /// Gets or sets a value indicating whether the event is allowed to continue. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Scp079/RoomBlackoutEventArgs.cs b/Exiled.Events/EventArgs/Scp079/RoomBlackoutEventArgs.cs index b024207835..2186e42fa3 100644 --- a/Exiled.Events/EventArgs/Scp079/RoomBlackoutEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp079/RoomBlackoutEventArgs.cs @@ -78,7 +78,7 @@ public RoomBlackoutEventArgs(ReferenceHub player, RoomIdentifier roomIdentifier, public double Cooldown { get; set; } /// - /// Gets or sets a value indicating whether or not SCP-079 can black out the room. + /// Gets or sets a value indicating whether SCP-079 can black out the room. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Scp079/StartingSpeakerEventArgs.cs b/Exiled.Events/EventArgs/Scp079/StartingSpeakerEventArgs.cs index b671e4da1c..77b17e9d5c 100644 --- a/Exiled.Events/EventArgs/Scp079/StartingSpeakerEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp079/StartingSpeakerEventArgs.cs @@ -59,7 +59,7 @@ public StartingSpeakerEventArgs(Player player, Room room, float auxiliaryPowerCo public float AuxiliaryPowerCost { get; set; } /// - /// Gets or sets a value indicating whether or not SCP-079 can use the speaker. + /// Gets or sets a value indicating whether SCP-079 can use the speaker. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Scp079/StoppingSpeakerEventArgs.cs b/Exiled.Events/EventArgs/Scp079/StoppingSpeakerEventArgs.cs index 2c69fbc161..fcc8a23a59 100644 --- a/Exiled.Events/EventArgs/Scp079/StoppingSpeakerEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp079/StoppingSpeakerEventArgs.cs @@ -50,7 +50,7 @@ public StoppingSpeakerEventArgs(Player player, Room room, bool isAllowed = true) public Room Room { get; } /// - /// Gets or sets a value indicating whether or not SCP-079 can stop using the speaker. + /// Gets or sets a value indicating whether SCP-079 can stop using the speaker. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Scp079/TriggeringDoorEventArgs.cs b/Exiled.Events/EventArgs/Scp079/TriggeringDoorEventArgs.cs index 83d9d48496..62997d8d05 100644 --- a/Exiled.Events/EventArgs/Scp079/TriggeringDoorEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp079/TriggeringDoorEventArgs.cs @@ -41,7 +41,7 @@ public TriggeringDoorEventArgs(Player player, DoorVariant door, float auxiliaryP } /// - /// Gets or sets a value indicating whether or not the player can interact with the door. + /// Gets or sets a value indicating whether the player can interact with the door. /// public bool IsAllowed { get; set; } = true; diff --git a/Exiled.Events/EventArgs/Scp079/ZoneBlackoutEventArgs.cs b/Exiled.Events/EventArgs/Scp079/ZoneBlackoutEventArgs.cs index 48cfb9b68a..84a6998977 100644 --- a/Exiled.Events/EventArgs/Scp079/ZoneBlackoutEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp079/ZoneBlackoutEventArgs.cs @@ -83,7 +83,7 @@ public ZoneBlackoutEventArgs(ReferenceHub player, FacilityZone zone, float auxil public float Cooldown { get; set; } /// - /// Gets or sets a value indicating whether or not SCP-079 can lockdown a room. + /// Gets or sets a value indicating whether SCP-079 can lockdown a room. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Scp096/AddingTargetEventArgs.cs b/Exiled.Events/EventArgs/Scp096/AddingTargetEventArgs.cs index 7a21f77f03..554422d4e2 100644 --- a/Exiled.Events/EventArgs/Scp096/AddingTargetEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp096/AddingTargetEventArgs.cs @@ -56,12 +56,12 @@ public AddingTargetEventArgs(Player scp096, Player target, bool isLooking, bool public Player Target { get; } /// - /// Gets a value indicating whether or not the target was being target cause of looking it's face. + /// Gets a value indicating whether the target was being target cause of looking it's face. /// public bool IsLooking { get; } /// - /// Gets or sets a value indicating whether or not the target is allowed to be added. + /// Gets or sets a value indicating whether the target is allowed to be added. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Scp096/CalmingDownEventArgs.cs b/Exiled.Events/EventArgs/Scp096/CalmingDownEventArgs.cs index 1a6647c685..133bc57769 100644 --- a/Exiled.Events/EventArgs/Scp096/CalmingDownEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp096/CalmingDownEventArgs.cs @@ -21,7 +21,7 @@ public class CalmingDownEventArgs : IScp096Event, IDeniableEvent /// /// The player who's controlling SCP-096. /// - /// Indicates whether or not SCP-096 can calm down. + /// Indicates whether SCP-096 can calm down. public CalmingDownEventArgs(Player player, bool shouldClearEnragedTimeLeft, bool isAllowed = true) { Player = player; @@ -44,7 +44,7 @@ public CalmingDownEventArgs(Player player, bool shouldClearEnragedTimeLeft, bool public bool ShouldClearEnragedTimeLeft { get; set; } /// - /// Gets or sets a value indicating whether or not SCP-096 can be enraged. + /// Gets or sets a value indicating whether SCP-096 can be enraged. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Scp096/ChargingEventArgs.cs b/Exiled.Events/EventArgs/Scp096/ChargingEventArgs.cs index be040740a1..ac7f2ba43c 100644 --- a/Exiled.Events/EventArgs/Scp096/ChargingEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp096/ChargingEventArgs.cs @@ -41,7 +41,7 @@ public ChargingEventArgs(Player player, bool isAllowed = true) public Player Player { get; } /// - /// Gets or sets a value indicating whether or not SCP-096 can charge. + /// Gets or sets a value indicating whether SCP-096 can charge. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Scp096/EnragingEventArgs.cs b/Exiled.Events/EventArgs/Scp096/EnragingEventArgs.cs index 001a67cecd..d469fd979e 100644 --- a/Exiled.Events/EventArgs/Scp096/EnragingEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp096/EnragingEventArgs.cs @@ -50,7 +50,7 @@ public EnragingEventArgs(Player player, float initialDuration, bool isAllowed = public float InitialDuration { get; set; } /// - /// Gets or sets a value indicating whether or not SCP-096 can be enraged. + /// Gets or sets a value indicating whether SCP-096 can be enraged. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Scp096/StartPryingGateEventArgs.cs b/Exiled.Events/EventArgs/Scp096/StartPryingGateEventArgs.cs index f40e1e8749..84c7b350b7 100644 --- a/Exiled.Events/EventArgs/Scp096/StartPryingGateEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp096/StartPryingGateEventArgs.cs @@ -44,7 +44,7 @@ public StartPryingGateEventArgs(Player player, PryableDoor gate, bool isAllowed public Scp096Role Scp096 { get; } /// - /// Gets or Sets a value indicating whether or not the gate can be pried open by SCP-096. + /// Gets or Sets a value indicating whether the gate can be pried open by SCP-096. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Scp096/TryingNotToCryEventArgs.cs b/Exiled.Events/EventArgs/Scp096/TryingNotToCryEventArgs.cs index 693bbb3776..378ef806e7 100644 --- a/Exiled.Events/EventArgs/Scp096/TryingNotToCryEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp096/TryingNotToCryEventArgs.cs @@ -58,7 +58,7 @@ public TryingNotToCryEventArgs(Player player, bool isAllowed = true) public GameObject GameObject { get; } /// - /// Gets or sets a value indicating whether or not SCP-096 can try not to cry. + /// Gets or sets a value indicating whether SCP-096 can try not to cry. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Scp106/AttackingEventArgs.cs b/Exiled.Events/EventArgs/Scp106/AttackingEventArgs.cs index f3bd011514..40521f8a0e 100644 --- a/Exiled.Events/EventArgs/Scp106/AttackingEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp106/AttackingEventArgs.cs @@ -44,7 +44,7 @@ public AttackingEventArgs(Player player, Player target, bool isAllowed = true) public Player Target { get; } /// - /// Gets or sets a value indicating whether or not target can be attacked. + /// Gets or sets a value indicating whether target can be attacked. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Scp106/ExitStalkingEventArgs.cs b/Exiled.Events/EventArgs/Scp106/ExitStalkingEventArgs.cs index 04e26942de..ead1434b49 100644 --- a/Exiled.Events/EventArgs/Scp106/ExitStalkingEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp106/ExitStalkingEventArgs.cs @@ -38,7 +38,7 @@ public ExitStalkingEventArgs(Player player, bool isAllowed = true) public Scp106Role Scp106 { get; } /// - /// Gets or sets a value indicating whether or not SCP-106 can stalk. + /// Gets or sets a value indicating whether SCP-106 can stalk. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Scp106/StalkingEventArgs.cs b/Exiled.Events/EventArgs/Scp106/StalkingEventArgs.cs index feedcc4484..3b9e5fe456 100644 --- a/Exiled.Events/EventArgs/Scp106/StalkingEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp106/StalkingEventArgs.cs @@ -47,7 +47,7 @@ public StalkingEventArgs(Player player, bool isAllowed = true) public Scp106Role Scp106 { get; } /// - /// Gets or sets a value indicating whether or not SCP-106 can stalk. + /// Gets or sets a value indicating whether SCP-106 can stalk. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Scp106/TeleportingEventArgs.cs b/Exiled.Events/EventArgs/Scp106/TeleportingEventArgs.cs index ffc5a10def..848918d625 100644 --- a/Exiled.Events/EventArgs/Scp106/TeleportingEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp106/TeleportingEventArgs.cs @@ -44,7 +44,7 @@ public TeleportingEventArgs(Player player, Vector3 position, bool isAllowed = tr public Vector3 Position { get; set; } /// - /// Gets or sets a value indicating whether or not SCP-106 can teleport using a portal. + /// Gets or sets a value indicating whether SCP-106 can teleport using a portal. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Scp173/BlinkingEventArgs.cs b/Exiled.Events/EventArgs/Scp173/BlinkingEventArgs.cs index f46635930b..77a278dcde 100644 --- a/Exiled.Events/EventArgs/Scp173/BlinkingEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp173/BlinkingEventArgs.cs @@ -61,7 +61,7 @@ public BlinkingEventArgs(Player player, List targets, Vector3 blinkPos) public IReadOnlyList Targets { get; } /// - /// Gets or sets a value indicating whether or not the player is allowed to blink. + /// Gets or sets a value indicating whether the player is allowed to blink. /// public bool IsAllowed { get; set; } = true; diff --git a/Exiled.Events/EventArgs/Scp173/BlinkingRequestEventArgs.cs b/Exiled.Events/EventArgs/Scp173/BlinkingRequestEventArgs.cs index cf05b21dd5..78b849b3d2 100644 --- a/Exiled.Events/EventArgs/Scp173/BlinkingRequestEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp173/BlinkingRequestEventArgs.cs @@ -42,7 +42,7 @@ public BlinkingRequestEventArgs(Player player, HashSet targets) public IReadOnlyCollection Targets { get; } /// - /// Gets or sets a value indicating whether or not the player is allowed to blink. + /// Gets or sets a value indicating whether the player is allowed to blink. /// public bool IsAllowed { get; set; } = true; diff --git a/Exiled.Events/EventArgs/Scp173/PlacingTantrumEventArgs.cs b/Exiled.Events/EventArgs/Scp173/PlacingTantrumEventArgs.cs index d632310483..2bf89a18d3 100644 --- a/Exiled.Events/EventArgs/Scp173/PlacingTantrumEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp173/PlacingTantrumEventArgs.cs @@ -60,7 +60,7 @@ public PlacingTantrumEventArgs(Player player, TantrumEnvironmentalHazard tantrum public AbilityCooldown Cooldown { get; } /// - /// Gets or sets a value indicating whether or not the tantrum can be placed. + /// Gets or sets a value indicating whether the tantrum can be placed. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Scp173/UsingBreakneckSpeedsEventArgs.cs b/Exiled.Events/EventArgs/Scp173/UsingBreakneckSpeedsEventArgs.cs index d8cad06ec5..47623ab5e5 100644 --- a/Exiled.Events/EventArgs/Scp173/UsingBreakneckSpeedsEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp173/UsingBreakneckSpeedsEventArgs.cs @@ -33,7 +33,7 @@ public UsingBreakneckSpeedsEventArgs(Player player, bool isAllowed = true) } /// - /// Gets or sets a value indicating whether or not the player can use breakneck speeds. + /// Gets or sets a value indicating whether the player can use breakneck speeds. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Scp244/OpeningScp244EventArgs.cs b/Exiled.Events/EventArgs/Scp244/OpeningScp244EventArgs.cs index 45e354b0cf..e2e4632c27 100644 --- a/Exiled.Events/EventArgs/Scp244/OpeningScp244EventArgs.cs +++ b/Exiled.Events/EventArgs/Scp244/OpeningScp244EventArgs.cs @@ -34,7 +34,7 @@ public OpeningScp244EventArgs(Scp244DeployablePickup pickup) public Scp244Pickup Pickup { get; } /// - /// Gets or sets a value indicating whether or not the player can open SCP-244. + /// Gets or sets a value indicating whether the player can open SCP-244. /// public bool IsAllowed { get; set; } = true; } diff --git a/Exiled.Events/EventArgs/Scp3114/DancingEventArgs.cs b/Exiled.Events/EventArgs/Scp3114/DancingEventArgs.cs index 981c597a37..58a8fa616f 100644 --- a/Exiled.Events/EventArgs/Scp3114/DancingEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp3114/DancingEventArgs.cs @@ -37,7 +37,7 @@ public DancingEventArgs(bool newState, Player player, bool isAllowed = true) public bool IsAllowed { get; set; } /// - /// Gets a value indicating whether or not SCP-3114 is dancing. + /// Gets a value indicating whether SCP-3114 is dancing. /// public bool IsDancing { get; } diff --git a/Exiled.Events/EventArgs/Scp330/DroppingScp330EventArgs.cs b/Exiled.Events/EventArgs/Scp330/DroppingScp330EventArgs.cs index a93c975716..9ecc5528de 100644 --- a/Exiled.Events/EventArgs/Scp330/DroppingScp330EventArgs.cs +++ b/Exiled.Events/EventArgs/Scp330/DroppingScp330EventArgs.cs @@ -45,12 +45,12 @@ public DroppingScp330EventArgs(Player player, Scp330Bag scp330, CandyKindID cand public Item Item => Scp330; /// - /// Gets or sets a value indicating whether or not the type of candy drop. + /// Gets or sets a value indicating whether the type of candy drop. /// public CandyKindID Candy { get; set; } /// - /// Gets or sets a value indicating whether or not the player can interact with SCP-330. + /// Gets or sets a value indicating whether the player can interact with SCP-330. /// public bool IsAllowed { get; set; } = true; diff --git a/Exiled.Events/EventArgs/Scp914/ActivatingEventArgs.cs b/Exiled.Events/EventArgs/Scp914/ActivatingEventArgs.cs index 6d229acf71..d8f879d5e3 100644 --- a/Exiled.Events/EventArgs/Scp914/ActivatingEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp914/ActivatingEventArgs.cs @@ -32,7 +32,7 @@ public ActivatingEventArgs(Player player, bool isAllowed = true) } /// - /// Gets or sets a value indicating whether or not SCP-914 can be activated. + /// Gets or sets a value indicating whether SCP-914 can be activated. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Scp914/ChangingKnobSettingEventArgs.cs b/Exiled.Events/EventArgs/Scp914/ChangingKnobSettingEventArgs.cs index ae9a250425..d490ebffdf 100644 --- a/Exiled.Events/EventArgs/Scp914/ChangingKnobSettingEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp914/ChangingKnobSettingEventArgs.cs @@ -49,7 +49,7 @@ public Scp914KnobSetting KnobSetting } /// - /// Gets or sets a value indicating whether or not SCP-914's knob setting can be changed. + /// Gets or sets a value indicating whether SCP-914's knob setting can be changed. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Scp914/UpgradingInventoryItemEventArgs.cs b/Exiled.Events/EventArgs/Scp914/UpgradingInventoryItemEventArgs.cs index 428121a830..a2bbb5a195 100644 --- a/Exiled.Events/EventArgs/Scp914/UpgradingInventoryItemEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp914/UpgradingInventoryItemEventArgs.cs @@ -60,7 +60,7 @@ public UpgradingInventoryItemEventArgs(Player player, ItemBase item, Scp914KnobS public Scp914Processor Processor { get; set; } /// - /// Gets or sets a value indicating whether or not the upgrade is successful. + /// Gets or sets a value indicating whether the upgrade is successful. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Scp914/UpgradingPickupEventArgs.cs b/Exiled.Events/EventArgs/Scp914/UpgradingPickupEventArgs.cs index d1995fc633..73b38365e6 100644 --- a/Exiled.Events/EventArgs/Scp914/UpgradingPickupEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp914/UpgradingPickupEventArgs.cs @@ -65,7 +65,7 @@ public UpgradingPickupEventArgs(ItemPickupBase item, Vector3 newPos, Scp914KnobS public Scp914Processor Processor { get; } /// - /// Gets or sets a value indicating whether or not the upgrade is successful. + /// Gets or sets a value indicating whether the upgrade is successful. /// public bool IsAllowed { get; set; } = true; } diff --git a/Exiled.Events/EventArgs/Scp914/UpgradingPlayerEventArgs.cs b/Exiled.Events/EventArgs/Scp914/UpgradingPlayerEventArgs.cs index 41ef533478..4a4bdc0fb2 100644 --- a/Exiled.Events/EventArgs/Scp914/UpgradingPlayerEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp914/UpgradingPlayerEventArgs.cs @@ -49,12 +49,12 @@ public UpgradingPlayerEventArgs(Player player, bool upgradeItems, bool heldOnly, public Vector3 OutputPosition { get; set; } /// - /// Gets or sets a value indicating whether or not items will be upgraded. + /// Gets or sets a value indicating whether items will be upgraded. /// public bool UpgradeItems { get; set; } /// - /// Gets or sets a value indicating whether or not only held items are upgraded. + /// Gets or sets a value indicating whether only held items are upgraded. /// public bool HeldOnly { get; set; } @@ -64,7 +64,7 @@ public UpgradingPlayerEventArgs(Player player, bool upgradeItems, bool heldOnly, public Scp914KnobSetting KnobSetting { get; set; } /// - /// Gets or sets a value indicating whether or not the event can continue. + /// Gets or sets a value indicating whether the event can continue. /// public bool IsAllowed { get; set; } = true; diff --git a/Exiled.Events/EventArgs/Scp939/ChangingFocusEventArgs.cs b/Exiled.Events/EventArgs/Scp939/ChangingFocusEventArgs.cs index ec3c29433b..e8954c4425 100644 --- a/Exiled.Events/EventArgs/Scp939/ChangingFocusEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp939/ChangingFocusEventArgs.cs @@ -37,12 +37,12 @@ public ChangingFocusEventArgs(ReferenceHub player, bool state, bool isAllowed = } /// - /// Gets or sets a value indicating whether or not SCP-939 can focus. + /// Gets or sets a value indicating whether SCP-939 can focus. /// public bool IsAllowed { get; set; } /// - /// Gets a value indicating whether or not SCP-939 is currently focusing or un-focusing. + /// Gets a value indicating whether SCP-939 is currently focusing or un-focusing. /// public bool State { get; } diff --git a/Exiled.Events/EventArgs/Scp939/PlacingAmnesticCloudEventArgs.cs b/Exiled.Events/EventArgs/Scp939/PlacingAmnesticCloudEventArgs.cs index e8b2c72f59..294ffb0bd9 100644 --- a/Exiled.Events/EventArgs/Scp939/PlacingAmnesticCloudEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp939/PlacingAmnesticCloudEventArgs.cs @@ -23,10 +23,10 @@ public class PlacingAmnesticCloudEventArgs : IScp939Event, IDeniableEvent /// /// /// - /// Whether or not SCP-939 is attempting to place an amnestic cloud. + /// Whether SCP-939 is attempting to place an amnestic cloud. /// /// - /// Whether or not the cooldown is ready. + /// Whether the cooldown is ready. /// /// /// SCP-939's amnestic cloud cooldown. @@ -45,17 +45,17 @@ public PlacingAmnesticCloudEventArgs(Player player, bool state, bool isReady, fl } /// - /// Gets or sets a value indicating whether or not SCP-939 can place an amnestic cloud. + /// Gets or sets a value indicating whether SCP-939 can place an amnestic cloud. /// public bool IsAllowed { get; set; } /// - /// Gets a value indicating whether or not SCP-939 is ready to place its amnestic cloud. + /// Gets a value indicating whether SCP-939 is ready to place its amnestic cloud. /// public bool State { get; } /// - /// Gets or sets a value indicating whether or not SCP-939's amnestic cloud cooldown is ready. + /// Gets or sets a value indicating whether SCP-939's amnestic cloud cooldown is ready. /// public bool IsReady { get; set; } diff --git a/Exiled.Events/EventArgs/Scp939/PlayingSoundEventArgs.cs b/Exiled.Events/EventArgs/Scp939/PlayingSoundEventArgs.cs index 7502be5fbf..74fdf59296 100644 --- a/Exiled.Events/EventArgs/Scp939/PlayingSoundEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp939/PlayingSoundEventArgs.cs @@ -27,7 +27,7 @@ public class PlayingSoundEventArgs : IScp939Event, IDeniableEvent /// The sound that is being played. /// /// - /// Whether or not SCP-939's environmental mimicry cooldown is ready. + /// Whether SCP-939's environmental mimicry cooldown is ready. /// /// /// The cooldown of the environmental mimicry. @@ -46,7 +46,7 @@ public PlayingSoundEventArgs(Player player, EnvMimicrySequence sound, bool isRea } /// - /// Gets or sets a value indicating whether or not SCP-939 can play the sound. + /// Gets or sets a value indicating whether SCP-939 can play the sound. /// /// This will default to if is . In this case, setting it to will override the cooldown. public bool IsAllowed { get; set; } @@ -57,7 +57,7 @@ public PlayingSoundEventArgs(Player player, EnvMimicrySequence sound, bool isRea public EnvMimicrySequence Sound { get; } /// - /// Gets a value indicating whether or not SCP-939's environmental mimicry cooldown is ready. + /// Gets a value indicating whether SCP-939's environmental mimicry cooldown is ready. /// public bool IsReady { get; } diff --git a/Exiled.Events/EventArgs/Scp939/PlayingVoiceEventArgs.cs b/Exiled.Events/EventArgs/Scp939/PlayingVoiceEventArgs.cs index 5b8dfdd374..1883f86a16 100644 --- a/Exiled.Events/EventArgs/Scp939/PlayingVoiceEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp939/PlayingVoiceEventArgs.cs @@ -33,7 +33,7 @@ public PlayingVoiceEventArgs(ReferenceHub player, ReferenceHub stolen) } /// - /// Gets or sets a value indicating whether or not SCP-939 can play the stolen voice. + /// Gets or sets a value indicating whether SCP-939 can play the stolen voice. /// public bool IsAllowed { get; set; } = true; diff --git a/Exiled.Events/EventArgs/Scp939/SavingVoiceEventArgs.cs b/Exiled.Events/EventArgs/Scp939/SavingVoiceEventArgs.cs index 6f6381430e..aa1bf73378 100644 --- a/Exiled.Events/EventArgs/Scp939/SavingVoiceEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp939/SavingVoiceEventArgs.cs @@ -37,7 +37,7 @@ public SavingVoiceEventArgs(ReferenceHub player, ReferenceHub stolen, bool isAll } /// - /// Gets or sets a value indicating whether or not SCP-939 can play the stolen voice. + /// Gets or sets a value indicating whether SCP-939 can play the stolen voice. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Scp939/ValidatingVisibilityEventArgs.cs b/Exiled.Events/EventArgs/Scp939/ValidatingVisibilityEventArgs.cs index 3a2bd2a0ba..f448b325be 100644 --- a/Exiled.Events/EventArgs/Scp939/ValidatingVisibilityEventArgs.cs +++ b/Exiled.Events/EventArgs/Scp939/ValidatingVisibilityEventArgs.cs @@ -26,7 +26,7 @@ public class ValidatingVisibilityEventArgs : IScp939Event, IDeniableEvent /// The target being shown to SCP-939. /// /// - /// Whether or not SCP-939 is allowed to view the player. + /// Whether SCP-939 is allowed to view the player. /// public ValidatingVisibilityEventArgs(ReferenceHub player, ReferenceHub target, bool isAllowed) { diff --git a/Exiled.Events/EventArgs/Server/AddingUnitNameEventArgs.cs b/Exiled.Events/EventArgs/Server/AddingUnitNameEventArgs.cs index 7af2fff057..2b380bf20d 100644 --- a/Exiled.Events/EventArgs/Server/AddingUnitNameEventArgs.cs +++ b/Exiled.Events/EventArgs/Server/AddingUnitNameEventArgs.cs @@ -20,7 +20,7 @@ public class AddingUnitNameEventArgs : IDeniableEvent /// Initializes a new instance of the class. /// /// The generated unit name. - /// The value indicating whether or not the unit name can be added. + /// The value indicating whether the unit name can be added. public AddingUnitNameEventArgs(UnitNamingRule unitNamingRule, bool isAllowed = true) { UnitNamingRule = unitNamingRule; diff --git a/Exiled.Events/EventArgs/Server/PreRespawningTeamEventArgs.cs b/Exiled.Events/EventArgs/Server/PreRespawningTeamEventArgs.cs index c565e98724..1f45d71938 100644 --- a/Exiled.Events/EventArgs/Server/PreRespawningTeamEventArgs.cs +++ b/Exiled.Events/EventArgs/Server/PreRespawningTeamEventArgs.cs @@ -70,7 +70,7 @@ public SpawnableTeamType NextKnownTeam } /// - /// Gets or sets a value indicating whether or not the spawn can occur. + /// Gets or sets a value indicating whether the spawn can occur. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Server/ReportingCheaterEventArgs.cs b/Exiled.Events/EventArgs/Server/ReportingCheaterEventArgs.cs index 715fba3aba..d6452e6a6b 100644 --- a/Exiled.Events/EventArgs/Server/ReportingCheaterEventArgs.cs +++ b/Exiled.Events/EventArgs/Server/ReportingCheaterEventArgs.cs @@ -59,7 +59,7 @@ public ReportingCheaterEventArgs(Player issuer, Player target, int serverPort, s public string Reason { get; set; } /// - /// Gets or sets a value indicating whether or not the report will be sent. + /// Gets or sets a value indicating whether the report will be sent. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Server/RespawningTeamEventArgs.cs b/Exiled.Events/EventArgs/Server/RespawningTeamEventArgs.cs index b1b250c6b9..d98f9842c0 100644 --- a/Exiled.Events/EventArgs/Server/RespawningTeamEventArgs.cs +++ b/Exiled.Events/EventArgs/Server/RespawningTeamEventArgs.cs @@ -59,7 +59,7 @@ public RespawningTeamEventArgs(List players, int maxRespawn, SpawnableTe public Queue SpawnQueue { get; set; } /// - /// Gets or sets a value indicating whether or not the spawn can occur. + /// Gets or sets a value indicating whether the spawn can occur. /// public bool IsAllowed { get; set; } } diff --git a/Exiled.Events/EventArgs/Warhead/ChangingLeverStatusEventArgs.cs b/Exiled.Events/EventArgs/Warhead/ChangingLeverStatusEventArgs.cs index 1caac039f6..4de821046d 100644 --- a/Exiled.Events/EventArgs/Warhead/ChangingLeverStatusEventArgs.cs +++ b/Exiled.Events/EventArgs/Warhead/ChangingLeverStatusEventArgs.cs @@ -41,7 +41,7 @@ public ChangingLeverStatusEventArgs(Player player, bool curState, bool isAllowed public bool CurrentState { get; } /// - /// Gets or sets a value indicating whether or not the lever status will change. + /// Gets or sets a value indicating whether the lever status will change. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/EventArgs/Warhead/StartingEventArgs.cs b/Exiled.Events/EventArgs/Warhead/StartingEventArgs.cs index be6f6f2fdf..24004578e1 100644 --- a/Exiled.Events/EventArgs/Warhead/StartingEventArgs.cs +++ b/Exiled.Events/EventArgs/Warhead/StartingEventArgs.cs @@ -18,7 +18,7 @@ public class StartingEventArgs : StoppingEventArgs /// Initializes a new instance of the class. /// /// The player who's going to start the warhead. - /// Indicating whether or not the nuke was set off automatically. + /// Indicating whether the nuke was set off automatically. /// Indicating whether the event can be executed or not. public StartingEventArgs(Player player, bool isAuto, bool isAllowed = true) : base(player, isAllowed) @@ -27,7 +27,7 @@ public StartingEventArgs(Player player, bool isAuto, bool isAllowed = true) } /// - /// Gets or sets a value indicating whether or not the nuke was set off automatically. + /// Gets or sets a value indicating whether the nuke was set off automatically. /// public bool IsAuto { get; set; } } diff --git a/Exiled.Events/EventArgs/Warhead/StoppingEventArgs.cs b/Exiled.Events/EventArgs/Warhead/StoppingEventArgs.cs index 57d1dd1bba..98423cc010 100644 --- a/Exiled.Events/EventArgs/Warhead/StoppingEventArgs.cs +++ b/Exiled.Events/EventArgs/Warhead/StoppingEventArgs.cs @@ -32,7 +32,7 @@ public StoppingEventArgs(Player player, bool isAllowed = true) } /// - /// Gets or sets a value indicating whether or not the warhead can be stopped. + /// Gets or sets a value indicating whether the warhead can be stopped. /// public bool IsAllowed { get; set; } diff --git a/Exiled.Events/Features/Event{T}.cs b/Exiled.Events/Features/Event{T}.cs index 4e2aea78bb..c6c95c3607 100644 --- a/Exiled.Events/Features/Event{T}.cs +++ b/Exiled.Events/Features/Event{T}.cs @@ -215,7 +215,7 @@ internal void InvokeAsync(T arg) } /// - /// Runs the coroutine manualy so exceptions can be caught and logged. + /// Runs the coroutine manually so exceptions can be caught and logged. /// private IEnumerator SafeCoroutineEnumerator(IEnumerator coroutine, CustomAsyncEventHandler handler) { diff --git a/Exiled.Events/Handlers/Cassie.cs b/Exiled.Events/Handlers/Cassie.cs index 9d2ca857f1..c8ed50c52e 100644 --- a/Exiled.Events/Handlers/Cassie.cs +++ b/Exiled.Events/Handlers/Cassie.cs @@ -18,12 +18,12 @@ public static class Cassie #pragma warning disable SA1623 // Property summary documentation should match accessors /// - /// Invoked before sending a cassie message. + /// Invoked before sending a C.A.S.S.I.E. message. /// public static Event SendingCassieMessage { get; set; } = new(); /// - /// Called before sending a cassie message. + /// Called before sending a C.A.S.S.I.E. message. /// /// The instance. public static void OnSendingCassieMessage(SendingCassieMessageEventArgs ev) => SendingCassieMessage.InvokeSafely(ev); diff --git a/Exiled.Events/Handlers/Item.cs b/Exiled.Events/Handlers/Item.cs index 7458529b00..e853a54e07 100644 --- a/Exiled.Events/Handlers/Item.cs +++ b/Exiled.Events/Handlers/Item.cs @@ -9,8 +9,11 @@ namespace Exiled.Events.Handlers { #pragma warning disable SA1623 // Property summary documentation should match accessors - using Exiled.Events.EventArgs.Item; + using System.Collections.Generic; + using Exiled.API.Features.Pickups; + using Exiled.API.Structs; + using Exiled.Events.EventArgs.Item; using Exiled.Events.Features; /// @@ -19,27 +22,28 @@ namespace Exiled.Events.Handlers public static class Item { /// - /// Invoked before the ammo of an firearm are changed. + /// Invoked before firearm ammo count is changed. /// public static Event ChangingAmmo { get; set; } = new (); /// - /// Invoked before item attachments are changed. + /// Invoked before firearm attachments are changed. /// public static Event ChangingAttachments { get; set; } = new(); /// - /// Invoked after item attachments are changed. + /// Invoked after firearm attachments were changed. /// public static Event ChangedAttachments { get; set; } = new(); /// - /// Invoked before receiving a preference. + /// Invoked before receiving firearm attachment preferences from a player. + /// Preferences are used as a default value when player receives a newly created firearm, for example, when spawning. /// public static Event ReceivingPreference { get; set; } = new(); /// - /// Invoked before a keycard interacts with a door. + /// Invoked before a thrown interacts with a door. /// public static Event KeycardInteracting { get; set; } = new(); @@ -49,46 +53,47 @@ public static class Item public static Event Swinging { get; set; } = new(); /// - /// Invoked before a is charged. + /// Invoked before a charged attack. /// public static Event ChargingJailbird { get; set; } = new(); /// - /// Invoked before a radio pickup is draining battery. + /// Invoked before draining a 's battery. /// public static Event UsingRadioPickupBattery { get; set; } = new(); /// - /// Invoked before jailbird breaks. + /// Invoked before a jailbird breaks. /// public static Event BreakingJailbird { get; set; } = new(); /// - /// Called before the ammo of an firearm is changed. + /// Called before firearm ammo count is changed. /// /// The instance. public static void OnChangingAmmo(ChangingAmmoEventArgs ev) => ChangingAmmo.InvokeSafely(ev); /// - /// Called before item attachments are changed. + /// Called before firearm attachments are changed. /// /// The instance. public static void OnChangingAttachments(ChangingAttachmentsEventArgs ev) => ChangingAttachments.InvokeSafely(ev); /// - /// Called after item attachments are changed. + /// Invoked after firearm attachments were changed. /// /// The instance. public static void OnChangedAttachments(ChangedAttachmentsEventArgs ev) => ChangedAttachments.InvokeSafely(ev); /// - /// Called before receiving a preference. + /// Invoked before receiving firearm attachment preferences from a player. + /// Preferences are used as a default value when player receives a newly created firearm, for example, when spawning. /// /// The instance. public static void OnReceivingPreference(ReceivingPreferenceEventArgs ev) => ReceivingPreference.InvokeSafely(ev); /// - /// Called before keycard interacts with a door. + /// Invoked before a thrown interacts with a door. /// /// The instance. public static void OnKeycardInteracting(KeycardInteractingEventArgs ev) => KeycardInteracting.InvokeSafely(ev); @@ -100,19 +105,19 @@ public static class Item public static void OnSwinging(SwingingEventArgs ev) => Swinging.InvokeSafely(ev); /// - /// Called before a is charged. + /// Invoked before a charged attack. /// /// The instance. public static void OnChargingJailbird(ChargingJailbirdEventArgs ev) => ChargingJailbird.InvokeSafely(ev); /// - /// Called before radio pickup is draining battery. + /// Invoked before draining a 's battery. /// /// The instance. public static void OnUsingRadioPickupBattery(UsingRadioPickupBatteryEventArgs ev) => UsingRadioPickupBattery.InvokeSafely(ev); /// - /// Called before jailbird breaks. + /// Invoked before a jailbird breaks. /// /// The instance. public static void OnBreakingJailbird(BreakingJailbirdEventArgs ev) => BreakingJailbird.InvokeSafely(ev); diff --git a/Exiled.Events/Handlers/Map.cs b/Exiled.Events/Handlers/Map.cs index 3886e33f68..80274424d1 100644 --- a/Exiled.Events/Handlers/Map.cs +++ b/Exiled.Events/Handlers/Map.cs @@ -76,12 +76,12 @@ public static class Map public static Event Generated { get; set; } = new(); /// - /// Invoked before the server changes a pickup into a grenade, when triggered by an explosion. + /// Invoked before a is changed into a live grenade by an explosion. /// public static Event ChangingIntoGrenade { get; set; } = new(); /// - /// Invoked after the server changes a pickup into a grenade, when triggered by an explosion. + /// Invoked after a was changed into a live grenade by an explosion. /// public static Event ChangedIntoGrenade { get; set; } = new(); @@ -206,13 +206,13 @@ public static class Map public static void OnGenerated() => Generated.InvokeSafely(); /// - /// Called before the server changes a into a live Grenade when hit by an explosion. + /// Called before a is changed into a live grenade by an explosion. /// /// The instance. public static void OnChangingIntoGrenade(ChangingIntoGrenadeEventArgs ev) => ChangingIntoGrenade.InvokeSafely(ev); /// - /// Called after the server changes a into a live Grenade when hit by an explosion. + /// Called after a was changed into a live grenade by an explosion. /// /// The instance. public static void OnChangedIntoGrenade(ChangedIntoGrenadeEventArgs ev) => ChangedIntoGrenade.InvokeSafely(ev); diff --git a/Exiled.Loader/TranslationManager.cs b/Exiled.Loader/TranslationManager.cs index f225cad05b..aa1673f39a 100644 --- a/Exiled.Loader/TranslationManager.cs +++ b/Exiled.Loader/TranslationManager.cs @@ -74,7 +74,7 @@ public static SortedDictionary Load(string rawTranslations /// Loads the translations of a plugin based on the actual distribution. /// /// The plugin which its translation has to be loaded. - /// The raw translations to check whether or not the plugin already has a translation config. + /// The raw translations to check whether the plugin already has a translation config. /// The of the desired plugin. public static ITranslation LoadTranslation(this IPlugin plugin, Dictionary rawTranslations = null) => LoaderPlugin.Config.ConfigType switch { @@ -210,7 +210,7 @@ public static bool Clear() /// Loads the translations of a plugin based on the default distribution. /// /// The plugin which its translation has to be loaded. - /// The raw translations to check whether or not the plugin already has a translation config. + /// The raw translations to check whether the plugin already has a translation config. /// The of the desired plugin. private static ITranslation LoadDefaultTranslation(this IPlugin plugin, Dictionary rawTranslations) {