Adjustments to the CustomEffect API

Author: marchellcx

LabExtended/API/Custom/Effects/CustomDurationEffect.cs

@@ -1,6 +1,7 @@
 using LabExtended.Attributes;
 
 using UnityEngine;
+using YamlDotNet.Serialization;
 
 namespace LabExtended.API.Custom.Effects;
 
@@ -11,21 +12,15 @@ namespace LabExtended.API.Custom.Effects;
 public abstract class CustomDurationEffect : CustomTickingEffect
 {
     /// <summary>
-    /// Gets or sets the remaining duration (in seconds).
-    /// </summary>
-    public float RemainingDuration { get; set; } = 0f;
-
-    /// <summary>
-    /// Gets the effect's default duration.
+    /// Gets or sets the effect's duration.
     /// </summary>
-    /// <returns>The effect's duration.</returns>
-    public abstract float GetDuration();
+    public float Duration { get; set; } = 0f;
 
     /// <summary>
-    /// Called once the remaining duration reaches zero.
+    /// Gets or sets the remaining duration (in seconds).
     /// </summary>
-    /// <returns>Seconds to add to remaining duration.</returns>
-    public virtual float CheckDuration() => 0f;
+    [YamlIgnore]
+    public float RemainingDuration { get; set; } = 0f;
 
     /// <inheritdoc cref="CustomTickingEffect.Tick"/>
     public override void Tick()
@@ -39,14 +34,6 @@ public override void Tick()
 
         if (RemainingDuration <= 0f)
         {
-            var addDuration = CheckDuration();
-
-            if (addDuration > 0f)
-            {
-                RemainingDuration += addDuration;
-                return;
-            }
-            
             RemainingDuration = 0f;
 
             IsActive = false;
@@ -57,7 +44,7 @@ public override void Tick()
 
     internal override void OnApplyEffects()
     {
-        RemainingDuration = GetDuration();
+        RemainingDuration = Duration;
         IsActive = RemainingDuration > 0f;
 
         if (IsActive)

LabExtended/API/Custom/Effects/CustomPlayerEffect.cs

@@ -7,6 +7,7 @@
 using LabExtended.Utilities;
 
 using PlayerRoles;
+using YamlDotNet.Serialization;
 
 namespace LabExtended.API.Custom.Effects;
 
@@ -63,11 +64,13 @@ public static bool TryGetEffect(string name, bool onlyFullName, bool ignoreCase,
     /// <summary>
     /// Gets the player that this effect belongs to.
     /// </summary>
+    [YamlIgnore]
     public ExPlayer? Player { get; internal set; }
 
     /// <summary>
     /// Whether or not this effect is active.
     /// </summary>
+    [YamlIgnore]
     public bool IsActive { get; internal set; }
 
     /// <summary>

LabExtended/API/Custom/Effects/CustomTickingEffect.cs

@@ -2,6 +2,7 @@
 using LabExtended.Utilities.Update;
 
 using UnityEngine;
+using YamlDotNet.Serialization;
 
 namespace LabExtended.API.Custom.Effects;
 
@@ -12,11 +13,11 @@ namespace LabExtended.API.Custom.Effects;
 public class CustomTickingEffect : CustomPlayerEffect
 {
     private float delayTime = 0f;
-    
+
     /// <summary>
     /// Custom delay between each tick.
     /// </summary>
-    public virtual float Delay { get; } = 0f;
+    public virtual float Delay { get; set; } = 0f;
 
     /// <summary>
     /// Called once a frame.