EntityEquipment

Class handling entity equipment slots, equipping / unequipping behaviour and armour damage negation.

Properties

EquipmentSlot[] EquipmentSlots

• Read-Only

• All equipment slots that this entity has.

• By default, the entity has head, torso, legs and feet slots.

Events

Action<float> ArmourValueChanged

• Called when an equipment change modifies the armour value of the entity.

• Event argument is the new armour value.

Methods

static int CalculateArmourDamage(float damage)

• Calculates the damage value that should be applied to a piece of armour.

• damage The incoming damage value.

void DamageArmour(int amount)

• Decreases the durability of all equipped armour by the given amount.

• amount The amount of damage.

void Equip(Item item)

• Equips the given item provided it is a piece of equipment and a matching equipment slot is available.

• item The item to equip.

void Unequip(Item item, bool addItemToInventory)

• Unequips the specified item, if it is equipped.

• Destroys the equipped item's GameObject.

• item The item to unequip.

• addItemToInventory Whether or not to add the removed item back to the inventory.

void UnequipAll(bool addItemToInventory)

• Unequips all equipped items in all equipment slots.

• addItemToInventory Whether or not to add the removed item back to the inventory.

bool CanEquip(EquipmentType equipmentType)

• Checks if an equipment slot is available for the given equipment type.

• equipmentType The equipment type to look for an empty slot for.

bool IsEquipped(Item item)

• Checks if the given item is equipped on this entity.

• item The potentially equipped item to check.

int CalculateNegatedDamage(float damage)

• Returns the damage value after being negated by the armour value of this entity.

• damage The incoming damage value.