fix comments, remove color utils and add example script framework

Author: Elektryk-Andrzej

ExampleScripts/ExampleScript.cs

@@ -0,0 +1,8 @@
+namespace SER.ExampleScripts;
+
+public abstract class ExampleScript
+{
+    public abstract string Name { get; }
+    
+    public abstract string Content { get; }
+}

ExampleScripts/Scripts/InviteInfoScript.cs

@@ -0,0 +1,16 @@
+namespace SER.ExampleScripts.Scripts;
+
+public class InviteInfoScript : ExampleScript
+{
+    public override string Name => "InviteBroadcast";
+
+    public override string Content =>
+        """
+        # this script is connected to the 'Joined' event, which means that this script will run when a player joins
+        # this event provides us with the @evPlayer variable with the player who just joined
+        !-- OnEvent Joined
+        
+        # this 'Broadcast' method sends a formatted message to the player who just joined
+        Broadcast @evPlayer 10s "<b><color=#8dfcef><size=35>Welcome {@evPlayer nickname}!</size></color>\n<color=#ebebb9><size=20>This server is using <u>Scripted Events Reloaded</u>, enjoy your stay!</size></color></b>"
+        """;
+}

Helpers/ColorUtils.cs

@@ -46,7 +46,7 @@ private static IEnumerator<float> TransitionColor(Room room, Color targetColor,
             }
 
             var roomLights = lightsController.Base.transform.parent.GetComponentsInChildren<RoomLight>(true);
-            var startColorForLight = ColorUtils.AverageColor(
+            var startColorForLight = AverageColor(
                 roomLights
                     .Select(l => l._overrideColorSet ? l._overrideColor : l._initialLightColor)
                     .Where(c => c != Color.clear)
@@ -72,4 +72,23 @@ private static IEnumerator<float> TransitionColor(Room room, Color targetColor,
 
         room.AllLightControllers.ForEachItem(ctrl => ctrl.OverrideLightsColor = targetColor);
     }
+    
+    private static Color AverageColor(Color[] colors)
+    {
+        if (colors.Length == 0)
+            return Color.clear;
+
+        float r = 0f, g = 0f, b = 0f, a = 0f;
+
+        foreach (Color color in colors)
+        {
+            r += color.r;
+            g += color.g;
+            b += color.b;
+            a += color.a;
+        }
+
+        float count = colors.Length;
+        return new Color(r / count, g / count, b / count, a / count);
+    }
 }

Helpers/Union.cs

@@ -138,12 +138,13 @@
         <Compile Include="ContextSystem\Structures\TryAddContextRes.cs" />
         <Compile Include="ContextSystem\Structures\TryAddTokenRes.cs" />
         <Compile Include="EventSystem\EventHandler.cs" />
+        <Compile Include="ExampleScripts\ExampleScript.cs" />
+        <Compile Include="ExampleScripts\Scripts\InviteInfoScript.cs" />
         <Compile Include="FlagSystem\Flags\CustomCommandFlag.cs" />
         <Compile Include="FlagSystem\Flags\OnEventFlag.cs" />
         <Compile Include="FlagSystem\ScriptFlagHandler.cs" />
         <Compile Include="FlagSystem\Structures\ConsoleType.cs" />
         <Compile Include="FlagSystem\Structures\Flag.cs" />
-        <Compile Include="Helpers\ColorUtils.cs" />
         <Compile Include="Helpers\Compiler\CompilerRequiredAttributes.cs" />
         <Compile Include="Helpers\Compiler\IsExternalInit.cs.cs" />
         <Compile Include="Helpers\Exceptions\AndrzejFuckedUpException.cs" />
@@ -159,7 +160,6 @@
         <Compile Include="Helpers\ResultSystem\DynamicTryGet.cs" />
         <Compile Include="Helpers\ResultSystem\ITryGet.cs" />
         <Compile Include="Helpers\ResultSystem\TryGet.cs" />
-        <Compile Include="Helpers\Union.cs" />
         <Compile Include="MethodSystem\BaseMethods\Method.cs" />
         <Compile Include="MethodSystem\BaseMethods\PlayerReturningMethod.cs" />
         <Compile Include="MethodSystem\BaseMethods\SynchronousMethod.cs" />

MethodSystem/Methods/LightMethods/TransitionLightColorMethod.cs

@@ -1,15 +1,23 @@
 using System.Linq;
+using SER.ContextSystem.BaseContexts;
+using SER.ContextSystem.Contexts;
 using SER.Helpers.ResultSystem;
 using SER.ScriptSystem;
+using SER.TokenSystem.Structures;
 
 namespace SER.TokenSystem.Tokens;
 
-public class CommentToken : BaseToken
+public class CommentToken : BaseToken, IContextableToken
 {
     protected override Result InternalParse(Script scr)
     {
         if (RawRepresentation.FirstOrDefault() == '#') return true;
 
         return "Value is not a comment.";
     }
+
+    public TryGet<Context> TryGetContext(Script scr)
+    {
+        return new NoOperationContext();
+    }
 }