Class UnequipAttemptEventBase

Inheritance

System.Object

UnequipAttemptEventBase

BeingUnequippedAttemptEvent

IsUnequippingAttemptEvent

Namespace: Content.Shared.Inventory.Events

Assembly: Content.Shared.dll

Syntax

public abstract class UnequipAttemptEventBase : CancellableEntityEventArgs

Constructors

UnequipAttemptEventBase(EntityUid, EntityUid, EntityUid, SlotDefinition)

Declaration

public UnequipAttemptEventBase(EntityUid unequipee, EntityUid unEquipTarget, EntityUid equipment, SlotDefinition slotDefinition)

Parameters

Type	Name	Description
EntityUid	unequipee
EntityUid	unEquipTarget
EntityUid	equipment
SlotDefinition	slotDefinition

Fields

Equipment

The entity to be unequipped.

Declaration

public readonly EntityUid Equipment

Field Value

Type	Description
EntityUid

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>

Slot

The slot the entity is being unequipped from.

Declaration

public readonly string Slot

Field Value

Type	Description
System.String

Unequipee

The entity performing the action. NOT necessarily the same as the entity whose equipment is being removed..

Declaration

public readonly EntityUid Unequipee

Field Value

Type	Description
EntityUid

UnEquipTarget

The entity being unequipped from.

Declaration

public readonly EntityUid UnEquipTarget

Field Value

Type	Description
EntityUid