UNLOZE/sourcemod
10
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

fixed some doc inconsistencies on ProcessTargetString

Browse Source 
--HG--
branch : sourcemod-1.0.x
extra : convert_revision : svn%3A39bc706e-5318-0410-9160-8a85361fbb7c/branches/sourcemod-1.0.x%402080
This commit is contained in:
David Anderson 2008-04-19 00:44:11 +00:00
parent 1a21832cbb
commit cc207eae51
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
plugins/include/commandfilters.inc
View File

@ -1,7 +1,7 @@
/** /**
* vim: set ts=4 : * vim: set ts=4 :
* ============================================================================= * =============================================================================
* SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved. * SourceMod (C)2004-2008 AlliedModders LLC. All rights reserved.
* ============================================================================= * =============================================================================
* *
* This file is part of the SourceMod/SourcePawn SDK. * This file is part of the SourceMod/SourcePawn SDK.
@ -57,6 +57,10 @@
* Processes a generic command target string, and resolves it to a list * Processes a generic command target string, and resolves it to a list
* of clients or one client, based on filtering rules and a pattern. * of clients or one client, based on filtering rules and a pattern.
* *
* Note that you should use LoadTranslations("common.phrases") in OnPluginStart(),
* as that file is guaranteed to contain all of the translatable phrases that
* ProcessTargetString() will return.
*
* @param pattern Pattern to find clients against. * @param pattern Pattern to find clients against.
* @param admin Admin performing the action, or 0 if the server. * @param admin Admin performing the action, or 0 if the server.
* @param targets Array to hold targets. * @param targets Array to hold targets.
@ -64,11 +68,11 @@
* @param filter_flags Filter flags. * @param filter_flags Filter flags.
* @param target_name Buffer to store the target name. * @param target_name Buffer to store the target name.
* @param tn_maxlength Maximum length of the target name buffer. * @param tn_maxlength Maximum length of the target name buffer.
* @param tn_is_ml Set to true if the target name buffer is an ML phrase, * @param tn_is_ml OUTPUT: Will be true if the target name buffer is an ML phrase,
* false if it is a normal string. * false if it is a normal string.
* @return If a multi-target pattern was used, the number of clients found * @return If a multi-target pattern was used, the number of clients found
* is returned. If a single-target pattern was used, 1 is returned * is returned. If a single-target pattern was used, 1 is returned
* if one valid client is found. Otherwise, a CLIENT_TARGET reason * if one valid client is found. Otherwise, a COMMAND_TARGET reason
* for failure is returned. * for failure is returned.
*/ */
native ProcessTargetString(const String:pattern[], native ProcessTargetString(const String:pattern[],