Table of Contents

Class CheckpointDoor

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

Represents a checkpoint door.

public class CheckpointDoor : Door, IWrapper<DoorVariant>, IWorldSpace, IPosition, IRotation, IDamageableDoor
Inheritance
CheckpointDoor
Implements
IWrapper<DoorVariant>
Inherited Members
Extension Methods

Properties

Base

Gets the base Interactables.Interobjects.CheckpointDoor.

public CheckpointDoor Base { get; }

Property Value

CheckpointDoor

CurrentStage

Gets or sets the current checkpoint stage.

public CheckpointDoor.SequenceState CurrentStage { get; set; }

Property Value

CheckpointDoor.SequenceState

Health

Gets or sets the health of the door.

public float Health { get; set; }

Property Value

float

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

MainTimer

Gets or sets a time in seconds for main timer.

public float MainTimer { get; set; }

Property Value

float

MaxHealth

Gets or sets max health of the door.

public float MaxHealth { get; set; }

Property Value

float

Subdoors

Gets the list of all sub doors belonging to this CheckpointDoor.

public IReadOnlyCollection<BreakableDoor> Subdoors { get; }

Property Value

IReadOnlyCollection<BreakableDoor>

WaitTime

Gets or sets time before doors close.

public float WaitTime { get; set; }

Property Value

float

WarningTime

Gets or sets time in seconds when warning will be shown.

public float WarningTime { 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.

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.

ToggleAllDoors(bool)

Toggles the state of the doors from Subdoors.

public void ToggleAllDoors(bool newState)

Parameters

newState bool

New state for the subdoors.

Edit this page