Class Gate

Namespace

Exiled.API.Features.Doors

Assembly

Exiled.API.dll

Represents a "pryable" door or gate.

public class Gate : BasicDoor, IWrapper<DoorVariant>, IWorldSpace, IPosition, IRotation

Inheritance

object

TypeCastObject<Door>

Door

BasicDoor

Gate

Implements

IWrapper<DoorVariant>

IWorldSpace

IPosition

IRotation

Inherited Members

BasicDoor.Scp106Colliders

BasicDoor.Cooldown

BasicDoor.RemainingCooldown

Door.List

Door.GameObject

Door.Transform

Door.Type

Door.Room

Door.Rooms

Door.ExactState

Door.IsConsideredOpen

Door.IsOpen

Door.IsGate

Door.IsCheckpoint

Door.IsElevator

Door.IsDamageable

Door.IsNonInteractable

Door.IsPartOfCheckpoint

Door.ParentCheckpointDoor

Door.IsKeycardDoor

Door.KeycardPermissions

Door.Position

Door.AllowsScp106

Door.IsLocked

Door.DoorLockType

Door.InstanceId

Door.Nametag

Door.Name

Door.RequiredPermissions

Door.Rotation

Door.Scale

Door.Zone

Door.Get(DoorVariant)

Door.Get<T>(DoorVariant)

Door.Get(DoorType)

Door.Get<T>(DoorType)

Door.Get(string)

Door.Get<T>(string)

Door.Get(GameObject)

Door.GetClosest(Vector3, out float)

Door.Random(ZoneType, bool)

Door.Get(Func<Door, bool>)

Door.LockAll(float, ZoneType, DoorLockType)

Door.LockAll(float, IEnumerable<ZoneType>, DoorLockType)

Door.LockAll(float, DoorLockType)

Door.UnlockAll()

Door.UnlockAll(ZoneType)

Door.UnlockAll(IEnumerable<ZoneType>)

Door.UnlockAll(Func<Door, bool>)

Door.PlaySound(DoorBeepType)

Door.ChangeLock(DoorLockType)

Door.Lock(float, DoorLockType)

Door.Lock(DoorLockType)

Door.Unlock()

Door.Unlock(float, DoorLockType)

Door.IsAllowToInteract(Player)

TypeCastObject<Door>.Cast<TObject>()

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

TypeCastObject<Door>.As<TObject>()

TypeCastObject<Door>.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)

Constructors

Gate(PryableDoor, List<Room>)

Initializes a new instance of the Gate class.

public Gate(PryableDoor door, List<Room> room)

Parameters

door PryableDoor

The base Interactables.Interobjects.PryableDoor for this door.

room List<Room>

The Room's for this door.

Properties

Base

Gets the base Interactables.Interobjects.PryableDoor.

public PryableDoor Base { get; }

Property Value

PryableDoor

BlockingPryingMask

Gets or sets DoorLockType which will block prying if door has them.

public DoorLockType BlockingPryingMask { get; set; }

Property Value

DoorLockType

IsFullyClosed

Gets a value indicating whether the door is fully closed.

public override bool IsFullyClosed { get; }

Property Value

bool

IsFullyOpen

Gets a value indicating whether the door is fully open.

public override bool IsFullyOpen { get; }

Property Value

bool

IsMoving

Gets a value indicating whether the door is currently moving.

public override bool IsMoving { get; }

Property Value

bool

PryPositions

Gets the list of all available pry positions.

public IEnumerable<Transform> PryPositions { get; }

Property Value

IEnumerable<Transform>

RemainingPryCooldown

Gets or sets remaining cooldown for prying.

public float RemainingPryCooldown { get; set; }

Property Value

float

Methods

ToString()

Returns the Door in a human-readable format.

public override string ToString()

Returns

string

A string containing Door-related data.

TryPry(Player)

Tries to pry the door open. No effect if the door cannot be pried.

public bool TryPry(Player player = null)

Parameters

player Player

Player to perform pry gate.

Returns

bool

true if the door was able to be pried open.