Table of Contents

Class SingleUseKeycard

Namespace
Exiled.API.Features.Items.Keycards
Assembly
Exiled.API.dll

A base class for SingleUse keycard items.

public class SingleUseKeycard : Keycard, IWrapper<ItemBase>, IWrapper<KeycardItem>
Inheritance
SingleUseKeycard
Implements
IWrapper<ItemBase>
IWrapper<KeycardItem>
Inherited Members
Extension Methods

Properties

AllowClosingDoors

Gets or sets a value indicating whether the Keycard allow the closing of Doors.

public bool AllowClosingDoors { get; set; }

Property Value

bool

Base

Gets the InventorySystem.Items.Keycards.KeycardItem this encapsulates.

public SingleUseKeycardItem Base { get; }

Property Value

SingleUseKeycardItem

IsDestroyed

Gets or sets a value indicating whether the Keycard is destroyed.

public bool IsDestroyed { get; set; }

Property Value

bool

Permissions

Gets or sets the KeycardPermissions of the keycard.

public override KeycardPermissions Permissions { get; set; }

Property Value

KeycardPermissions

TimeToDestroy

Gets or sets the time delay to destroy the Keycard after being used.

public float TimeToDestroy { get; set; }

Property Value

float

Uses

Gets or sets the amount of uses remaining on the keycard.

public int Uses { get; set; }

Property Value

int

Remarks

Multiple uses can look strange for clients (they'll run the discard animation, but can reselect the keycard)

Setting this to 0 or lower will destroy the keycard.

Methods

ToString()

Returns the Keycard in a human readable format.

public override string ToString()

Returns

string

A string containing Keycard-related data.

Edit this page