UNLOZE/sm-zombiereloaded-3
10
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update spcomp and includes to latest 1.10-fork

Browse Source 
disable warning 241: Array-based enum structs will be removed in 1.11
This commit is contained in:
BotoX
2024-06-21 06:55:55 +02:00
committed by zaCade
parent 689c4e89cf
commit 917ec936f8
72 changed files with 7755 additions and 6440 deletions
Download Patch File Download Diff File Expand all files Collapse all files
env/include/usermessages.inc
Vendored
+91 -78
View File
@@ -9,7 +9,7 @@
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, version 3.0, as published by the
* Free Software Foundation.
*
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
@@ -29,7 +29,7 @@
*
* Version: $Id$
*/
#if defined _eventsmsgs_included
#endinput
#endif
@@ -40,7 +40,7 @@
*/
enum UserMsg
{
INVALID_MESSAGE_ID = -1,
INVALID_MESSAGE_ID = -1
};
/**
@@ -49,15 +49,15 @@ enum UserMsg
enum UserMessageType
{
UM_BitBuf = 0,
UM_Protobuf,
UM_Protobuf
};
/**
* @section Message Flags.
*/
#define USERMSG_RELIABLE (1<<2) /**< Message will be set on the reliable stream */
#define USERMSG_INITMSG (1<<3) /**< Message will be considered to be an initmsg */
#define USERMSG_BLOCKHOOKS (1<<7) /**< Prevents the message from triggering SourceMod and Metamod hooks */
#define USERMSG_RELIABLE (1<<2) /**< Message will be set on the reliable stream */
#define USERMSG_INITMSG (1<<3) /**< Message will be considered to be an initmsg */
#define USERMSG_BLOCKHOOKS (1<<7) /**< Prevents the message from triggering SourceMod and Metamod hooks */
/**
* @endsection
@@ -66,14 +66,17 @@ enum UserMessageType
/**
* Returns usermessage serialization type used for the current engine
*
* @return The supported usermessage type.
* @return The supported usermessage type.
*/
native UserMessageType GetUserMessageType();
stock Protobuf UserMessageToProtobuf(Handle msg)
{
if (GetUserMessageType() != UM_Protobuf)
{
return null;
}
return view_as<Protobuf>(msg);
}
@@ -81,67 +84,75 @@ stock Protobuf UserMessageToProtobuf(Handle msg)
stock BfWrite UserMessageToBfWrite(Handle msg)
{
if (GetUserMessageType() == UM_Protobuf)
{
return null;
}
return view_as<BfWrite>(msg);
}
// Make sure to only call this on readable buffers (eg from a message hook).
stock BfWrite UserMessageToBfRead(Handle msg)
stock BfRead UserMessageToBfRead(Handle msg)
{
if (GetUserMessageType() == UM_Protobuf)
{
return null;
}
return view_as<BfRead>(msg);
}
/**
* Returns the ID of a given message, or -1 on failure.
*
* @param msg String containing message name (case sensitive).
* @return A message index, or INVALID_MESSAGE_ID on failure.
* @param msg String containing message name (case sensitive).
* @return A message index, or INVALID_MESSAGE_ID on failure.
*/
native UserMsg GetUserMessageId(const char[] msg);
/**
* Retrieves the name of a message by ID.
*
* @param msg_id Message index.
* @param msg Buffer to store the name of the message.
* @param maxlength Maximum length of string buffer.
* @return True if message index is valid, false otherwise.
* @param msg_id Message index.
* @param msg Buffer to store the name of the message.
* @param maxlength Maximum length of string buffer.
* @return True if message index is valid, false otherwise.
*/
native bool GetUserMessageName(UserMsg msg_id, char[] msg, int maxlength);
/**
* Starts a usermessage (network message).
*
* @note Only one message can be active at a time.
* @note It is illegal to send any message while a non-intercept hook is in progress.
*
* @param msgname Message name to start.
* @param clients Array containing player indexes to broadcast to.
* @param numClients Number of players in the array.
* @param flags Optional flags to set.
* @return A handle to a bf_write bit packing structure, or
* INVALID_HANDLE on failure.
* @error Invalid message name, unable to start a message, invalid client,
* or client not connected.
* @param msgname Message name to start.
* @param clients Array containing player indexes to broadcast to.
* @param numClients Number of players in the array.
* @param flags Optional flags to set.
* @return A handle to a bf_write bit packing structure, or
* INVALID_HANDLE on failure.
* @error Invalid message name, unable to start a message, invalid client,
* or client not connected.
*/
native Handle StartMessage(char[] msgname, int[] clients, int numClients, int flags=0);
native Handle StartMessage(const char[] msgname, const int[] clients, int numClients, int flags=0);
/**
* Starts a usermessage (network message).
*
* @note Only one message can be active at a time.
* @note It is illegal to send any message while a non-intercept hook is in progress.
*
* @param msg Message index to start.
* @param clients Array containing player indexes to broadcast to.
* @param numClients Number of players in the array.
* @param flags Optional flags to set.
* @return A handle to a bf_write bit packing structure, or
* INVALID_HANDLE on failure.
* @error Invalid message name, unable to start a message, invalid client,
* or client not connected.
* @param msg Message index to start.
* @param clients Array containing player indexes to broadcast to.
* @param numClients Number of players in the array.
* @param flags Optional flags to set.
* @return A handle to a bf_write bit packing structure, or
* INVALID_HANDLE on failure.
* @error Invalid message name, unable to start a message, invalid client,
* or client not connected.
*/
native Handle StartMessageEx(UserMsg msg, int[] clients, int numClients, int flags=0);
native Handle StartMessageEx(UserMsg msg, const int[] clients, int numClients, int flags=0);
/**
* Ends a previously started user message (network message).
@@ -156,29 +167,29 @@ typeset MsgHook
/**
* Called when a bit buffer based usermessage is hooked
*
* @param msg_id Message index.
* @param msg Handle to the input bit buffer.
* @param players Array containing player indexes.
* @param playersNum Number of players in the array.
* @param reliable True if message is reliable, false otherwise.
* @param init True if message is an initmsg, false otherwise.
* @return Ignored for normal hooks. For intercept hooks, Plugin_Handled
* blocks the message from being sent, and Plugin_Continue
* resumes normal functionality.
* @param msg_id Message index.
* @param msg Handle to the input bit buffer.
* @param players Array containing player indexes.
* @param playersNum Number of players in the array.
* @param reliable True if message is reliable, false otherwise.
* @param init True if message is an initmsg, false otherwise.
* @return Ignored for normal hooks. For intercept hooks, Plugin_Handled
* blocks the message from being sent, and Plugin_Continue
* resumes normal functionality.
*/
function Action (UserMsg msg_id, BfRead msg, const int[] players, int playersNum, bool reliable, bool init);
/**
* Called when a protobuf based usermessage is hooked
*
* @param msg_id Message index.
* @param msg Handle to the input protobuf.
* @param players Array containing player indexes.
* @param playersNum Number of players in the array.
* @param reliable True if message is reliable, false otherwise.
* @param init True if message is an initmsg, false otherwise.
* @return Ignored for normal hooks. For intercept hooks, Plugin_Handled
* blocks the message from being sent, and Plugin_Continue
* resumes normal functionality.
* @param msg_id Message index.
* @param msg Handle to the input protobuf.
* @param players Array containing player indexes.
* @param playersNum Number of players in the array.
* @param reliable True if message is reliable, false otherwise.
* @param init True if message is an initmsg, false otherwise.
* @return Ignored for normal hooks. For intercept hooks, Plugin_Handled
* blocks the message from being sent, and Plugin_Continue
* resumes normal functionality.
*/
function Action (UserMsg msg_id, Protobuf msg, const int[] players, int playersNum, bool reliable, bool init);
};
@@ -186,72 +197,74 @@ typeset MsgHook
/**
* Called when a message hook has completed.
*
* @param msg_id Message index.
* @param sent True if message was sent, false if blocked.
* @param msg_id Message index.
* @param sent True if message was sent, false if blocked.
*/
typedef MsgPostHook = function void (UserMsg msg_id, bool sent);
/**
* Hooks a user message.
*
* @param msg_id Message index.
* @param hook Function to use as a hook.
* @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 post Notification function.
* @error Invalid message index.
* @param msg_id Message index.
* @param hook Function to use as a hook.
* @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 post Notification function.
* @error Invalid message index.
*/
native void HookUserMessage(UserMsg msg_id, MsgHook hook, bool intercept=false, MsgPostHook post=INVALID_FUNCTION);
/**
* Removes one usermessage hook.
*
* @param msg_id Message index.
* @param hook Function used for the hook.
* @param intercept Specifies whether the hook was an intercept hook or not.
* @error Invalid message index.
* @param msg_id Message index.
* @param hook Function used for the hook.
* @param intercept Specifies whether the hook was an intercept hook or not.
* @error Invalid message index.
*/
native void UnhookUserMessage(UserMsg msg_id, MsgHook hook, bool intercept=false);
/**
* Starts a usermessage (network message) that broadcasts to all clients.
*
* @note See StartMessage or StartMessageEx().
*
* @param msgname Message name to start.
* @param flags Optional flags to set.
* @return A handle to a bf_write bit packing structure, or
* INVALID_HANDLE on failure.
* @param msgname Message name to start.
* @param flags Optional flags to set.
* @return A handle to a bf_write bit packing structure, or
* INVALID_HANDLE on failure.
*/
stock Handle StartMessageAll(char[] msgname, int flags=0)
stock Handle StartMessageAll(const char[] msgname, int flags=0)
{
int total = 0;
int[] clients = new int[MaxClients];
for (int i=1; i<=MaxClients; i++)
for (int i = 1; i <= MaxClients; i++)
{
if (IsClientConnected(i))
{
clients[total++] = i;
}
}
return StartMessage(msgname, clients, total, flags);
}
/**
* Starts a simpler usermessage (network message) for one client.
*
* @note See StartMessage or StartMessageEx().
*
* @param msgname Message name to start.
* @param client Client to send to.
* @param flags Optional flags to set.
* @return A handle to a bf_write bit packing structure, or
* INVALID_HANDLE on failure.
* @param msgname Message name to start.
* @param client Client to send to.
* @param flags Optional flags to set.
* @return A handle to a bf_write bit packing structure, or
* INVALID_HANDLE on failure.
*/
stock Handle StartMessageOne(char[] msgname, int client, int flags=0)
stock Handle StartMessageOne(const char[] msgname, int client, int flags=0)
{
int players[1];
players[0] = client;
return StartMessage(msgname, players, 1, flags);
}