Class DamageHandlerBase

Namespace

Exiled.API.Features.DamageHandlers

Assembly

Exiled.API.dll

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

public abstract class DamageHandlerBase

Inheritance

object

DamageHandlerBase

Derived

DamageHandler

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

ReflectionExtensions.CopyProperties(object, object)

Constructors

DamageHandlerBase()

Initializes a new instance of the DamageHandlerBase class.

protected DamageHandlerBase()

DamageHandlerBase(DamageHandlerBase)

Initializes a new instance of the DamageHandlerBase class.

protected DamageHandlerBase(DamageHandlerBase baseHandler)

Parameters

baseHandler DamageHandlerBase

The base PlayerStatsSystem.DamageHandlerBase.

Properties

Base

Gets or sets the base PlayerStatsSystem.DamageHandlerBase.

public DamageHandlerBase Base { get; protected set; }

Property Value

DamageHandlerBase

CassieDeathAnnouncement

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

public virtual DamageHandlerBase.CassieAnnouncement CassieDeathAnnouncement { get; protected set; }

Property Value

DamageHandlerBase.CassieAnnouncement

DeathTranslation

Gets the PlayerStatsSystem.DeathTranslation.

public virtual DeathTranslation DeathTranslation { get; }

Property Value

DeathTranslation

ServerLogsText

Gets the text to show in the server logs.

public virtual string ServerLogsText { get; }

Property Value

string

Type

Gets or sets the DamageType for the damage handler.

public virtual DamageType Type { get; protected set; }

Property Value

DamageType

Methods

ApplyDamage(Player)

Applies the damage to the specified Player.

public abstract DamageHandlerBase.Action ApplyDamage(Player player)

Parameters

player Player

The Player to damage.

Returns

DamageHandlerBase.Action

The DamageHandlerBase.Action of the call to this method.

As<T>()

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

public T As<T>() where T : DamageHandlerBase

Returns

T

A PlayerStatsSystem.DamageHandlerBase object.

Type Parameters

T

The specified PlayerStatsSystem.DamageHandlerBase type.

BaseAs<T>()

Unsafely casts the damage handler to the specified DamageHandlerBase type.

public T BaseAs<T>() where T : DamageHandlerBase

Returns

T

A DamageHandlerBase object.

Type Parameters

T

The specified DamageHandlerBase type.

BaseIs<T>(out T)

Safely casts the damage handler to the specified DamageHandlerBase type.

public bool BaseIs<T>(out T param) where T : DamageHandlerBase

Parameters

param T

The casted DamageHandlerBase.

Returns

bool

A DamageHandlerBase object.

Type Parameters

T

The specified DamageHandlerBase type.

GetDamageType(DamageHandlerBase)

Gets the DamageType assosiated with damageHandler.

protected DamageType GetDamageType(DamageHandlerBase damageHandler = null)

Parameters

damageHandler DamageHandlerBase

PlayerStatsSystem.DamageHandlerBase from which DamageType should be get. If null, Base will be used.

Returns

DamageType

Assosiated DamageType.

Is<T>(out T)

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

public bool Is<T>(out T param) where T : DamageHandlerBase

Parameters

param T

The casted PlayerStatsSystem.DamageHandlerBase.

Returns

bool

A PlayerStatsSystem.DamageHandlerBase object.

Type Parameters

T

The specified PlayerStatsSystem.DamageHandlerBase type.

ProcessDamage(Player)

Computes and processes the damage.

public virtual void ProcessDamage(Player player)

Parameters

player Player

The Player to damage.

Operators

implicit operator DamageHandlerBase(DamageHandlerBase)

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

public static implicit operator DamageHandlerBase(DamageHandlerBase damageHandlerBase)

Parameters

damageHandlerBase DamageHandlerBase

The DamageHandlerBase instance.

Returns

DamageHandlerBase