Add @note in get_user_msgid() #506
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Arkshine
reviewed
Aug 9, 2018
plugins/include/amxmodx.inc
Outdated
| @@ -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 | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
@Arkshine Done. Btw, your English is great.
OciXCrom
added a commit
to OciXCrom/amxmodx
that referenced
this pull request
Sep 10, 2018
* Update lang.inc * Update lang.inc * Update amxmodx.inc * Improve @note phrasing
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This function should not be used inside plugin_precache(), as it will return 0 if the server was just started.
https://forums.alliedmods.net/showthread.php?t=308592