Class BreakableDoor

Represents Interactables.Interobjects.BreakableDoor.

Inheritance
System.Object
TypeCastObject<Door>
Door
BasicDoor
BreakableDoor
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 BreakableDoor : BasicDoor, IWrapper<DoorVariant>, IWorldSpace, IPosition, IRotation, IDamageableDoor, INonInteractableDoor

Properties

| Improve this Doc View Source

Base

Gets the base Interactables.Interobjects.BreakableDoor.

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

BrokenDoorPrefab

Gets the prefab of broken door.

Declaration
public BrokenDoor BrokenDoorPrefab { get; }
Property Value
Type Description
Interactables.Interobjects.DoorUtils.BrokenDoor
| Improve this Doc View Source

Health

Gets or sets remaining health of the door.

Declaration
public float Health { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

IgnoredDamage

Gets or sets damage types which will be ignored.

Declaration
public DoorDamageType IgnoredDamage { get; set; }
Property Value
Type Description
Interactables.Interobjects.DoorUtils.DoorDamageType
| Improve this Doc View Source

IgnoreLockdowns

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

IgnoreRemoteAdmin

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

IsBreakable

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

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

IsDestroyed

Gets or sets a value indicating whether or not door is destroyed.

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

MaxHealth

Gets or sets max health of the door.

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

Methods

| Improve this Doc View Source

Break(DoorDamageType)

Breaks the specified door. No effect if the door cannot be broken, or if it is already broken.

Declaration
public bool Break(DoorDamageType type = DoorDamageType.ServerCommand)
Parameters
Type Name Description
Interactables.Interobjects.DoorUtils.DoorDamageType type

The Interactables.Interobjects.DoorUtils.DoorDamageType to apply to the door.
Returns
Type Description
System.Boolean

true if the door was broken, false if it was unable to be broken, or was already broken before.
| Improve this Doc View Source

Damage(Single, DoorDamageType)

Damages the door.

Declaration
public bool Damage(float amount, DoorDamageType damageType = DoorDamageType.ServerCommand)
Parameters
Type Name Description
System.Single amount

Amount to be dealt.
Interactables.Interobjects.DoorUtils.DoorDamageType damageType

Damage type. Some types can be ignored according to IgnoredDamage.
Returns
Type Description
System.Boolean

true if door was damaged. Otherwise, false.
| 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

Implements

Extension Methods