Added Entity.emit_sound, Player.play_sound and Player.stop_sound.

Author: L'In20Cible

addons/source-python/packages/source-python/engines/sound.py

@@ -29,8 +29,6 @@
 from entities.constants import INVALID_ENTITY_INDEX
 #   Filesystem
 from filesystem import SourceFile
-#   Filters
-from filters.recipients import RecipientFilter
 #   Mathlib
 from mathlib import NULL_VECTOR
 #   Paths
@@ -146,6 +144,9 @@ def __init__(
 
     def play(self, *recipients):
         """Play the sound."""
+        # Done here to fix a cyclic import...
+        from filters.recipients import RecipientFilter
+
         # Get the recipients to play the sound to
         recipients = RecipientFilter(*recipients)
 

addons/source-python/packages/source-python/entities/entity.py

@@ -12,8 +12,17 @@
 # Source.Python Imports
 #   Core
 from core import GAME_NAME
+#   Entities
+from entities.constants import INVALID_ENTITY_INDEX
 #   Engines
 from engines.precache import Model
+from engines.sound import Attenuation
+from engines.sound import Channel
+from engines.sound import Pitch
+from engines.sound import Sound
+from engines.sound import SoundFlags
+from engines.sound import StreamSound
+from engines.sound import VOL_NORM
 from engines.trace import engine_trace
 from engines.trace import ContentMasks
 from engines.trace import GameTrace
@@ -31,6 +40,8 @@
 from entities.helpers import wrap_entity_mem_func
 #   Filters
 from filters.weapons import WeaponClassIter
+#   Mathlib
+from mathlib import NULL_VECTOR
 #   Memory
 from memory import get_object_pointer
 from memory import make_object
@@ -502,6 +513,52 @@ def lookup_attachment(self, name):
         # No attachment found
         return INVALID_ATTACHMENT_INDEX
 
+    def emit_sound(
+            self, sample, recipients=(), volume=VOL_NORM,
+            attenuation=Attenuation.NONE, channel=Channel.AUTO,
+            flags=SoundFlags.NO_FLAGS, pitch=Pitch.NORMAL, origin=NULL_VECTOR,
+            direction=NULL_VECTOR, origins=(), update_positions=True,
+            sound_time=0.0, speaker_entity=INVALID_ENTITY_INDEX,
+            download=False, stream=False):
+        """Emit a sound from this entity.
+
+        :param str sample: Sound file relative to the "sounds" directory.
+        :param RecipientFilter recipients: Recipients to emit the sound to.
+        :param int index: Index of the entity to emit the sound from.
+        :param float volume: Volume of the sound.
+        :param Attenuation attenuation: How far the sound should reaches.
+        :param int channel: Channel to emit the sound with.
+        :param SoundFlags flags: Flags of the sound.
+        :param Pitch pitch: Pitch of the sound.
+        :param Vector origin: Origin of the sound.
+        :param Vector direction: Direction of the sound.
+        :param tuple origins: Origins of the sound.
+        :param bool update_positions: Whether or not the positions should be
+            updated.
+        :param float sound_time: Time to play the sound for.
+        :param int speaker_entity: Index of the speaker entity.
+        :param bool download: Whether or not the sample should be added to the
+            downloadables.
+        :param bool stream: Whether or not the sound should be streamed.
+        """
+        # Get the correct Sound class...
+        if not stream:
+            sound_class = Sound
+        else:
+            sound_class = StreamSound
+
+        # Get the sound...
+        sound = sound_class(sample, self.index, volume, attenuation, channel,
+            flags, pitch, origin, direction, origins, update_positions,
+            sound_time, speaker_entity, download)
+
+        # Make sure we have a tuple as recipients...
+        if not isinstance(recipients, tuple):
+            recipients = (recipients,)
+
+        # Emit the sound to the given recipients...
+        sound.play(*recipients)
+
     def is_in_solid(
             self, mask=ContentMasks.ALL, generator=BaseEntityGenerator):
         """Return whether or not the entity is in solid."""

addons/source-python/packages/source-python/players/_base.py

@@ -19,6 +19,15 @@
 from engines.server import engine_server
 from engines.server import execute_server_command
 from engines.server import server_game_dll
+from engines.sound import Attenuation
+from engines.sound import Channel
+from engines.sound import engine_sound
+from engines.sound import Pitch
+from engines.sound import Sound
+from engines.sound import SoundFlags
+from engines.sound import SOUND_FROM_WORLD
+from engines.sound import StreamSound
+from engines.sound import VOL_NORM
 from engines.trace import engine_trace
 from engines.trace import ContentMasks
 from engines.trace import GameTrace
@@ -39,6 +48,7 @@
 #   Filters
 from filters.entities import EntityIter
 #   Mathlib
+from mathlib import NULL_VECTOR
 from mathlib import Vector
 from mathlib import QAngle
 #   Memory
@@ -619,6 +629,58 @@ def ban(self, duration=0, kick=True, write_ban=True):
         if write_ban:
             execute_server_command('writeid')
 
+    def play_sound(
+            self, sample, volume=VOL_NORM, attenuation=Attenuation.NONE,
+            channel=Channel.AUTO, flags=SoundFlags.NO_FLAGS,
+            pitch=Pitch.NORMAL, origin=NULL_VECTOR, direction=NULL_VECTOR,
+            origins=(), update_positions=True, sound_time=0.0,
+            speaker_entity=INVALID_ENTITY_INDEX, download=False,
+            stream=False):
+        """Play a sound to the player.
+
+        :param str sample: Sound file relative to the "sounds" directory.
+        :param float volume: Volume of the sound.
+        :param Attenuation attenuation: How far the sound should reaches.
+        :param int channel: Channel to emit the sound with.
+        :param SoundFlags flags: Flags of the sound.
+        :param Pitch pitch: Pitch of the sound.
+        :param Vector origin: Origin of the sound.
+        :param Vector direction: Direction of the sound.
+        :param tuple origins: Origins of the sound.
+        :param bool update_positions: Whether or not the positions should be
+            updated.
+        :param float sound_time: Time to play the sound for.
+        :param int speaker_entity: Index of the speaker entity.
+        :param bool download: Whether or not the sample should be added to the
+            downloadables.
+        :param bool stream: Whether or not the sound should be streamed.
+        """
+        # Don't bother playing sounds to bots...
+        if self.is_fake_client():
+            return
+
+        # Get the correct Sound class...
+        if not stream:
+            sound_class = Sound
+        else:
+            sound_class = StreamSound
+
+        # Get the sound...
+        sound = sound_class(sample, SOUND_FROM_WORLD, volume, attenuation,
+            channel, flags, pitch, origin, direction, origins,
+            update_positions, sound_time, speaker_entity, download)
+
+        # Play the sound to the player...
+        sound.play(self.index)
+
+    def stop_sound(self, sample, channel=Channel.AUTO):
+        """Stop the given sound from being played to the player.
+
+        :param str sample: Sound file relative to the "sounds" directory.
+        :param Channel channel: Te channel of the sound.
+        """
+        engine_sound.stop_sound(self.index, channel, sample)
+
     # =========================================================================
     # >> PLAYER WEAPON FUNCTIONALITY
     # =========================================================================