add example script system

Author: Elektryk-Andrzej

ExampleScripts/ExampleScript.cs

@@ -0,0 +1,196 @@
+namespace SER.Examples;
+
+public class ChaosCoinScript : IExample
+{
+    public string Name => "chaosCoin";
+
+    public string Content =>
+        """
+        !-- OnEvent FlippingCoin
+
+        # formats of broadcasts, used to not repeat the same things in different broadcasts
+        $hintInfo = "<color=#ff5555><size=30><b>"
+        $baseText = "<size=20><b><color=green>the holy coin has been used<br><size=35></color>"
+        $afterText = "<color=white><size=25><b>"
+
+        # "coin locked" is a property of this player, storing whether a coin can be used.
+        # this is because some effects of the coin take time, and we DO NOT want to
+        # have the coin be used again WHILE a different effect is still ongoing
+        if {PlayerDataExists @evPlayer "coin locked"}
+            if {GetPlayerData @evPlayer "coin locked"}
+                Hint @evPlayer 5s "{$hintInfo}You can't use the coin for now!<br><size=20>Come back when the current effect has finished."
+                IsAllowed false
+                stop
+            end
+        end
+
+        # 50% chance to lose the coin
+        if {RandomNum 1 2 int} == 1
+            Hint @evPlayer 3s "{$hintInfo}Your coin has turned into dust..."
+            AdvDestroyItem {@evPlayer heldItemRef}
+        end
+
+        # select a random effect of the coin, from 9 available
+        $effect = RandomNum 9 9 int
+
+        # russian rulette with a full gun :trollface:
+        if $effect == 1
+            GiveItem @evPlayer GunRevolver
+            Broadcast @evPlayer 5s "{$baseText}Let's play russian rulette!"
+            stop
+        end
+
+        # HP change 
+        if $effect == 2
+            $newHP = RandomNum 1 150 int
+            SetHealth @evPlayer $newHP
+            SetMaxHealth @evPlayer $newHP
+
+            Broadcast @evPlayer 5s "{$baseText}You now have {$newHP} HP!"
+            stop
+        end
+
+        # rave 
+        if $effect == 3
+            *room = {@evPlayer roomRef}
+
+            # explode player if he isnt in a room
+            if not {ValidRef *room}
+                Explode @evPlayer
+                stop
+            end
+
+            # we are blocking the use of the coin for the player
+            # until the rave is over
+            SetPlayerData @evPlayer "coin locked" true
+
+            Broadcast @evPlayer 5s "{$baseText}Time for a rave!"
+
+            CloseDoor *room
+            LockDoor *room AdminCommand
+            SetLightColor *room #000000
+
+            repeat 5
+                TransitionLightColor *room #ff0000ff .5s
+                Wait .5s
+                TransitionLightColor *room #00ff00ff .5s
+                Wait .5s
+                TransitionLightColor *room #0000ffff .5s
+                Wait .5s
+            end
+
+            Wait .1s
+            UnlockDoor *room
+            ResetLightColor *room
+
+            SetPlayerData @evPlayer "coin locked" false
+            stop
+        end
+
+        # bomb 
+        if $effect == 4
+            SetPlayerData @evPlayer "coin locked" true
+            $initRole = {@evPlayer role}
+
+            Countdown @evPlayer 15s "{$baseText}<color=red>You have %seconds% seconds left to live!"
+
+            # waiting 15 seconds here
+            repeat 15
+                Wait 1s
+
+                # every second we are checking if the role of the player changed
+                # if so, we remove the countdown and unlock the coin
+                if {@evPlayer role} != $initRole
+                    ClearCountdown @evPlayer
+                    SetPlayerData @evPlayer "coin locked" false
+                    stop
+                end
+            end
+
+            Explode @evPlayer
+            SetPlayerData @evPlayer "coin locked" false
+            stop
+        end
+
+        # bypass
+        if $effect == 5
+            $initRole = {@evPlayer role}
+            SetPlayerData @evPlayer "coin locked" true
+
+            Countdown @evPlayer 15s "{$baseText}You can now open any keycard locked thing! (for %seconds% seconds)"
+            Bypass @evPlayer true
+
+            repeat 15
+                Wait 1s
+
+                if {@evPlayer role} != $initRole
+                    ClearCountdown @evPlayer
+                    break
+                end
+            end
+
+            Bypass @evPlayer false
+            SetPlayerData @evPlayer "coin locked" false
+            stop
+        end
+
+        # role downgrade 
+        if $effect == 6
+            if {@evPlayer role} != "ClassD"
+                SetRole @evPlayer ClassD None
+            elif {@evPlayer role} != "Scp0492"
+                SetRole @evPlayer Scp0492
+            else
+                SetRole @evPlayer Spectator
+            end
+
+            Broadcast @evPlayer 5s "{$baseText}Your role got downgraded!"
+            stop
+        end
+
+        # funny cassie
+        if $effect == 7
+            SetPlayerData @evPlayer "coin locked" true
+
+            Cassie noJingle "pitch_0.7 warning . pitch_3 XMAS_JINGLEBELLS" ""
+            Broadcast @evPlayer 5s "{$baseText}Most useful cassie message sent!"
+
+            Wait 7s
+            SetPlayerData @evPlayer "coin locked" false
+            stop
+        end
+
+        # change size
+        if $effect == 8
+            # set player size in every direction to a random number between 10% and 100%
+            SetSize @evPlayer {RandomNum 0.1 1} {RandomNum 0.1 1} {RandomNum 0.1 1}
+
+            Broadcast @evPlayer 5s "{$baseText}Your size has changed a little!"
+            stop
+        end
+
+        # swap places 
+        if $effect == 9
+            # cant swap places if there arent at least 2 players
+            if {AmountOf @alivePlayers} < 2
+                Explode @evPlayer
+                stop
+            end
+
+            # gets a random player that is not @evPlayer
+            @swapPlayer = LimitPlayers {RemovePlayers * @evPlayer} 1
+            $swapX = {@swapPlayer positionX}
+            $swapY = {@swapPlayer positionY}
+            $swapZ = {@swapPlayer positionZ}
+
+            # we can teleport @swapPlayer directly to @evPlayer
+            TPPlayer @swapPlayer @evPlayer 
+            Broadcast @swapPlayer 5s "{$baseText}You have swapped places with {@evPlayer name}"
+
+            # because @swapPlayer is in the same place as @evPlayer, we need to use the saved values to teleport
+            TPPosition @evPlayer $swapX $swapY $swapZ
+            Broadcast @evPlayer 5s "{$baseText}You have swapped places with {@swapPlayer name}"
+            stop
+        end
+        """;
+}

ExampleScripts/Scripts/InviteInfoScript.cs

@@ -0,0 +1,36 @@
+namespace SER.Examples;
+
+public class DoorRestartScript : IExample
+{
+    public string Name => "doorRestart";
+
+    public string Content =>
+        """
+        # initial cassie announcement
+        Cassie jingle "ATTENTIONALLPERSONNEL . DOOR CONTROL CONSOLE MALFUNCTION DETECTED . INITIALIZING REACTIVATION SEQUENCE . ATTEMPTING FULL SYSTEM REACTIVATION IN . 3 . 2 . 1" "Attention all personnel. Door control console malfunction detected.<split>Initializing reactivation sequence. Attempting full system reactivation in..."
+
+        # wait for cassie to finish before restarting doors
+        Wait 1s
+        WaitUntil ({IsCassieSpeaking} == false)
+
+        # restart effects
+        LightsOut * 15s
+        CloseDoor *
+        LockDoor * NoPower
+
+        # cassie for spooky effect
+        repeat 2
+            Cassie noJingle "pitch_{RandomNum 0.15 0.25} .g{RandomNum 1 6 int}"
+        end
+
+        # duration of the restart
+        Wait 15s
+
+        # revert to unlocked
+        UnlockDoor *
+
+        # cassie information that restart was successful
+        ClearCassie
+        Cassie jingle "DOOR CONTROL CONSOLE SUCCESSFULLY ACTIVATED . SYSTEM IS BACK IN OPERATIONAL MODE" "Door control console successfully activated.<split>System is back in operational mode."
+        """;
+}

Examples/ChaosCoinScript.cs

@@ -0,0 +1,7 @@
+namespace SER.Examples;
+
+public interface IExample
+{
+    public string Name { get; }
+    public string Content { get; }
+}

Examples/DoorRestartScript.cs

@@ -0,0 +1,35 @@
+namespace SER.Examples;
+
+public class RaveScript : IExample
+{
+    public string Name => "rave";
+
+    public string Content =>
+        """
+        # confirm that @sender variable was created
+        if {VarExists @sender} == false
+            Reply "you need to run this script through remote admin!"
+            stop
+        end
+        
+        # the values for the rave
+        $duration = .5s
+        *room = {@sender roomRef}
+        
+        # changing colors for the room
+        repeat 20
+            TransitionLightColor *room #ff0000ff $duration
+            Wait $duration
+            
+            TransitionLightColor *room #00ff00ff $duration
+            Wait $duration
+            
+            TransitionLightColor *room #0000ffff $duration
+            Wait $duration
+        end
+        
+        # reset color to default
+        Wait 1ms
+        ResetLightColor *room
+        """;
+}

Examples/IExample.cs

@@ -0,0 +1,30 @@
+namespace SER.Examples;
+
+public class ScanScript : IExample
+{
+    public string Name => "scan";
+
+    public string Content =>
+        """
+        # scan beginning announcement
+        Cassie jingle "a facility scan is commencing" "A facility scan is commencing..."
+
+        Wait 1s
+        WaitUntil (not {IsCassieSpeaking})
+
+        repeat 3
+            Wait 10s
+            
+            # scan sound
+            Cassie noJingle "pitch_0.3 .G1 .G4" ""
+        end
+
+        # wait until cassie finishes
+        Wait 10s
+
+        # results
+        $cassie = "scan complete . {AmountOf @scpPlayers} scpsubjects remaining . {AmountOf @classDPlayers} class d personnel remaining . {AmountOf @scientistPlayers} scientist personnel remaining . {AmountOf @foundationForcePlayers} foundation forces remaining . {AmountOf @chaosInsurgencyPlayers} hostileforces remaining . . . . ."
+        $translation = "<br><size=30><color=red>[{AmountOf @scpPlayers}] SCP subjects</color><br><color=#FF8E00>[{AmountOf @classDPlayers}] Class-D personnel</color><br><color=#FFFF7C>[{AmountOf @scientistPlayers}] Scientist personnel</color><br><color=#70C3FF>[{AmountOf @foundationForcePlayers}] Foundation forces</color><br><color=#15853D>[{AmountOf @chaosInsurgencyPlayers}] Hostile forces</color>"
+        Cassie jingle $cassie $translation
+        """;
+}

Examples/RaveScript.cs

@@ -0,0 +1,19 @@
+namespace SER.Examples;
+
+public class WelcomeScript : IExample
+{
+    public string Name => "welcome";
+
+    public 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 name}!</size></color>\n<color=#ebebb9><size=20>This server is using <u>Scripted Events Reloaded</u>, enjoy your stay!</size></color></b>"
+        
+        # information for the server owner to visit the scripts folder
+        Hint @evPlayer 10s "<line-height=1000%><br></line-height><b><size=30>This is the default message.<br>You can modify it - as well as any other example script - by going to the SER folder in plugin configs."
+        """;
+}

Examples/ScanScript.cs

@@ -35,11 +35,6 @@ public static void Error(string scrName, string msg)
         Logger.Raw($"[Script '{scrName}'] {msg}", ConsoleColor.Red);
     }
 
-    public static void Assert(bool condition, string msg)
-    {
-        if (!condition) throw new AndrzejFuckedUpException(msg);
-    }
-
     public static void D(string msg)
     {
         #if DEBUG