Document JP func_80082BC8_837C8 and rename to draw_text_with_shadow (#719)

* Document and func_80082BC8_837C8 to draw_text_with_shadow

* Document for real this time

Author: davozebi

src/menu.c

@@ -3029,8 +3029,12 @@ void draw_menu_elements(s32 state, MenuElement *elems, f32 scale) {
     sMenuGuiOpacity = 255;
 }
 
+/**
+ * Draw text with a drop shadow on a dialogue box.
+ * Note: dialogueBoxID is always -1, so the global dialogue box is always used.
+ */
 #if REGION == REGION_JP
-void func_80082BC8_837C8(s32 dialogueBoxID, s32 xPos1, s32 yPos1, s32 xPos2, s32 yPos2, char *text,
+void draw_text_with_shadow(s32 dialogueBoxID, s32 xPos1, s32 yPos1, s32 xPos2, s32 yPos2, char *text,
                          AlignmentFlags alignment, s32 textColour, s32 alpha) {
     s32 opacity;
     opacity = textColour & 0xFF;
@@ -6848,7 +6852,7 @@ void charselect_render_text(UNUSED s32 updateRate) {
                 yPos = 234;
             }
 #if REGION == REGION_JP
-            func_80082BC8_837C8(-1, SCREEN_WIDTH_HALF, yPos, 1, 3, "OK?", ALIGN_MIDDLE_CENTER,
+            draw_text_with_shadow(-1, SCREEN_WIDTH_HALF, yPos, 1, 3, "OK?", ALIGN_MIDDLE_CENTER,
                                 COLOUR_RGBA32(255, 255, 255, 255), 0);
 #else
             draw_text(&sMenuCurrDisplayList, SCREEN_WIDTH_HALF, yPos, "OK?", ALIGN_MIDDLE_CENTER);
@@ -9456,7 +9460,7 @@ void trackmenu_setup_render(UNUSED s32 updateRate) {
                     regionOffset += 24;
                 }
 #if REGION == REGION_JP
-                func_80082BC8_837C8(-1, SCREEN_WIDTH_HALF, regionOffset + 172, 1, 3, "OK?", ALIGN_MIDDLE_CENTER,
+                draw_text_with_shadow(-1, SCREEN_WIDTH_HALF, regionOffset + 172, 1, 3, "OK?", ALIGN_MIDDLE_CENTER,
                                     COLOUR_RGBA32(255, 255, 255, 255), 0);
 #else
                 draw_text(&sMenuCurrDisplayList, SCREEN_WIDTH_HALF, regionOffset + 172, "OK?", ALIGN_MIDDLE_CENTER);
@@ -9978,7 +9982,7 @@ void adventuretrack_render(UNUSED s32 updateRate, s32 arg1, s32 arg2) {
 #endif
                         set_text_colour(255, 255, 255, 0, 255);
 #if REGION == REGION_JP
-                        func_80082BC8_837C8(-1, SCREEN_WIDTH_HALF, yOffset + 172, 1, 3, "OK?", ALIGN_MIDDLE_CENTER,
+                        draw_text_with_shadow(-1, SCREEN_WIDTH_HALF, yOffset + 172, 1, 3, "OK?", ALIGN_MIDDLE_CENTER,
                                             COLOUR_RGBA32(255, 255, 255, 255), 0);
 #else
                         draw_text(&sMenuCurrDisplayList, SCREEN_WIDTH_HALF, yOffset + 172, "OK?", ALIGN_MIDDLE_CENTER);
@@ -11320,7 +11324,7 @@ void results_render(UNUSED s32 updateRate, f32 opacity) {
         time = offsetX;
         x2 = offsetX;
 #if REGION == REGION_JP
-        func_80082BC8_837C8(-1, time - 40, y2 + offsetY + 2, 2, 2, gRacePlacementsArray[spA0], ALIGN_MIDDLE_CENTER,
+        draw_text_with_shadow(-1, time - 40, y2 + offsetY + 2, 2, 2, gRacePlacementsArray[spA0], ALIGN_MIDDLE_CENTER,
                             COLOUR_RGBA32(255, 255, 255, 255), 0);
 #else
         set_text_colour(0, 0, 0, 255, 255);

src/menu.h

@@ -740,7 +740,7 @@ void func_80084854(s32 updateRate);
 void func_80098774(s32);
 void postrace_viewport(UNUSED s32 updateRate);
 
-void func_80082BC8_837C8(s32 dialogueBoxID, s32 xPos1, s32 yPos1, s32 xPos2, 
+void draw_text_with_shadow(s32 dialogueBoxID, s32 xPos1, s32 yPos1, s32 xPos2, 
     s32 yPos2, char *text, AlignmentFlags alignment, s32 textColour, s32 alpha);
 
 typedef enum MenuTextures {

tools/python/score.py

@@ -114,7 +114,7 @@ def contains_forbidden_func(self, string):
 MAP_FILE = DkrMapFile()
 
 # Adding regional and other version functions here to ignore since we're only scoring US_1.0 for now.
-NOT_FUNCTION_NAMES = ['if', 'else', 'switch', 'while', 'for', 'dmacopy_internal', 'func_80082BC8_837C8', 'rumble_enable',
+NOT_FUNCTION_NAMES = ['if', 'else', 'switch', 'while', 'for', 'dmacopy_internal', 'draw_text_with_shadow', 'rumble_enable',
     'func_800C6464_C7064', 'func_800C663C_C723C', 'func_800C67F4_C73F4', 'func_800C6870_C7470',
     'func_800C68CC_C74CC', 'fontCreateDisplayList', 'func_800C7744_C8344', 'func_800C7804_C8404',
     'fontConvertString', 'func_800C78E0_C84E0']

ver/symbols/symbol_addrs.jpn.v79.txt

@@ -1324,7 +1324,7 @@ menu_number_render = 0x80081F14;
 postrace_offsets = 0x80082164;
 postrace_render = 0x8008225C;
 draw_menu_elements = 0x800824FC;
-func_80082BC8_837C8 = 0x80082BC8;
+draw_text_with_shadow = 0x80082BC8;
 trackmenu_set_records = 0x80082D78;
 menu_missing_controller = 0x80082EB8;
 menu_logos_screen_init = 0x80082F6C;