Expand playlist ids for soundpack #56045
Conversation
stop_music function did not clear the playlist_indexes vector.
Update master to original project
# Conflicts: # src/do_turn.cpp
It now supports 4 different ids of, 1. mp3 2. instrument 3. sound 4. title mp3 is triggered when an item with MP3 flag is activated. instrument is triggered when a musical instrument is played by the player. sound is triggered when player character hears any sound that is classified as music title is the base. It will always remain triggered. When multiple ids are triggered at the same time, the one with higher priority(the order is as written above) gets played.
github-actions
bot
added
[C++]
NetSysFire
added
<Enhancement / Feature>
|
You need to fix your PR summary but you almost got it right. See https://github.com/CleverRaven/Cataclysm-DDA/blob/master/.github/CONTRIBUTING.md#all-prs-should-have-a-summary-section-with-one-line Just remove the dummy 'Category "Brief summary"' |
|
Also ping @dseguin, looks like you have done lots related to the sound system in the past so you may be interested in this PR |
github-actions
bot
added
the
BasicBuildPassed
github-actions
bot
removed
the
SDL: Tiles / Sound
Thanks! I think I changed it correctly based on your suggestion, though I'm very new to all this so it's entirely possible I still messed up somehow lol. |
There was a problem hiding this comment.
I agree with anothersimulacrum's suggestion, it might be better to add the enum conversions as a io:: template (see widget.cpp, line 56 for some examples).
I think it would be a bonus if the new headers could be added to the list in alphabetical order (ex: #include "music.h" between #include "mtype.h" and #include "mutation.h")
(again, changes are not necessary, except for the string comparisons because it triggers clang-tidy)
Otherwise, looks good! Glad to see people working on the sound stuff :)
Mainly, 1. Change music_id_list to use std::map, and change related codes accordingly. 2. Reimplement enum_to_string for music_id in io namespace, and remove my separate implementation of string_to_enum 3. Place #include directive for music.h in correct alphabetical order alongside its buddies. 4. Add whitespace before EOF as per project convention. 5. Replace string comparison method call with comparison operator.
Thanks for reviewing my code! I applied most of the suggested changes in this commit(MegasKomnenos@fc934d8). It's nice getting a better grasp of the conventions and stuff, so thanks for helping me out with that! And yeah, sound is a really cool part of any game, and I think I wanted to expand upon that based on an idea that I got. |
github-actions
bot
added
the
astyled
|
So, are there more stuffs remaining that I can do for the merge? |
|
Can you update the documentation with this neaw feature please? https://github.com/CleverRaven/Cataclysm-DDA/blob/master/doc/SOUNDPACKS.md |
Sure. I was about to make a new PR that fixes some issues, so I think I can do that along with what I was going to do anyway. |
Summary
Features "Add new id hooks that soundpack creators can use to control which playlist is played at which situation."
Purpose of change
Soundpack creators can use the 'playlist' feature to add a playlist of background musics. However, there is practically no control on which playlist will be played at a given situation. There's is only one id that playlists can use, which is 'title', and that's really not that much. Specifically, I wanted to give players an experience similar to fallout, where you can turn on the radio and listen to the music being played.
Describe the solution
I added a set of new functions in music.h/music.cpp which manages which music id is activated at a given time. I added function call to its related functions in iuse.cpp, iuse_actor.cpp sounds.cpp, sdlsound.cpp, do_turn.cpp, and main_menu.cpp to make correct music id be activated at a correct situation, and to make correct playlist be played depending on currently activated music ids.
Testing
More help would be very welcome. I did some very rudimentary tests where I opened up a game and spawned in acoustic guitar, mp3 player, smartphone, and stereo to confirm that they work. My machine is in linux, and I did not test in windows.
Additional context
I made a test soundpack to use for testing this feature.
https://drive.google.com/file/d/1w0fhbKPmPTxOg_152Qw__Bawhq2xATIf/view?usp=sharing