Fix SoundEvent name collisions by using InstanceID-based unique identifiers #48
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…cts and whitespace handling Previously, SoundEvent identification depended solely on an asset's name. If multiple assets shared the same name—even if located in different paths—it caused collisions, and spaces in asset names led to additional issues. To address these problems, the naming convention has been updated in two specific places: ## PHASESource.cs When playing a SoundEvent, instead of passing `_soundEvent.name` to `Helpers.PHASEPlaySoundEvent`, the code now passes a unique identifier created by concatenating `"SoundEvent_"` with `_soundEvent.GetInstanceID().ToString()`. This change ensures that each SoundEvent played by a PHASESource is uniquely identified at runtime. ## PHASESoundEventNodeGraph.cs During the registration of a SoundEvent asset via `Helpers.PHASERegisterSoundEventAsset`, the asset name parameter is now set to `"SoundEvent_" + GetInstanceID().ToString()` instead of the original asset name. This prevents conflicts when multiple assets share the same name or contain spaces. These modifications guarantee that each SoundEvent, even with identical or whitespace-containing names, will have a unique identifier based on its runtime InstanceID, thereby eliminating naming collisions.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Previously, SoundEvent identification relied solely on the asset's name. If multiple assets shared the same name—even if stored in different directories—it caused naming conflicts. Additionally, spaces in asset names led to registration and playback issues.
Solution
To ensure each SoundEvent has a unique identifier and to avoid whitespace-related issues, the naming convention has been updated in the following locations:
PHASESource.cs
Helpers.PHASEPlaySoundEvent, the_soundEvent.nameparameter has been replaced with"SoundEvent_" + _soundEvent.GetInstanceID().ToString().PHASESourcehas a unique name at runtime.PHASESoundEventNodeGraph.cs
Helpers.PHASERegisterSoundEventAssethas been updated to"SoundEvent_" + GetInstanceID().ToString(), ensuring that even if multiple assets have the same name or contain spaces, they will be uniquely registered.Impact
Testing
Additional Notes