mm icon indicating copy to clipboard operation
mm copied to clipboard

Audio Sfx (code_801A5BD0 and selected sfx functions in code_8019AF00.c) OK and Documented

Open engineer124 opened this issue 2 years ago • 5 comments

Before opening this PR, ensure the following:

  • ./format.sh was run to apply standard formatting.
  • make successfully builds a matching ROM.
  • No new compiler warnings were introduced during the build process.
    • Can be verified locally by running tools/warnings_count/check_new_warnings.sh
  • New variables & functions should follow standard naming conventions.
  • Comments and variables have correct spelling.

The next audio file, this one primarily focusing on the high level processing of sfx's specifically.

engineer124 avatar Apr 19 '22 09:04 engineer124

For reference, I decided to change the following names, although feedback is still welcome: gSfxDefaultPosScreenCenter -> gSfxPosScreenCenter gSfxDefaultVolOrFreq -> gSfxVolOrFreqDefaultVal gSfxDefaultReverbAddNone -> gSfxReverbAddNone

engineer124 avatar Apr 20 '22 00:04 engineer124

I'll be drafting this until PlayState is renamed https://github.com/zeldaret/mm/pull/835

engineer124 avatar Jun 08 '22 00:06 engineer124

This PR can now be undrafted or is it waiting for something else?

AngheloAlf avatar Jul 24 '22 13:07 AngheloAlf

Sorry, should have mentioned this PR is on hold for https://github.com/zeldaret/mm/pull/927

engineer124 avatar Jul 24 '22 14:07 engineer124

This PR is now ready for review again. Documentation has had an overhaul due to new and improved knowledge. Also, a few functions from code_8019AF00.c are also part of the audio sfx system and are now included in this PR, as those functions closely tie in with code_801A5BD0.c

engineer124 avatar Aug 10 '22 22:08 engineer124