Merge pull request #194 from Crystalwarrior:scuffed-sfx-command

Add an /sfx command

Author: Crystalwarrior

server/client_manager.py

@@ -1943,6 +1943,14 @@ def need_call_time(self):
         def need_call_time(self, value):
             self.server.client_manager.set_spam_delay(self.ipid, "need_call", value)
 
+        @property
+        def sfx_time(self):
+            return self.server.client_manager.get_spam_delay(self.ipid, "sfx")
+
+        @sfx_time.setter
+        def sfx_time(self, value):
+            self.server.client_manager.set_spam_delay(self.ipid, "sfx", value)
+
         @property
         def ip(self):
             """Get an anonymized version of the IP address."""
@@ -2219,6 +2227,12 @@ def set_need_call_delay(self):
             except:
                 self.need_call_time = round(time.time() * 1000 + 60000)
 
+        def set_sfx_delay(self):
+            """Begin the sfx cooldown."""
+            # 3 second delay by default
+            sfx_delay = 3000
+            self.sfx_time = round(time.time() * 1000.0 + sfx_delay)
+
         def can_call_case(self):
             """Whether or not the client can currently announce a case."""
             return (time.time() * 1000.0 - self.case_call_time) > 0
@@ -2227,6 +2241,10 @@ def can_call_need(self):
             """Whether or not the client can currently call a need."""
             return (time.time() * 1000.0 - self.need_call_time) > 0
 
+        def can_sfx(self):
+            """Whether or not the client can currently play an sfx."""
+            return (time.time() * 1000.0 - self.sfx_time) > 0
+
         def disemvowel_message(self, message):
             """Disemvowel a chat message."""
             message = re.sub("[aeiou]", "", message, flags=re.IGNORECASE)

server/commands/roleplay.py

@@ -38,6 +38,7 @@
     "ooc_cmd_format_timer",
     "ooc_cmd_timer_interval",
     "ooc_cmd_ooc_actions",
+    "ooc_cmd_sfx",
 ]
 
 
@@ -1124,3 +1125,49 @@ def ooc_cmd_ooc_actions(client, arg):
     if client.ooc_actions:
         stat = "now see"
     client.send_ooc(f"You will {stat} actions in OOC.")
+
+
+def ooc_cmd_sfx(client, arg):
+    """
+    Play a sound effect directly without associating it with an emote.
+    Usage: /sfx [sound_path]
+    """
+    if arg == "":
+        raise ArgumentError(
+            "sound_path can't be empty. Usage: /sfx [sound_path]"
+        )
+    is_mod = client.is_mod or client in client.area.owners
+    # Only incur cooldowns etc. on mods.
+    if not is_mod:
+        if client.char_id <= -1 or client.char_id == None:
+            raise ClientError(
+                "You can't play sfx when you're a spectator and not a CM/GM!"
+            )
+        if not client.can_sfx():
+            raise ClientError(
+                "You need to wait before playing sfx again!"
+            )
+    target_areas = [client.area]
+    if len(client.broadcast_list) > 0 and is_mod:
+        try:
+            a_list = ", ".join([str(a.id)
+                                for a in client.broadcast_list])
+            client.send_ooc(f"Broadcasting to areas {a_list}")
+            target_areas = client.broadcast_list
+        except:
+            client.send_ooc(
+                "Your broadcast list is invalid! Do /clear_broadcast to reset it and /broadcast <id(s)> to set a new one."
+            )
+            return
+    for area in target_areas:
+        # Plays on unused music layer 3 (max channel)
+        area.send_command("MC", f"../general/{arg}", -1, "", 0, 3, 0)
+        area.broadcast_ooc(f"[{client.id}] {client.showname} has played sfx '{arg}'.")
+        for a in area.broadcast_list:
+            # Plays on unused music layer 3 (max channel)
+            a.send_command("MC", f"../general/{arg}", -1, "", 0, 3, 0)
+            a.broadcast_ooc(f"[{client.id}] {client.showname} has played sfx '{arg}'.")
+    client.set_sfx_delay()
+    database.log_area(
+        "sfx", client, client.area, message=f"has played sfx {arg}"
+    )