Class Gate

Represents a "pryable" door or gate.

Inheritance
System.Object
TypeCastObject<Door>
Door
BasicDoor
Gate
Implements
IWrapper<Interactables.Interobjects.DoorUtils.DoorVariant>
Inherited Members
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 Gate : BasicDoor, IWrapper<DoorVariant>, IWorldSpace, IPosition, IRotation

Constructors

| Improve this Doc View Source

Gate(PryableDoor, List<Room>)

Initializes a new instance of the Gate class.

Declaration
public Gate(PryableDoor door, List<Room> room)
Parameters
Type Name Description
Interactables.Interobjects.PryableDoor door

The base Interactables.Interobjects.PryableDoor for this door.
System.Collections.Generic.List<Room> room

The Room's for this door.

Properties

| Improve this Doc View Source

Base

Gets the base Interactables.Interobjects.PryableDoor.

Declaration
public PryableDoor Base { get; }
Property Value
Type Description
Interactables.Interobjects.PryableDoor
| Improve this Doc View Source

BlockingPryingMask

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

Declaration
public DoorLockType BlockingPryingMask { get; set; }
Property Value
Type Description
DoorLockType
| Improve this Doc View Source

IsFullyClosed

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

Declaration
public override bool IsFullyClosed { get; }
Property Value
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

IsFullyOpen

Gets a value indicating whether the door is fully open.

Declaration
public override bool IsFullyOpen { get; }
Property Value
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

IsMoving

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

Declaration
public override bool IsMoving { get; }
Property Value
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

PryPositions

Gets the list of all available pry positions.

Declaration
public IEnumerable<Transform> PryPositions { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<UnityEngine.Transform>
| Improve this Doc View Source

RemainingPryCooldown

Gets or sets remaining cooldown for prying.

Declaration
public float RemainingPryCooldown { get; set; }
Property Value
Type Description
System.Single

Methods

| 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
| Improve this Doc View Source

TryPry(Player)

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

Declaration
public bool TryPry(Player player = null)
Parameters
Type Name Description
Player player

Player to perform pry gate.
Returns
Type Description
System.Boolean

true if the door was able to be pried open.

Implements

Extension Methods