remove * from valid options for PlayersArgument, update example scripts

Author: Elektryk-Andrzej

Code/ArgumentSystem/Arguments/PlayersArgument.cs

@@ -16,8 +16,7 @@ public class PlayersArgument(string name) : EnumHandlingArgument(name)
         $"Player variable (e.g. {PlayerVariableToken.Example}), " +
         $"RoleTypeId enum (e.g. ClassD), " +
         $"Team enum (e.g. SCPs), " +
-        $"player id's or name, " +
-        $"or * for every player";
+        $"player id's or name";
 
     [UsedImplicitly]
     public DynamicTryGet<Player[]> GetConvertSolution(BaseToken token)
@@ -32,11 +31,6 @@ public DynamicTryGet<Player[]> GetConvertSolution(BaseToken token)
             },
             () =>
             {
-                if (token is SymbolToken { IsJoker: true })
-                {
-                    return new(() => Player.ReadyList.ToArray());
-                }
-
                 if (!token.CanReturn<PlayerValue>(out var get))
                 {
                     return $"{token} does not represent a " +

Code/MethodSystem/Methods/PlayerDataMethods/GetPlayerDataMethod.cs

@@ -13,33 +13,47 @@ public class GetPlayerDataMethod : ReturningMethod, IAdditionalDescription, ICan
     public override string Description => "Gets player data from the key.";
 
     public string AdditionalDescription => 
-        "WARNING: This method will error if the key doesn't exist. " +
-        $"Use {NameOfMethod(typeof(HasPlayerDataMethod))} to verify if a key exists before calling this method.";
+        "It's recommended to set 'default value' argument for you to not get errors when the key doesn't exist " +
+        "for a given player!";
 
     public override TypeOfValue Returns => new UnknownTypeOfValue();
 
     public string[] ErrorReasons { get; } =
     [
-        "Key was not found for the player."
+        "Key %key% was not found for the player %player_name%."
     ];
 
     public override Argument[] ExpectedArguments { get; } =
     [
         new PlayerArgument("player"),
-        new TextArgument("key")
+        new TextArgument("key"),
+        new AnyValueArgument("default value")
+        {
+            Description = "If the key doesn't exist, this value will be returned.",
+            DefaultValue = new(null, "no default value - will error when key doesnt exist")
+        }
     ];
 
     public override void Execute()
     {
         var player = Args.GetPlayer("player");
         var key = Args.GetText("key");
 
-        if (!SetPlayerDataMethod.PlayerData.TryGetValue(player, out var dict) || 
-            !dict.TryGetValue(key, out var value))
+        if (SetPlayerDataMethod.PlayerData.TryGetValue(player, out var dict) &&
+            dict.TryGetValue(key, out var value))
         {
-            throw new ScriptRuntimeError(this, ErrorReasons[0]);
+            ReturnValue = value;
+        }
+        else if (Args.GetAnyValue("default value") is { } defaultValue)
+        {
+            ReturnValue = defaultValue;
+        }
+        else
+        {
+            throw new ScriptRuntimeError(
+                this,
+                ErrorReasons[0].Replace("%key%", key).Replace("%player_name%", player.Nickname)
+            );
         }
-
-        ReturnValue = value;
     }
 }

Example Scripts/chaosCoin.ser

@@ -47,7 +47,7 @@ if $effect is 3
     *room = @evPlayer -> roomRef
 
     # explode player if he isnt in a room
-    if *room is invalid
+    if {*room -> isInvalid}
         Explode @evPlayer
         stop
     end
@@ -171,7 +171,7 @@ if $effect is 9
     end
 
     # gets a random player that is not @evPlayer
-    @swapPlayer = Take {Except * @evPlayer} 1
+    @swapPlayer = Take {Except @all @evPlayer} 1
     $swapX = @swapPlayer -> posX
     $swapY = @swapPlayer -> posY
     $swapZ = @swapPlayer -> posZ

Example Scripts/custom roles/seniorGuardOnSpawned.ser

@@ -2,10 +2,10 @@
 -- forRoles senior_guard
 
 ClearInventory @evPlayer
+GiveItem @evPlayer GunFSP9
 GiveItem @evPlayer KeycardMTFPrivate
-GiveItem @evPlayer Radio
 GiveItem @evPlayer Medkit
 GiveItem @evPlayer GrenadeHE
-GiveItem @evPlayer Ammo9x19 3
+GiveItem @evPlayer Radio
 GiveItem @evPlayer ArmorCombat
-GiveItem @evPlayer GunFSP9
+GiveItem @evPlayer Ammo9x19 3

Example Scripts/killStreak.ser

@@ -11,13 +11,8 @@ if {VarExists @evAttacker} is false
 end
 
 # increment killer's streak
-$streak = GetPlayerData @evAttacker "streak"
-
-if $streak isnt invalid
-    $streak = $streak + 1
-else
-    $streak = 1
-end
+$streak = GetPlayerData @evAttacker "streak" 0
+$streak = $streak + 1
 
 # save the new kill streak
 SetPlayerData @evAttacker "streak" $streak

Example Scripts/surfaceSmite.ser

@@ -2,18 +2,18 @@
 -- availableFor RemoteAdmin
 -- description "Kills a random player currently in the Surface Zone."
 
-Countdown * 10s "A random person on surface is going to be killed in %seconds% seconds!"
+Countdown @all 10s "A random person on surface is going to be killed in %seconds% seconds!"
 wait 11s
 
 # 1. Get all players on the surface and limit the selection to 1 random person.
 @target = Take @surfacePlayers 1
 
 # 2. Check if anyone was actually found to avoid a runtime error.
 if {AmountOf @target} isnt 1
-    Broadcast * 5s "No players found in the Surface Zone!"
+    Broadcast @all 5s "No players found in the Surface Zone!"
     stop
 end
 
 # 3. Execute the kill with a custom reason.
 Kill @target "The surface is no longer safe."
-Broadcast * 5s "Eliminated {@target -> name} from the surface."
+Broadcast @all 5s "Eliminated {@target -> name} from the surface."

Example Scripts/zombie infection/onZombieBit.ser

@@ -22,14 +22,13 @@ if {Chance 50%}
     stop
 end
 
-*date = GetPlayerData @victim date_of_death_by_infection
-
-if *date is invalid
+if {HasPlayerData @victim date_of_death_by_infection} is false
     # set the date of death to 1 minute in the future
     *date = Date.Offset {Date.Current} add 1m
 else
     # when was bit before, remove 20 seconds from the date
     # so the infection happens faster
+    *date = GetPlayerData @victim date_of_death_by_infection
     *date = Date.Offset *date subtract 20s
 end
 

Example Scripts/zombie infection/zombieInfectionHandler.ser

@@ -9,16 +9,14 @@ forever
     over @all with @plr
         wait 1ms
 
-        *dateOfDeath = GetPlayerData @plr date_of_death_by_infection
-
-        # invalid -> infection date not set -> not infected
-        if *dateOfDeath is invalid
+        # infection date not set -> not infected
+        if {HasPlayerData @plr date_of_death_by_infection} is false
             continue
         end
-
+        
         # if the current date is "lower" than the date of death
         # it means that the player is not fully infected
-        if {Date.Current} < *dateOfDeath
+        if {Date.Current} < {GetPlayerData @plr date_of_death_by_infection}
             continue
         end