Class BodyArmorPickup

Namespace

Exiled.API.Features.Pickups

Assembly

Exiled.API.dll

A wrapper class for a Body Armor pickup.

public class BodyArmorPickup : Pickup, IWrapper<ItemPickupBase>, IWorldSpace, IPosition, IRotation, IWrapper<BodyArmorPickup>

Inheritance

object

TypeCastObject<Pickup>

Pickup

BodyArmorPickup

Implements

IWrapper<ItemPickupBase>

IWorldSpace

IPosition

IRotation

IWrapper<BodyArmorPickup>

Inherited Members

Pickup.List

Pickup.GameObject

Pickup.Transform

Pickup.Rigidbody

Pickup.Room

Pickup.PhysicsModule

Pickup.Serial

Pickup.Scale

Pickup.Weight

Pickup.PickupTime

Pickup.Type

Pickup.Category

Pickup.IsLocked

Pickup.Info

Pickup.PreviousOwner

Pickup.InUse

Pickup.Position

Pickup.RelativePosition

Pickup.Rotation

Pickup.IsSpawned

Pickup.Get(ItemPickupBase)

Pickup.Get<T>(ItemPickupBase)

Pickup.Get(ushort)

Pickup.Get(GameObject)

Pickup.Get(IEnumerable<ItemPickupBase>)

Pickup.Get(ItemType)

Pickup.Get(IEnumerable<GameObject>)

Pickup.Get<T>(IEnumerable<ItemPickupBase>)

Pickup.Get<T>(ItemType)

Pickup.Get<T>(IEnumerable<GameObject>)

Pickup.Create(ItemType)

Pickup.Create<T>(ItemType)

Pickup.CreateAndSpawn(ItemType, Vector3, Quaternion?, Player)

Pickup.CreateAndSpawn<T>(ItemType, Vector3, Quaternion?, Player)

Pickup.PickupTimeForPlayer(Player)

Pickup.Spawn()

Pickup.Spawn(Vector3, Quaternion?, Player)

Pickup.UnSpawn()

Pickup.Destroy()

Pickup.Clone()

TypeCastObject<Pickup>.Cast<TObject>()

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

TypeCastObject<Pickup>.As<TObject>()

TypeCastObject<Pickup>.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)

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

public BodyArmorPickup Base { get; }

Property Value

BodyArmorPickup

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>

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.

[Obsolete("Propetry is internal, and controls armor remove logic for clearing inventory")]
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

Methods

InitializeProperties(ItemBase)

initialize item properties.

protected override void InitializeProperties(ItemBase itemBase)

Parameters

itemBase ItemBase

target item.

ToString()

Returns the BodyArmorPickup in a human readable format.

public override string ToString()

Returns

string

A string containing BodyArmorPickup related data.