fixed some doc inconsistencies on ProcessTargetString
authorDavid Anderson <dvander@alliedmods.net>
Sat Apr 19 00:44:28 2008 +0000 (2008-04-19)
changeset 201539c6f6f945db
parent 2014 2cd20f4e007b
child 2016 b05796b1096b
fixed some doc inconsistencies on ProcessTargetString
plugins/include/commandfilters.inc
     1.1 --- a/plugins/include/commandfilters.inc	Thu Apr 17 10:00:52 2008 +0000
     1.2 +++ b/plugins/include/commandfilters.inc	Sat Apr 19 00:44:28 2008 +0000
     1.3 @@ -57,6 +57,10 @@
     1.4   * Processes a generic command target string, and resolves it to a list 
     1.5   * of clients or one client, based on filtering rules and a pattern.
     1.6   *
     1.7 + * Note that you should use LoadTranslations("common.phrases") in OnPluginStart(), 
     1.8 + * as that file is guaranteed to contain all of the translatable phrases that 
     1.9 + * ProcessTargetString() will return.
    1.10 + *
    1.11   * @param pattern		Pattern to find clients against.
    1.12   * @param admin			Admin performing the action, or 0 if the server.
    1.13   * @param targets		Array to hold targets.
    1.14 @@ -64,11 +68,11 @@
    1.15   * @param filter_flags	Filter flags.
    1.16   * @param target_name	Buffer to store the target name.
    1.17   * @param tn_maxlength	Maximum length of the target name buffer.
    1.18 - * @param tn_is_ml		Set to true if the target name buffer is an ML phrase,
    1.19 + * @param tn_is_ml		OUTPUT: Will be true if the target name buffer is an ML phrase,
    1.20   *						false if it is a normal string.
    1.21   * @return				If a multi-target pattern was used, the number of clients found 
    1.22   *						is returned.  If a single-target pattern was used, 1 is returned 
    1.23 - *						if one valid client is found.  Otherwise, a CLIENT_TARGET reason 
    1.24 + *						if one valid client is found.  Otherwise, a COMMAND_TARGET reason 
    1.25   *						for failure is returned.
    1.26   */
    1.27  native ProcessTargetString(const String:pattern[],