Class EffectTypeExtension

Namespace

Exiled.API.Extensions

Assembly

Exiled.API.dll

A set of extensions for EffectType.

public static class EffectTypeExtension

Inheritance

object

EffectTypeExtension

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

object.ReferenceEquals(object, object)

Properties

EffectTypeToType

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

public static ReadOnlyDictionary<EffectType, Type> EffectTypeToType { get; }

Property Value

ReadOnlyDictionary<EffectType, Type>

TypeToEffectType

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

public static ReadOnlyDictionary<Type, EffectType> TypeToEffectType { get; }

Property Value

ReadOnlyDictionary<Type, EffectType>

Methods

GetCategories(EffectType)

Returns the EffectCategory of the given effect.

public static EffectCategory GetCategories(this EffectType effect)

Parameters

effect EffectType

The EffectType.

Returns

EffectCategory

The EffectCategory representing the effect.

GetEffectType(StatusEffectBase)

Gets the EffectType of the specified CustomPlayerEffects.StatusEffectBase.

public static EffectType GetEffectType(this StatusEffectBase statusEffectBase)

Parameters

statusEffectBase StatusEffectBase

The CustomPlayerEffects.StatusEffectBase enum.

Returns

EffectType

The EffectType.

IsDisplayed(EffectType)

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

public static bool IsDisplayed(this EffectType effect)

Parameters

effect EffectType

The EffectType.

Returns

bool

Whether the effect is displayed to spectators as text.

IsHarmful(EffectType)

Returns whether the provided effect drains health over time.

public static bool IsHarmful(this EffectType effect)

Parameters

effect EffectType

The EffectType.

Returns

bool

Whether the effect drains health over time.

See Also

IsHealing(EffectType)

IsHealing(EffectType)

Returns whether the provided effect heals a player.

public static bool IsHealing(this EffectType effect)

Parameters

effect EffectType

The EffectType.

Returns

bool

Whether the effect heals.

See Also

IsHarmful(EffectType)

IsMovement(EffectType)

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

public static bool IsMovement(this EffectType effect)

Parameters

effect EffectType

The EffectType.

Returns

bool

Whether the effect modifies the player's movement speed.

IsNegative(EffectType)

Returns whether the provided effect is a negative effect.

public static bool IsNegative(this EffectType effect)

Parameters

effect EffectType

The EffectType.

Returns

bool

Whether the effect is a negative effect.

See Also

IsHarmful(EffectType)

IsPositive(EffectType)

Returns whether the provided effect is a positive effect.

public static bool IsPositive(this EffectType effect)

Parameters

effect EffectType

The EffectType.

Returns

bool

Whether the effect is a positive effect.

See Also

IsHealing(EffectType)

SetFogType(FogControl, FogType)

Sets the CustomRendering.FogType of the specified CustomPlayerEffects.FogControl.

public static void SetFogType(this FogControl fogControl, FogType fogType)

Parameters

fogControl FogControl

The CustomPlayerEffects.FogControl effect.

fogType FogType

The CustomRendering.FogType applied.

TryGetEffectType(StatusEffectBase, out EffectType)

Gets the EffectType of the specified CustomPlayerEffects.StatusEffectBase.

public static bool TryGetEffectType(this StatusEffectBase statusEffectBase, out EffectType effect)

Parameters

statusEffectBase StatusEffectBase

The CustomPlayerEffects.StatusEffectBase enum.

effect EffectType

The effect found.

Returns

bool

Whether the effect has been found.

TryGetType(EffectType, out Type)

Gets an instance of Type points to an effect.

public static bool TryGetType(this EffectType effect, out Type type)

Parameters

effect EffectType

The EffectType enum.

type Type

The type found with the corresponding EffecType.

Returns

bool

Whether the effectType has been found.

Type(EffectType)

Gets an instance of Type points to an effect.

public static Type Type(this EffectType effect)

Parameters

effect EffectType

The EffectType enum.

Returns

Type

The Type.