Class EffectTypeExtension

A set of extensions for EffectType.

Inheritance
System.Object
EffectTypeExtension
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.Extensions
Assembly: Exiled.API.dll
Syntax
public static class EffectTypeExtension

Properties

| Improve this Doc View Source

EffectTypeToType

Gets a dictionary that maps each EffectType to its corresponding System.Type.

Declaration
public static Dictionary<EffectType, Type> EffectTypeToType { get; }
Property Value
Type Description
System.Collections.Generic.Dictionary<EffectType, System.Type>
| Improve this Doc View Source

TypeToEffectType

Gets a dictionary that maps each System.Type to its corresponding EffectType.

Declaration
public static Dictionary<Type, EffectType> TypeToEffectType { get; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.Type, EffectType>

Methods

| Improve this Doc View Source

GetCategories(EffectType)

Returns the EffectCategory of the given effect.

Declaration
public static EffectCategory GetCategories(this EffectType effect)
Parameters
Type Name Description
EffectType effect

The EffectType.
Returns
Type Description
EffectCategory

The EffectCategory representing the effect.
| Improve this Doc View Source

GetEffectType(StatusEffectBase)

Gets the EffectType of the specified CustomPlayerEffects.StatusEffectBase.

Declaration
public static EffectType GetEffectType(this StatusEffectBase statusEffectBase)
Parameters
Type Name Description
CustomPlayerEffects.StatusEffectBase statusEffectBase

The CustomPlayerEffects.StatusEffectBase enum.
Returns
Type Description
EffectType

The EffectType.
| Improve this Doc View Source

IsDisplayed(EffectType)

Returns whether or not the provided effect is displayed to spectators as text.

Declaration
public static bool IsDisplayed(this EffectType effect)
Parameters
Type Name Description
EffectType effect

The EffectType.
Returns
Type Description
System.Boolean

Whether or not the effect is displayed to spectators as text.
| Improve this Doc View Source

IsHarmful(EffectType)

Returns whether or not the provided effect drains health over time.

Declaration
public static bool IsHarmful(this EffectType effect)
Parameters
Type Name Description
EffectType effect

The EffectType.
Returns
Type Description
System.Boolean

Whether or not the effect drains health over time.
See Also
| Improve this Doc View Source

IsHealing(EffectType)

Returns whether or not the provided effect heals a player.

Declaration
public static bool IsHealing(this EffectType effect)
Parameters
Type Name Description
EffectType effect

The EffectType.
Returns
Type Description
System.Boolean

Whether or not the effect heals.
See Also
| Improve this Doc View Source

IsMovement(EffectType)

Returns whether or not the provided effect affects the player's movement speed.

Declaration
public static bool IsMovement(this EffectType effect)
Parameters
Type Name Description
EffectType effect

The EffectType.
Returns
Type Description
System.Boolean

Whether or not the effect modifies the player's movement speed.
| Improve this Doc View Source

IsNegative(EffectType)

Returns whether or not the provided effect is a negative effect.

Declaration
public static bool IsNegative(this EffectType effect)
Parameters
Type Name Description
EffectType effect

The EffectType.
Returns
Type Description
System.Boolean

Whether or not the effect is a negative effect.
See Also
| Improve this Doc View Source

IsPositive(EffectType)

Returns whether or not the provided effect is a positive effect.

Declaration
public static bool IsPositive(this EffectType effect)
Parameters
Type Name Description
EffectType effect

The EffectType.
Returns
Type Description
System.Boolean

Whether or not the effect is a positive effect.
See Also
| Improve this Doc View Source

TryGetEffectType(StatusEffectBase, out EffectType)

Gets the EffectType of the specified CustomPlayerEffects.StatusEffectBase.

Declaration
public static bool TryGetEffectType(this StatusEffectBase statusEffectBase, out EffectType effect)
Parameters
Type Name Description
CustomPlayerEffects.StatusEffectBase statusEffectBase

The CustomPlayerEffects.StatusEffectBase enum.
EffectType effect

The effect found.
Returns
Type Description
System.Boolean

Whether or not the effect has been found.
| Improve this Doc View Source

TryGetType(EffectType, out Type)

Gets an instance of System.Type points to an effect.

Declaration
public static bool TryGetType(this EffectType effect, out Type type)
Parameters
Type Name Description
EffectType effect

The EffectType enum.
System.Type type

The type found with the corresponding EffecType.
Returns
Type Description
System.Boolean

Whether or not the effectType has been found.
| Improve this Doc View Source

Type(EffectType)

Gets an instance of System.Type points to an effect.

Declaration
public static Type Type(this EffectType effect)
Parameters
Type Name Description
EffectType effect

The EffectType enum.
Returns
Type Description
System.Type

The System.Type.