Class RemovingHandcuffsEventArgs

Namespace

Exiled.Events.EventArgs.Player

Assembly

Exiled.Events.dll

Contains all information before freeing a handcuffed player.

public class RemovingHandcuffsEventArgs : IPlayerEvent, IDeniableEvent, IExiledEvent

Inheritance

object

RemovingHandcuffsEventArgs

Implements

IPlayerEvent

IDeniableEvent

IExiledEvent

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

ReflectionExtensions.CopyProperties(object, object)

Constructors

RemovingHandcuffsEventArgs(Player, Player, UncuffReason, bool)

Initializes a new instance of the RemovingHandcuffsEventArgs class.

public RemovingHandcuffsEventArgs(Player cuffer, Player target, UncuffReason uncuffReason, bool isAllowed = true)

Parameters

cuffer Player

The cuffer player.

target Player

The target player to be uncuffed.

uncuffReason UncuffReason

The reason of removing handcuffs.

isAllowed bool

Indicates whether the event can be executed.

Properties

IsAllowed

Gets or sets a value indicating whether the player can be handcuffed. Denying the event will only have an effect when UncuffReason is Player until next major update.

public bool IsAllowed { get; set; }

Property Value

bool

Player

Gets the cuffer player.

public Player Player { get; }

Property Value

Player

Target

Gets the target player to be cuffed.

public Player Target { get; }

Property Value

Player

UncuffReason

Gets the reason of removing handcuffs.

public UncuffReason UncuffReason { get; }

Property Value

UncuffReason