Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update EndTextCommandIsThisHelpMessageBeingDisplayed.md #797

Merged
merged 3 commits into from
Jul 6, 2023
Merged

Update EndTextCommandIsThisHelpMessageBeingDisplayed.md #797

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b10309a
Update EndTextCommandIsThisHelpMessageBeingDisplayed.md
TomStilson Aug 13, 2022
946e786
Update EndTextCommandIsThisHelpMessageBeingDisplayed.md
TomStilson Jun 21, 2023
be32eff
Update EndTextCommandIsThisHelpMessageBeingDisplayed.md
TomStilson Jun 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions HUD/EndTextCommandIsThisHelpMessageBeingDisplayed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@ aliases: ["0x10BDDBFC529428DD"]

```c
// 0x10BDDBFC529428DD 0xF63A13EC
BOOL END_TEXT_COMMAND_IS_THIS_HELP_MESSAGE_BEING_DISPLAYED(int p0);
BOOL END_TEXT_COMMAND_IS_THIS_HELP_MESSAGE_BEING_DISPLAYED(int hudIndex);
```


## 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`.
Copy link
Contributor

@4mmonium 4mmonium Jun 20, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 😃

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will add it now, thanks!


## Return value
```true```: Indicates if the specific help message has been displayed. ```false```: Indicates that the specific help message is still being displayed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, why did you choose to use triple back ticks? I think single back ticks would do just as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a misclick, I will change it now.