Update EndTextCommandIsThisHelpMessageBeingDisplayed.md #797
Conversation
Detailed description update, tested on local server.
|
|
||
| ## Return value | ||
| ```true```: Indicates if the specific help message has been displayed. ```false```: Indicates that the specific help message is still being displayed. |
There was a problem hiding this comment.
Hi, why did you choose to use triple back ticks? I think single back ticks would do just as well.
There was a problem hiding this comment.
Just a misclick, I will change it now.
| ``` | ||
|
|
||
|
|
||
| ## Parameters | ||
| * **p0**: | ||
| * **hudIndex**: The hud index for help message. `0` is `HELP_TEXT`, `1` and `2` is `FLOATING_HELP_TEXT_1` and `FLOATING_HELP_TEXT_2`. |
There was a problem hiding this comment.
Maybe declare an enum for the hudIndex under the description? (by line 11, add a new line though, so it's not right under the function code block)
i.e.
enum HudIndexes {
HELP_TEXT = 0,
FLOATING_HELP_TEXT_1 = 1,
FLOATING_HELP_TEXT_2 = 2,
}It's neater in my opinion, just nitpicking really 😃
There was a problem hiding this comment.
I will add it now, thanks!
Update description.
| @@ -11,7 +11,15 @@ BOOL END_TEXT_COMMAND_IS_THIS_HELP_MESSAGE_BEING_DISPLAYED(int hudIndex); | |||
|
|
|||
|
|
|||
| ## Parameters | |||
| * **hudIndex**: The hud index for help message. `0` is `HELP_TEXT`, `1` and `2` is `FLOATING_HELP_TEXT_1` and `FLOATING_HELP_TEXT_2`. | |||
| * **hudIndex**: The hud index for help message. | |||
| ```csharp | |||
There was a problem hiding this comment.
Move all this C# code over to line 12, I attached a file showing you how it should look, you can replace everything with the contents from this file I attached if you want.
There was a problem hiding this comment.
Thank you, I have replaced the content you sent to me and made a commit.
There was a problem hiding this comment.
Thank you, I have replaced the content you sent to me and made a commit.
Amazing, thank you! I'll approve this now 🙂
Detailed description update, tested on local server.