Class Door

A wrapper class for Interactables.Interobjects.DoorUtils.DoorVariant.

Inheritance

System.Object

TypeCastObject<Door>

Door

BasicDoor

CheckpointDoor

Implements

IWrapper<Interactables.Interobjects.DoorUtils.DoorVariant>

IWorldSpace

IPosition

IRotation

Inherited Members

TypeCastObject<Door>.Cast<TObject>()

TypeCastObject<Door>.Cast<TObject>(TObject)

TypeCastObject<Door>.As<TObject>()

TypeCastObject<Door>.Is<TObject>(TObject)

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Exiled.API.Features.Doors

Assembly: Exiled.API.dll

Syntax

public class Door : TypeCastObject<Door>, IWrapper<DoorVariant>, IWorldSpace, IPosition, IRotation

Properties

| Improve this Doc View Source

AllowsScp106

Gets or sets a value indicating whether or not SCP-106 can walk through the door.

Declaration

public bool AllowsScp106 { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

Base

Gets the base-game Interactables.Interobjects.DoorUtils.DoorVariant corresponding with this door.

Declaration

public DoorVariant Base { get; }

Property Value

Type	Description
Interactables.Interobjects.DoorUtils.DoorVariant

| Improve this Doc View Source

DoorLockType

Gets or sets the door lock type.

Declaration

public DoorLockType DoorLockType { get; set; }

Property Value

Type	Description
DoorLockType

| Improve this Doc View Source

ExactState

Gets a value indicating the precise state of the door, from 0-1. A value of 0 indicates the door is fully closed, while a value of 1 indicates the door is fully open. Values in-between represent the door's animation progress.

Declaration

public float ExactState { get; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

GameObject

Gets the door's UnityEngine.GameObject.

Declaration

public GameObject GameObject { get; }

Property Value

Type	Description
UnityEngine.GameObject

| Improve this Doc View Source

InstanceId

Gets the door's Instance ID.

Declaration

public int InstanceId { get; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

IsCheckpoint

Gets a value indicating whether or not this door is a checkpoint door.

Declaration

public bool IsCheckpoint { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsConsideredOpen

Gets a value indicating whether the door is considered open by the game.

Declaration

public bool IsConsideredOpen { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsDamageable

Gets a value indicating whether or not this door can be damaged.

Declaration

public bool IsDamageable { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsElevator

Gets a value indicating whether or not this door is an elevator door.

Declaration

public bool IsElevator { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsFullyClosed

Gets a value indicating whether or not the door is fully closed.

Declaration

public virtual bool IsFullyClosed { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsFullyOpen

Gets a value indicating whether the door is fully open.

Declaration

public virtual bool IsFullyOpen { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsGate

Gets a value indicating whether or not this door is a gate.

Declaration

public bool IsGate { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsKeycardDoor

Gets a value indicating whether or not this door requires a keycard to open.

Declaration

public bool IsKeycardDoor { get; }

Property Value

Type	Description
System.Boolean

Remarks

This value is false if KeycardPermissions is equal to None.

| Improve this Doc View Source

IsLocked

Gets a value indicating whether or not the door is locked.

Declaration

public bool IsLocked { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsMoving

Gets a value indicating whether or not the door is currently moving.

Declaration

public virtual bool IsMoving { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsNonInteractable

Gets a value indicating whether or not this door is non-interactable.

Declaration

public bool IsNonInteractable { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsOpen

Gets or sets a value indicating whether the door is open.

Declaration

public bool IsOpen { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsPartOfCheckpoint

Gets a value indicating whether or not this door is subdoor belonging to a checkpoint.

Declaration

public bool IsPartOfCheckpoint { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

KeycardPermissions

Gets or sets the keycard permissions required to open the door.

Declaration

public KeycardPermissions KeycardPermissions { get; set; }

Property Value

Type	Description
KeycardPermissions

Remarks

Setting this value to None will allow this door to be opened without a keycard.

| Improve this Doc View Source

List

Gets a System.Collections.Generic.IEnumerable<T> of Door which contains all the Door instances.

Declaration

public static IReadOnlyCollection<Door> List { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyCollection<Door>

| Improve this Doc View Source

Name

Gets the name of this door.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Nametag

Gets a nametag of a door.

Declaration

public DoorNametagExtension Nametag { get; }

Property Value

Type	Description
Interactables.Interobjects.DoorUtils.DoorNametagExtension

| Improve this Doc View Source

Position

Gets or sets the door's position.

Declaration

public Vector3 Position { get; set; }

Property Value

Type	Description
UnityEngine.Vector3

| Improve this Doc View Source

RequiredPermissions

Gets or sets the required permissions to open the door.

Declaration

public DoorPermissions RequiredPermissions { get; set; }

Property Value

Type	Description
Interactables.Interobjects.DoorUtils.DoorPermissions

| Improve this Doc View Source

Room

Gets the Room that the door is located in.

Declaration

public Room Room { get; }

Property Value

Type	Description
Room

| Improve this Doc View Source

Rooms

Gets the Room's that the door is located in.

Declaration

public IReadOnlyCollection<Room> Rooms { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyCollection<Room>

| Improve this Doc View Source

Rotation

Gets or sets the door's rotation.

Declaration

public Quaternion Rotation { get; set; }

Property Value

Type	Description
UnityEngine.Quaternion

| Improve this Doc View Source

Scale

Gets or sets the size scale of the door.

Declaration

public Vector3 Scale { get; set; }

Property Value

Type	Description
UnityEngine.Vector3

| Improve this Doc View Source

Transform

Gets the door's UnityEngine.Transform.

Declaration

public Transform Transform { get; }

Property Value

Type	Description
UnityEngine.Transform

| Improve this Doc View Source

Type

Gets the door's DoorType.

Declaration

public DoorType Type { get; }

Property Value

Type	Description
DoorType

| Improve this Doc View Source

Zone

Gets the door's ZoneType.

Declaration

public ZoneType Zone { get; }

Property Value

Type	Description
ZoneType

Methods

| Improve this Doc View Source

ChangeLock(DoorLockType)

Change the door lock with the given lock type.

Declaration

public void ChangeLock(DoorLockType lockType)

Parameters

Type	Name	Description
DoorLockType	lockType	The DoorLockType to use.

| Improve this Doc View Source

Get(DoorType)

Gets a Door given the specified DoorType.

Declaration

public static Door Get(DoorType doorType)

Parameters

Type	Name	Description
DoorType	doorType	The DoorType to search for.

Returns

Type	Description
Door	The Door with the given DoorType or null if not found.

| Improve this Doc View Source

Get(DoorVariant)

Gets the door object associated with a specific Interactables.Interobjects.DoorUtils.DoorVariant, or creates a new one if there isn't one.

Declaration

public static Door Get(DoorVariant doorVariant)

Parameters

Type	Name	Description
Interactables.Interobjects.DoorUtils.DoorVariant	doorVariant	The base-game Interactables.Interobjects.DoorUtils.DoorVariant.

Returns

Type	Description
Door	A Door wrapper object.

| Improve this Doc View Source

Get(Func<Door, Boolean>)

Gets a System.Collections.Generic.IEnumerable<T> of Door filtered based on a predicate.

Declaration

public static IEnumerable<Door> Get(Func<Door, bool> predicate)

Parameters

Type	Name	Description
System.Func<Door, System.Boolean>	predicate	The condition to satify.

Returns

Type	Description
System.Collections.Generic.IEnumerable<Door>	A System.Collections.Generic.IEnumerable<T> of Door which contains elements that satify the condition.

| Improve this Doc View Source

Get(String)

Gets a Door given the specified name.

Declaration

public static Door Get(string name)

Parameters

Type	Name	Description
System.String	name	The name to search for.

Returns

Type	Description
Door	The Door with the given name or null if not found.

| Improve this Doc View Source

Get(GameObject)

Gets the door object associated with a specific UnityEngine.GameObject, or creates a new one if there isn't one.

Declaration

public static Door Get(GameObject gameObject)

Parameters

Type	Name	Description
UnityEngine.GameObject	gameObject	The base-game UnityEngine.GameObject.

Returns

Type	Description
Door	The Door with the given name or null if not found.

| Improve this Doc View Source

GetClosest(Vector3, out Single)

Returns the closest Door to the given position.

Declaration

public static Door GetClosest(Vector3 position, out float distance)

Parameters

Type	Name	Description
UnityEngine.Vector3	position	The UnityEngine.Vector3 to find the closest door to.
System.Single	distance	The distance between the door and the point.

Returns

Type	Description
Door	The door closest to the provided position.

| Improve this Doc View Source

IsAllowToInteract(Player)

Checks if specified Player can interact with the door.

Declaration

public bool IsAllowToInteract(Player player = null)

Parameters

Type	Name	Description
Player	player	Player to check.

Returns

Type	Description
System.Boolean	true if the specified player can interact with the door. Otherwise, false.

| Improve this Doc View Source

Lock(Single, DoorLockType)

Locks all active locks on the door, and then reverts back any changes after a specified length of time.

Declaration

public void Lock(float time, DoorLockType lockType)

Parameters

Type	Name	Description
System.Single	time	The amount of time that must pass before unlocking the door.
DoorLockType	lockType	The DoorLockType of the lockdown.

| Improve this Doc View Source

LockAll(Single, DoorLockType)

Locks all doors in the facility.

Declaration

public static void LockAll(float duration, DoorLockType lockType = DoorLockType.Regular079)

Parameters

Type	Name	Description
System.Single	duration	The duration of the lockdown.
DoorLockType	lockType	The specified DoorLockType.

| Improve this Doc View Source

LockAll(Single, ZoneType, DoorLockType)

Locks all doors given the specified ZoneType.

Declaration

public static void LockAll(float duration, ZoneType zoneType = ZoneType.Unspecified, DoorLockType lockType = DoorLockType.Regular079)

Parameters

Type	Name	Description
System.Single	duration	The duration of the lockdown.
ZoneType	zoneType	The ZoneType to affect.
DoorLockType	lockType	The specified DoorLockType.

| Improve this Doc View Source

LockAll(Single, IEnumerable<ZoneType>, DoorLockType)

Locks all doors given the specified ZoneType.

Declaration

public static void LockAll(float duration, IEnumerable<ZoneType> zoneTypes, DoorLockType lockType = DoorLockType.Regular079)

Parameters

Type	Name	Description
System.Single	duration	The duration of the lockdown.
System.Collections.Generic.IEnumerable<ZoneType>	zoneTypes	The ZoneTypes to affect.
DoorLockType	lockType	The specified DoorLockType.

| Improve this Doc View Source

PlaySound(DoorBeepType)

Makes the door play a beep sound.

Declaration

public void PlaySound(DoorBeepType beep)

Parameters

Type	Name	Description
DoorBeepType	beep	The beep sound to play.

| Improve this Doc View Source

Random(ZoneType, Boolean)

Gets a random Door.

Declaration

public static Door Random(ZoneType type = ZoneType.Unspecified, bool onlyUnbroken = false)

Parameters

Type	Name	Description
ZoneType	type	Filters by ZoneType.
System.Boolean	onlyUnbroken	A value indicating whether it filters broken doors.

Returns

Type	Description
Door	Door object.

| Improve this Doc View Source

ToString()

Returns the Door in a human-readable format.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A string containing Door-related data.

Overrides

System.Object.ToString()

| Improve this Doc View Source

Unlock()

Unlocks and clears all active locks on the door.

Declaration

public void Unlock()

| Improve this Doc View Source

Unlock(Single, DoorLockType)

Unlocks and clears all active locks on the door after a specified length of time.

Declaration

public void Unlock(float time, DoorLockType flagsToUnlock)

Parameters

Type	Name	Description
System.Single	time	The amount of time that must pass before unlocking the door.
DoorLockType	flagsToUnlock	The DoorLockType of the lockdown.

| Improve this Doc View Source

UnlockAll()

Unlocks all doors in the facility.

Declaration

public static void UnlockAll()

| Improve this Doc View Source

UnlockAll(ZoneType)

Unlocks all doors in the facility.

Declaration

public static void UnlockAll(ZoneType zoneType)

Parameters

Type	Name	Description
ZoneType	zoneType	The ZoneType to affect.

| Improve this Doc View Source

UnlockAll(IEnumerable<ZoneType>)

Unlocks all doors in the facility.

Declaration

public static void UnlockAll(IEnumerable<ZoneType> zoneTypes)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<ZoneType>	zoneTypes	The ZoneTypes to affect.

| Improve this Doc View Source

UnlockAll(Func<Door, Boolean>)

Unlocks all doors in the facility.

Declaration

public static void UnlockAll(Func<Door, bool> predicate)

Parameters

Type	Name	Description
System.Func<Door, System.Boolean>	predicate	The condition to satify.

Implements

IWrapper<T>

IWorldSpace

IPosition

IRotation

Extension Methods

ReflectionExtensions.CopyProperties(Object, Object)