Class ReceivingEffectEventArgs

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

Inheritance
System.Object
ReceivingEffectEventArgs
Implements
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.Events.EventArgs.Player
Assembly: Exiled.Events.dll
Syntax
public class ReceivingEffectEventArgs : IPlayerEvent, IDeniableEvent, IExiledEvent

Constructors

| Improve this Doc View Source

ReceivingEffectEventArgs(Player, StatusEffectBase, Byte, Byte, Single)

Initializes a new instance of the ReceivingEffectEventArgs class.

Declaration
public ReceivingEffectEventArgs(Player player, StatusEffectBase effect, byte intensity, byte currentIntensity, float duration)
Parameters
Type Name Description
Player player
CustomPlayerEffects.StatusEffectBase effect
System.Byte intensity

The intensity the effect is being changed to.
System.Byte currentIntensity
System.Single duration

Properties

| Improve this Doc View Source

CurrentIntensity

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

Declaration
public byte CurrentIntensity { get; }
Property Value
Type Description
System.Byte
| Improve this Doc View Source

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.

Declaration
public float Duration { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

Effect

Gets the CustomPlayerEffects.StatusEffectBase being received.

Declaration
public StatusEffectBase Effect { get; }
Property Value
Type Description
CustomPlayerEffects.StatusEffectBase
| Improve this Doc View Source

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.

Declaration
public byte Intensity { get; set; }
Property Value
Type Description
System.Byte
| Improve this Doc View Source

IsAllowed

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

Declaration
public bool IsAllowed { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Player

Gets the Player receiving the effect.

Declaration
public Player Player { get; }
Property Value
Type Description
Player

Implements

Extension Methods