Slightly update DisplayHelpTextThisFrame (#1040)

* Slightly update DisplayHelpTextThisFrame Changed description and put parameters * Update DisplayHelpTextThisFrame.md Refactor parameter naming for improved clarity: Changed parameter names to use prefixes for clarity, i.e., 'bCurvedWindow'. This enhances readability, especially in dynamic languages where type information might not be explicit. --------- Co-authored-by: ammonia-cfx <[email protected]>
citizenfx · Mar 4, 2024 · 31864ad · 31864ad · freedy69 · Mar 4, 2024
1 parent 3f36443
commit 31864ad
Showing 1 changed file with 5 additions and 16 deletions.
diff --git a/HUD/DisplayHelpTextThisFrame.md b/HUD/DisplayHelpTextThisFrame.md
@@ -5,24 +5,13 @@ ns: HUD
 
 ```c
 // 0x960C9FF8F616E41C 0x18E3360A
-void DISPLAY_HELP_TEXT_THIS_FRAME(char* message, BOOL p1);
+void DISPLAY_HELP_TEXT_THIS_FRAME(char* pTextLabel, BOOL bCurvedWindow);
 ```
 
-```
-The messages are localized strings.  
-Examples:  
-"No_bus_money"  
-"Enter_bus"  
-"Tour_help"  
-"LETTERS_HELP2"  
-"Dummy"  
-**The bool appears to always be false (if it even is a bool, as it's represented by a zero)**  
---------  
-p1 doesn't seem to make a difference, regardless of the state it's in.   
-picture of where on the screen this is displayed?  
-```
+Shows a help message for one frame.
+Do note that this message doesn't get added to the Pause Menu info section.
 
 ## Parameters
-* **message**: 
-* **p1**: 
+* **pTextLabel**: Text label for this message.
+* **bCurvedWindow**: Unused parameter.