Class ReceivingEffectEventArgs

Namespace

Exiled.Events.EventArgs.Player

Assembly

Exiled.Events.dll

Contains all information before a player receives a CustomPlayerEffects.StatusEffectBase.

public class ReceivingEffectEventArgs : IPlayerEvent, IDeniableEvent, IExiledEvent

Inheritance

object

ReceivingEffectEventArgs

Implements

IPlayerEvent

IDeniableEvent

IExiledEvent

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

ReceivingEffectEventArgs(Player, StatusEffectBase, byte, byte, float)

Initializes a new instance of the ReceivingEffectEventArgs class.

public ReceivingEffectEventArgs(Player player, StatusEffectBase effect, byte intensity, byte currentIntensity, float duration)

Parameters

player Player

effect StatusEffectBase

intensity byte

The intensity the effect is being changed to.

currentIntensity byte

duration float

Properties

CurrentIntensity

Gets the value of the intensity of this effect on the player.

public byte CurrentIntensity { get; }

Property Value

byte

Duration

Gets or sets a value indicating how long the effect will last. If its value is 0, then it doesn't always reflect the real effect duration.

public float Duration { get; set; }

Property Value

float

Effect

Gets the CustomPlayerEffects.StatusEffectBase being received.

public StatusEffectBase Effect { get; }

Property Value

StatusEffectBase

Intensity

Gets or sets the value of the new intensity of the effect. Setting this to 0 is the same as setting IsAllowed to false.

public byte Intensity { get; set; }

Property Value

byte

IsAllowed

Gets or sets a value indicating whether the effect will be applied.

public bool IsAllowed { get; set; }

Property Value

bool

Player

Gets the Player receiving the effect.

public Player Player { get; }

Property Value

Player