Class CustomArmor

Namespace

Exiled.CustomItems.API.Features

Assembly

Exiled.CustomItems.dll

The Custom Armor base class.

public abstract class CustomArmor : CustomItem

Inheritance

object

CustomItem

CustomArmor

Inherited Members

CustomItem.Registered

CustomItem.Id

CustomItem.Name

CustomItem.Description

CustomItem.Weight

CustomItem.SpawnProperties

CustomItem.Scale

CustomItem.TrackedSerials

CustomItem.ShouldMessageOnGban

CustomItem.Get(uint)

CustomItem.Get(string)

CustomItem.Get(Type)

CustomItem.TryGet(uint, out CustomItem)

CustomItem.TryGet(string, out CustomItem)

CustomItem.TryGet(Type, out IEnumerable<CustomItem>)

CustomItem.TryGet(Player, out CustomItem)

CustomItem.TryGet(Player, out IEnumerable<CustomItem>)

CustomItem.TryGet(Item, out CustomItem)

CustomItem.TryGet(Pickup, out CustomItem)

CustomItem.TrySpawn(uint, Vector3, out Pickup)

CustomItem.TrySpawn(string, Vector3, out Pickup)

CustomItem.TryGive(Player, string, bool)

CustomItem.TryGive(Player, uint, bool)

CustomItem.RegisterItems(bool, object)

CustomItem.RegisterItems(IEnumerable<Type>, bool, bool, object)

CustomItem.UnregisterItems()

CustomItem.UnregisterItems(IEnumerable<Type>, bool)

CustomItem.UnregisterItems(IEnumerable<CustomItem>, bool)

CustomItem.Spawn(float, float, float)

CustomItem.Spawn(float, float, float, Item)

CustomItem.Spawn(Player, Player)

CustomItem.Spawn(Player, Item, Player)

CustomItem.Spawn(Vector3, Player)

CustomItem.Spawn(Vector3, Item, Player)

CustomItem.Spawn(IEnumerable<SpawnPoint>, uint)

CustomItem.SpawnAll()

CustomItem.Give(Player, Item, bool)

CustomItem.Give(Player, Pickup, bool)

CustomItem.Init()

CustomItem.Destroy()

CustomItem.Check(Pickup)

CustomItem.Check(Item)

CustomItem.Check(Player)

CustomItem.ToString()

CustomItem.OnOwnerChangingRole(OwnerChangingRoleEventArgs)

CustomItem.OnOwnerDying(OwnerDyingEventArgs)

CustomItem.OnOwnerEscaping(OwnerEscapingEventArgs)

CustomItem.OnOwnerHandcuffing(OwnerHandcuffingEventArgs)

CustomItem.OnDroppingItem(DroppingItemEventArgs)

CustomItem.OnDropping(DroppingItemEventArgs)

CustomItem.OnDroppingAmmo(DroppingAmmoEventArgs)

CustomItem.OnPickingUp(PickingUpItemEventArgs)

CustomItem.OnChanging(ChangingItemEventArgs)

CustomItem.OnUpgrading(UpgradingEventArgs)

CustomItem.OnUpgrading(UpgradingItemEventArgs)

CustomItem.OnAcquired(Player, Item, bool)

CustomItem.OnWaitingForPlayers()

CustomItem.ShowPickedUpMessage(Player)

CustomItem.ShowSelectedMessage(Player)

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

Extensions.Register(CustomItem)

Extensions.Unregister(CustomItem)

ReflectionExtensions.CopyProperties(object, object)

Properties

HelmetEfficacy

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

public virtual int HelmetEfficacy { get; set; }

Property Value

int

StaminaUseMultiplier

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

public virtual float StaminaUseMultiplier { get; set; }

Property Value

float

Type

Gets or sets the ItemType to use for this armor.

public override ItemType Type { get; set; }

Property Value

ItemType

VestEfficacy

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

public virtual int VestEfficacy { get; set; }

Property Value

int

Methods

Give(Player, bool)

Gives the CustomItem to a player.

public override void Give(Player player, bool displayMessage = true)

Parameters

player Player

The Player who will receive the item.

displayMessage bool

Indicates whether ShowPickedUpMessage(Player) will be called when the player receives the item.

SubscribeEvents()

Called after the manager is initialized, to allow loading of special event handlers.

protected override void SubscribeEvents()

UnsubscribeEvents()

Called when the manager is being destroyed, to allow unloading of special event handlers.

protected override void UnsubscribeEvents()