Table of Contents

Class CustomKeycardPickup

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

A base class for all keycard pickups.

public abstract class CustomKeycardPickup : KeycardPickup, IWrapper<ItemPickupBase>, IWorldSpace, IPosition, IRotation, IWrapper<KeycardPickup>
Inheritance
CustomKeycardPickup
Implements
IWrapper<ItemPickupBase>
IWrapper<KeycardPickup>
Derived
Inherited Members
Extension Methods

Properties

Color

Gets or sets the color of this keycard.

public Color Color { get; set; }

Property Value

Color

ItemName

Gets or sets the name of this keycard within the inventory.

public string ItemName { get; set; }

Property Value

string

KeycardLevels

Gets or sets the permissions this keycard has.

public KeycardLevels KeycardLevels { get; set; }

Property Value

KeycardLevels

Permissions

Gets or sets the permissions this keycard has.

public override KeycardPermissions Permissions { get; set; }

Property Value

KeycardPermissions

PermissionsColor

Gets or sets the color of this keycard's permissions.

public Color PermissionsColor { get; set; }

Property Value

Color

Methods

FindMatch(bool, bool, bool)

Finds a ItemType for a keycard by checking if keycard properties match.

public ItemType FindMatch(bool matchDesign, bool matchPerms, bool matchColors)

Parameters

matchDesign bool

Whether to use design to check keycards.

matchPerms bool

Whether to use permissions to check keycards.

matchColors bool

Whether to use colors to check keycards.

Returns

ItemType

If 1 match is found, returns the matched value. Otherwise, returns ItemType.ItemType.None.

Remarks

Unoptimized for now, but shouldn't be too bad.

InitializeProperties(ItemBase)

initialize item properties.

protected override void InitializeProperties(ItemBase itemBase)

Parameters

itemBase ItemBase

target item.

Resync()

Resyncs all properties of the keycard. Gets called by all setters by default.

public void Resync()

ToString()

Returns the Keycard in a human readable format.

public override string ToString()

Returns

string

A string containing Keycard-related data.