Class Armor

A wrapper class for InventorySystem.Items.Armor.BodyArmor.

Inheritance
System.Object
TypeCastObject<Item>
Item
Armor
Implements
IWrapper<InventorySystem.Items.ItemBase>
IWrapper<InventorySystem.Items.Armor.BodyArmor>
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Exiled.API.Features.Items
Assembly: Exiled.API.dll
Syntax
public class Armor : Item, IWrapper<ItemBase>, IWrapper<BodyArmor>

Constructors

| Improve this Doc View Source

Armor(BodyArmor)

Initializes a new instance of the Armor class.

Declaration
public Armor(BodyArmor itemBase)
Parameters
Type Name Description
InventorySystem.Items.Armor.BodyArmor itemBase

The base InventorySystem.Items.Armor.BodyArmor class.

Properties

| Improve this Doc View Source

AmmoLimits

Gets or sets the ammo limit of the wearer when using this armor.

Declaration
public IEnumerable<ArmorAmmoLimit> AmmoLimits { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<ArmorAmmoLimit>
| Improve this Doc View Source

Base

Gets the InventorySystem.Items.Armor.BodyArmor that this class is encapsulating.

Declaration
public BodyArmor Base { get; }
Property Value
Type Description
InventorySystem.Items.Armor.BodyArmor
| Improve this Doc View Source

CategoryLimits

Gets or sets the item caterory limit of the wearer when using this armor.

Declaration
public IEnumerable<BodyArmor.ArmorCategoryLimitModifier> CategoryLimits { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<InventorySystem.Items.Armor.BodyArmor.ArmorCategoryLimitModifier>
| Improve this Doc View Source

CivilianDownsideMultiplier

Gets how much worse PlayerRoles.RoleTypeId.ClassD and PlayerRoles.RoleTypeId.Scientists are affected by wearing this armor.

Declaration
public float CivilianDownsideMultiplier { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

Equippable

Gets a value indicating whether this item is equippable.

Declaration
public bool Equippable { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

HelmetEfficacy

Gets or sets how strong the helmet on the armor is.

Declaration
public int HelmetEfficacy { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Holsterable

Gets a value indicating whether this item is holsterable.

Declaration
public bool Holsterable { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsWorn

Gets a value indicating whether or not this is a worn item.

Declaration
public bool IsWorn { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

MovementSpeedMultiplier

Gets or sets how much the users movement speed should be affected when wearing this armor. (higher values = slower movement).

Declaration
public float MovementSpeedMultiplier { get;

    [Obsolete("This Setter was causing desync to client", true)]

    set;

}
Property Value
Type Description
System.Single
| Improve this Doc View Source

RemoveExcessOnDrop

Gets or sets a value indicating whether or not excess ammo should be removed when the armor is dropped.

Declaration
public bool RemoveExcessOnDrop { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

StaminaUseMultiplier

Gets or sets how much faster stamina will drain when wearing this armor.

Declaration
public float StaminaUseMultiplier { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

VestEfficacy

Gets or sets how strong the vest on the armor is.

Declaration
public int VestEfficacy { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Weight

Gets or sets the Weight of the armor.

Declaration
public float Weight { get; set; }
Property Value
Type Description
System.Single

Methods

| Improve this Doc View Source

Clone()

Clones current Armor object.

Declaration
public override Item Clone()
Returns
Type Description
Item

New Armor object.

Overrides

Implements

Extension Methods