Interface IDamageableDoor
Interface for doors that can be damaged.
Namespace: Exiled.API.Interfaces
Assembly: Exiled.API.dll
Syntax
public interface IDamageableDoor
Properties
| Improve this Doc View SourceHealth
Gets or sets the health of the door.
Declaration
float Health { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
IgnoredDamage
Gets or sets damage types which will be ignored.
Declaration
DoorDamageType IgnoredDamage { get; set; }
Property Value
Type | Description |
---|---|
Interactables.Interobjects.DoorUtils.DoorDamageType |
IsBreakable
Gets a value indicating whether or not this door is breakable.
Declaration
bool IsBreakable { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsDestroyed
Gets or sets a value indicating whether or not door is destroyed.
Declaration
bool IsDestroyed { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
MaxHealth
Gets or sets max health of the door.
Declaration
float MaxHealth { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Methods
| Improve this Doc View SourceBreak(DoorDamageType)
Breaks the specified door. No effect if the door cannot be broken, or if it is already broken.
Declaration
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. |
Damage(Single, DoorDamageType)
Damages the door.
Declaration
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. |
Returns
Type | Description |
---|---|
System.Boolean | true if door was damaged. Otherwise, false. |