Class BodyArmorPickup

A wrapper class for a Body Armor pickup.

Inheritance
System.Object
TypeCastObject<Pickup>
Pickup
BodyArmorPickup
Implements
IWrapper<InventorySystem.Items.Pickups.ItemPickupBase>
IWrapper<InventorySystem.Items.Armor.BodyArmorPickup>
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.Pickups
Assembly: Exiled.API.dll
Syntax
public class BodyArmorPickup : Pickup, IWrapper<ItemPickupBase>, IWorldSpace, IPosition, IRotation, IWrapper<BodyArmorPickup>

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.BodyArmorPickup that this class is encapsulating.

Declaration
public BodyArmorPickup Base { get; }
Property Value
Type Description
InventorySystem.Items.Armor.BodyArmorPickup
| 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

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 how much the users movement speed should be affected when wearing this armor. (higher values = slower movement).

Declaration
public float MovementSpeedMultiplier { get; }
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

Methods

| Improve this Doc View Source

InitializeProperties(ItemBase)

Declaration
protected override void InitializeProperties(ItemBase itemBase)
Parameters
Type Name Description
InventorySystem.Items.ItemBase itemBase
Overrides
| Improve this Doc View Source

ToString()

Returns the BodyArmorPickup in a human readable format.

Declaration
public override string ToString()
Returns
Type Description
System.String

A string containing BodyArmorPickup related data.
Overrides

Implements

Extension Methods