Class Armor

Namespace

Exiled.API.Features.Items

Assembly

Exiled.API.dll

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

public class Armor : Item, IWrapper<ItemBase>, IWrapper<BodyArmor>

Inheritance

object

TypeCastObject<Item>

Item

Armor

Implements

IWrapper<ItemBase>

IWrapper<BodyArmor>

Inherited Members

Item.List

Item.Serial

Item.IsInInventory

Item.Scale

Item.Type

Item.Category

Item.TierFlags

Item.IsAmmo

Item.IsArmor

Item.IsKeycard

Item.IsConsumable

Item.IsThrowable

Item.IsUsable

Item.IsWeapon

Item.IsFirearm

Item.IsLightEmitter

Item.IsDisarmer

Item.Owner

Item.AddReason

Item.Get(ItemBase)

Item.Get<T>(ItemBase)

Item.Get(ushort)

Item.Get<T>(ushort)

Item.Create(ItemType, Player)

Item.Create<T>(ItemType, Player)

Item.Give(Player)

Item.Destroy()

Item.CreatePickup(Vector3, Quaternion?, bool)

Item.ToString()

Item.ChangeItemOwner(Player, Player)

TypeCastObject<Item>.Cast<TObject>()

TypeCastObject<Item>.Cast<TObject>(out TObject)

TypeCastObject<Item>.As<TObject>()

TypeCastObject<Item>.Is<TObject>(out TObject)

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

ReflectionExtensions.CopyProperties(object, object)

Constructors

Armor(BodyArmor)

Initializes a new instance of the Armor class.

public Armor(BodyArmor itemBase)

Parameters

itemBase BodyArmor

The base InventorySystem.Items.Armor.BodyArmor class.

Properties

AmmoLimits

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

public IEnumerable<ArmorAmmoLimit> AmmoLimits { get; set; }

Property Value

IEnumerable<ArmorAmmoLimit>

Base

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

public BodyArmor Base { get; }

Property Value

BodyArmor

CategoryLimits

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

public IEnumerable<BodyArmor.ArmorCategoryLimitModifier> CategoryLimits { get; set; }

Property Value

IEnumerable<BodyArmor.ArmorCategoryLimitModifier>

CivilianDownsideMultiplier

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

public float CivilianDownsideMultiplier { get; }

Property Value

float

Equippable

Gets a value indicating whether this item is equippable.

public bool Equippable { get; }

Property Value

bool

HelmetEfficacy

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

public int HelmetEfficacy { get; set; }

Property Value

int

Holsterable

Gets a value indicating whether this item is holsterable.

public bool Holsterable { get; }

Property Value

bool

IsWorn

Gets a value indicating whether this is a worn item.

public bool IsWorn { get; }

Property Value

bool

MovementSpeedMultiplier

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

public float MovementSpeedMultiplier { get; }

Property Value

float

RemoveExcessOnDrop

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

public bool RemoveExcessOnDrop { get; set; }

Property Value

bool

StaminaRegenMultiplier

Gets or sets the stamina regen multiplier.

public float StaminaRegenMultiplier { get; set; }

Property Value

float

StaminaUseMultiplier

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

public float StaminaUseMultiplier { get; set; }

Property Value

float

VestEfficacy

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

public int VestEfficacy { get; set; }

Property Value

int

Weight

Gets or sets the Weight of the armor.

public float Weight { get; set; }

Property Value

float

Methods

Clone()

Clones current Armor object.

public override Item Clone()

Returns

Item

New Armor object.