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

Add @note in get_user_msgid() #506

Merged
merged 7 commits into from
Aug 20, 2018
Merged

Add @note in get_user_msgid() #506

Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
663cbef
Update lang.inc
OciXCrom Jun 25, 2018
10defb9
Update lang.inc
OciXCrom Jul 15, 2018
ec4aa4b
Merge pull request #1 from alliedmodders/master
OciXCrom Jul 15, 2018
a167170
Merge pull request #2 from alliedmodders/master
OciXCrom Jul 23, 2018
61b996e
Merge pull request #3 from alliedmodders/master
OciXCrom Jul 24, 2018
f74e83a
Update amxmodx.inc
OciXCrom Jul 24, 2018
94ea725
Improve @note phrasing
OciXCrom Aug 9, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions plugins/include/amxmodx.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2142,6 +2142,8 @@ native random_num(a, b);
* @note Example usage: get_user_msgid("TextMsg")
* @note The message id is unique as long as the server is running, but might
* change between updates. They should not be hardcoded into plugins.
* @note This function should not be used inside plugin_precache(), as it
Copy link
Member

Choose a reason for hiding this comment

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

It's kind of weirdly phrased. The context should be first. My English is horrible but I would go like:

On first server start, this function returns 0 inside plugin_precache(). Consider hooking RegUserMsg in order to retrieve the message id.

Something like that with a better english if not good.

Copy link
Contributor Author

@OciXCrom OciXCrom Aug 9, 2018 •
edited

Choose a reason for hiding this comment

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

@Arkshine Done. Btw, your English is great.

* will return 0 if the server was just started.
*
* @param name Client message name
*
Expand Down