Class SingleUseKeycardPickup

Namespace

Exiled.API.Features.Pickups.Keycards

Assembly

Exiled.API.dll

A base class for all keycard pickups.

public class SingleUseKeycardPickup : KeycardPickup, IWrapper<ItemPickupBase>, IWorldSpace, IPosition, IRotation, IWrapper<KeycardPickup>

Inheritance

object

TypeCastObject<Pickup>

Pickup

KeycardPickup

SingleUseKeycardPickup

Implements

IWrapper<ItemPickupBase>

IWorldSpace

IPosition

IRotation

IWrapper<KeycardPickup>

Inherited Members

KeycardPickup.Base

Pickup.List

Pickup.GameObject

Pickup.Transform

Pickup.Rigidbody

Pickup.Room

Pickup.PhysicsModule

Pickup.Serial

Pickup.Scale

Pickup.Weight

Pickup.PickupTime

Pickup.Type

Pickup.Category

Pickup.IsLocked

Pickup.Info

Pickup.PreviousOwner

Pickup.InUse

Pickup.Position

Pickup.RelativePosition

Pickup.Rotation

Pickup.IsSpawned

Pickup.Get(ItemPickupBase)

Pickup.Get<T>(ItemPickupBase)

Pickup.Get(ushort)

Pickup.Get(GameObject)

Pickup.Get(IEnumerable<ItemPickupBase>)

Pickup.Get(ItemType)

Pickup.Get(IEnumerable<GameObject>)

Pickup.Get<T>(IEnumerable<ItemPickupBase>)

Pickup.Get<T>(ItemType)

Pickup.Get<T>(IEnumerable<GameObject>)

Pickup.Create(ItemType)

Pickup.Create<T>(ItemType)

Pickup.CreateAndSpawn(ItemType, Vector3, Quaternion?, Player)

Pickup.CreateAndSpawn<T>(ItemType, Vector3, Quaternion?, Player)

Pickup.PickupTimeForPlayer(Player)

Pickup.Spawn()

Pickup.Spawn(Vector3, Quaternion?, Player)

Pickup.UnSpawn()

Pickup.Destroy()

Pickup.Clone()

TypeCastObject<Pickup>.Cast<TObject>()

TypeCastObject<Pickup>.Cast<TObject>(out TObject)

TypeCastObject<Pickup>.As<TObject>()

TypeCastObject<Pickup>.Is<TObject>(out TObject)

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

ReflectionExtensions.CopyProperties(object, object)

Properties

AllowClosingDoors

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

public bool AllowClosingDoors { 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

InitializeProperties(ItemBase)

initialize item properties.

protected override void InitializeProperties(ItemBase itemBase)

Parameters

itemBase ItemBase

target item.

ToString()

Returns the Keycard in a human readable format.

public override string ToString()

Returns

string

A string containing Keycard-related data.