Interface IDamageableDoor

Namespace

Exiled.API.Interfaces

Assembly

Exiled.API.dll

Interface for doors that can be damaged.

public interface IDamageableDoor

Extension Methods

ReflectionExtensions.CopyProperties(object, object)

Properties

Health

Gets or sets the health of the door.

float Health { get; set; }

Property Value

float

IgnoredDamage

Gets or sets damage types which will be ignored.

DoorDamageType IgnoredDamage { get; set; }

Property Value

DoorDamageType

IsBreakable

Gets a value indicating whether this door is breakable.

bool IsBreakable { get; }

Property Value

bool

IsDestroyed

Gets or sets a value indicating whether door is destroyed.

bool IsDestroyed { get; set; }

Property Value

bool

MaxHealth

Gets or sets max health of the door.

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.

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.

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

Parameters

amount float

Amount to be dealt.

damageType DoorDamageType

Damage type. Some types can be ignored.

Returns

bool

true if door was damaged. Otherwise, false.

Repair()

Repair the door.

void Repair()