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

initial implementation of message hooks

Browse Source 
--HG--
extra : convert_revision : svn%3A39bc706e-5318-0410-9160-8a85361fbb7c/trunk%40558
This commit is contained in:
Borja Ferrer
2007-03-01 22:49:08 +00:00
parent f7df18f6fd
commit 7ebe3f33cd
9 changed files with 770 additions and 171 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/include/usermessages.inc
+11 -29
View File
@@ -85,6 +85,7 @@ native EndMessage();
* @brief Called when a message is hooked
*
* @param msg_id Message index.
* @param bf Handle to the input bit buffer of the message.
* @param players Array containing player indexes.
* @param playersNum Number of players in the array.
* @param reliable True if message is reliable, false otherwise.
@@ -92,7 +93,14 @@ native EndMessage();
* @return Ignored for normal hooks. For intercept hooks, false blocks
* the message from being sent, and true continues.
*/
functag MsgHook bool:public(UserMsg:msg_id, Handle:bf, const players[], playersNum, bool:reliable, bool:init);
functag MsgHook Action:public(UserMsg:msg_id, Handle:bf, const players[], playersNum, bool:reliable, bool:init);
/**
* @brief Called when a message is finished sending.
*
* @param msg_id Message index.
*/
functag MsgSentNotify public(UserMsg:msg_id);
/**
* @brief Hooks a user message.
@@ -102,10 +110,11 @@ functag MsgHook bool:public(UserMsg:msg_id, Handle:bf, const players[], playersN
* @param intercept If intercept is true, message will be fully intercepted,
* allowing the user to block the message. Otherwise,
* the hook is normal and ignores the return value.
* @param notify Notification function.
* @noreturn
* @error Invalid message index.
*/
native HookUserMessage(UserMsg:msg_id, MsgHook:hook, bool:intercept=false);
native HookUserMessage(UserMsg:msg_id, MsgHook:hook, bool:intercept=false, MsgSentNotify:notify=MsgSentNotify:-1);
/**
* @brief Removes one usermessage hook.
@@ -118,33 +127,6 @@ native HookUserMessage(UserMsg:msg_id, MsgHook:hook, bool:intercept=false);
*/
native UnHookUserMessage(UserMsg:msg_id, MsgHook:hook, bool:intercept=false);
/**
* @brief Called when a message is finished sending.
*
* @param msg_id Message index.
*/
functag MsgSentNotify public(UserMsg:msg_id);
/**
* @brief Notifies when a message has finished sending.
*
* @param msg_id Message index.
* @param notify Notification function.
* @noreturn
* @error Invalid message index.
*/
native NotifyUserMessage(UserMsg:msg_id, MsgSentNotify:notify);
/**
* @brief Removes a user message notification.
*
* @param msg_id Message index.
* @param notify Notification function.
* @noreturn
* @error Invalid message index.
*/
native RemoveNotifyUserMessage(UserMsg:msg_id, MsgSentNotify:notify);
/**
* Starts a usermessage (network message) that broadcasts to all clients.
* @note See StartMessage or StartMessageEx().