added API spec sample for data packs
--HG-- extra : convert_revision : svn%3A39bc706e-5318-0410-9160-8a85361fbb7c/trunk%40434
This commit is contained in:
David Anderson
parent
485692e6a4
commit
8649e57ebc
72
plugins/include/datapack.inc
Normal file
72
plugins/include/datapack.inc
Normal file
@ -0,0 +1,72 @@
|
||||
/**
|
||||
* ===============================================================
|
||||
* SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved.
|
||||
* ===============================================================
|
||||
*
|
||||
* This file is part of the SourceMod/SourcePawn SDK. This file may only be used
|
||||
* or modified under the Terms and Conditions of its License Agreement, which is found
|
||||
* in LICENSE.txt. The Terms and Conditions for making SourceMod extensions/plugins
|
||||
* may change at any time. To view the latest information, see:
|
||||
* http://www.sourcemod.net/license.php
|
||||
*
|
||||
* Version: $Id$
|
||||
*/
|
||||
|
||||
#if defined _datapack_included
|
||||
#endinput
|
||||
#endif
|
||||
#define _datapack_included
|
||||
|
||||
|
||||
/**
|
||||
* Creates a new data pack.
|
||||
*
|
||||
* @return A Handle to the data pack. Must be closed with CloseHandle().
|
||||
*/
|
||||
native Handle:CreateDataPack();
|
||||
|
||||
/**
|
||||
* Packs a normal cell into a data pack.
|
||||
*
|
||||
* @param pack Handle to the data pack.
|
||||
* @param cell Cell to add.
|
||||
* @noreturn
|
||||
* @error Invalid handle.
|
||||
*/
|
||||
native WritePackCell(Handle:pack, cell);
|
||||
|
||||
/**
|
||||
* Reads a cell from a data pack.
|
||||
*
|
||||
* @param pack Handle to the data pack.
|
||||
* @return Cell value.
|
||||
* @error Invalid handle, or bounds error.
|
||||
*/
|
||||
native ReadPackCell(Handle:pack);
|
||||
|
||||
/**
|
||||
* Resets the position in a data pack.
|
||||
*
|
||||
* @param pack Handle to the data pack.
|
||||
* @param clear If true, clears the contained data.
|
||||
* @noreturn
|
||||
*/
|
||||
native ResetPack(Handle:pack, bool:clear=false);
|
||||
|
||||
/**
|
||||
* Returns the read or write position in a data pack.
|
||||
*
|
||||
* @param pack Handle to the data pack.
|
||||
* @return Numerical position in the data pack.
|
||||
*/
|
||||
native GetPackPosition(Handle:pack);
|
||||
|
||||
/**
|
||||
* Sets the read/write position in a data pack.
|
||||
*
|
||||
* @param pack Handle to the data pack.
|
||||
* @param position New position to set.
|
||||
* @noreturn
|
||||
* @error Position is beyond the pack bounds.
|
||||
*/
|
||||
native SetPackPosition(Handle:pack, position);
|
||||
@ -1,265 +0,0 @@
|
||||
/**
|
||||
* ===============================================================
|
||||
* SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved.
|
||||
* ===============================================================
|
||||
*
|
||||
* This file is part of the SourceMod/SourcePawn SDK. This file may only be used
|
||||
* or modified under the Terms and Conditions of its License Agreement, which is found
|
||||
* in LICENSE.txt. The Terms and Conditions for making SourceMod extensions/plugins
|
||||
* may change at any time. To view the latest information, see:
|
||||
* http://www.sourcemod.net/license.php
|
||||
*
|
||||
* Version: $Id$
|
||||
*/
|
||||
|
||||
#if defined _sourcemod_included
|
||||
#endinput
|
||||
#endif
|
||||
#define _sourcemod_included
|
||||
|
||||
struct Plugin
|
||||
{
|
||||
const String:name[], /* Plugin Name */
|
||||
const String:description[], /* Plugin Description */
|
||||
const String:author[], /* Plugin Author */
|
||||
const String:version[], /* Plugin Version */
|
||||
const String:url[], /* Plugin URL */
|
||||
};
|
||||
|
||||
#include <core>
|
||||
#include <float>
|
||||
#include <handles>
|
||||
#include <string>
|
||||
#include <admin>
|
||||
#include <files>
|
||||
|
||||
/**
|
||||
* Declare this as a struct in your plugin to expose its information.
|
||||
* Example:
|
||||
*
|
||||
* public Plugin:myinfo =
|
||||
* {
|
||||
* name = "My Plugin",
|
||||
* //etc
|
||||
* };
|
||||
*/
|
||||
public Plugin:myinfo;
|
||||
|
||||
/**
|
||||
* Called when the plugin is fully initialized and all known external references are resolved.
|
||||
* This is called even if the plugin type is "private."
|
||||
* NOTE: Errors in this function will cause the plugin to stop running.
|
||||
*
|
||||
* @noreturn
|
||||
*/
|
||||
forward OnPluginStart(Handle:myself);
|
||||
|
||||
/**
|
||||
* Called before OnPluginStart, in case the plugin wants to check for load failure.
|
||||
* This is called even if the plugin type is "private." Any natives from modules are
|
||||
* not available at this point. Thus, this forward should only be used for explicit
|
||||
* pre-emptive things, such as adding dynamic natives, or setting certain types of load filters.
|
||||
*
|
||||
* NOTE: It is not safe to call externally resolved natives until OnPluginStart().
|
||||
* NOTE: Any sort of RTE in this function will cause the plugin to fail loading.
|
||||
*
|
||||
* @param myself Handle to the plugin.
|
||||
* @param late Whether or not the plugin was loaded "late" (after map load).
|
||||
* @param error Error message buffer in case load failed.
|
||||
* @param err_max Maximum number of characters for error message buffer.
|
||||
* @return True if load success, false otherwise.
|
||||
*/
|
||||
forward bool:AskPluginLoad(Handle:myself, bool:late, String:error[], err_max);
|
||||
|
||||
/**
|
||||
* Called when the plugin is about to be unloaded.
|
||||
*
|
||||
* @noreturn
|
||||
*/
|
||||
forward OnPluginEnd();
|
||||
|
||||
/**
|
||||
* Called when the plugin's pause status is changing.
|
||||
*
|
||||
* @param pause True if the plugin is being paused, false otherwise.
|
||||
* @noreturn
|
||||
*/
|
||||
forward OnPluginPauseChange(bool:pause);
|
||||
|
||||
/**
|
||||
* Called on client connection.
|
||||
*
|
||||
* @param client Player index.
|
||||
* @param rejectmsg Buffer to store the rejection message when the connection is refused.
|
||||
* @param maxlen Maximum number of characters for rejection buffer.
|
||||
* @return True to validate client's connection, false to refuse it.
|
||||
*/
|
||||
forward bool:OnClientConnect(client, String:rejectmsg[], maxlen);
|
||||
|
||||
/**
|
||||
* Called when a client is entering to the game.
|
||||
*
|
||||
* @param client Player index.
|
||||
* @noreturn
|
||||
*/
|
||||
forward OnClientPutInServer(client);
|
||||
|
||||
/**
|
||||
* Called when a client is disconnecting from the server.
|
||||
*
|
||||
* @param client Player index.
|
||||
* @noreturn
|
||||
*/
|
||||
forward OnClientDisconnect(client);
|
||||
|
||||
/**
|
||||
* Called when a client is disconnected from the server.
|
||||
*
|
||||
* @param client Player index.
|
||||
* @noreturn
|
||||
*/
|
||||
forward OnClientDisconnect_Post(client);
|
||||
|
||||
/**
|
||||
* Called when a client is sending a command.
|
||||
*
|
||||
* @param client Player index.
|
||||
* @noreturn
|
||||
*/
|
||||
forward OnClientCommand(client);
|
||||
|
||||
/**
|
||||
* Called whenever the client's settings are changed.
|
||||
*
|
||||
* @param client Player index.
|
||||
* @noreturn
|
||||
*/
|
||||
forward OnClientSettingsChanged(client);
|
||||
|
||||
/**
|
||||
* Returns the maximum number of clients allowed on the server.
|
||||
*
|
||||
* @return Maximum number of clients allowed.
|
||||
*/
|
||||
native GetMaxClients();
|
||||
|
||||
/**
|
||||
* Returns the client count put in the server.
|
||||
*
|
||||
* @param inGameOnly If false connecting players are also counted.
|
||||
* @return Client count in the server.
|
||||
*/
|
||||
native GetClientCount(bool:inGameOnly=true);
|
||||
|
||||
/**
|
||||
* Returns the client's name.
|
||||
*
|
||||
* @param client Player index.
|
||||
* @param name Buffer to store the client's name.
|
||||
* @param maxlen Maximum length of string buffer (includes NULL terminator).
|
||||
* @return True on success, false otherwise.
|
||||
* @error If the client is not connected an error will be thrown.
|
||||
*/
|
||||
native bool:GetClientName(client, String:name[], maxlen);
|
||||
|
||||
/**
|
||||
* Retrieves a client's IP address.
|
||||
*
|
||||
* @param client Player index.
|
||||
* @param name Buffer to store the client's ip address.
|
||||
* @param maxlen Maximum length of string buffer (includes NULL terminator).
|
||||
* @param remport Remove client's port from the ip string (true by default).
|
||||
* @return True on success, false otherwise.
|
||||
* @error If the client is not connected an error will be thrown.
|
||||
*/
|
||||
native bool:GetClientIP(client, String:ip[], maxlen, bool:remport=true);
|
||||
|
||||
/**
|
||||
* Retrieves a client's authentication string (SteamID).
|
||||
*
|
||||
* @param client Player index.
|
||||
* @param auth Buffer to store the client's auth string.
|
||||
* @param maxlen Maximum length of string buffer (includes NULL terminator).
|
||||
* @return True on success, false otherwise.
|
||||
* @error If the client is not connected an error will be thrown.
|
||||
*/
|
||||
native bool:GetClientAuthString(client, String:auth[], maxlen);
|
||||
|
||||
/**
|
||||
* Returns if a certain player is connected.
|
||||
*
|
||||
* @param client Player index.
|
||||
* @return True if player is connected to the server, false otherwise.
|
||||
*/
|
||||
native bool:IsPlayerConnected(client);
|
||||
|
||||
/**
|
||||
* Returns if a certain player has entered the game.
|
||||
*
|
||||
* @param client Player index.
|
||||
* @return True if player has entered the game, false otherwise.
|
||||
*/
|
||||
native bool:IsPlayerInGame(client);
|
||||
|
||||
/**
|
||||
* Returns if a certain player has been authenticated.
|
||||
*
|
||||
* @param client Player index.
|
||||
* @return True if player has been authenticated, false otherwise.
|
||||
*/
|
||||
native bool:IsPlayerAuthorized(client);
|
||||
|
||||
/**
|
||||
* Returns if a certain player is a fake client.
|
||||
*
|
||||
* @param client Player index.
|
||||
* @return True if player is a fake client, false otherwise.
|
||||
*/
|
||||
native bool:IsPlayerFakeClient(client);
|
||||
|
||||
/**
|
||||
* Sends a message to the server console.
|
||||
*
|
||||
* @param format Formatting rules.
|
||||
* @param ... Variable number of format parameters.
|
||||
* @noreturn
|
||||
*/
|
||||
native PrintToServer(const String:format[], {Handle,Float,String,_}:...);
|
||||
|
||||
/**
|
||||
* Sends a message to a client's console.
|
||||
*
|
||||
* @param client Player index.
|
||||
* @param format Formatting rules.
|
||||
* @param ... Variable number of format parameters.
|
||||
* @noreturn
|
||||
* @error If the client is not connected an error will be thrown.
|
||||
*/
|
||||
native PrintToConsole(client, const String:format[], {Handle,Float,String,_}:...);
|
||||
|
||||
/**
|
||||
* Logs a generic message to the HL2 logs.
|
||||
*
|
||||
* @param format String format.
|
||||
* @param ... Format arguments.
|
||||
* @noreturn
|
||||
*/
|
||||
native LogToGame(const String:format[], {Handle,Float,String,_}:...);
|
||||
|
||||
/**
|
||||
* Logs a plugin message to the SourceMod logs.
|
||||
*
|
||||
* @param format String format.
|
||||
* @param ... Format arguments.
|
||||
* @noreturn
|
||||
*/
|
||||
native LogMessage(const String:format[], {Handle,Float,String,_}:...);
|
||||
|
||||
/**
|
||||
* Logs a plugin error message to the SourceMod logs.
|
||||
*
|
||||
* @param format String format.
|
||||
* @param ... Format arguments.
|
||||
* @noreturn
|
||||
*/
|
||||
native LogError(const String:format[], {Handle,Float,String,_}:...);
|
||||
Loading…
Reference in New Issue
Block a user