Remove LogMessageEx definition from logging.inc (
bug 5897, r=kyles).
3 * =============================================================================
4 * SourceMod (C)2004-2008 AlliedModders LLC. All rights reserved.
5 * =============================================================================
7 * This file is part of the SourceMod/SourcePawn SDK.
9 * This program is free software; you can redistribute it and/or modify it under
10 * the terms of the GNU General Public License, version 3.0, as published by the
11 * Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
18 * You should have received a copy of the GNU General Public License along with
19 * this program. If not, see <http://www.gnu.org/licenses/>.
21 * As a special exception, AlliedModders LLC gives you permission to link the
22 * code of this program (as well as its derivative works) to "Half-Life 2," the
23 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
24 * by the Valve Corporation. You must obey the GNU General Public License in
25 * all respects for all other code used. Additionally, AlliedModders LLC grants
26 * this exception to all derivative works. AlliedModders LLC defines further
27 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
28 * or <http://www.sourcemod.net/license.php>.
33 #if defined _sm_logging_included
36 #define _sm_logging_included
39 * Logs a plugin message to the SourceMod logs. The log message will be
40 * prefixed by the plugin's logtag (filename).
42 * @param format String format.
43 * @param ... Format arguments.
46 native LogMessage(const String:format[], any:...);
49 * Logs a message to any file. The log message will be in the normal
50 * SourceMod format, with the plugin logtag prepended.
52 * @param file File to write the log message in.
53 * @param format String format.
54 * @param ... Format arguments.
56 * @error File could not be opened/written.
58 native LogToFile(const String:file[], const String:format[], any:...);
61 * Same as LogToFile(), except no plugin logtag is prepended.
63 * @param file File to write the log message in.
64 * @param format String format.
65 * @param ... Format arguments.
67 * @error File could not be opened/written.
69 native LogToFileEx(const String:file[], const String:format[], any:...);
72 * Logs an action from a command or event whereby interception and routing may
73 * be important. This is intended to be a logging version of ShowActivity().
75 * @param client Client performing the action, 0 for server, or -1 if not
77 * @param target Client being targetted, or -1 if not applicable.
78 * @param message Message format.
79 * @param ... Message formatting parameters.
82 native LogAction(client, target, const String:message[], any:...);
85 * Logs a plugin error message to the SourceMod logs.
87 * @param format String format.
88 * @param ... Format arguments.
91 native LogError(const String:format[], any:...);
94 * Called when an action is going to be logged.
96 * @param source Handle to the object logging the action, or INVALID_HANDLE
97 * if Core is logging the action.
98 * @param ident Type of object logging the action (plugin, ext, or core).
99 * @param client Client the action is from; 0 for server, -1 if not applicable.
100 * @param target Client the action is targetting, or -1 if not applicable.
101 * @param message Message that is being logged.
102 * @return Plugin_Continue will cause Core to defaulty log the message.
103 * Plugin_Handled will stop Core from logging the message.
104 * Plugin_Stop is the same as Handled, but prevents any other
105 * plugins from handling the message.
107 forward Action:OnLogAction(Handle:source,
111 const String:message[]);
114 * Called when a game log message is received.
116 * Any Log*() functions called within this callback will not recursively
117 * pass through. That is, they will log directly, bypassing this callback.
119 * Note that this does not capture log messages from the engine. It only
120 * captures log messages being sent from the game/mod itself.
122 * @param message Message contents.
123 * @return Plugin_Handled or Plugin_Stop will prevent the message
124 * from being written to the log file.
126 functag public Action:GameLogHook(const String:message[]);
129 * Adds a game log hook.
131 * @param hook Hook function.
134 native AddGameLogHook(GameLogHook:hook);
137 * Removes a game log hook.
139 * @param hook Hook function.
142 native RemoveGameLogHook(GameLogHook:hook);
