Add all missing docs

PkmnLib.Dynamic/ScriptHandling/Script.cs

@@ -18,6 +18,9 @@ public abstract class Script : IDeepCloneable
 
     private int _suppressCount;
 
+    /// <summary>
+    /// Remove the script from its owner.
+    /// </summary>
     public void RemoveSelf()
     {
         OnRemoveEvent?.Invoke(this);
@@ -62,6 +65,10 @@ public abstract class Script : IDeepCloneable
     /// </summary>
     public void Unsuppress() => _suppressCount--;
 
+    /// <summary>
+    /// This function is ran before any hook is invoked. This allows for suppressing certain categories
+    /// of scripts. This is useful for example to prevent certain effects from running.
+    /// </summary>
     public virtual void OnBeforeAnyHookInvoked(ref List<ScriptCategory>? suppressedCategories)
     {
     }
@@ -95,6 +102,10 @@ public abstract class Script : IDeepCloneable
     {
     }
 
+    /// <summary>
+    /// Force a certain move choice to be selected. If the choice is set, the Pokemon will be forced
+    /// to use it, and will not be able to select any other choice.
+    /// </summary>
     public virtual void ForceTurnSelection(byte sideIndex, byte position, ref ITurnChoice? choice)
     {
     }
@@ -140,6 +151,9 @@ public abstract class Script : IDeepCloneable
     {
     }
 
+    /// <summary>
+    /// This function allows you to change the targets of a move choice before the move starts.
+    /// </summary>
     public virtual void ChangeIncomingTargets(IMoveChoice moveChoice, ref IReadOnlyList<IPokemon?> targets)
     {
     }
@@ -230,6 +244,9 @@ public abstract class Script : IDeepCloneable
     {
     }
 
+    /// <summary>
+    /// This function allows the script to override how effective a move is on a target.
+    /// </summary>
     public virtual void ChangeIncomingEffectiveness(IExecutingMove executingMove, IPokemon target, byte hitIndex,
         ref float effectiveness)
     {
@@ -504,6 +521,10 @@ public abstract class Script : IDeepCloneable
     {
     }
 
+    /// <summary>
+    /// This function is triggered on a Pokemon and its parents when the given Pokemon switches out
+    /// of the battlefield.
+    /// </summary>
     public virtual void OnSwitchOut(IPokemon oldPokemon, byte position)
     {
     }
@@ -559,10 +580,16 @@ public abstract class Script : IDeepCloneable
     {
     }
 
+    /// <summary>
+    /// This function allows a script to block an incoming hit.
+    /// </summary>
     public virtual void BlockIncomingHit(IExecutingMove executingMove, IPokemon target, byte hitIndex, ref bool block)
     {
     }
 
+    /// <summary>
+    /// This function allows a script to block an outgoing hit.
+    /// </summary>
     public virtual void BlockOutgoingHit(IExecutingMove executingMove, IPokemon target, byte hitIndex, ref bool block)
     {
     }
@@ -582,23 +609,44 @@ public abstract class Script : IDeepCloneable
     {
     }
 
+    /// <summary>
+    /// This function allows a script to prevent a held item from being consumed. 
+    /// </summary>
     public virtual void PreventHeldItemConsume(IPokemon pokemon, IItem heldItem, ref bool prevented)
     {
     }
 
+    /// <summary>
+    /// This function allows a script to change any kind of damage that is incoming.
+    /// </summary>
     public virtual void ChangeIncomingDamage(IPokemon pokemon, DamageSource source, ref uint damage)
     {
     }
 
+    /// <summary>
+    /// This function allows a script to change the accuracy of a move used. The value for accuracy is in percentage.
+    /// A custom case goes when 255 is returned, in which case the entire accuracy check is skipped, and the move
+    /// will always hit.
+    /// </summary>
+    /// <param name="executingMove"></param>
+    /// <param name="target"></param>
+    /// <param name="hitIndex"></param>
+    /// <param name="modifiedAccuracy"></param>
     public virtual void ChangeAccuracy(IExecutingMove executingMove, IPokemon target, byte hitIndex,
         ref int modifiedAccuracy)
     {
     }
 
+    /// <summary>
+    /// This function allows a script to change the weather duration of a weather effect.
+    /// </summary>
     public virtual void ChangeWeatherDuration(StringKey weatherName, ref int duration)
     {
     }
 
+    /// <summary>
+    /// This function allows a script to prevent a Pokemon from being healed. 
+    /// </summary>
     public virtual void PreventHeal(IPokemon pokemon, uint heal, bool allowRevive, ref bool prevented)
     {
     }