Table of Contents

Class BreakableDoor

Namespace
Exiled.API.Features.Doors
Assembly
Exiled.API.dll

Represents Interactables.Interobjects.BreakableDoor.

public class BreakableDoor : BasicDoor, IWrapper<DoorVariant>, IWorldSpace, IPosition, IRotation, IDamageableDoor, INonInteractableDoor
Inheritance
BreakableDoor
Implements
IWrapper<DoorVariant>
Inherited Members
Extension Methods

Properties

Base

Gets the base Interactables.Interobjects.BreakableDoor.

public BreakableDoor Base { get; }

Property Value

BreakableDoor

BrokenDoorPrefab

Gets the prefab of broken door.

public BrokenDoor BrokenDoorPrefab { get; }

Property Value

BrokenDoor

Health

Gets or sets remaining health of the door.

public float Health { get; set; }

Property Value

float

IgnoreLockdowns

Gets or sets a value indicating whether door should ignore lockdowns.

public bool IgnoreLockdowns { get; set; }

Property Value

bool

IgnoreRemoteAdmin

Gets or sets a value indicating whether door should ignore RA requests.

public bool IgnoreRemoteAdmin { get; set; }

Property Value

bool

IgnoredDamage

Gets or sets damage types which will be ignored.

public DoorDamageType IgnoredDamage { get; set; }

Property Value

DoorDamageType

IsBreakable

Gets a value indicating whether this door is breakable.

public bool IsBreakable { get; }

Property Value

bool

IsDestroyed

Gets or sets a value indicating whether door is destroyed.

public bool IsDestroyed { get; set; }

Property Value

bool

MaxHealth

Gets or sets max health of the door.

public float MaxHealth { get; set; }

Property Value

float

Methods

Break(DoorDamageType)

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

public bool Break(DoorDamageType type = DoorDamageType.ServerCommand)

Parameters

type DoorDamageType

The Interactables.Interobjects.DoorUtils.DoorDamageType to apply to the door.

Returns

bool

true if the door was broken, false if it was unable to be broken, or was already broken before.

Damage(float, DoorDamageType)

Damages the door.

public bool Damage(float amount, DoorDamageType damageType = DoorDamageType.ServerCommand)

Parameters

amount float

Amount to be dealt.

damageType DoorDamageType

Damage type. Some types can be ignored according to IgnoredDamage.

Returns

bool

true if door was damaged. Otherwise, false.

Repair()

Repair the door.

public void Repair()

ToString()

Returns the Door in a human-readable format.

public override string ToString()

Returns

string

A string containing Door-related data.

Edit this page