Class CustomKeycard

Namespace

Exiled.CustomItems.API.Features

Assembly

Exiled.CustomItems.dll

The Custom keycard base class.

public abstract class CustomKeycard : CustomItem

Inheritance

object

CustomItem

CustomKeycard

Inherited Members

CustomItem.Registered

CustomItem.Id

CustomItem.Name

CustomItem.Description

CustomItem.Weight

CustomItem.SpawnProperties

CustomItem.Scale

CustomItem.TrackedSerials

CustomItem.ShouldMessageOnGban

CustomItem.Get(uint)

CustomItem.Get(string)

CustomItem.Get(Type)

CustomItem.TryGet(uint, out CustomItem)

CustomItem.TryGet(string, out CustomItem)

CustomItem.TryGet(Type, out IEnumerable<CustomItem>)

CustomItem.TryGet(Player, out CustomItem)

CustomItem.TryGet(Player, out IEnumerable<CustomItem>)

CustomItem.TryGet(Item, out CustomItem)

CustomItem.TryGet(Pickup, out CustomItem)

CustomItem.TrySpawn(uint, Vector3, out Pickup)

CustomItem.TrySpawn(string, Vector3, out Pickup)

CustomItem.TryGive(Player, string, bool)

CustomItem.TryGive(Player, uint, bool)

CustomItem.RegisterItems(bool, object)

CustomItem.RegisterItems(IEnumerable<Type>, bool, bool, object)

CustomItem.UnregisterItems()

CustomItem.UnregisterItems(IEnumerable<Type>, bool)

CustomItem.UnregisterItems(IEnumerable<CustomItem>, bool)

CustomItem.Spawn(float, float, float)

CustomItem.Spawn(float, float, float, Item)

CustomItem.Spawn(Player, Player)

CustomItem.Spawn(Player, Item, Player)

CustomItem.Spawn(Vector3, Player)

CustomItem.Spawn(IEnumerable<SpawnPoint>, uint)

CustomItem.SpawnAll()

CustomItem.Give(Player, Pickup, bool)

CustomItem.Give(Player, bool)

CustomItem.Init()

CustomItem.Destroy()

CustomItem.Check(Pickup)

CustomItem.Check(Item)

CustomItem.Check(Player)

CustomItem.ToString()

CustomItem.OnOwnerChangingRole(OwnerChangingRoleEventArgs)

CustomItem.OnOwnerDying(OwnerDyingEventArgs)

CustomItem.OnOwnerEscaping(OwnerEscapingEventArgs)

CustomItem.OnOwnerHandcuffing(OwnerHandcuffingEventArgs)

CustomItem.OnDroppingItem(DroppingItemEventArgs)

CustomItem.OnDropping(DroppingItemEventArgs)

CustomItem.OnDroppingAmmo(DroppingAmmoEventArgs)

CustomItem.OnPickingUp(PickingUpItemEventArgs)

CustomItem.OnChanging(ChangingItemEventArgs)

CustomItem.OnUpgrading(UpgradingEventArgs)

CustomItem.OnUpgrading(UpgradingItemEventArgs)

CustomItem.OnAcquired(Player, Item, bool)

CustomItem.OnWaitingForPlayers()

CustomItem.ShowPickedUpMessage(Player)

CustomItem.ShowSelectedMessage(Player)

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

Extensions.Register(CustomItem)

Extensions.Unregister(CustomItem)

ReflectionExtensions.CopyProperties(object, object)

Properties

Permissions

Gets or sets the permissions for custom keycard.

public virtual KeycardPermissions Permissions { get; set; }

Property Value

KeycardPermissions

Type

Gets or sets the ItemType to use for this item.

public override ItemType Type { get; set; }

Property Value

ItemType

Exceptions

ArgumentOutOfRangeException

Throws if specified ItemType is not Keycard.

Methods

Give(Player, Item, bool)

Gives an Item as a CustomItem to a Player.

public override void Give(Player player, Item item, bool displayMessage = true)

Parameters

player Player

The Player who will receive the item.

item Item

The Item to be given.

displayMessage bool

Indicates whether ShowPickedUpMessage(Player) will be called when the player receives the item.

OnInteractingDoor(Player, Door)

Called when custom keycard interacts with a door.

protected virtual void OnInteractingDoor(Player player, Door door)

Parameters

player Player

Owner of Custom keycard.

door Door

Door with which interacting.

OnInteractingLocker(Player, Chamber)

Called when custom keycard interacts with a locker.

protected virtual void OnInteractingLocker(Player player, Chamber chamber)

Parameters

player Player

Owner of Custom keycard.

chamber Chamber

Chamber with which interacting.

Spawn(Vector3, Item, Player?)

Spawns the CustomItem in a specific position.

public override Pickup? Spawn(Vector3 position, Item item, Player? previousOwner = null)

Parameters

position Vector3

The UnityEngine.Vector3 where the CustomItem will be spawned.

item Item

The Item to be spawned as a CustomItem.

previousOwner Player

The PreviousOwner of the item. Can be null.

Returns

Pickup

The Pickup of the spawned CustomItem.

SubscribeEvents()

Called after the manager is initialized, to allow loading of special event handlers.

protected override void SubscribeEvents()

UnsubscribeEvents()

Called when the manager is being destroyed, to allow unloading of special event handlers.

protected override void UnsubscribeEvents()