Audio Sfx Functions Decompiled and Documented (code_8019AF00.c) (#1242)

* sfx decomp and docs

* function headers

* namefixer

* oops

* better sfx name

* PR review

* namefixer

* PR review

* float

* namefixer

* namefixer

* namefixer

* PR Suggestions

1 files changed, 39 insertions, 39 deletions

diff --git a/docs/tutorial/advanced_control_flow.md b/docs/tutorial/advanced_control_flow.md
index aa4ba3621..0217cdde2 100644
--- a/docs/tutorial/advanced_control_flow.md
+++ b/docs/tutorial/advanced_control_flow.md
@@ -181,23 +181,23 @@ void func_809527F8(EnMs* this, PlayState* play) {
             if (temp_v0_2 != 1) {
 
             }
-            func_8019F230();
+            Audio_PlaySfx_MessageCancel();
             Message_ContinueTextbox(play, 0x934U);
             // Duplicate return node #17. Try simplifying control flow for better match
             return;
         }
         Message_CloseTextbox(play);
         if ((s32) gSaveContext.save.saveInfo.playerData.rupees < 0xA) {
-            play_sound(0x4806U);
+            Audio_PlaySfx(0x4806U);
             Message_ContinueTextbox(play, 0x935U);
             return;
         }
         if ((s32) gSaveContext.save.saveInfo.inventory.ammo[gItemSlots[0xA]] >= 0x14) {
-            play_sound(0x4806U);
+            Audio_PlaySfx(0x4806U);
             Message_ContinueTextbox(play, 0x937U);
             return;
         }
-        func_8019F208();
+        Audio_PlaySfx_MessageDecide();
         Actor_OfferGetItem((Actor *) this, play, 0x35, 90.0f, 10.0f);
         Rupees_ChangeBy(-0xA);
         this->actionFunc = func_809529AC;
@@ -277,24 +277,24 @@ block_11:
     if ((s32) gSaveContext.save.saveInfo.playerData.rupees >= 0xA) {
         goto block_13;
     }
-    play_sound(0x4806U);
+    Audio_PlaySfx(0x4806U);
     Message_ContinueTextbox(play, 0x935U);
     return;
 block_13:
     if ((s32) gSaveContext.save.saveInfo.inventory.ammo[gItemSlots[0xA]] < 0x14) {
         goto block_15;
     }
-    play_sound(0x4806U);
+    Audio_PlaySfx(0x4806U);
     Message_ContinueTextbox(play, 0x937U);
     return;
 block_15:
-    func_8019F208();
+    Audio_PlaySfx_MessageDecide();
     Actor_OfferGetItem((Actor *) this, play, 0x35, 90.0f, 10.0f);
     Rupees_ChangeBy(-0xA);
     this->actionFunc = func_809529AC;
     return;
 block_16:
-    func_8019F230();
+    Audio_PlaySfx_MessageCancel();
     Message_ContinueTextbox(play, 0x934U);
 block_17:
     return;
@@ -315,17 +315,17 @@ The simplest sort of block label to eliminate is one that is only used once, and
     if ((s32) gSaveContext.save.saveInfo.playerData.rupees >= 0xA) {
         goto block_13;
     }
-    play_sound(0x4806U);
+    Audio_PlaySfx(0x4806U);
     Message_ContinueTextbox(play, 0x935U);
     return;
 block_13:
 ```
 
-Currently, this says to jump over the code block `play_sound...` if the condition in the if is satisfied. In non-goto terms, this means that the block should be run if the condition is *not* satisfied. This also illustrates a general property of goto-only mode: you have to reverse the senses of all of the ifs. Therefore the appropriate approach is to swap the if round, put the code block inside, and remove the goto and the label:
+Currently, this says to jump over the code block `Audio_PlaySfx...` if the condition in the if is satisfied. In non-goto terms, this means that the block should be run if the condition is *not* satisfied. This also illustrates a general property of goto-only mode: you have to reverse the senses of all of the ifs. Therefore the appropriate approach is to swap the if round, put the code block inside, and remove the goto and the label:
 
 ```C
     if (gSaveContext.save.saveInfo.playerData.rupees < 0xA) {
-        play_sound(0x4806U);
+        Audio_PlaySfx(0x4806U);
         Message_ContinueTextbox(play, 0x935U);
         return;
     }
@@ -379,23 +379,23 @@ block_11:
     Message_CloseTextbox(play);
     
     if (gSaveContext.save.saveInfo.playerData.rupees < 0xA) {
-        play_sound(0x4806U);
+        Audio_PlaySfx(0x4806U);
         Message_ContinueTextbox(play, 0x935U);
         return;
     }
     if (gSaveContext.save.saveInfo.inventory.ammo[gItemSlots[0xA]] >= 0x14) {
-        play_sound(0x4806U);
+        Audio_PlaySfx(0x4806U);
         Message_ContinueTextbox(play, 0x937U);
         return;
     }
 
-    func_8019F208();
+    Audio_PlaySfx_MessageDecide();
     Actor_OfferGetItem((Actor *) this, play, 0x35, 90.0f, 10.0f);
     Rupees_ChangeBy(-0xA);
     this->actionFunc = func_809529AC;
     return;
 block_16:
-    func_8019F230();
+    Audio_PlaySfx_MessageCancel();
     Message_ContinueTextbox(play, 0x934U);
 block_17:
     return;
@@ -448,23 +448,23 @@ block_11:
     Message_CloseTextbox(play);
     
     if (gSaveContext.save.saveInfo.playerData.rupees < 0xA) {
-        play_sound(0x4806U);
+        Audio_PlaySfx(0x4806U);
         Message_ContinueTextbox(play, 0x935U);
         return;
     }
     if (gSaveContext.save.saveInfo.inventory.ammo[gItemSlots[0xA]] >= 0x14) {
-        play_sound(0x4806U);
+        Audio_PlaySfx(0x4806U);
         Message_ContinueTextbox(play, 0x937U);
         return;
     }
 
-    func_8019F208();
+    Audio_PlaySfx_MessageDecide();
     Actor_OfferGetItem((Actor *) this, play, 0x35, 90.0f, 10.0f);
     Rupees_ChangeBy(-0xA);
     this->actionFunc = func_809529AC;
     return;
 block_16:
-    func_8019F230();
+    Audio_PlaySfx_MessageCancel();
     Message_ContinueTextbox(play, 0x934U);   
 }
 ```
@@ -498,17 +498,17 @@ So let us rewrite the entire second half as a switch:
             Message_CloseTextbox(play);
             
             if (gSaveContext.save.saveInfo.playerData.rupees < 0xA) {
-                play_sound(0x4806U);
+                Audio_PlaySfx(0x4806U);
                 Message_ContinueTextbox(play, 0x935U);
                 return;
             }
             if (gSaveContext.save.saveInfo.inventory.ammo[gItemSlots[0xA]] >= 0x14) {
-                play_sound(0x4806U);
+                Audio_PlaySfx(0x4806U);
                 Message_ContinueTextbox(play, 0x937U);
                 return;
             }
 
-            func_8019F208();
+            Audio_PlaySfx_MessageDecide();
             Actor_OfferGetItem((Actor *) this, play, 0x35, 90.0f, 10.0f);
             Rupees_ChangeBy(-0xA);
             this->actionFunc = func_809529AC;
@@ -517,7 +517,7 @@ So let us rewrite the entire second half as a switch:
 
         case 1:
         default:
-            func_8019F230();
+            Audio_PlaySfx_MessageCancel();
             Message_ContinueTextbox(play, 0x934U);
             break;
     }
@@ -534,13 +534,13 @@ There's a couple of other obvious things here:
             Message_CloseTextbox(play);
             
             if (gSaveContext.save.saveInfo.playerData.rupees < 0xA) {
-                play_sound(0x4806U);
+                Audio_PlaySfx(0x4806U);
                 Message_ContinueTextbox(play, 0x935U);
             } else if (gSaveContext.save.saveInfo.inventory.ammo[gItemSlots[0xA]] >= 0x14) {
-                play_sound(0x4806U);
+                Audio_PlaySfx(0x4806U);
                 Message_ContinueTextbox(play, 0x937U);
             } else {
-                func_8019F208();
+                Audio_PlaySfx_MessageDecide();
                 Actor_OfferGetItem((Actor *) this, play, 0x35, 90.0f, 10.0f);
                 Rupees_ChangeBy(-0xA);
                 this->actionFunc = func_809529AC;
@@ -549,7 +549,7 @@ There's a couple of other obvious things here:
 
         case 1:
         default:
-            func_8019F230();
+            Audio_PlaySfx_MessageCancel();
             Message_ContinueTextbox(play, 0x934U);
             break;
     }
@@ -599,13 +599,13 @@ block_7:
                 Message_CloseTextbox(play);
                 
                 if (gSaveContext.save.saveInfo.playerData.rupees < 0xA) {
-                    play_sound(0x4806U);
+                    Audio_PlaySfx(0x4806U);
                     Message_ContinueTextbox(play, 0x935U);
                 } else if (gSaveContext.save.saveInfo.inventory.ammo[gItemSlots[0xA]] >= 0x14) {
-                    play_sound(0x4806U);
+                    Audio_PlaySfx(0x4806U);
                     Message_ContinueTextbox(play, 0x937U);
                 } else {
-                    func_8019F208();
+                    Audio_PlaySfx_MessageDecide();
                     Actor_OfferGetItem((Actor *) this, play, 0x35, 90.0f, 10.0f);
                     Rupees_ChangeBy(-0xA);
                     this->actionFunc = func_809529AC;
@@ -614,7 +614,7 @@ block_7:
 
             case 1:
             default:
-                func_8019F230();
+                Audio_PlaySfx_MessageCancel();
                 Message_ContinueTextbox(play, 0x934U);
                 break;
         }
@@ -664,13 +664,13 @@ void func_809527F8(EnMs* this, PlayState* play) {
                         Message_CloseTextbox(play);
 
                         if (gSaveContext.save.saveInfo.playerData.rupees < 0xA) {
-                            play_sound(0x4806U);
+                            Audio_PlaySfx(0x4806U);
                             Message_ContinueTextbox(play, 0x935U);
                         } else if (gSaveContext.save.saveInfo.inventory.ammo[gItemSlots[0xA]] >= 0x14) {
-                            play_sound(0x4806U);
+                            Audio_PlaySfx(0x4806U);
                             Message_ContinueTextbox(play, 0x937U);
                         } else {
-                            func_8019F208();
+                            Audio_PlaySfx_MessageDecide();
                             Actor_OfferGetItem((Actor *) this, play, 0x35, 90.0f, 10.0f);
                             Rupees_ChangeBy(-0xA);
                             this->actionFunc = func_809529AC;
@@ -679,7 +679,7 @@ void func_809527F8(EnMs* this, PlayState* play) {
 
                     case 1:
                     default:
-                        func_8019F230();
+                        Audio_PlaySfx_MessageCancel();
                         Message_ContinueTextbox(play, 0x934U);
                         break;
                 }
@@ -716,13 +716,13 @@ void func_809527F8(EnMs* this, PlayState* play) {
                         Message_CloseTextbox(play);
 
                         if (gSaveContext.save.saveInfo.playerData.rupees < 0xA) {
-                            play_sound(0x4806U);
+                            Audio_PlaySfx(0x4806U);
                             Message_ContinueTextbox(play, 0x935U);
                         } else if (gSaveContext.save.saveInfo.inventory.ammo[gItemSlots[0xA]] >= 0x14) {
-                            play_sound(0x4806U);
+                            Audio_PlaySfx(0x4806U);
                             Message_ContinueTextbox(play, 0x937U);
                         } else {
-                            func_8019F208();
+                            Audio_PlaySfx_MessageDecide();
                             Actor_OfferGetItem((Actor *) this, play, 0x35, 90.0f, 10.0f);
                             Rupees_ChangeBy(-0xA);
                             this->actionFunc = func_809529AC;
@@ -731,7 +731,7 @@ void func_809527F8(EnMs* this, PlayState* play) {
 
                     case 1:
                     default:
-                        func_8019F230();
+                        Audio_PlaySfx_MessageCancel();
                         Message_ContinueTextbox(play, 0x934U);
                         break;
                 }