Class EquipAttemptBase

Inheritance
System.Object
EquipAttemptBase
BeingEquippedAttemptEvent
IsEquippingAttemptEvent
Namespace: Content.Shared.Inventory.Events
Assembly: Content.Shared.dll
Syntax
public abstract class EquipAttemptBase : CancellableEntityEventArgs

Constructors

| Improve this Doc View Source

EquipAttemptBase(EntityUid, EntityUid, EntityUid, SlotDefinition)

Declaration
public EquipAttemptBase(EntityUid equipee, EntityUid equipTarget, EntityUid equipment, SlotDefinition slotDefinition)
Parameters
Type Name Description
EntityUid equipee
EntityUid equipTarget
EntityUid equipment
SlotDefinition slotDefinition

Fields

| Improve this Doc View Source

Equipee

The entity performing the action. NOT necessarily the one actually "receiving" the equipment.

Declaration
public readonly EntityUid Equipee
Field Value
Type Description
EntityUid
| Improve this Doc View Source

Equipment

The entity to be equipped.

Declaration
public readonly EntityUid Equipment
Field Value
Type Description
EntityUid
| Improve this Doc View Source

EquipTarget

The entity being equipped to.

Declaration
public readonly EntityUid EquipTarget
Field Value
Type Description
EntityUid
| Improve this Doc View Source

Reason

If cancelling and wanting to provide a custom reason, use this field. Not that this expects a loc-id.

Declaration
public string? Reason
Field Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Slot

The slot the entity is being equipped to.

Declaration
public readonly string Slot
Field Value
Type Description
System.String
| Improve this Doc View Source

SlotFlags

The slotFlags of the slot to equip the entity into.

Declaration
public readonly SlotFlags SlotFlags
Field Value
Type Description
SlotFlags