Class DamageHandlerBase

A wrapper to easily manipulate the behavior of PlayerStatsSystem.DamageHandlerBase.

Inheritance
System.Object
DamageHandlerBase
DamageHandler
Inherited Members
System.Object.ToString()
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.DamageHandlers
Assembly: Exiled.API.dll
Syntax
public abstract class DamageHandlerBase

Constructors

| Improve this Doc View Source

DamageHandlerBase()

Initializes a new instance of the DamageHandlerBase class.

Declaration
protected DamageHandlerBase()
| Improve this Doc View Source

DamageHandlerBase(DamageHandlerBase)

Initializes a new instance of the DamageHandlerBase class.

Declaration
protected DamageHandlerBase(DamageHandlerBase baseHandler)
Parameters
Type Name Description
PlayerStatsSystem.DamageHandlerBase baseHandler

The base PlayerStatsSystem.DamageHandlerBase.

Properties

| Improve this Doc View Source

Base

Gets or sets the base PlayerStatsSystem.DamageHandlerBase.

Declaration
public DamageHandlerBase Base { get; protected set; }
Property Value
Type Description
PlayerStatsSystem.DamageHandlerBase
| Improve this Doc View Source

CassieDeathAnnouncement

Gets or sets the DamageHandlerBase.CassieAnnouncement belonging to this DamageHandler instance.

Declaration
public virtual DamageHandlerBase.CassieAnnouncement CassieDeathAnnouncement { get; protected set; }
Property Value
Type Description
DamageHandlerBase.CassieAnnouncement
| Improve this Doc View Source

DeathTranslation

Gets the PlayerStatsSystem.DeathTranslation.

Declaration
public virtual DeathTranslation DeathTranslation { get; }
Property Value
Type Description
PlayerStatsSystem.DeathTranslation
| Improve this Doc View Source

ServerLogsText

Gets the text to show in the server logs.

Declaration
public virtual string ServerLogsText { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Type

Gets or sets the DamageType for the damage handler.

Declaration
public virtual DamageType Type { get; protected set; }
Property Value
Type Description
DamageType

Methods

| Improve this Doc View Source

ApplyDamage(Player)

Applies the damage to the specified Player.

Declaration
public abstract DamageHandlerBase.Action ApplyDamage(Player player)
Parameters
Type Name Description
Player player

The Player to damage.
Returns
Type Description
DamageHandlerBase.Action

The DamageHandlerBase.Action of the call to this method.
| Improve this Doc View Source

As<T>()

Unsafely casts the damage handler to the specified PlayerStatsSystem.DamageHandlerBase type.

Declaration
public T As<T>()

    where T : DamageHandlerBase
Returns
Type Description
T

A PlayerStatsSystem.DamageHandlerBase object.
Type Parameters
Name Description
T

The specified PlayerStatsSystem.DamageHandlerBase type.
| Improve this Doc View Source

BaseAs<T>()

Unsafely casts the damage handler to the specified DamageHandlerBase type.

Declaration
public T BaseAs<T>()

    where T : DamageHandlerBase
Returns
Type Description
T

A DamageHandlerBase object.
Type Parameters
Name Description
T

The specified DamageHandlerBase type.
| Improve this Doc View Source

BaseIs<T>(out T)

Safely casts the damage handler to the specified DamageHandlerBase type.

Declaration
public bool BaseIs<T>(out T param)

    where T : DamageHandlerBase
Parameters
Type Name Description
T param

The casted DamageHandlerBase.
Returns
Type Description
System.Boolean

A DamageHandlerBase object.
Type Parameters
Name Description
T

The specified DamageHandlerBase type.
| Improve this Doc View Source

Is<T>(out T)

Safely casts the damage handler to the specified PlayerStatsSystem.DamageHandlerBase type.

Declaration
public bool Is<T>(out T param)

    where T : DamageHandlerBase
Parameters
Type Name Description
T param

The casted PlayerStatsSystem.DamageHandlerBase.
Returns
Type Description
System.Boolean

A PlayerStatsSystem.DamageHandlerBase object.
Type Parameters
Name Description
T

The specified PlayerStatsSystem.DamageHandlerBase type.
| Improve this Doc View Source

ProcessDamage(Player)

Computes and processes the damage.

Declaration
public virtual void ProcessDamage(Player player)
Parameters
Type Name Description
Player player

The Player to damage.

Operators

| Improve this Doc View Source

Implicit(DamageHandlerBase to DamageHandlerBase)

Implicitly converts the given DamageHandlerBase instance to a PlayerStatsSystem.DamageHandlerBase object.

Declaration
public static implicit operator DamageHandlerBase(DamageHandlerBase damageHandlerBase)
Parameters
Type Name Description
DamageHandlerBase damageHandlerBase

The DamageHandlerBase instance.
Returns
Type Description
PlayerStatsSystem.DamageHandlerBase

Extension Methods