Reorganized _engines._sound

Renamed Channels to Channel
Renamed Attenuations to Attenuation
Fixed Attenuation enum (its members are floats -- not ints)

Author: Ayuto

Diff for: addons/source-python/packages/source-python/engines/sound.py

@@ -7,6 +7,7 @@
 # =============================================================================
 # Python Imports
 #   Enum
+from enum import Enum
 from enum import IntEnum
 
 # Source.Python Imports
@@ -28,7 +29,7 @@
 # =============================================================================
 # Source.Python Imports
 #   Engines
-from _engines._sound import Channels
+from _engines._sound import Channel
 from _engines._sound import VOL_NORM
 from _engines._sound import ATTN_NONE
 from _engines._sound import ATTN_NORM
@@ -38,9 +39,7 @@
 from _engines._sound import ATTN_GUNFIRE
 from _engines._sound import MAX_ATTENUATION
 from _engines._sound import SoundFlags
-from _engines._sound import PITCH_NORM
-from _engines._sound import PITCH_LOW
-from _engines._sound import PITCH_HIGH
+from _engines._sound import Pitch
 from _engines._sound import SOUND_FROM_LOCAL_PLAYER
 from _engines._sound import SOUND_FROM_WORLD
 from _engines._sound import engine_sound
@@ -49,9 +48,9 @@
 # =============================================================================
 # >> ALL DECLARATION
 # =============================================================================
-__all__ = ('Attenuations',
-           'Channels',
-           'PitchTypes',
+__all__ = ('Attenuation',
+           'Channel',
+           'Pitch',
            'SOUND_FROM_LOCAL_PLAYER',
            'SOUND_FROM_WORLD',
            'Sound',
@@ -71,7 +70,7 @@
 # =============================================================================
 # >> ENUMERATORS
 # =============================================================================
-class Attenuations(IntEnum):
+class Attenuation(float, Enum):
     """Attenuation values wrapper enumerator."""
 
     NONE = ATTN_NONE
@@ -83,14 +82,9 @@ class Attenuations(IntEnum):
     MAXIMUM = MAX_ATTENUATION
 
 
-class PitchTypes(IntEnum):
-    """Pitch values wrapper enumerator."""
-
-    NORMAL = PITCH_NORM
-    LOW = PITCH_LOW
-    HIGH = PITCH_HIGH
-
-
+# =============================================================================
+# >> CLASSES
+# =============================================================================
 class Sound(AutoUnload):
     """Class used to interact with a specific sound file."""
 
@@ -100,8 +94,8 @@ class Sound(AutoUnload):
 
     def __init__(
             self, recipients, index, sample, volume=VOL_NORM,
-            attenuation=Attenuations.NONE, channel=Channels.AUTO,
-            flags=0, pitch=PitchTypes.NORMAL, origin=NULL_VECTOR,
+            attenuation=Attenuation.NONE, channel=Channel.AUTO,
+            flags=0, pitch=Pitch.NORMAL, origin=NULL_VECTOR,
             direction=NULL_VECTOR, origins=(), update_positions=True,
             sound_time=0.0, speaker_entity=-1, download=False):
         """Store all the given attributes and set the module for unloading."""

Diff for: src/core/modules/engines/engines_sound_wrap.cpp

@@ -47,6 +47,11 @@ extern IEngineSound* enginesound;
 // Forward declarations.
 //---------------------------------------------------------------------------------
 void export_engine_sound(scope);
+void export_channel(scope);
+void export_global_sound_variables(scope);
+void export_attenuation(scope);
+void export_sound_flags_t(scope);
+void export_pitch(scope);
 
 
 //---------------------------------------------------------------------------------
@@ -55,6 +60,11 @@ void export_engine_sound(scope);
 DECLARE_SP_SUBMODULE(_engines, _sound)
 {
 	export_engine_sound(_sound);
+	export_channel(_sound);
+	export_global_sound_variables(_sound);
+	export_attenuation(_sound);
+	export_sound_flags_t(_sound);
+	export_pitch(_sound);
 }
 
 
@@ -124,9 +134,15 @@ void export_engine_sound(scope _sound)
 	) ADD_MEM_TOOLS(IEngineSound); // IEngineSound_Visitor
 
 	_sound.attr("engine_sound") = object(ptr(enginesound));
+}
+
 
-	// Channels
-	enum_<int>("Channels")
+//---------------------------------------------------------------------------------
+// Exports Channel.
+//---------------------------------------------------------------------------------
+void export_channel(scope _sound)
+{
+	enum_<int>("Channel")
 		.value("REPLACE", CHAN_REPLACE)
 		.value("AUTO", CHAN_AUTO)
 		.value("WEAPON", CHAN_WEAPON)
@@ -138,20 +154,42 @@ void export_engine_sound(scope _sound)
 		.value("VOICE_BASE", CHAN_VOICE_BASE)
 		.value("USER_BASE", CHAN_USER_BASE)
 	;
+}
 
+
+//---------------------------------------------------------------------------------
+// Exports volume values.
+//---------------------------------------------------------------------------------
+void export_global_sound_variables(scope _sound)
+{
 	// Common volume values
 	_sound.attr("VOL_NORM") = VOL_NORM;
 
-	// Common attenuation values
+	_sound.attr("SOUND_FROM_LOCAL_PLAYER") = SOUND_FROM_LOCAL_PLAYER;
+	_sound.attr("SOUND_FROM_WORLD") = SOUND_FROM_WORLD;
+}
+
+
+//---------------------------------------------------------------------------------
+// Exports attenuation values.
+//---------------------------------------------------------------------------------
+void export_attenuation(scope _sound)
+{
 	_sound.attr("ATTN_NONE") = ATTN_NONE;
 	_sound.attr("ATTN_NORM") = ATTN_NORM;
 	_sound.attr("ATTN_IDLE") = ATTN_IDLE;
 	_sound.attr("ATTN_STATIC") = ATTN_STATIC;
 	_sound.attr("ATTN_RICOCHET") = ATTN_RICOCHET;
 	_sound.attr("ATTN_GUNFIRE") = ATTN_GUNFIRE;
 	_sound.attr("MAX_ATTENUATION") = MAX_ATTENUATION;
+}
+
 
-	// Flags for iFlags fields
+//---------------------------------------------------------------------------------
+// Exports SoundFlags_t.
+//---------------------------------------------------------------------------------
+void export_sound_flags_t(scope _sound)
+{
 	enum_<SoundFlags_t>("SoundFlags")
 		.value("NOFLAGS", SND_NOFLAGS)
 		.value("CHANGE_VOL", SND_CHANGE_VOL)
@@ -165,12 +203,19 @@ void export_engine_sound(scope _sound)
 		.value("IGNORE_PHONEMES", SND_IGNORE_PHONEMES)
 		.value("IGNORE_NAME", SND_IGNORE_NAME)
 	;
+}
 
-	// Common pitch values
-	_sound.attr("PITCH_NORM") = PITCH_NORM;
-	_sound.attr("PITCH_LOW") = PITCH_LOW;
-	_sound.attr("PITCH_HIGH") = PITCH_HIGH;
 
-	_sound.attr("SOUND_FROM_LOCAL_PLAYER") = SOUND_FROM_LOCAL_PLAYER;
-	_sound.attr("SOUND_FROM_WORLD") = SOUND_FROM_WORLD;
+//---------------------------------------------------------------------------------
+// Exports pitch values.
+//---------------------------------------------------------------------------------
+void export_pitch(scope _sound)
+{
+	enum Pitch {};
+
+	enum_<Pitch> _Pitch("Pitch");
+
+	_Pitch.value("NORMAL", (Pitch) PITCH_NORM);
+	_Pitch.value("LOW", (Pitch) PITCH_LOW);
+	_Pitch.value("HIGH", (Pitch) PITCH_HIGH);
 }

Diff for: src/core/modules/engines/engines_trace_wrap.cpp

@@ -61,6 +61,7 @@ void export_content_flags(scope);
 void export_content_masks(scope);
 void export_surface_flags(scope);
 
+
 //---------------------------------------------------------------------------------
 // Declare the _trace module.
 //---------------------------------------------------------------------------------