AlliedModders Wiki - User contributions [en]

AdminInterface (Metamod:Source)

2008-04-19T23:22:39Z

EKS: /* What plugins use this interface */

=Introduction=

AdminInterface is a interface that allows sourcemm plugins to interact with admin plugins like [http://forums.alliedmods.net/showthread.php?t=39356 Basic Admin Tool] / [http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] to get the current admin rights of the players. It also allows the plugins to register custom access rights for their plugin.
This interface was made so smaller plugins, that may need admin rights for something simple dont need to make a system where the admin have to setup user rights for ever plugin. But instead can setup admin right in the admin plugin he preferes and the other plugins can get the information they need for it.

''Note: AdminInterface is NOT created or maintained by the team behing Sourcemm /Amxmodx, its a interface created by a 3dparty and is kindly hosted on this wiki''

[[Category:Half-Life 2]]
[[Category:Metamod:Source Development]]

=What Admin plugins support it=
[http://www.thexsoft.com/index.php?page=basic-admin-tool Basic Admin Tool] 
[http://www.mani-admin-plugin.com Mani] 

''If you have a admin plugin that supports has support for the AdminInterface edit this page.''

=What plugins use this interface=
[http://www.thexsoft.com/index.php?page=high-ping-kicker HPK] - This plugin kicks players with a high ping. 
[http://forums.alliedmods.net/showthread.php?t=39511 ForgiveTK] - This plugin adds a simple TK system to any source server, so players can forgive teamkills & teamattacks. 
[http://forums.alliedmods.net/showthread.php?t=40097 CS Bot Control] - A plugin to easly manage the CS bots, with a handy menu 
[http://forums.alliedmods.net/showthread.php?t=40089 Sharedbans Spectator ESP (Source)] - This plugin allows admins/players who are spectating/dead and are in first person view of another player to see the enemies (and teammates) of that player through the walls. This may help to catch wallhackers 
[http://www.siekhe-trophy.de/forum/viewtopic.php?t=669 Clanmatch-Plugin ] A plugin to making controling a clan server more easy 

''If you have a plugin that uses the interface, feel free to add it here.''

=How do I use the AdminInterface in my plugin=
The following example is taken directly out of the [http://forums.alliedmods.net/showthread.php?t=39511 ForgiveTK] plugin, and this plugin offcourse is based of the sourcemm sample plugins. The soucemm sample plugins have this AllPluginsLoaded() function, this is a good time to check to see if you can find the AdminInterface, incase your plugin is loaded before the admin plugin.

==Getting started==
Before you start coding, you should get the AdminInterface.h file, you can get this file easy from [http://forums.alliedmods.net/showthread.php?t=39356 Basic Admin Tool] source ( in hl2sdk/batinterface.h ).
<pre>
AdminInterface *m_AdminManager;

void ForgiveTK::AllPluginsLoaded()
{
if(m_AdminManager) // We dont need to find the AdminInterface again, we allready found it once.
return;

//we don't really need this for anything other than interplugin communication
//and that's not used in this plugin.
//If we really wanted, we could override the factories so other plugins can request
// interfaces we make. In this callback, the plugin could be assured that either
// the interfaces it requires were either loaded in another plugin or not.
PluginId id2;

void *ptr = g_SMAPI->MetaFactory("AdminInterface", NULL, &id2);

if (!ptr)
{
ServerCommand("echo Did not find AdminInterface, plugin will not check admin rights");
} else {
m_AdminManager = (AdminInterface *)ptr;
m_AdminManager->AddEventListner(this);
int InterfaceVersion = m_AdminManager->GetInterfaceVersion();

if(InterfaceVersion == ADMININTERFACE_VERSION)
ServerCommand("echo Found AdminInterface[%d] at (%p), via %s (Interface version: %d)", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion);
else
ServerCommand("echo Found AdminInterface[%d] at (%p), but interface was NOT the expected version: Was %d Expected %d, this can create problems. Please update the plugin with the lowest interface version", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion,ADMININTERFACE_VERSION);
}
}
void ForgiveTK::Client_Authorized(int id) // This is called when a client is fully connected and authed by the admin tool, this normaly happens after the client has gotten a valid steamid & the admin tool has checked it against its internal user lists.
{
ServerCommand("echo Client_Authorized: %d",id);
}
void ForgiveTK::OnAdminInterfaceUnload() // Called when the admin interface is getting unloaded, this happens if a admin uses meta unload or the server is shutting down.
{
m_AdminManager = NULL;
ServerCommand("echo AdminInterface was unloaded");
}
</pre>
Its importent that you setup a callback to your plugin, when use the interface so the admin plugin can inform you plugin when its being unloaded.

==Using the interface==
The following function bellow would check if a user has a admin right equal to "immunity" and return true if thats the case.
<pre>
bool ForgiveTK::HasAdminImmunity(int id) // Checks if the user has a admin right "immunity"
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->HasFlag(id,"immunity");
}
</pre>
<pre>
Here we register a new access right, that we can check again later. If we dont want to use one of the predefined access rights.
bool ForgiveTK::RegisterNewAcccessFlag()
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->RegisterFlag("FakeAccess Class","FakeAccessRight","This is a fake access right");
}
</pre>

==Pre defined access rights==
These are the rights the admin tools allready support. And you can check for in your plugin:
Notice that all access rights are in lower case, and they are strings. The reason they are strings is becuse most admin tools are going to handle admin rights internaly diffrently, so this is the only way to export it properbly.

any - The "any" right may only be supported by [http://forums.alliedmods.net/showthread.php?t=39356 Basic Admin Tool], it basicly checks if the user has any of the rights bellow not including reservedslots 
kick - The access to kick a another player. 
slap - The access to slap another player. 
slay - The access to slay another player. 
ban - The access to ban another player. 
chat - The access to use admin chat and or admin say commads. 
rcon - the access to execute commands the server console. 
map - The access to change maps. 
reservedslots - The access to reservedslots. 
immunity - Immunity from certain actions from other players, like kick. 

=How do I add the AdminInterface in my plugin=
This is only for those that have a admin plugin, and want their plugin to support the interface
Download the [http://forums.alliedmods.net/showthread.php?t=39356 Basic Admin Tool] source code, and look at BATInterface .cpp / .h and add it to your plugin. Remember you cannot change AdminInterface / AdminInterfaceListner class in the header file as the interface must be the same in all the admin plugins.

AdminInterface (Metamod:Source)

2008-04-19T23:21:17Z

EKS: /* What Admin plugins support it */

=Introduction=

AdminInterface is a interface that allows sourcemm plugins to interact with admin plugins like [http://forums.alliedmods.net/showthread.php?t=39356 Basic Admin Tool] / [http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] to get the current admin rights of the players. It also allows the plugins to register custom access rights for their plugin.
This interface was made so smaller plugins, that may need admin rights for something simple dont need to make a system where the admin have to setup user rights for ever plugin. But instead can setup admin right in the admin plugin he preferes and the other plugins can get the information they need for it.

''Note: AdminInterface is NOT created or maintained by the team behing Sourcemm /Amxmodx, its a interface created by a 3dparty and is kindly hosted on this wiki''

[[Category:Half-Life 2]]
[[Category:Metamod:Source Development]]

=What Admin plugins support it=
[http://www.thexsoft.com/index.php?page=basic-admin-tool Basic Admin Tool] 
[http://www.mani-admin-plugin.com Mani] 

''If you have a admin plugin that supports has support for the AdminInterface edit this page.''

=What plugins use this interface=
[http://forums.alliedmods.net/showthread.php?t=39511 ForgiveTK] - This plugin adds a simple TK system to any source server, so players can forgive teamkills & teamattacks. 
[http://forums.alliedmods.net/showthread.php?t=40097 CS Bot Control] - A plugin to easly manage the CS bots, with a handy menu 
[http://forums.alliedmods.net/showthread.php?t=40089 Sharedbans Spectator ESP (Source)] - This plugin allows admins/players who are spectating/dead and are in first person view of another player to see the enemies (and teammates) of that player through the walls. This may help to catch wallhackers 
[http://www.siekhe-trophy.de/forum/viewtopic.php?t=669 Clanmatch-Plugin ] A plugin to making controling a clan server more easy 

''If you have a plugin that uses the interface, feel free to add it here.''

=How do I use the AdminInterface in my plugin=
The following example is taken directly out of the [http://forums.alliedmods.net/showthread.php?t=39511 ForgiveTK] plugin, and this plugin offcourse is based of the sourcemm sample plugins. The soucemm sample plugins have this AllPluginsLoaded() function, this is a good time to check to see if you can find the AdminInterface, incase your plugin is loaded before the admin plugin.

==Getting started==
Before you start coding, you should get the AdminInterface.h file, you can get this file easy from [http://forums.alliedmods.net/showthread.php?t=39356 Basic Admin Tool] source ( in hl2sdk/batinterface.h ).
<pre>
AdminInterface *m_AdminManager;

void ForgiveTK::AllPluginsLoaded()
{
if(m_AdminManager) // We dont need to find the AdminInterface again, we allready found it once.
return;

//we don't really need this for anything other than interplugin communication
//and that's not used in this plugin.
//If we really wanted, we could override the factories so other plugins can request
// interfaces we make. In this callback, the plugin could be assured that either
// the interfaces it requires were either loaded in another plugin or not.
PluginId id2;

void *ptr = g_SMAPI->MetaFactory("AdminInterface", NULL, &id2);

if (!ptr)
{
ServerCommand("echo Did not find AdminInterface, plugin will not check admin rights");
} else {
m_AdminManager = (AdminInterface *)ptr;
m_AdminManager->AddEventListner(this);
int InterfaceVersion = m_AdminManager->GetInterfaceVersion();

if(InterfaceVersion == ADMININTERFACE_VERSION)
ServerCommand("echo Found AdminInterface[%d] at (%p), via %s (Interface version: %d)", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion);
else
ServerCommand("echo Found AdminInterface[%d] at (%p), but interface was NOT the expected version: Was %d Expected %d, this can create problems. Please update the plugin with the lowest interface version", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion,ADMININTERFACE_VERSION);
}
}
void ForgiveTK::Client_Authorized(int id) // This is called when a client is fully connected and authed by the admin tool, this normaly happens after the client has gotten a valid steamid & the admin tool has checked it against its internal user lists.
{
ServerCommand("echo Client_Authorized: %d",id);
}
void ForgiveTK::OnAdminInterfaceUnload() // Called when the admin interface is getting unloaded, this happens if a admin uses meta unload or the server is shutting down.
{
m_AdminManager = NULL;
ServerCommand("echo AdminInterface was unloaded");
}
</pre>
Its importent that you setup a callback to your plugin, when use the interface so the admin plugin can inform you plugin when its being unloaded.

==Using the interface==
The following function bellow would check if a user has a admin right equal to "immunity" and return true if thats the case.
<pre>
bool ForgiveTK::HasAdminImmunity(int id) // Checks if the user has a admin right "immunity"
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->HasFlag(id,"immunity");
}
</pre>
<pre>
Here we register a new access right, that we can check again later. If we dont want to use one of the predefined access rights.
bool ForgiveTK::RegisterNewAcccessFlag()
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->RegisterFlag("FakeAccess Class","FakeAccessRight","This is a fake access right");
}
</pre>

==Pre defined access rights==
These are the rights the admin tools allready support. And you can check for in your plugin:
Notice that all access rights are in lower case, and they are strings. The reason they are strings is becuse most admin tools are going to handle admin rights internaly diffrently, so this is the only way to export it properbly.

any - The "any" right may only be supported by [http://forums.alliedmods.net/showthread.php?t=39356 Basic Admin Tool], it basicly checks if the user has any of the rights bellow not including reservedslots 
kick - The access to kick a another player. 
slap - The access to slap another player. 
slay - The access to slay another player. 
ban - The access to ban another player. 
chat - The access to use admin chat and or admin say commads. 
rcon - the access to execute commands the server console. 
map - The access to change maps. 
reservedslots - The access to reservedslots. 
immunity - Immunity from certain actions from other players, like kick. 

=How do I add the AdminInterface in my plugin=
This is only for those that have a admin plugin, and want their plugin to support the interface
Download the [http://forums.alliedmods.net/showthread.php?t=39356 Basic Admin Tool] source code, and look at BATInterface .cpp / .h and add it to your plugin. Remember you cannot change AdminInterface / AdminInterfaceListner class in the header file as the interface must be the same in all the admin plugins.

Insurgency: Source Events

2007-07-08T19:13:01Z

EKS: New page: :''Refer back to Game Events (Source) for more events.'' === game_newmap === {{qnotice|Called before the chattime when the server is about to change amp}} {{begin-hl2msg|game_newmap|s...

:''Refer back to [[Game Events (Source)]] for more events.''

=== game_newmap ===
{{qnotice|Called before the chattime when the server is about to change amp}}
{{begin-hl2msg|game_newmap|string}}
{{hl2msg|string|mapname}}
{{end-hl2msg}}

Game Events (Source)

2007-07-08T16:27:51Z

EKS: Added Insurgency

These are all the games that the Source engine covers (that we could find).
* [[Generic Source Events]]
* [[Generic Source Server Events]]
* [[Counter-Strike: Source Events]]
* [[Day of Defeat: Source Events]]
* [[Half-Life 2: Deathmatch Events]]
* [[Half-Life 2: Capture the Flag Events]]
* [[Dystopia Events]]
* [[Pirates, Vikings, Knights II Events]]
* [[SourceForts Events]]
* [[Hidden: Source Events]]
* [[Perfect Dark: Source Events]]
* [[Iron Grip: Source Events]]
* [[Insurgency: Source Events]]
* [[Garry's Mod Events]]

== Credits ==
[[User:Shane|Shane]] - Writing some of the events pages and organization and general wikiknowhow 
[[User:FlyingMongoose|FlyingMongoose]] - Writing a lot of the events pages 
[[User:sslice|sslice]] - For creating a wikitizer application for these events

AdminInterface (Metamod:Source)

2006-12-26T19:50:26Z

EKS: /* What Admin plugins support it */ Removed upcomming text from an

=Introduction=

AdminInterface is a interface that allows sourcemm plugins to interact with admin plugins like [http://forums.alliedmods.net/showthread.php?t=39356 Basic Admin Tool] / [http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] to get the current admin rights of the players. It also allows the plugins to register custom access rights for their plugin.
This interface was made so smaller plugins, that may need admin rights for something simple dont need to make a system where the admin have to setup user rights for ever plugin. But instead can setup admin right in the admin plugin he preferes and the other plugins can get the information they need for it.

''Note: AdminInterface is NOT created or maintained by the team behing Sourcemm /Amxmodx, its a interface created by a 3dparty and is kindly hosted on this wiki''

[[Category:Half-Life 2]]
[[Category:SourceMM]]

=What Admin plugins support it=
[http://forums.alliedmods.net/showthread.php?t=39356 Basic Admin Tool] 
[http://www.mani-admin-plugin.com Mani] 

''If you have a admin plugin that supports has support for the AdminInterface edit this page.''

=What plugins use this interface=
[http://forums.alliedmods.net/showthread.php?t=39511 ForgiveTK] - This plugin adds a simple TK system to any source server, so players can forgive teamkills & teamattacks. 
[http://forums.alliedmods.net/showthread.php?t=40097 CS Bot Control] - A plugin to easly manage the CS bots, with a handy menu 
[http://forums.alliedmods.net/showthread.php?t=40089 Sharedbans Spectator ESP (Source)] - This plugin allows admins/players who are spectating/dead and are in first person view of another player to see the enemies (and teammates) of that player through the walls. This may help to catch wallhackers 
[http://www.siekhe-trophy.de/forum/viewtopic.php?t=669 Clanmatch-Plugin ] A plugin to making controling a clan server more easy 

''If you have a plugin that uses the interface, feel free to add it here.''

=How do I use the AdminInterface in my plugin=
The following example is taken directly out of the [http://forums.alliedmods.net/showthread.php?t=39511 ForgiveTK] plugin, and this plugin offcourse is based of the sourcemm sample plugins. The soucemm sample plugins have this AllPluginsLoaded() function, this is a good time to check to see if you can find the AdminInterface, incase your plugin is loaded before the admin plugin.

==Getting started==
Before you start coding, you should get the AdminInterface.h file, you can get this file easy from [http://forums.alliedmods.net/showthread.php?t=39356 Basic Admin Tool] source ( in hl2sdk/batinterface.h ).
<pre>
AdminInterface *m_AdminManager;

void ForgiveTK::AllPluginsLoaded()
{
if(m_AdminManager) // We dont need to find the AdminInterface again, we allready found it once.
return;

//we don't really need this for anything other than interplugin communication
//and that's not used in this plugin.
//If we really wanted, we could override the factories so other plugins can request
// interfaces we make. In this callback, the plugin could be assured that either
// the interfaces it requires were either loaded in another plugin or not.
PluginId id2;

void *ptr = g_SMAPI->MetaFactory("AdminInterface", NULL, &id2);

if (!ptr)
{
ServerCommand("echo Did not find AdminInterface, plugin will not check admin rights");
} else {
m_AdminManager = (AdminInterface *)ptr;
m_AdminManager->AddEventListner(this);
int InterfaceVersion = m_AdminManager->GetInterfaceVersion();

if(InterfaceVersion == ADMININTERFACE_VERSION)
ServerCommand("echo Found AdminInterface[%d] at (%p), via %s (Interface version: %d)", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion);
else
ServerCommand("echo Found AdminInterface[%d] at (%p), but interface was NOT the expected version: Was %d Expected %d, this can create problems. Please update the plugin with the lowest interface version", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion,ADMININTERFACE_VERSION);
}
}
void ForgiveTK::Client_Authorized(int id) // This is called when a client is fully connected and authed by the admin tool, this normaly happens after the client has gotten a valid steamid & the admin tool has checked it against its internal user lists.
{
ServerCommand("echo Client_Authorized: %d",id);
}
void ForgiveTK::OnAdminInterfaceUnload() // Called when the admin interface is getting unloaded, this happens if a admin uses meta unload or the server is shutting down.
{
m_AdminManager = NULL;
ServerCommand("echo AdminInterface was unloaded");
}
</pre>
Its importent that you setup a callback to your plugin, when use the interface so the admin plugin can inform you plugin when its being unloaded.

==Using the interface==
The following function bellow would check if a user has a admin right equal to "immunity" and return true if thats the case.
<pre>
bool ForgiveTK::HasAdminImmunity(int id) // Checks if the user has a admin right "immunity"
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->HasFlag(id,"immunity");
}
</pre>
<pre>
Here we register a new access right, that we can check again later. If we dont want to use one of the predefined access rights.
bool ForgiveTK::RegisterNewAcccessFlag()
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->RegisterFlag("FakeAccess Class","FakeAccessRight","This is a fake access right");
}
</pre>

==Pre defined access rights==
These are the rights the admin tools allready support. And you can check for in your plugin:
Notice that all access rights are in lower case, and they are strings. The reason they are strings is becuse most admin tools are going to handle admin rights internaly diffrently, so this is the only way to export it properbly.

any - The "any" right may only be supported by [http://forums.alliedmods.net/showthread.php?t=39356 Basic Admin Tool], it basicly checks if the user has any of the rights bellow not including reservedslots 
kick - The access to kick a another player. 
slap - The access to slap another player. 
slay - The access to slay another player. 
ban - The access to ban another player. 
chat - The access to use admin chat and or admin say commads. 
rcon - the access to execute commands the server console. 
map - The access to change maps. 
reservedslots - The access to reservedslots. 
immunity - Immunity from certain actions from other players, like kick. 

=How do I add the AdminInterface in my plugin=
This is only for those that have a admin plugin, and want their plugin to support the interface
Download the [http://forums.alliedmods.net/showthread.php?t=39356 Basic Admin Tool] source code, and look at BATInterface .cpp / .h and add it to your plugin. Remember you cannot change AdminInterface / AdminInterfaceListner class in the header file as the interface must be the same in all the admin plugins.

Open Source Plugins for Metamod:Source

2006-08-03T23:26:44Z

EKS: /* HLStatsX ( Allows srcds to interact with hlstatsx ingame) */

= Open Source Plugins for SourceMM =
This page lists known plugins with available source code. Please check the licenses for each one as they may not truly be "open source."
 
== Basic Templates ==
=== stub_mm ===
Author: [[User:BAILOPAN|BAILOPAN]] 
Description: minmum implentation of a valid SourceMM plugin 
Features: starting template 
Download: Included in the SourceMM source code package: [http://www.sourcemm.net www.sourcemm.net]
 

=== sample_mm ===
Author: [[User:BAILOPAN|BAILOPAN]] 
Description: implements the features of the standard Valve server plugin from the SDK 
Features: starting template with similar functionality to the Valve sample_plugin 
Download: Included in the SourceMM source code package: [http://www.sourcemm.net www.sourcemm.net]
 

=== sample2_mm ===
Author: [[User:BAILOPAN|BAILOPAN]], edited by [[User:L._Duke|L. Duke]] 
Description: fixes (by inheriting from IGameEventListener2 instead of hooking FireGameEvent) the problem in sample_mm plugin where some events are not received 
Features: starting template with similar functionality to the Valve sample_plugin 
Download: [http://forums.alliedmods.net/showthread.php?p=342749 forums.alliedmods.net/showthread.php?p=342749] (you must be logged in to view the download link)
 

== Functional Plugins ==
=== Anti-Griefer ===
Author: [[User:devicenull|devicenull]] 
Description: This plugin is for the mod SourceForts. In keeps track of what player unfreezes or freezes a block, and allows any other player to retrieve this information by aiming at a block. 
Features: Basic VFuncs, listening for events, partial traceline (The method used for traceline might not be effective for any other mod) 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3652 http://www.sourcemod.net/forums/viewtopic.php?t=3652]
 
=== Basic Admin Tool (BAT) ===
Author: [[User:EKS|EKS]] 
Description: Provides basic admin functions 
Features: Kick, ban, menus, reserved slots, timeleft/nextmap say commands, and more 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=2923 www.sourcemod.net/forums/viewtopic.php?t=2923]
 
=== Counter Strike Bot Control ===
Author: [[User:EKS|EKS]] 
Description: This plugin allows you to control the counter strike source bots more easly, you can have them them automaticly keep the server populated. You can have bots automaticly killed when all the human players are dead, and any changes can be made in the bot menu. 
Features: Control the built in bots in CSS via a menu 
Download: [http://forums.alliedmods.net/showthread.php?t=40097 http://forums.alliedmods.net/showthread.php?t=40097]
 

=== CS:S Weapon Restrictions 2 ===
Author: [[User:L._Duke|L. Duke]] 
Description: Prevents players from picking up restricted weapons (if bought, they fall to the ground). Also includes an option to remove restricted weapons from the game. 
Features: Hook CCSPlayer::Weapon_CanUse(CBaseCombatWeapon *pWeapon) and returns false for restricted weapons. Also shows how to use virtual functions on weapons such as Delete()and GetName() and on players for Weapon_GetSlot(int) and Drop(CBaseCombatWeapon*). 
Download: [http://forums.alliedmods.net/showthread.php?p=342750 forums.alliedmods.net/showthread.php?p=342750]
 
=== ForgiveTK ===
Author: [[User:EKS|EKS]] 
Description: This is a basic plugin to handle teamkilll and teamattack on your source server, it supports any Source mod. It will automaticly kick someone with to many offenses 
Features: Forgive via menu or chat. Support both Valves ESC menus and radio menus. 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3081 http://www.sourcemod.net/forums/viewtopic.php?t=3081]
 
=== Global Banlist===
Author: [[User:devicenull|devicenull]] 
Description: This plugin allows srcds to reguarly connect to an external PHP page, and download updates about it's banlist. Srcds then stores these in a SQLite database. 
Features: Embedding sqlite, using pthreads, using libcurl. 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3539 http://www.sourcemod.net/forums/viewtopic.php?t=3539]
 
=== HLStatsX ( Allows srcds to interact with hlstatsx ingame) ===
Author: [[User:EKS|EKS]] 
Description: This plugin is made to interact with hlstatsx ( www.hlstatsx.org ) to give proper ingame stats, and provide the extra logging required for hit detection 
Download: [http://forums.alliedmods.net/showthread.php?t=42502 http://forums.alliedmods.net/showthread.php?t=42502]
 

=== Last Users Connected ===
Author: [[User:devicenull|devicenull]] 
Description: With this plugin, every player who comes onto your server has their steamid logged, along with any name they used on the server. You can then either view the names/steamid's of the last people to disconnect, or you can search for a name/steamid and see everyone who has used that name. 
Features: shows how to embed sqlite3, send basic messages/basic hooks. 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3339 http://www.sourcemod.net/forums/viewtopic.php?t=3339]
 
=== Stripper:Source ===
Author: [[User:BAILOPAN|BAILOPAN]] 
Description: You can add any type of entity - hostage, spawn point, physics prop, permanently to the map. You can also filter out entities for deletion, either by specific entries or regular expressions. Stripper:Source lets you define global rules and per-map rules. It also lets other plugins (both SourceMM plugins and Server Plugins) use its API. 
Features: shows how to edit the map entity lump in memory to change map entities 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3008 www.sourcemod.net/forums/viewtopic.php?t=3008]
 
[[Category:Documentation (SourceMM)]]

= Open Source Valve Server Plugins (VSP) =
A list of open source plugins for the Valve Server Plugin (VSP) interface can be found [http://developer.valvesoftware.com/wiki/List_of_Open_Source_Server_Plugins here].

Open Source Plugins for Metamod:Source

2006-08-03T23:26:13Z

EKS: /* Functional Plugins */

= Open Source Plugins for SourceMM =
This page lists known plugins with available source code. Please check the licenses for each one as they may not truly be "open source."
 
== Basic Templates ==
=== stub_mm ===
Author: [[User:BAILOPAN|BAILOPAN]] 
Description: minmum implentation of a valid SourceMM plugin 
Features: starting template 
Download: Included in the SourceMM source code package: [http://www.sourcemm.net www.sourcemm.net]
 

=== sample_mm ===
Author: [[User:BAILOPAN|BAILOPAN]] 
Description: implements the features of the standard Valve server plugin from the SDK 
Features: starting template with similar functionality to the Valve sample_plugin 
Download: Included in the SourceMM source code package: [http://www.sourcemm.net www.sourcemm.net]
 

=== sample2_mm ===
Author: [[User:BAILOPAN|BAILOPAN]], edited by [[User:L._Duke|L. Duke]] 
Description: fixes (by inheriting from IGameEventListener2 instead of hooking FireGameEvent) the problem in sample_mm plugin where some events are not received 
Features: starting template with similar functionality to the Valve sample_plugin 
Download: [http://forums.alliedmods.net/showthread.php?p=342749 forums.alliedmods.net/showthread.php?p=342749] (you must be logged in to view the download link)
 

== Functional Plugins ==
=== Anti-Griefer ===
Author: [[User:devicenull|devicenull]] 
Description: This plugin is for the mod SourceForts. In keeps track of what player unfreezes or freezes a block, and allows any other player to retrieve this information by aiming at a block. 
Features: Basic VFuncs, listening for events, partial traceline (The method used for traceline might not be effective for any other mod) 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3652 http://www.sourcemod.net/forums/viewtopic.php?t=3652]
 
=== Basic Admin Tool (BAT) ===
Author: [[User:EKS|EKS]] 
Description: Provides basic admin functions 
Features: Kick, ban, menus, reserved slots, timeleft/nextmap say commands, and more 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=2923 www.sourcemod.net/forums/viewtopic.php?t=2923]
 
=== Counter Strike Bot Control ===
Author: [[User:EKS|EKS]] 
Description: This plugin allows you to control the counter strike source bots more easly, you can have them them automaticly keep the server populated. You can have bots automaticly killed when all the human players are dead, and any changes can be made in the bot menu. 
Features: Control the built in bots in CSS via a menu 
Download: [http://forums.alliedmods.net/showthread.php?t=40097 http://forums.alliedmods.net/showthread.php?t=40097]
 

=== CS:S Weapon Restrictions 2 ===
Author: [[User:L._Duke|L. Duke]] 
Description: Prevents players from picking up restricted weapons (if bought, they fall to the ground). Also includes an option to remove restricted weapons from the game. 
Features: Hook CCSPlayer::Weapon_CanUse(CBaseCombatWeapon *pWeapon) and returns false for restricted weapons. Also shows how to use virtual functions on weapons such as Delete()and GetName() and on players for Weapon_GetSlot(int) and Drop(CBaseCombatWeapon*). 
Download: [http://forums.alliedmods.net/showthread.php?p=342750 forums.alliedmods.net/showthread.php?p=342750]
 
=== ForgiveTK ===
Author: [[User:EKS|EKS]] 
Description: This is a basic plugin to handle teamkilll and teamattack on your source server, it supports any Source mod. It will automaticly kick someone with to many offenses 
Features: Forgive via menu or chat. Support both Valves ESC menus and radio menus. 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3081 http://www.sourcemod.net/forums/viewtopic.php?t=3081]
 
=== Global Banlist===
Author: [[User:devicenull|devicenull]] 
Description: This plugin allows srcds to reguarly connect to an external PHP page, and download updates about it's banlist. Srcds then stores these in a SQLite database. 
Features: Embedding sqlite, using pthreads, using libcurl. 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3539 http://www.sourcemod.net/forums/viewtopic.php?t=3539]
 
=== HLStatsX ( Allows srcds to interact with hlstatsx ingame) ===
Author: [[User:EKS|EKS]] 
Description: This plugin is made to interact with hlstatsx ( www.hlstatsx.org ) to give proper ingame stats, and provide the extra logging required for hit detection
Download: [http://forums.alliedmods.net/showthread.php?t=42502 http://forums.alliedmods.net/showthread.php?t=42502]
 
=== Last Users Connected ===
Author: [[User:devicenull|devicenull]] 
Description: With this plugin, every player who comes onto your server has their steamid logged, along with any name they used on the server. You can then either view the names/steamid's of the last people to disconnect, or you can search for a name/steamid and see everyone who has used that name. 
Features: shows how to embed sqlite3, send basic messages/basic hooks. 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3339 http://www.sourcemod.net/forums/viewtopic.php?t=3339]
 
=== Stripper:Source ===
Author: [[User:BAILOPAN|BAILOPAN]] 
Description: You can add any type of entity - hostage, spawn point, physics prop, permanently to the map. You can also filter out entities for deletion, either by specific entries or regular expressions. Stripper:Source lets you define global rules and per-map rules. It also lets other plugins (both SourceMM plugins and Server Plugins) use its API. 
Features: shows how to edit the map entity lump in memory to change map entities 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3008 www.sourcemod.net/forums/viewtopic.php?t=3008]
 
[[Category:Documentation (SourceMM)]]

= Open Source Valve Server Plugins (VSP) =
A list of open source plugins for the Valve Server Plugin (VSP) interface can be found [http://developer.valvesoftware.com/wiki/List_of_Open_Source_Server_Plugins here].

AdminInterface (Metamod:Source)

2006-07-18T19:10:38Z

EKS: Fixed old links

=Introduction=

AdminInterface is a interface that allows sourcemm plugins to interact with admin plugins like [http://forums.alliedmods.net/showthread.php?t=39356 Basic Admin Tool] / [http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] to get the current admin rights of the players. It also allows the plugins to register custom access rights for their plugin.
This interface was made so smaller plugins, that may need admin rights for something simple dont need to make a system where the admin have to setup user rights for ever plugin. But instead can setup admin right in the admin plugin he preferes and the other plugins can get the information they need for it.

''Note: AdminInterface is NOT created or maintained by the team behing Sourcemm /Amxmodx, its a interface created by a 3dparty and is kindly hosted on this wiki''

[[Category:Half-Life 2]]
[[Category:SourceMM]]

=What Admin plugins support it=
[http://forums.alliedmods.net/showthread.php?t=39356 Basic Admin Tool] 
[http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] 

''If you have a admin plugin that supports has support for the AdminInterface edit this page.''

=What plugins use this interface=
[http://forums.alliedmods.net/showthread.php?t=39511 ForgiveTK] - This plugin adds a simple TK system to any source server, so players can forgive teamkills & teamattacks. 
[http://forums.alliedmods.net/showthread.php?t=40097 CS Bot Control] - A plugin to easly manage the CS bots, with a handy menu 
[http://forums.alliedmods.net/showthread.php?t=40089 Sharedbans Spectator ESP (Source)] - This plugin allows admins/players who are spectating/dead and are in first person view of another player to see the enemies (and teammates) of that player through the walls. This may help to catch wallhackers 
[http://www.siekhe-trophy.de/forum/viewtopic.php?t=669 Clanmatch-Plugin ] A plugin to making controling a clan server more easy 

''If you have a plugin that uses the interface, feel free to add it here.''

=How do I use the AdminInterface in my plugin=
The following example is taken directly out of the [http://forums.alliedmods.net/showthread.php?t=39511 ForgiveTK] plugin, and this plugin offcourse is based of the sourcemm sample plugins. The soucemm sample plugins have this AllPluginsLoaded() function, this is a good time to check to see if you can find the AdminInterface, incase your plugin is loaded before the admin plugin.

==Getting started==
Before you start coding, you should get the AdminInterface.h file, you can get this file easy from [http://forums.alliedmods.net/showthread.php?t=39356 Basic Admin Tool] source ( in hl2sdk/batinterface.h ).
<pre>
AdminInterface *m_AdminManager;

void ForgiveTK::AllPluginsLoaded()
{
if(m_AdminManager) // We dont need to find the AdminInterface again, we allready found it once.
return;

//we don't really need this for anything other than interplugin communication
//and that's not used in this plugin.
//If we really wanted, we could override the factories so other plugins can request
// interfaces we make. In this callback, the plugin could be assured that either
// the interfaces it requires were either loaded in another plugin or not.
PluginId id2;

void *ptr = g_SMAPI->MetaFactory("AdminInterface", NULL, &id2);

if (!ptr)
{
ServerCommand("echo Did not find AdminInterface, plugin will not check admin rights");
} else {
m_AdminManager = (AdminInterface *)ptr;
m_AdminManager->AddEventListner(this);
int InterfaceVersion = m_AdminManager->GetInterfaceVersion();

if(InterfaceVersion == ADMININTERFACE_VERSION)
ServerCommand("echo Found AdminInterface[%d] at (%p), via %s (Interface version: %d)", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion);
else
ServerCommand("echo Found AdminInterface[%d] at (%p), but interface was NOT the expected version: Was %d Expected %d, this can create problems. Please update the plugin with the lowest interface version", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion,ADMININTERFACE_VERSION);
}
}
void ForgiveTK::Client_Authorized(int id) // This is called when a client is fully connected and authed by the admin tool, this normaly happens after the client has gotten a valid steamid & the admin tool has checked it against its internal user lists.
{
ServerCommand("echo Client_Authorized: %d",id);
}
void ForgiveTK::OnAdminInterfaceUnload() // Called when the admin interface is getting unloaded, this happens if a admin uses meta unload or the server is shutting down.
{
m_AdminManager = NULL;
ServerCommand("echo AdminInterface was unloaded");
}
</pre>
Its importent that you setup a callback to your plugin, when use the interface so the admin plugin can inform you plugin when its being unloaded.

==Using the interface==
The following function bellow would check if a user has a admin right equal to "immunity" and return true if thats the case.
<pre>
bool ForgiveTK::HasAdminImmunity(int id) // Checks if the user has a admin right "immunity"
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->HasFlag(id,"immunity");
}
</pre>
<pre>
Here we register a new access right, that we can check again later. If we dont want to use one of the predefined access rights.
bool ForgiveTK::RegisterNewAcccessFlag()
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->RegisterFlag("FakeAccess Class","FakeAccessRight","This is a fake access right");
}
</pre>

==Pre defined access rights==
These are the rights the admin tools allready support. And you can check for in your plugin:
Notice that all access rights are in lower case, and they are strings. The reason they are strings is becuse most admin tools are going to handle admin rights internaly diffrently, so this is the only way to export it properbly.

any - The "any" right may only be supported by [http://forums.alliedmods.net/showthread.php?t=39356 Basic Admin Tool], it basicly checks if the user has any of the rights bellow not including reservedslots 
kick - The access to kick a another player. 
slap - The access to slap another player. 
slay - The access to slay another player. 
ban - The access to ban another player. 
chat - The access to use admin chat and or admin say commads. 
rcon - the access to execute commands the server console. 
map - The access to change maps. 
reservedslots - The access to reservedslots. 
immunity - Immunity from certain actions from other players, like kick. 

=How do I add the AdminInterface in my plugin=
This is only for those that have a admin plugin, and want their plugin to support the interface
Download the [http://forums.alliedmods.net/showthread.php?t=39356 Basic Admin Tool] source code, and look at BATInterface .cpp / .h and add it to your plugin. Remember you cannot change AdminInterface / AdminInterfaceListner class in the header file as the interface must be the same in all the admin plugins.

AdminInterface (Metamod:Source)

2006-07-18T19:08:13Z

EKS: /* What plugins use this interface */

=Introduction=

AdminInterface is a interface that allows sourcemm plugins to interact with admin plugins like [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] / [http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] to get the current admin rights of the players. It also allows the plugins to register custom access rights for their plugin.
This interface was made so smaller plugins, that may need admin rights for something simple dont need to make a system where the admin have to setup user rights for ever plugin. But instead can setup admin right in the admin plugin he preferes and the other plugins can get the information they need for it.

''Note: AdminInterface is NOT created or maintained by the team behing Sourcemm /Amxmodx, its a interface created by a 3dparty and is kindly hosted on this wiki''

[[Category:Half-Life 2]]
[[Category:SourceMM]]

=What Admin plugins support it=
[http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] 
[http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] 

''If you have a admin plugin that supports has support for the AdminInterface edit this page.''

=What plugins use this interface=
[http://forums.alliedmods.net/showthread.php?t=39511 ForgiveTK] - This plugin adds a simple TK system to any source server, so players can forgive teamkills & teamattacks. 
[http://forums.alliedmods.net/showthread.php?t=40097 CS Bot Control] - A plugin to easly manage the CS bots, with a handy menu 
[http://forums.alliedmods.net/showthread.php?t=40089 Sharedbans Spectator ESP (Source)] - This plugin allows admins/players who are spectating/dead and are in first person view of another player to see the enemies (and teammates) of that player through the walls. This may help to catch wallhackers 
[http://www.siekhe-trophy.de/forum/viewtopic.php?t=669 Clanmatch-Plugin ] A plugin to making controling a clan server more easy 

''If you have a plugin that uses the interface, feel free to add it here.''

=How do I use the AdminInterface in my plugin=
The following example is taken directly out of the [http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] plugin, and this plugin offcourse is based of the sourcemm sample plugins. The soucemm sample plugins have this AllPluginsLoaded() function, this is a good time to check to see if you can find the AdminInterface, incase your plugin is loaded before the admin plugin.

==Getting started==
Before you start coding, you should get the AdminInterface.h file, you can get this file easy from [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source ( in hl2sdk/batinterface.h ).
<pre>
AdminInterface *m_AdminManager;

void ForgiveTK::AllPluginsLoaded()
{
if(m_AdminManager) // We dont need to find the AdminInterface again, we allready found it once.
return;

//we don't really need this for anything other than interplugin communication
//and that's not used in this plugin.
//If we really wanted, we could override the factories so other plugins can request
// interfaces we make. In this callback, the plugin could be assured that either
// the interfaces it requires were either loaded in another plugin or not.
PluginId id2;

void *ptr = g_SMAPI->MetaFactory("AdminInterface", NULL, &id2);

if (!ptr)
{
ServerCommand("echo Did not find AdminInterface, plugin will not check admin rights");
} else {
m_AdminManager = (AdminInterface *)ptr;
m_AdminManager->AddEventListner(this);
int InterfaceVersion = m_AdminManager->GetInterfaceVersion();

if(InterfaceVersion == ADMININTERFACE_VERSION)
ServerCommand("echo Found AdminInterface[%d] at (%p), via %s (Interface version: %d)", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion);
else
ServerCommand("echo Found AdminInterface[%d] at (%p), but interface was NOT the expected version: Was %d Expected %d, this can create problems. Please update the plugin with the lowest interface version", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion,ADMININTERFACE_VERSION);
}
}
void ForgiveTK::Client_Authorized(int id) // This is called when a client is fully connected and authed by the admin tool, this normaly happens after the client has gotten a valid steamid & the admin tool has checked it against its internal user lists.
{
ServerCommand("echo Client_Authorized: %d",id);
}
void ForgiveTK::OnAdminInterfaceUnload() // Called when the admin interface is getting unloaded, this happens if a admin uses meta unload or the server is shutting down.
{
m_AdminManager = NULL;
ServerCommand("echo AdminInterface was unloaded");
}
</pre>
Its importent that you setup a callback to your plugin, when use the interface so the admin plugin can inform you plugin when its being unloaded.

==Using the interface==
The following function bellow would check if a user has a admin right equal to "immunity" and return true if thats the case.
<pre>
bool ForgiveTK::HasAdminImmunity(int id) // Checks if the user has a admin right "immunity"
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->HasFlag(id,"immunity");
}
</pre>
<pre>
Here we register a new access right, that we can check again later. If we dont want to use one of the predefined access rights.
bool ForgiveTK::RegisterNewAcccessFlag()
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->RegisterFlag("FakeAccess Class","FakeAccessRight","This is a fake access right");
}
</pre>

==Pre defined access rights==
These are the rights the admin tools allready support. And you can check for in your plugin:
Notice that all access rights are in lower case, and they are strings. The reason they are strings is becuse most admin tools are going to handle admin rights internaly diffrently, so this is the only way to export it properbly.

any - The "any" right may only be supported by [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool], it basicly checks if the user has any of the rights bellow not including reservedslots 
kick - The access to kick a another player. 
slap - The access to slap another player. 
slay - The access to slay another player. 
ban - The access to ban another player. 
chat - The access to use admin chat and or admin say commads. 
rcon - the access to execute commands the server console. 
map - The access to change maps. 
reservedslots - The access to reservedslots. 
immunity - Immunity from certain actions from other players, like kick. 

=How do I add the AdminInterface in my plugin=
This is only for those that have a admin plugin, and want their plugin to support the interface
Download the [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source code, and look at BATInterface .cpp / .h and add it to your plugin. Remember you cannot change AdminInterface / AdminInterfaceListner class in the header file as the interface must be the same in all the admin plugins.

AdminInterface (Metamod:Source)

2006-07-18T18:58:54Z

EKS: /* What plugins use this interface */ Fixed links added 2 plugins

=Introduction=

AdminInterface is a interface that allows sourcemm plugins to interact with admin plugins like [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] / [http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] to get the current admin rights of the players. It also allows the plugins to register custom access rights for their plugin.
This interface was made so smaller plugins, that may need admin rights for something simple dont need to make a system where the admin have to setup user rights for ever plugin. But instead can setup admin right in the admin plugin he preferes and the other plugins can get the information they need for it.

''Note: AdminInterface is NOT created or maintained by the team behing Sourcemm /Amxmodx, its a interface created by a 3dparty and is kindly hosted on this wiki''

[[Category:Half-Life 2]]
[[Category:SourceMM]]

=What Admin plugins support it=
[http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] 
[http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] 

''If you have a admin plugin that supports has support for the AdminInterface edit this page.''

=What plugins use this interface=
[http://forums.alliedmods.net/showthread.php?t=39511 ForgiveTK] - This plugin adds a simple TK system to any source server, so players can forgive teamkills & teamattacks. 
[http://forums.alliedmods.net/showthread.php?t=40097 CS Bot Control] - A plugin to easly manage the CS bots, with a handy menu
[http://forums.alliedmods.net/showthread.php?t=40089 Sharedbans Spectator ESP (Source)] - This plugin allows admins/players who are spectating/dead and are in first person view of another player to see the enemies (and teammates) of that player through the walls. This may help to catch wallhackers
[http://www.siekhe-trophy.de/forum/viewtopic.php?t=669 Clanmatch-Plugin ] A plugin to making controling a clan server more easy

''If you have a plugin that uses the interface, feel free to add it here.''

=How do I use the AdminInterface in my plugin=
The following example is taken directly out of the [http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] plugin, and this plugin offcourse is based of the sourcemm sample plugins. The soucemm sample plugins have this AllPluginsLoaded() function, this is a good time to check to see if you can find the AdminInterface, incase your plugin is loaded before the admin plugin.

==Getting started==
Before you start coding, you should get the AdminInterface.h file, you can get this file easy from [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source ( in hl2sdk/batinterface.h ).
<pre>
AdminInterface *m_AdminManager;

void ForgiveTK::AllPluginsLoaded()
{
if(m_AdminManager) // We dont need to find the AdminInterface again, we allready found it once.
return;

//we don't really need this for anything other than interplugin communication
//and that's not used in this plugin.
//If we really wanted, we could override the factories so other plugins can request
// interfaces we make. In this callback, the plugin could be assured that either
// the interfaces it requires were either loaded in another plugin or not.
PluginId id2;

void *ptr = g_SMAPI->MetaFactory("AdminInterface", NULL, &id2);

if (!ptr)
{
ServerCommand("echo Did not find AdminInterface, plugin will not check admin rights");
} else {
m_AdminManager = (AdminInterface *)ptr;
m_AdminManager->AddEventListner(this);
int InterfaceVersion = m_AdminManager->GetInterfaceVersion();

if(InterfaceVersion == ADMININTERFACE_VERSION)
ServerCommand("echo Found AdminInterface[%d] at (%p), via %s (Interface version: %d)", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion);
else
ServerCommand("echo Found AdminInterface[%d] at (%p), but interface was NOT the expected version: Was %d Expected %d, this can create problems. Please update the plugin with the lowest interface version", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion,ADMININTERFACE_VERSION);
}
}
void ForgiveTK::Client_Authorized(int id) // This is called when a client is fully connected and authed by the admin tool, this normaly happens after the client has gotten a valid steamid & the admin tool has checked it against its internal user lists.
{
ServerCommand("echo Client_Authorized: %d",id);
}
void ForgiveTK::OnAdminInterfaceUnload() // Called when the admin interface is getting unloaded, this happens if a admin uses meta unload or the server is shutting down.
{
m_AdminManager = NULL;
ServerCommand("echo AdminInterface was unloaded");
}
</pre>
Its importent that you setup a callback to your plugin, when use the interface so the admin plugin can inform you plugin when its being unloaded.

==Using the interface==
The following function bellow would check if a user has a admin right equal to "immunity" and return true if thats the case.
<pre>
bool ForgiveTK::HasAdminImmunity(int id) // Checks if the user has a admin right "immunity"
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->HasFlag(id,"immunity");
}
</pre>
<pre>
Here we register a new access right, that we can check again later. If we dont want to use one of the predefined access rights.
bool ForgiveTK::RegisterNewAcccessFlag()
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->RegisterFlag("FakeAccess Class","FakeAccessRight","This is a fake access right");
}
</pre>

==Pre defined access rights==
These are the rights the admin tools allready support. And you can check for in your plugin:
Notice that all access rights are in lower case, and they are strings. The reason they are strings is becuse most admin tools are going to handle admin rights internaly diffrently, so this is the only way to export it properbly.

any - The "any" right may only be supported by [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool], it basicly checks if the user has any of the rights bellow not including reservedslots 
kick - The access to kick a another player. 
slap - The access to slap another player. 
slay - The access to slay another player. 
ban - The access to ban another player. 
chat - The access to use admin chat and or admin say commads. 
rcon - the access to execute commands the server console. 
map - The access to change maps. 
reservedslots - The access to reservedslots. 
immunity - Immunity from certain actions from other players, like kick. 

=How do I add the AdminInterface in my plugin=
This is only for those that have a admin plugin, and want their plugin to support the interface
Download the [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source code, and look at BATInterface .cpp / .h and add it to your plugin. Remember you cannot change AdminInterface / AdminInterfaceListner class in the header file as the interface must be the same in all the admin plugins.

AdminInterface (Metamod:Source)

2006-06-25T13:13:08Z

EKS: /* Pre defined access rights */ fixed formating

=Introduction=

AdminInterface is a interface that allows sourcemm plugins to interact with admin plugins like [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] / [http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] to get the current admin rights of the players. It also allows the plugins to register custom access rights for their plugin.
This interface was made so smaller plugins, that may need admin rights for something simple dont need to make a system where the admin have to setup user rights for ever plugin. But instead can setup admin right in the admin plugin he preferes and the other plugins can get the information they need for it.

''Note: AdminInterface is NOT created or maintained by the team behing Sourcemm /Amxmodx, its a interface created by a 3dparty and is kindly hosted on this wiki''

[[Category:Half-Life 2]]
[[Category:SourceMM]]

=What Admin plugins support it=
[http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] 
[http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] 

''If you have a admin plugin that supports has support for the AdminInterface edit this page.''

=What plugins use this interface=
[http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] - This plugin adds a simple TK system to any source server, so players can forgive teamkills & teamattacks. 
[http://www.sourcemod.net/forums/viewtopic.php?p=35047 CS Bot Control] - A plugin to easly manage the CS bots, with a handy menu

''If you have a plugin that uses the interface, feel free to add it here.''

=How do I use the AdminInterface in my plugin=
The following example is taken directly out of the [http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] plugin, and this plugin offcourse is based of the sourcemm sample plugins. The soucemm sample plugins have this AllPluginsLoaded() function, this is a good time to check to see if you can find the AdminInterface, incase your plugin is loaded before the admin plugin.

==Getting started==
Before you start coding, you should get the AdminInterface.h file, you can get this file easy from [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source ( in hl2sdk/batinterface.h ).
<pre>
AdminInterface *m_AdminManager;

void ForgiveTK::AllPluginsLoaded()
{
if(m_AdminManager) // We dont need to find the AdminInterface again, we allready found it once.
return;

//we don't really need this for anything other than interplugin communication
//and that's not used in this plugin.
//If we really wanted, we could override the factories so other plugins can request
// interfaces we make. In this callback, the plugin could be assured that either
// the interfaces it requires were either loaded in another plugin or not.
PluginId id2;

void *ptr = g_SMAPI->MetaFactory("AdminInterface", NULL, &id2);

if (!ptr)
{
ServerCommand("echo Did not find AdminInterface, plugin will not check admin rights");
} else {
m_AdminManager = (AdminInterface *)ptr;
m_AdminManager->AddEventListner(this);
int InterfaceVersion = m_AdminManager->GetInterfaceVersion();

if(InterfaceVersion == ADMININTERFACE_VERSION)
ServerCommand("echo Found AdminInterface[%d] at (%p), via %s (Interface version: %d)", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion);
else
ServerCommand("echo Found AdminInterface[%d] at (%p), but interface was NOT the expected version: Was %d Expected %d, this can create problems. Please update the plugin with the lowest interface version", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion,ADMININTERFACE_VERSION);
}
}
void ForgiveTK::Client_Authorized(int id) // This is called when a client is fully connected and authed by the admin tool, this normaly happens after the client has gotten a valid steamid & the admin tool has checked it against its internal user lists.
{
ServerCommand("echo Client_Authorized: %d",id);
}
void ForgiveTK::OnAdminInterfaceUnload() // Called when the admin interface is getting unloaded, this happens if a admin uses meta unload or the server is shutting down.
{
m_AdminManager = NULL;
ServerCommand("echo AdminInterface was unloaded");
}
</pre>
Its importent that you setup a callback to your plugin, when use the interface so the admin plugin can inform you plugin when its being unloaded.

==Using the interface==
The following function bellow would check if a user has a admin right equal to "immunity" and return true if thats the case.
<pre>
bool ForgiveTK::HasAdminImmunity(int id) // Checks if the user has a admin right "immunity"
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->HasFlag(id,"immunity");
}
</pre>
<pre>
Here we register a new access right, that we can check again later. If we dont want to use one of the predefined access rights.
bool ForgiveTK::RegisterNewAcccessFlag()
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->RegisterFlag("FakeAccess Class","FakeAccessRight","This is a fake access right");
}
</pre>

==Pre defined access rights==
These are the rights the admin tools allready support. And you can check for in your plugin:
Notice that all access rights are in lower case, and they are strings. The reason they are strings is becuse most admin tools are going to handle admin rights internaly diffrently, so this is the only way to export it properbly.

any - The "any" right may only be supported by [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool], it basicly checks if the user has any of the rights bellow not including reservedslots 
kick - The access to kick a another player. 
slap - The access to slap another player. 
slay - The access to slay another player. 
ban - The access to ban another player. 
chat - The access to use admin chat and or admin say commads. 
rcon - the access to execute commands the server console. 
map - The access to change maps. 
reservedslots - The access to reservedslots. 
immunity - Immunity from certain actions from other players, like kick. 

=How do I add the AdminInterface in my plugin=
This is only for those that have a admin plugin, and want their plugin to support the interface
Download the [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source code, and look at BATInterface .cpp / .h and add it to your plugin. Remember you cannot change AdminInterface / AdminInterfaceListner class in the header file as the interface must be the same in all the admin plugins.

AdminInterface (Metamod:Source)

2006-06-10T20:26:37Z

EKS: /* What plugins use this interface */

=Introduction=

AdminInterface is a interface that allows sourcemm plugins to interact with admin plugins like [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] / [http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] to get the current admin rights of the players. It also allows the plugins to register custom access rights for their plugin.
This interface was made so smaller plugins, that may need admin rights for something simple dont need to make a system where the admin have to setup user rights for ever plugin. But instead can setup admin right in the admin plugin he preferes and the other plugins can get the information they need for it.

''Note: AdminInterface is NOT created or maintained by the team behing Sourcemm /Amxmodx, its a interface created by a 3dparty and is kindly hosted on this wiki''

[[Category:Half-Life 2]]
[[Category:SourceMM]]

=What Admin plugins support it=
[http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] 
[http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] 

''If you have a admin plugin that supports has support for the AdminInterface edit this page.''

=What plugins use this interface=
[http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] - This plugin adds a simple TK system to any source server, so players can forgive teamkills & teamattacks. 
[http://www.sourcemod.net/forums/viewtopic.php?p=35047 CS Bot Control] - A plugin to easly manage the CS bots, with a handy menu

''If you have a plugin that uses the interface, feel free to add it here.''

=How do I use the AdminInterface in my plugin=
The following example is taken directly out of the [http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] plugin, and this plugin offcourse is based of the sourcemm sample plugins. The soucemm sample plugins have this AllPluginsLoaded() function, this is a good time to check to see if you can find the AdminInterface, incase your plugin is loaded before the admin plugin.

==Getting started==
Before you start coding, you should get the AdminInterface.h file, you can get this file easy from [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source ( in hl2sdk/batinterface.h ).
<pre>
AdminInterface *m_AdminManager;

void ForgiveTK::AllPluginsLoaded()
{
if(m_AdminManager) // We dont need to find the AdminInterface again, we allready found it once.
return;

//we don't really need this for anything other than interplugin communication
//and that's not used in this plugin.
//If we really wanted, we could override the factories so other plugins can request
// interfaces we make. In this callback, the plugin could be assured that either
// the interfaces it requires were either loaded in another plugin or not.
PluginId id2;

void *ptr = g_SMAPI->MetaFactory("AdminInterface", NULL, &id2);

if (!ptr)
{
ServerCommand("echo Did not find AdminInterface, plugin will not check admin rights");
} else {
m_AdminManager = (AdminInterface *)ptr;
m_AdminManager->AddEventListner(this);
int InterfaceVersion = m_AdminManager->GetInterfaceVersion();

if(InterfaceVersion == ADMININTERFACE_VERSION)
ServerCommand("echo Found AdminInterface[%d] at (%p), via %s (Interface version: %d)", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion);
else
ServerCommand("echo Found AdminInterface[%d] at (%p), but interface was NOT the expected version: Was %d Expected %d, this can create problems. Please update the plugin with the lowest interface version", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion,ADMININTERFACE_VERSION);
}
}
void ForgiveTK::Client_Authorized(int id) // This is called when a client is fully connected and authed by the admin tool, this normaly happens after the client has gotten a valid steamid & the admin tool has checked it against its internal user lists.
{
ServerCommand("echo Client_Authorized: %d",id);
}
void ForgiveTK::OnAdminInterfaceUnload() // Called when the admin interface is getting unloaded, this happens if a admin uses meta unload or the server is shutting down.
{
m_AdminManager = NULL;
ServerCommand("echo AdminInterface was unloaded");
}
</pre>
Its importent that you setup a callback to your plugin, when use the interface so the admin plugin can inform you plugin when its being unloaded.

==Using the interface==
The following function bellow would check if a user has a admin right equal to "immunity" and return true if thats the case.
<pre>
bool ForgiveTK::HasAdminImmunity(int id) // Checks if the user has a admin right "immunity"
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->HasFlag(id,"immunity");
}
</pre>
<pre>
Here we register a new access right, that we can check again later. If we dont want to use one of the predefined access rights.
bool ForgiveTK::RegisterNewAcccessFlag()
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->RegisterFlag("FakeAccess Class","FakeAccessRight","This is a fake access right");
}
</pre>

==Pre defined access rights==
These are the rights the admin tools allready support. And you can check for in your plugin:
Notice that all access rights are in lower case, and they are strings. The reason they are strings is becuse most admin tools are going to handle admin rights internaly diffrently, so this is the only way to export it properbly.

any - The "any" right may only be supported by [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool], it basicly checks if the user has any of the rights bellow not including reservedslots
kick - The access to kick a another player. 
slap - The access to slap another player. 
slay - The access to slay another player. 
ban - The access to ban another player. 
chat - The access to use admin chat and or admin say commads. 
rcon - the access to execute commands the server console. 
map - The access to change maps. 
reservedslots - The access to reservedslots. 
immunity - Immunity from certain actions from other players, like kick. 

=How do I add the AdminInterface in my plugin=
This is only for those that have a admin plugin, and want their plugin to support the interface
Download the [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source code, and look at BATInterface .cpp / .h and add it to your plugin. Remember you cannot change AdminInterface / AdminInterfaceListner class in the header file as the interface must be the same in all the admin plugins.

AdminInterface (Metamod:Source)

2006-06-10T20:25:53Z

EKS: /* What plugins use this interface */

=Introduction=

AdminInterface is a interface that allows sourcemm plugins to interact with admin plugins like [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] / [http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] to get the current admin rights of the players. It also allows the plugins to register custom access rights for their plugin.
This interface was made so smaller plugins, that may need admin rights for something simple dont need to make a system where the admin have to setup user rights for ever plugin. But instead can setup admin right in the admin plugin he preferes and the other plugins can get the information they need for it.

''Note: AdminInterface is NOT created or maintained by the team behing Sourcemm /Amxmodx, its a interface created by a 3dparty and is kindly hosted on this wiki''

[[Category:Half-Life 2]]
[[Category:SourceMM]]

=What Admin plugins support it=
[http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] 
[http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] 

''If you have a admin plugin that supports has support for the AdminInterface edit this page.''

=What plugins use this interface=
[http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] - This plugin adds a simple TK system to any source server, so players can forgive teamkills & teamattacks. 
[http://www.sourcemod.net/forums/viewtopic.php?t=35047 CS Bot Control] - A plugin to easly manage the CS bots, with a handy menu

''If you have a plugin that uses the interface, feel free to add it here.''

=How do I use the AdminInterface in my plugin=
The following example is taken directly out of the [http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] plugin, and this plugin offcourse is based of the sourcemm sample plugins. The soucemm sample plugins have this AllPluginsLoaded() function, this is a good time to check to see if you can find the AdminInterface, incase your plugin is loaded before the admin plugin.

==Getting started==
Before you start coding, you should get the AdminInterface.h file, you can get this file easy from [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source ( in hl2sdk/batinterface.h ).
<pre>
AdminInterface *m_AdminManager;

void ForgiveTK::AllPluginsLoaded()
{
if(m_AdminManager) // We dont need to find the AdminInterface again, we allready found it once.
return;

//we don't really need this for anything other than interplugin communication
//and that's not used in this plugin.
//If we really wanted, we could override the factories so other plugins can request
// interfaces we make. In this callback, the plugin could be assured that either
// the interfaces it requires were either loaded in another plugin or not.
PluginId id2;

void *ptr = g_SMAPI->MetaFactory("AdminInterface", NULL, &id2);

if (!ptr)
{
ServerCommand("echo Did not find AdminInterface, plugin will not check admin rights");
} else {
m_AdminManager = (AdminInterface *)ptr;
m_AdminManager->AddEventListner(this);
int InterfaceVersion = m_AdminManager->GetInterfaceVersion();

if(InterfaceVersion == ADMININTERFACE_VERSION)
ServerCommand("echo Found AdminInterface[%d] at (%p), via %s (Interface version: %d)", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion);
else
ServerCommand("echo Found AdminInterface[%d] at (%p), but interface was NOT the expected version: Was %d Expected %d, this can create problems. Please update the plugin with the lowest interface version", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion,ADMININTERFACE_VERSION);
}
}
void ForgiveTK::Client_Authorized(int id) // This is called when a client is fully connected and authed by the admin tool, this normaly happens after the client has gotten a valid steamid & the admin tool has checked it against its internal user lists.
{
ServerCommand("echo Client_Authorized: %d",id);
}
void ForgiveTK::OnAdminInterfaceUnload() // Called when the admin interface is getting unloaded, this happens if a admin uses meta unload or the server is shutting down.
{
m_AdminManager = NULL;
ServerCommand("echo AdminInterface was unloaded");
}
</pre>
Its importent that you setup a callback to your plugin, when use the interface so the admin plugin can inform you plugin when its being unloaded.

==Using the interface==
The following function bellow would check if a user has a admin right equal to "immunity" and return true if thats the case.
<pre>
bool ForgiveTK::HasAdminImmunity(int id) // Checks if the user has a admin right "immunity"
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->HasFlag(id,"immunity");
}
</pre>
<pre>
Here we register a new access right, that we can check again later. If we dont want to use one of the predefined access rights.
bool ForgiveTK::RegisterNewAcccessFlag()
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->RegisterFlag("FakeAccess Class","FakeAccessRight","This is a fake access right");
}
</pre>

==Pre defined access rights==
These are the rights the admin tools allready support. And you can check for in your plugin:
Notice that all access rights are in lower case, and they are strings. The reason they are strings is becuse most admin tools are going to handle admin rights internaly diffrently, so this is the only way to export it properbly.

any - The "any" right may only be supported by [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool], it basicly checks if the user has any of the rights bellow not including reservedslots
kick - The access to kick a another player. 
slap - The access to slap another player. 
slay - The access to slay another player. 
ban - The access to ban another player. 
chat - The access to use admin chat and or admin say commads. 
rcon - the access to execute commands the server console. 
map - The access to change maps. 
reservedslots - The access to reservedslots. 
immunity - Immunity from certain actions from other players, like kick. 

=How do I add the AdminInterface in my plugin=
This is only for those that have a admin plugin, and want their plugin to support the interface
Download the [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source code, and look at BATInterface .cpp / .h and add it to your plugin. Remember you cannot change AdminInterface / AdminInterfaceListner class in the header file as the interface must be the same in all the admin plugins.

AdminInterface (Metamod:Source)

2006-06-10T20:25:38Z

EKS: /* What plugins use this interface */ added csbotc

=Introduction=

AdminInterface is a interface that allows sourcemm plugins to interact with admin plugins like [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] / [http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] to get the current admin rights of the players. It also allows the plugins to register custom access rights for their plugin.
This interface was made so smaller plugins, that may need admin rights for something simple dont need to make a system where the admin have to setup user rights for ever plugin. But instead can setup admin right in the admin plugin he preferes and the other plugins can get the information they need for it.

''Note: AdminInterface is NOT created or maintained by the team behing Sourcemm /Amxmodx, its a interface created by a 3dparty and is kindly hosted on this wiki''

[[Category:Half-Life 2]]
[[Category:SourceMM]]

=What Admin plugins support it=
[http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] 
[http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] 

''If you have a admin plugin that supports has support for the AdminInterface edit this page.''

=What plugins use this interface=
[http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] - This plugin adds a simple TK system to any source server, so players can forgive teamkills & teamattacks.
[http://www.sourcemod.net/forums/viewtopic.php?t=35047 CS Bot Control] - A plugin to easly manage the CS bots, with a handy menu

''If you have a plugin that uses the interface, feel free to add it here.''

=How do I use the AdminInterface in my plugin=
The following example is taken directly out of the [http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] plugin, and this plugin offcourse is based of the sourcemm sample plugins. The soucemm sample plugins have this AllPluginsLoaded() function, this is a good time to check to see if you can find the AdminInterface, incase your plugin is loaded before the admin plugin.

==Getting started==
Before you start coding, you should get the AdminInterface.h file, you can get this file easy from [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source ( in hl2sdk/batinterface.h ).
<pre>
AdminInterface *m_AdminManager;

void ForgiveTK::AllPluginsLoaded()
{
if(m_AdminManager) // We dont need to find the AdminInterface again, we allready found it once.
return;

//we don't really need this for anything other than interplugin communication
//and that's not used in this plugin.
//If we really wanted, we could override the factories so other plugins can request
// interfaces we make. In this callback, the plugin could be assured that either
// the interfaces it requires were either loaded in another plugin or not.
PluginId id2;

void *ptr = g_SMAPI->MetaFactory("AdminInterface", NULL, &id2);

if (!ptr)
{
ServerCommand("echo Did not find AdminInterface, plugin will not check admin rights");
} else {
m_AdminManager = (AdminInterface *)ptr;
m_AdminManager->AddEventListner(this);
int InterfaceVersion = m_AdminManager->GetInterfaceVersion();

if(InterfaceVersion == ADMININTERFACE_VERSION)
ServerCommand("echo Found AdminInterface[%d] at (%p), via %s (Interface version: %d)", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion);
else
ServerCommand("echo Found AdminInterface[%d] at (%p), but interface was NOT the expected version: Was %d Expected %d, this can create problems. Please update the plugin with the lowest interface version", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion,ADMININTERFACE_VERSION);
}
}
void ForgiveTK::Client_Authorized(int id) // This is called when a client is fully connected and authed by the admin tool, this normaly happens after the client has gotten a valid steamid & the admin tool has checked it against its internal user lists.
{
ServerCommand("echo Client_Authorized: %d",id);
}
void ForgiveTK::OnAdminInterfaceUnload() // Called when the admin interface is getting unloaded, this happens if a admin uses meta unload or the server is shutting down.
{
m_AdminManager = NULL;
ServerCommand("echo AdminInterface was unloaded");
}
</pre>
Its importent that you setup a callback to your plugin, when use the interface so the admin plugin can inform you plugin when its being unloaded.

==Using the interface==
The following function bellow would check if a user has a admin right equal to "immunity" and return true if thats the case.
<pre>
bool ForgiveTK::HasAdminImmunity(int id) // Checks if the user has a admin right "immunity"
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->HasFlag(id,"immunity");
}
</pre>
<pre>
Here we register a new access right, that we can check again later. If we dont want to use one of the predefined access rights.
bool ForgiveTK::RegisterNewAcccessFlag()
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->RegisterFlag("FakeAccess Class","FakeAccessRight","This is a fake access right");
}
</pre>

==Pre defined access rights==
These are the rights the admin tools allready support. And you can check for in your plugin:
Notice that all access rights are in lower case, and they are strings. The reason they are strings is becuse most admin tools are going to handle admin rights internaly diffrently, so this is the only way to export it properbly.

any - The "any" right may only be supported by [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool], it basicly checks if the user has any of the rights bellow not including reservedslots
kick - The access to kick a another player. 
slap - The access to slap another player. 
slay - The access to slay another player. 
ban - The access to ban another player. 
chat - The access to use admin chat and or admin say commads. 
rcon - the access to execute commands the server console. 
map - The access to change maps. 
reservedslots - The access to reservedslots. 
immunity - Immunity from certain actions from other players, like kick. 

=How do I add the AdminInterface in my plugin=
This is only for those that have a admin plugin, and want their plugin to support the interface
Download the [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source code, and look at BATInterface .cpp / .h and add it to your plugin. Remember you cannot change AdminInterface / AdminInterfaceListner class in the header file as the interface must be the same in all the admin plugins.

AdminInterface (Metamod:Source)

2006-06-08T22:31:05Z

EKS: /* Using the interface */

=Introduction=

AdminInterface is a interface that allows sourcemm plugins to interact with admin plugins like [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] / [http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] to get the current admin rights of the players. It also allows the plugins to register custom access rights for their plugin.
This interface was made so smaller plugins, that may need admin rights for something simple dont need to make a system where the admin have to setup user rights for ever plugin. But instead can setup admin right in the admin plugin he preferes and the other plugins can get the information they need for it.

''Note: AdminInterface is NOT created or maintained by the team behing Sourcemm /Amxmodx, its a interface created by a 3dparty and is kindly hosted on this wiki''

[[Category:Half-Life 2]]
[[Category:SourceMM]]

=What Admin plugins support it=
[http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] 
[http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] 

''If you have a admin plugin that supports has support for the AdminInterface edit this page.''

=What plugins use this interface=
[http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] - This plugin adds a simple TK system to any source server, so players can forgive teamkills & teamattacks.

''If you have a plugin that uses the interface, feel free to add it here.''

=How do I use the AdminInterface in my plugin=
The following example is taken directly out of the [http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] plugin, and this plugin offcourse is based of the sourcemm sample plugins. The soucemm sample plugins have this AllPluginsLoaded() function, this is a good time to check to see if you can find the AdminInterface, incase your plugin is loaded before the admin plugin.

==Getting started==
Before you start coding, you should get the AdminInterface.h file, you can get this file easy from [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source ( in hl2sdk/batinterface.h ).
<pre>
AdminInterface *m_AdminManager;

void ForgiveTK::AllPluginsLoaded()
{
if(m_AdminManager) // We dont need to find the AdminInterface again, we allready found it once.
return;

//we don't really need this for anything other than interplugin communication
//and that's not used in this plugin.
//If we really wanted, we could override the factories so other plugins can request
// interfaces we make. In this callback, the plugin could be assured that either
// the interfaces it requires were either loaded in another plugin or not.
PluginId id2;

void *ptr = g_SMAPI->MetaFactory("AdminInterface", NULL, &id2);

if (!ptr)
{
ServerCommand("echo Did not find AdminInterface, plugin will not check admin rights");
} else {
m_AdminManager = (AdminInterface *)ptr;
m_AdminManager->AddEventListner(this);
int InterfaceVersion = m_AdminManager->GetInterfaceVersion();

if(InterfaceVersion == ADMININTERFACE_VERSION)
ServerCommand("echo Found AdminInterface[%d] at (%p), via %s (Interface version: %d)", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion);
else
ServerCommand("echo Found AdminInterface[%d] at (%p), but interface was NOT the expected version: Was %d Expected %d, this can create problems. Please update the plugin with the lowest interface version", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion,ADMININTERFACE_VERSION);
}
}
void ForgiveTK::Client_Authorized(int id) // This is called when a client is fully connected and authed by the admin tool, this normaly happens after the client has gotten a valid steamid & the admin tool has checked it against its internal user lists.
{
ServerCommand("echo Client_Authorized: %d",id);
}
void ForgiveTK::OnAdminInterfaceUnload() // Called when the admin interface is getting unloaded, this happens if a admin uses meta unload or the server is shutting down.
{
m_AdminManager = NULL;
ServerCommand("echo AdminInterface was unloaded");
}
</pre>
Its importent that you setup a callback to your plugin, when use the interface so the admin plugin can inform you plugin when its being unloaded.

==Using the interface==
The following function bellow would check if a user has a admin right equal to "immunity" and return true if thats the case.
<pre>
bool ForgiveTK::HasAdminImmunity(int id) // Checks if the user has a admin right "immunity"
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->HasFlag(id,"immunity");
}
</pre>
<pre>
Here we register a new access right, that we can check again later. If we dont want to use one of the predefined access rights.
bool ForgiveTK::RegisterNewAcccessFlag()
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->RegisterFlag("FakeAccess Class","FakeAccessRight","This is a fake access right");
}
</pre>

==Pre defined access rights==
These are the rights the admin tools allready support. And you can check for in your plugin:
Notice that all access rights are in lower case, and they are strings. The reason they are strings is becuse most admin tools are going to handle admin rights internaly diffrently, so this is the only way to export it properbly.

any - The "any" right may only be supported by [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool], it basicly checks if the user has any of the rights bellow not including reservedslots
kick - The access to kick a another player. 
slap - The access to slap another player. 
slay - The access to slay another player. 
ban - The access to ban another player. 
chat - The access to use admin chat and or admin say commads. 
rcon - the access to execute commands the server console. 
map - The access to change maps. 
reservedslots - The access to reservedslots. 
immunity - Immunity from certain actions from other players, like kick. 

=How do I add the AdminInterface in my plugin=
This is only for those that have a admin plugin, and want their plugin to support the interface
Download the [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source code, and look at BATInterface .cpp / .h and add it to your plugin. Remember you cannot change AdminInterface / AdminInterfaceListner class in the header file as the interface must be the same in all the admin plugins.

AdminInterface (Metamod:Source)

2006-06-08T13:54:53Z

EKS: /* Pre defined access rights */

=Introduction=

AdminInterface is a interface that allows sourcemm plugins to interact with admin plugins like [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] / [http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] to get the current admin rights of the players. It also allows the plugins to register custom access rights for their plugin.
This interface was made so smaller plugins, that may need admin rights for something simple dont need to make a system where the admin have to setup user rights for ever plugin. But instead can setup admin right in the admin plugin he preferes and the other plugins can get the information they need for it.

''Note: AdminInterface is NOT created or maintained by the team behing Sourcemm /Amxmodx, its a interface created by a 3dparty and is kindly hosted on this wiki''

[[Category:Half-Life 2]]
[[Category:SourceMM]]

=What Admin plugins support it=
[http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] 
[http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] 

''If you have a admin plugin that supports has support for the AdminInterface edit this page.''

=What plugins use this interface=
[http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] - This plugin adds a simple TK system to any source server, so players can forgive teamkills & teamattacks.

''If you have a plugin that uses the interface, feel free to add it here.''

=How do I use the AdminInterface in my plugin=
The following example is taken directly out of the [http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] plugin, and this plugin offcourse is based of the sourcemm sample plugins. The soucemm sample plugins have this AllPluginsLoaded() function, this is a good time to check to see if you can find the AdminInterface, incase your plugin is loaded before the admin plugin.

==Getting started==
Before you start coding, you should get the AdminInterface.h file, you can get this file easy from [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source ( in hl2sdk/batinterface.h ).
<pre>
AdminInterface *m_AdminManager;

void ForgiveTK::AllPluginsLoaded()
{
if(m_AdminManager) // We dont need to find the AdminInterface again, we allready found it once.
return;

//we don't really need this for anything other than interplugin communication
//and that's not used in this plugin.
//If we really wanted, we could override the factories so other plugins can request
// interfaces we make. In this callback, the plugin could be assured that either
// the interfaces it requires were either loaded in another plugin or not.
PluginId id2;

void *ptr = g_SMAPI->MetaFactory("AdminInterface", NULL, &id2);

if (!ptr)
{
ServerCommand("echo Did not find AdminInterface, plugin will not check admin rights");
} else {
m_AdminManager = (AdminInterface *)ptr;
m_AdminManager->AddEventListner(this);
int InterfaceVersion = m_AdminManager->GetInterfaceVersion();

if(InterfaceVersion == ADMININTERFACE_VERSION)
ServerCommand("echo Found AdminInterface[%d] at (%p), via %s (Interface version: %d)", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion);
else
ServerCommand("echo Found AdminInterface[%d] at (%p), but interface was NOT the expected version: Was %d Expected %d, this can create problems. Please update the plugin with the lowest interface version", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion,ADMININTERFACE_VERSION);
}
}
void ForgiveTK::Client_Authorized(int id) // This is called when a client is fully connected and authed by the admin tool, this normaly happens after the client has gotten a valid steamid & the admin tool has checked it against its internal user lists.
{
ServerCommand("echo Client_Authorized: %d",id);
}
void ForgiveTK::OnAdminInterfaceUnload() // Called when the admin interface is getting unloaded, this happens if a admin uses meta unload or the server is shutting down.
{
m_AdminManager = NULL;
ServerCommand("echo AdminInterface was unloaded");
}
</pre>
Its importent that you setup a callback to your plugin, when use the interface so the admin plugin can inform you plugin when its being unloaded.

==Using the interface==
The following function bellow would check if a user has a admin right equal to "immunity" and return true if thats the case.
<pre>
bool ForgiveTK::HasAdminImmunity(int id) // Checks if the user has a admin right "immunity"
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->HasFlag(id,"immunity");
}
</pre>
<pre>
Here we register a new access right, that we can check again later. If we dont want to use one of the predefined access rights.
bool ForgiveTK::RegisterNewAcccessFlag()
{
if(m_AdminManager == NULL)
return false;

m_AdminManager->RegisterFlag("FakeAccess Class","FakeAccessRight","This is a fake access right");
return true;
}
</pre>

==Pre defined access rights==
These are the rights the admin tools allready support. And you can check for in your plugin:
Notice that all access rights are in lower case, and they are strings. The reason they are strings is becuse most admin tools are going to handle admin rights internaly diffrently, so this is the only way to export it properbly.

any - The "any" right may only be supported by [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool], it basicly checks if the user has any of the rights bellow not including reservedslots
kick - The access to kick a another player. 
slap - The access to slap another player. 
slay - The access to slay another player. 
ban - The access to ban another player. 
chat - The access to use admin chat and or admin say commads. 
rcon - the access to execute commands the server console. 
map - The access to change maps. 
reservedslots - The access to reservedslots. 
immunity - Immunity from certain actions from other players, like kick. 

=How do I add the AdminInterface in my plugin=
This is only for those that have a admin plugin, and want their plugin to support the interface
Download the [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source code, and look at BATInterface .cpp / .h and add it to your plugin. Remember you cannot change AdminInterface / AdminInterfaceListner class in the header file as the interface must be the same in all the admin plugins.

AdminInterface (Metamod:Source)

2006-06-08T13:29:12Z

EKS: /* Pre defined access rights */ made the explination of the any right more clear

=Introduction=

AdminInterface is a interface that allows sourcemm plugins to interact with admin plugins like [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] / [http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] to get the current admin rights of the players. It also allows the plugins to register custom access rights for their plugin.
This interface was made so smaller plugins, that may need admin rights for something simple dont need to make a system where the admin have to setup user rights for ever plugin. But instead can setup admin right in the admin plugin he preferes and the other plugins can get the information they need for it.

''Note: AdminInterface is NOT created or maintained by the team behing Sourcemm /Amxmodx, its a interface created by a 3dparty and is kindly hosted on this wiki''

[[Category:Half-Life 2]]
[[Category:SourceMM]]

=What Admin plugins support it=
[http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] 
[http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] 

''If you have a admin plugin that supports has support for the AdminInterface edit this page.''

=What plugins use this interface=
[http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] - This plugin adds a simple TK system to any source server, so players can forgive teamkills & teamattacks.

''If you have a plugin that uses the interface, feel free to add it here.''

=How do I use the AdminInterface in my plugin=
The following example is taken directly out of the [http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] plugin, and this plugin offcourse is based of the sourcemm sample plugins. The soucemm sample plugins have this AllPluginsLoaded() function, this is a good time to check to see if you can find the AdminInterface, incase your plugin is loaded before the admin plugin.

==Getting started==
Before you start coding, you should get the AdminInterface.h file, you can get this file easy from [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source ( in hl2sdk/batinterface.h ).
<pre>
AdminInterface *m_AdminManager;

void ForgiveTK::AllPluginsLoaded()
{
if(m_AdminManager) // We dont need to find the AdminInterface again, we allready found it once.
return;

//we don't really need this for anything other than interplugin communication
//and that's not used in this plugin.
//If we really wanted, we could override the factories so other plugins can request
// interfaces we make. In this callback, the plugin could be assured that either
// the interfaces it requires were either loaded in another plugin or not.
PluginId id2;

void *ptr = g_SMAPI->MetaFactory("AdminInterface", NULL, &id2);

if (!ptr)
{
ServerCommand("echo Did not find AdminInterface, plugin will not check admin rights");
} else {
m_AdminManager = (AdminInterface *)ptr;
m_AdminManager->AddEventListner(this);
int InterfaceVersion = m_AdminManager->GetInterfaceVersion();

if(InterfaceVersion == ADMININTERFACE_VERSION)
ServerCommand("echo Found AdminInterface[%d] at (%p), via %s (Interface version: %d)", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion);
else
ServerCommand("echo Found AdminInterface[%d] at (%p), but interface was NOT the expected version: Was %d Expected %d, this can create problems. Please update the plugin with the lowest interface version", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion,ADMININTERFACE_VERSION);
}
}
void ForgiveTK::Client_Authorized(int id) // This is called when a client is fully connected and authed by the admin tool, this normaly happens after the client has gotten a valid steamid & the admin tool has checked it against its internal user lists.
{
ServerCommand("echo Client_Authorized: %d",id);
}
void ForgiveTK::OnAdminInterfaceUnload() // Called when the admin interface is getting unloaded, this happens if a admin uses meta unload or the server is shutting down.
{
m_AdminManager = NULL;
ServerCommand("echo AdminInterface was unloaded");
}
</pre>
Its importent that you setup a callback to your plugin, when use the interface so the admin plugin can inform you plugin when its being unloaded.

==Using the interface==
The following function bellow would check if a user has a admin right equal to "immunity" and return true if thats the case.
<pre>
bool ForgiveTK::HasAdminImmunity(int id) // Checks if the user has a admin right "immunity"
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->HasFlag(id,"immunity");
}
</pre>
<pre>
Here we register a new access right, that we can check again later. If we dont want to use one of the predefined access rights.
bool ForgiveTK::RegisterNewAcccessFlag()
{
if(m_AdminManager == NULL)
return false;

m_AdminManager->RegisterFlag("FakeAccess Class","FakeAccessRight","This is a fake access right");
return true;
}
</pre>

==Pre defined access rights==
These are the rights the admin tools allready support. And you can check for in your plugin:
any (the "any" right may only be supported by [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool], it basicly checks if the user has any of the rights bellow not including reservedslots)
Notice that all access rights are in lower case, and they are strings. The reason they are strings is becuse most admin tools are going to handle admin rights internaly diffrently, so this is the only way to export it properbly.

kick - The access to kick a another player. 
slap - The access to slap another player. 
slay - The access to slay another player. 
ban - The access to ban another player. 
chat - The access to use admin chat and or admin say commads. 
rcon - the access to execute commands the server console. 
map - The access to change maps. 
reservedslots - The access to reservedslots. 
immunity - Immunity from certain actions from other players, like kick. 

=How do I add the AdminInterface in my plugin=
This is only for those that have a admin plugin, and want their plugin to support the interface
Download the [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source code, and look at BATInterface .cpp / .h and add it to your plugin. Remember you cannot change AdminInterface / AdminInterfaceListner class in the header file as the interface must be the same in all the admin plugins.

AdminInterface (Metamod:Source)

2006-06-08T13:25:30Z

EKS: /* Using the interface */ Fixed a function not returning anything

=Introduction=

AdminInterface is a interface that allows sourcemm plugins to interact with admin plugins like [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] / [http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] to get the current admin rights of the players. It also allows the plugins to register custom access rights for their plugin.
This interface was made so smaller plugins, that may need admin rights for something simple dont need to make a system where the admin have to setup user rights for ever plugin. But instead can setup admin right in the admin plugin he preferes and the other plugins can get the information they need for it.

''Note: AdminInterface is NOT created or maintained by the team behing Sourcemm /Amxmodx, its a interface created by a 3dparty and is kindly hosted on this wiki''

[[Category:Half-Life 2]]
[[Category:SourceMM]]

=What Admin plugins support it=
[http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] 
[http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] 

''If you have a admin plugin that supports has support for the AdminInterface edit this page.''

=What plugins use this interface=
[http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] - This plugin adds a simple TK system to any source server, so players can forgive teamkills & teamattacks.

''If you have a plugin that uses the interface, feel free to add it here.''

=How do I use the AdminInterface in my plugin=
The following example is taken directly out of the [http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] plugin, and this plugin offcourse is based of the sourcemm sample plugins. The soucemm sample plugins have this AllPluginsLoaded() function, this is a good time to check to see if you can find the AdminInterface, incase your plugin is loaded before the admin plugin.

==Getting started==
Before you start coding, you should get the AdminInterface.h file, you can get this file easy from [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source ( in hl2sdk/batinterface.h ).
<pre>
AdminInterface *m_AdminManager;

void ForgiveTK::AllPluginsLoaded()
{
if(m_AdminManager) // We dont need to find the AdminInterface again, we allready found it once.
return;

//we don't really need this for anything other than interplugin communication
//and that's not used in this plugin.
//If we really wanted, we could override the factories so other plugins can request
// interfaces we make. In this callback, the plugin could be assured that either
// the interfaces it requires were either loaded in another plugin or not.
PluginId id2;

void *ptr = g_SMAPI->MetaFactory("AdminInterface", NULL, &id2);

if (!ptr)
{
ServerCommand("echo Did not find AdminInterface, plugin will not check admin rights");
} else {
m_AdminManager = (AdminInterface *)ptr;
m_AdminManager->AddEventListner(this);
int InterfaceVersion = m_AdminManager->GetInterfaceVersion();

if(InterfaceVersion == ADMININTERFACE_VERSION)
ServerCommand("echo Found AdminInterface[%d] at (%p), via %s (Interface version: %d)", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion);
else
ServerCommand("echo Found AdminInterface[%d] at (%p), but interface was NOT the expected version: Was %d Expected %d, this can create problems. Please update the plugin with the lowest interface version", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion,ADMININTERFACE_VERSION);
}
}
void ForgiveTK::Client_Authorized(int id) // This is called when a client is fully connected and authed by the admin tool, this normaly happens after the client has gotten a valid steamid & the admin tool has checked it against its internal user lists.
{
ServerCommand("echo Client_Authorized: %d",id);
}
void ForgiveTK::OnAdminInterfaceUnload() // Called when the admin interface is getting unloaded, this happens if a admin uses meta unload or the server is shutting down.
{
m_AdminManager = NULL;
ServerCommand("echo AdminInterface was unloaded");
}
</pre>
Its importent that you setup a callback to your plugin, when use the interface so the admin plugin can inform you plugin when its being unloaded.

==Using the interface==
The following function bellow would check if a user has a admin right equal to "immunity" and return true if thats the case.
<pre>
bool ForgiveTK::HasAdminImmunity(int id) // Checks if the user has a admin right "immunity"
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->HasFlag(id,"immunity");
}
</pre>
<pre>
Here we register a new access right, that we can check again later. If we dont want to use one of the predefined access rights.
bool ForgiveTK::RegisterNewAcccessFlag()
{
if(m_AdminManager == NULL)
return false;

m_AdminManager->RegisterFlag("FakeAccess Class","FakeAccessRight","This is a fake access right");
return true;
}
</pre>

==Pre defined access rights==
These are the rights the admin tools allready support. And you can check for in your plugin:
any (This may only be supported by [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool], it basicly checks if the user has any of the rights bellow not including reservedslots)
Notice that all access rights are in lower case, and they are strings. The reason they are strings is becuse most admin tools are going to handle admin rights internaly diffrently, so this is the only way to export it properbly.

kick - The access to kick a another player. 
slap - The access to slap another player. 
slay - The access to slay another player. 
ban - The access to ban another player. 
chat - The access to use admin chat and or admin say commads. 
rcon - the access to execute commands the server console. 
map - The access to change maps. 
reservedslots - The access to reservedslots. 
immunity - Immunity from certain actions from other players, like kick. 

=How do I add the AdminInterface in my plugin=
This is only for those that have a admin plugin, and want their plugin to support the interface
Download the [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source code, and look at BATInterface .cpp / .h and add it to your plugin. Remember you cannot change AdminInterface / AdminInterfaceListner class in the header file as the interface must be the same in all the admin plugins.

AdminInterface (Metamod:Source)

2006-06-05T11:18:28Z

EKS: /* Introduction */ minor edit

=Introduction=

AdminInterface is a interface that allows sourcemm plugins to interact with admin plugins like [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] / [http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] to get the current admin rights of the players. It also allows the plugins to register custom access rights for their plugin.
This interface was made so smaller plugins, that may need admin rights for something simple dont need to make a system where the admin have to setup user rights for ever plugin. But instead can setup admin right in the admin plugin he preferes and the other plugins can get the information they need for it.

''Note: AdminInterface is NOT created or maintained by the team behing Sourcemm /Amxmodx, its a interface created by a 3dparty and is kindly hosted on this wiki''

[[Category:Half-Life 2]]
[[Category:SourceMM]]

=What Admin plugins support it=
[http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] 
[http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] 

''If you have a admin plugin that supports has support for the AdminInterface edit this page.''

=What plugins use this interface=
[http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] - This plugin adds a simple TK system to any source server, so players can forgive teamkills & teamattacks.

''If you have a plugin that uses the interface, feel free to add it here.''

=How do I use the AdminInterface in my plugin=
The following example is taken directly out of the [http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] plugin, and this plugin offcourse is based of the sourcemm sample plugins. The soucemm sample plugins have this AllPluginsLoaded() function, this is a good time to check to see if you can find the AdminInterface, incase your plugin is loaded before the admin plugin.

==Getting started==
Before you start coding, you should get the AdminInterface.h file, you can get this file easy from [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source ( in hl2sdk/batinterface.h ).
<pre>
AdminInterface *m_AdminManager;

void ForgiveTK::AllPluginsLoaded()
{
if(m_AdminManager) // We dont need to find the AdminInterface again, we allready found it once.
return;

//we don't really need this for anything other than interplugin communication
//and that's not used in this plugin.
//If we really wanted, we could override the factories so other plugins can request
// interfaces we make. In this callback, the plugin could be assured that either
// the interfaces it requires were either loaded in another plugin or not.
PluginId id2;

void *ptr = g_SMAPI->MetaFactory("AdminInterface", NULL, &id2);

if (!ptr)
{
ServerCommand("echo Did not find AdminInterface, plugin will not check admin rights");
} else {
m_AdminManager = (AdminInterface *)ptr;
m_AdminManager->AddEventListner(this);
int InterfaceVersion = m_AdminManager->GetInterfaceVersion();

if(InterfaceVersion == ADMININTERFACE_VERSION)
ServerCommand("echo Found AdminInterface[%d] at (%p), via %s (Interface version: %d)", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion);
else
ServerCommand("echo Found AdminInterface[%d] at (%p), but interface was NOT the expected version: Was %d Expected %d, this can create problems. Please update the plugin with the lowest interface version", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion,ADMININTERFACE_VERSION);
}
}
void ForgiveTK::Client_Authorized(int id) // This is called when a client is fully connected and authed by the admin tool, this normaly happens after the client has gotten a valid steamid & the admin tool has checked it against its internal user lists.
{
ServerCommand("echo Client_Authorized: %d",id);
}
void ForgiveTK::OnAdminInterfaceUnload() // Called when the admin interface is getting unloaded, this happens if a admin uses meta unload or the server is shutting down.
{
m_AdminManager = NULL;
ServerCommand("echo AdminInterface was unloaded");
}
</pre>
Its importent that you setup a callback to your plugin, when use the interface so the admin plugin can inform you plugin when its being unloaded.

==Using the interface==
The following function bellow would check if a user has a admin right equal to "immunity" and return true if thats the case.
<pre>
bool ForgiveTK::HasAdminImmunity(int id) // Checks if the user has a admin right "immunity"
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->HasFlag(id,"immunity");
}
</pre>
<pre>
Here we register a new access right, that we can check again later. If we dont want to use one of the predefined access rights.
bool ForgiveTK::RegisterNewAcccessFlag()
{
if(m_AdminManager == NULL)
return false;

m_AdminManager->RegisterFlag("FakeAccess Class","FakeAccessRight","This is a fake access right");
}
</pre>
==Pre defined access rights==
These are the rights the admin tools allready support. And you can check for in your plugin:
any (This may only be supported by [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool], it basicly checks if the user has any of the rights bellow not including reservedslots)
Notice that all access rights are in lower case, and they are strings. The reason they are strings is becuse most admin tools are going to handle admin rights internaly diffrently, so this is the only way to export it properbly.

kick - The access to kick a another player. 
slap - The access to slap another player. 
slay - The access to slay another player. 
ban - The access to ban another player. 
chat - The access to use admin chat and or admin say commads. 
rcon - the access to execute commands the server console. 
map - The access to change maps. 
reservedslots - The access to reservedslots. 
immunity - Immunity from certain actions from other players, like kick. 

=How do I add the AdminInterface in my plugin=
This is only for those that have a admin plugin, and want their plugin to support the interface
Download the [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source code, and look at BATInterface .cpp / .h and add it to your plugin. Remember you cannot change AdminInterface / AdminInterfaceListner class in the header file as the interface must be the same in all the admin plugins.

Open Source Plugins for Metamod:Source

2006-06-05T11:17:23Z

EKS: Added ForgiveTK

= Open Source Plugins for SourceMM =
This page lists known plugins with available source code. Please check the licenses for each one as they may not truly be "open source."
 
== Basic Templates ==
=== stub_mm ===
Author: [[User:BAILOPAN|BAILOPAN]] 
Description: minmum implentation of a valid SourceMM plugin 
Features: starting template 
Download: Included in the SourceMM source code package: [http://prdownloads.sourceforge.net/sourcemm/sourcemm-1.2.2-source.tar.gz?download prdownloads.sourceforge.net/sourcemm/sourcemm-1.2.2-source.tar.gz?download]
 
=== sample_mm ===
Author: [[User:BAILOPAN|BAILOPAN]] 
Description: implements the features of the standard Valve server plugin from the SDK 
Features: starting template with similar functionality to the Valve sample_plugin 
Download: Included in the SourceMM source code package: [http://prdownloads.sourceforge.net/sourcemm/sourcemm-1.2.2-source.tar.gz?download prdownloads.sourceforge.net/sourcemm/sourcemm-1.2.2-source.tar.gz?download]
 
=== sample2_mm ===
Author: [[User:BAILOPAN|BAILOPAN]], edited by [[User:L._Duke|L. Duke]] 
Description: fixes (by inheriting from IGameEventListener2 instead of hooking FireGameEvent) the problem in sample_mm plugin where some events are not received 
Features: starting template with similar functionality to the Valve sample_plugin 
Download: [http://www.sourcemod.net/forums/viewtopic.php?p=34891 www.sourcemod.net/forums/viewtopic.php?p=34891] (you must be logged in to view the download link)
 

== Functional Plugins ==
=== Anti-Griefer ===
Author: [[User:devicenull|devicenull]] 
Description: This plugin is for the mod SourceForts. In keeps track of what player unfreezes or freezes a block, and allows any other player to retrieve this information by aiming at a block. 
Features: Basic VFuncs, listening for events, partial traceline (The method used for traceline might not be effective for any other mod) 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3652 http://www.sourcemod.net/forums/viewtopic.php?t=3652]
 
=== Basic Admin Tool (BAT) ===
Author: [[User:EKS|EKS]] 
Description: Provides basic admin functions 
Features: Kick, ban, menus, reserved slots, timeleft/nextmap say commands, and more 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=2923 www.sourcemod.net/forums/viewtopic.php?t=2923]
 
=== CS:S Weapon Restrictions 2 ===
Author: [[User:L._Duke|L. Duke]] 
Description: Prevents players from picking up restricted weapons (if bought, they fall to the ground). Also includes an option to remove restricted weapons from the game. 
Features: Hook CCSPlayer::Weapon_CanUse(CBaseCombatWeapon *pWeapon) and returns false for restricted weapons. Also shows how to use virtual functions on weapons such as Delete()and GetName() and on players for Weapon_GetSlot(int) and Drop(CBaseCombatWeapon*). 
Download: [http://www.sourcemod.net/forums/viewtopic.php?p=34892 www.sourcemod.net/forums/viewtopic.php?p=34892]
 
=== ForgiveTK ===
Author: [[User:EKS|EKS]] 
Description: This is a basic plugin to handle teamkilll and teamattack on your source server, it supports any Source mod. It will automaticly kick someone with to many offenses 
Features: Forgive via menu or chat. Support both Valves ESC menus and radio menus. 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3081 http://www.sourcemod.net/forums/viewtopic.php?t=3081]
 
=== Global Banlist===
Author: [[User:devicenull|devicenull]] 
Description: This plugin allows srcds to reguarly connect to an external PHP page, and download updates about it's banlist. Srcds then stores these in a SQLite database. 
Features: Embedding sqlite, using pthreads, using libcurl. 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3539 http://www.sourcemod.net/forums/viewtopic.php?t=3539]
 
=== Last Users Connected ===
Author: [[User:devicenull|devicenull]] 
Description: With this plugin, every player who comes onto your server has their steamid logged, along with any name they used on the server. You can then either view the names/steamid's of the last people to disconnect, or you can search for a name/steamid and see everyone who has used that name. 
Features: shows how to embed sqlite3, send basic messages/basic hooks. 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3339 http://www.sourcemod.net/forums/viewtopic.php?t=3339]
 
=== Stripper:Source ===
Author: [[User:BAILOPAN|BAILOPAN]] 
Description: You can add any type of entity - hostage, spawn point, physics prop, permanently to the map. You can also filter out entities for deletion, either by specific entries or regular expressions. Stripper:Source lets you define global rules and per-map rules. It also lets other plugins (both SourceMM plugins and Server Plugins) use its API. 
Features: shows how to edit the map entity lump in memory to change map entities 
Download: [http://www.sourcemod.net/forums/viewtopic.php?t=3008 www.sourcemod.net/forums/viewtopic.php?t=3008]
 
[[Category:Documentation (SourceMM)]]

= Open Source Valve Server Plugins (VSP) =
A list of open source plugins for the Valve Server Plugin (VSP) interface can be found [http://developer.valvesoftware.com/wiki/List_of_Open_Source_Server_Plugins here].

AdminInterface (Metamod:Source)

2006-06-05T10:49:34Z

EKS: /* Introduction */

=Introduction=

AdminInterface is a interface that allows sourcemm plugins to interact with admin plugins like [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] / [http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] to get the current admin rights of the players. It also allows the plugins to register custom access rights for their plugin.
This interface was made so smaller plugins, that may need admin rights for something simple dont need to make a system where the admin have to setup user rights for ever plugin. But instead can setup admin right in the admin plugin he preferes and the other plugins can get the information they need for it.

''Note: AdminInterface is NOT created or maintained by the team behing Sourcemm /Amxmodx, its a interface created by a 3dparty''

[[Category:Half-Life 2]]
[[Category:SourceMM]]

=What Admin plugins support it=
[http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] 
[http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] 

''If you have a admin plugin that supports has support for the AdminInterface edit this page.''

=What plugins use this interface=
[http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] - This plugin adds a simple TK system to any source server, so players can forgive teamkills & teamattacks.

''If you have a plugin that uses the interface, feel free to add it here.''

=How do I use the AdminInterface in my plugin=
The following example is taken directly out of the [http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] plugin, and this plugin offcourse is based of the sourcemm sample plugins. The soucemm sample plugins have this AllPluginsLoaded() function, this is a good time to check to see if you can find the AdminInterface, incase your plugin is loaded before the admin plugin.

==Getting started==
Before you start coding, you should get the AdminInterface.h file, you can get this file easy from [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source ( in hl2sdk/batinterface.h ).
<pre>
AdminInterface *m_AdminManager;

void ForgiveTK::AllPluginsLoaded()
{
if(m_AdminManager) // We dont need to find the AdminInterface again, we allready found it once.
return;

//we don't really need this for anything other than interplugin communication
//and that's not used in this plugin.
//If we really wanted, we could override the factories so other plugins can request
// interfaces we make. In this callback, the plugin could be assured that either
// the interfaces it requires were either loaded in another plugin or not.
PluginId id2;

void *ptr = g_SMAPI->MetaFactory("AdminInterface", NULL, &id2);

if (!ptr)
{
ServerCommand("echo Did not find AdminInterface, plugin will not check admin rights");
} else {
m_AdminManager = (AdminInterface *)ptr;
m_AdminManager->AddEventListner(this);
int InterfaceVersion = m_AdminManager->GetInterfaceVersion();

if(InterfaceVersion == ADMININTERFACE_VERSION)
ServerCommand("echo Found AdminInterface[%d] at (%p), via %s (Interface version: %d)", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion);
else
ServerCommand("echo Found AdminInterface[%d] at (%p), but interface was NOT the expected version: Was %d Expected %d, this can create problems. Please update the plugin with the lowest interface version", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion,ADMININTERFACE_VERSION);
}
}
void ForgiveTK::Client_Authorized(int id) // This is called when a client is fully connected and authed by the admin tool, this normaly happens after the client has gotten a valid steamid & the admin tool has checked it against its internal user lists.
{
ServerCommand("echo Client_Authorized: %d",id);
}
void ForgiveTK::OnAdminInterfaceUnload() // Called when the admin interface is getting unloaded, this happens if a admin uses meta unload or the server is shutting down.
{
m_AdminManager = NULL;
ServerCommand("echo AdminInterface was unloaded");
}
</pre>
Its importent that you setup a callback to your plugin, when use the interface so the admin plugin can inform you plugin when its being unloaded.

==Using the interface==
The following function bellow would check if a user has a admin right equal to "immunity" and return true if thats the case.
<pre>
bool ForgiveTK::HasAdminImmunity(int id) // Checks if the user has a admin right "immunity"
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->HasFlag(id,"immunity");
}
</pre>
<pre>
Here we register a new access right, that we can check again later. If we dont want to use one of the predefined access rights.
bool ForgiveTK::RegisterNewAcccessFlag()
{
if(m_AdminManager == NULL)
return false;

m_AdminManager->RegisterFlag("FakeAccess Class","FakeAccessRight","This is a fake access right");
}
</pre>
==Pre defined access rights==
These are the rights the admin tools allready support. And you can check for in your plugin:
any (This may only be supported by [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool], it basicly checks if the user has any of the rights bellow not including reservedslots)
Notice that all access rights are in lower case, and they are strings. The reason they are strings is becuse most admin tools are going to handle admin rights internaly diffrently, so this is the only way to export it properbly.

kick - The access to kick a another player. 
slap - The access to slap another player. 
slay - The access to slay another player. 
ban - The access to ban another player. 
chat - The access to use admin chat and or admin say commads. 
rcon - the access to execute commands the server console. 
map - The access to change maps. 
reservedslots - The access to reservedslots. 
immunity - Immunity from certain actions from other players, like kick. 

=How do I add the AdminInterface in my plugin=
This is only for those that have a admin plugin, and want their plugin to support the interface
Download the [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source code, and look at BATInterface .cpp / .h and add it to your plugin. Remember you cannot change AdminInterface / AdminInterfaceListner class in the header file as the interface must be the same in all the admin plugins.

AdminInterface (Metamod:Source)

2006-06-05T10:46:45Z

EKS: /* Introduction */

=Introduction=
''note: AdminInterface is NOT created or maintained by the team behing Sourcemm /Amxmodx, its a interface created by a 3dparty''

AdminInterface is a interface that allows sourcemm plugins to interact with admin plugins like [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] / [http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] to get the current admin rights of the players. It also allows the plugins to register custom access rights for their plugin.
This interface was made so smaller plugins, that may need admin rights for something simple dont need to make a system where the admin have to setup user rights for ever plugin. But instead can setup admin right in the admin plugin he preferes and the other plugins can get the information they need for it.

[[Category:Half-Life 2]]
[[Category:SourceMM]]
[[Category:BAT]]

=What Admin plugins support it=
[http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] 
[http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] 

''If you have a admin plugin that supports has support for the AdminInterface edit this page.''

=What plugins use this interface=
[http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] - This plugin adds a simple TK system to any source server, so players can forgive teamkills & teamattacks.

''If you have a plugin that uses the interface, feel free to add it here.''

=How do I use the AdminInterface in my plugin=
The following example is taken directly out of the [http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] plugin, and this plugin offcourse is based of the sourcemm sample plugins. The soucemm sample plugins have this AllPluginsLoaded() function, this is a good time to check to see if you can find the AdminInterface, incase your plugin is loaded before the admin plugin.

==Getting started==
Before you start coding, you should get the AdminInterface.h file, you can get this file easy from [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source ( in hl2sdk/batinterface.h ).
<pre>
AdminInterface *m_AdminManager;

void ForgiveTK::AllPluginsLoaded()
{
if(m_AdminManager) // We dont need to find the AdminInterface again, we allready found it once.
return;

//we don't really need this for anything other than interplugin communication
//and that's not used in this plugin.
//If we really wanted, we could override the factories so other plugins can request
// interfaces we make. In this callback, the plugin could be assured that either
// the interfaces it requires were either loaded in another plugin or not.
PluginId id2;

void *ptr = g_SMAPI->MetaFactory("AdminInterface", NULL, &id2);

if (!ptr)
{
ServerCommand("echo Did not find AdminInterface, plugin will not check admin rights");
} else {
m_AdminManager = (AdminInterface *)ptr;
m_AdminManager->AddEventListner(this);
int InterfaceVersion = m_AdminManager->GetInterfaceVersion();

if(InterfaceVersion == ADMININTERFACE_VERSION)
ServerCommand("echo Found AdminInterface[%d] at (%p), via %s (Interface version: %d)", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion);
else
ServerCommand("echo Found AdminInterface[%d] at (%p), but interface was NOT the expected version: Was %d Expected %d, this can create problems. Please update the plugin with the lowest interface version", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion,ADMININTERFACE_VERSION);
}
}
void ForgiveTK::Client_Authorized(int id) // This is called when a client is fully connected and authed by the admin tool, this normaly happens after the client has gotten a valid steamid & the admin tool has checked it against its internal user lists.
{
ServerCommand("echo Client_Authorized: %d",id);
}
void ForgiveTK::OnAdminInterfaceUnload() // Called when the admin interface is getting unloaded, this happens if a admin uses meta unload or the server is shutting down.
{
m_AdminManager = NULL;
ServerCommand("echo AdminInterface was unloaded");
}
</pre>
Its importent that you setup a callback to your plugin, when use the interface so the admin plugin can inform you plugin when its being unloaded.

==Using the interface==
The following function bellow would check if a user has a admin right equal to "immunity" and return true if thats the case.
<pre>
bool ForgiveTK::HasAdminImmunity(int id) // Checks if the user has a admin right "immunity"
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->HasFlag(id,"immunity");
}
</pre>
<pre>
Here we register a new access right, that we can check again later. If we dont want to use one of the predefined access rights.
bool ForgiveTK::RegisterNewAcccessFlag()
{
if(m_AdminManager == NULL)
return false;

m_AdminManager->RegisterFlag("FakeAccess Class","FakeAccessRight","This is a fake access right");
}
</pre>
==Pre defined access rights==
These are the rights the admin tools allready support. And you can check for in your plugin:
any (This may only be supported by [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool], it basicly checks if the user has any of the rights bellow not including reservedslots)
Notice that all access rights are in lower case, and they are strings. The reason they are strings is becuse most admin tools are going to handle admin rights internaly diffrently, so this is the only way to export it properbly.

kick - The access to kick a another player. 
slap - The access to slap another player. 
slay - The access to slay another player. 
ban - The access to ban another player. 
chat - The access to use admin chat and or admin say commads. 
rcon - the access to execute commands the server console. 
map - The access to change maps. 
reservedslots - The access to reservedslots. 
immunity - Immunity from certain actions from other players, like kick. 

=How do I add the AdminInterface in my plugin=
This is only for those that have a admin plugin, and want their plugin to support the interface
Download the [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source code, and look at BATInterface .cpp / .h and add it to your plugin. Remember you cannot change AdminInterface / AdminInterfaceListner class in the header file as the interface must be the same in all the admin plugins.

AdminInterface (Metamod:Source)

2006-06-03T23:39:43Z

EKS: First edition of AdminInterface

:{{owned_project}}
=Introduction=
AdminInterface is a interface that allows sourcemm plugins to interact with admin plugins like [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] / [http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] to get the current admin rights of the players. It also allows the plugins to register custom access rights for their plugin.
This interface was made so smaller plugins, that may need admin rights for something simple dont need to make a system where the admin have to setup user rights for ever plugin. But instead can setup admin right in the admin plugin he preferes and the other plugins can get the information they need for it.

[[Category:Half-Life 2]]
[[Category:SourceMM]]

=What Admin plugins support it=
[http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] 
[http://www.mani-admin-plugin.com Mani (Support comming in a upcomming version)] 

''If you have a admin plugin that supports has support for the AdminInterface edit this page.''

=What plugins use this interface=
[http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] - This plugin adds a simple TK system to any source server, so players can forgive teamkills & teamattacks.

''If you have a plugin that uses the interface, feel free to add it here.''

=How do I use the AdminInterface in my plugin=
The following example is taken directly out of the [http://www.sourcemod.net/forums/viewtopic.php?t=3081 ForgiveTK] plugin, and this plugin offcourse is based of the sourcemm sample plugins. The soucemm sample plugins have this AllPluginsLoaded() function, this is a good time to check to see if you can find the AdminInterface, incase your plugin is loaded before the admin plugin.

==Getting started==
Before you start coding, you should get the AdminInterface.h file, you can get this file easy from [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source ( in hl2sdk/batinterface.h ).
<pre>
AdminInterface *m_AdminManager;

void ForgiveTK::AllPluginsLoaded()
{
if(m_AdminManager) // We dont need to find the AdminInterface again, we allready found it once.
return;

//we don't really need this for anything other than interplugin communication
//and that's not used in this plugin.
//If we really wanted, we could override the factories so other plugins can request
// interfaces we make. In this callback, the plugin could be assured that either
// the interfaces it requires were either loaded in another plugin or not.
PluginId id2;

void *ptr = g_SMAPI->MetaFactory("AdminInterface", NULL, &id2);

if (!ptr)
{
ServerCommand("echo Did not find AdminInterface, plugin will not check admin rights");
} else {
m_AdminManager = (AdminInterface *)ptr;
m_AdminManager->AddEventListner(this);
int InterfaceVersion = m_AdminManager->GetInterfaceVersion();

if(InterfaceVersion == ADMININTERFACE_VERSION)
ServerCommand("echo Found AdminInterface[%d] at (%p), via %s (Interface version: %d)", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion);
else
ServerCommand("echo Found AdminInterface[%d] at (%p), but interface was NOT the expected version: Was %d Expected %d, this can create problems. Please update the plugin with the lowest interface version", id2, ptr,m_AdminManager->GetModName(),InterfaceVersion,ADMININTERFACE_VERSION);
}
}
void ForgiveTK::Client_Authorized(int id) // This is called when a client is fully connected and authed by the admin tool, this normaly happens after the client has gotten a valid steamid & the admin tool has checked it against its internal user lists.
{
ServerCommand("echo Client_Authorized: %d",id);
}
void ForgiveTK::OnAdminInterfaceUnload() // Called when the admin interface is getting unloaded, this happens if a admin uses meta unload or the server is shutting down.
{
m_AdminManager = NULL;
ServerCommand("echo AdminInterface was unloaded");
}
</pre>
Its importent that you setup a callback to your plugin, when use the interface so the admin plugin can inform you plugin when its being unloaded.

==Using the interface==
The following function bellow would check if a user has a admin right equal to "immunity" and return true if thats the case.
<pre>
bool ForgiveTK::HasAdminImmunity(int id) // Checks if the user has a admin right "immunity"
{
if(m_AdminManager == NULL)
return false;

return m_AdminManager->HasFlag(id,"immunity");
}
</pre>
<pre>
Here we register a new access right, that we can check again later. If we dont want to use one of the predefined access rights.
bool ForgiveTK::RegisterNewAcccessFlag()
{
if(m_AdminManager == NULL)
return false;

m_AdminManager->RegisterFlag("FakeAccess Class","FakeAccessRight","This is a fake access right");
}
</pre>
==Pre defined access rights==
These are the rights the admin tools allready support. And you can check for in your plugin:
any (This may only be supported by [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool], it basicly checks if the user has any of the rights bellow not including reservedslots)
Notice that all access rights are in lower case, and they are strings. The reason they are strings is becuse most admin tools are going to handle admin rights internaly diffrently, so this is the only way to export it properbly.

kick - The access to kick a another player. 
slap - The access to slap another player. 
slay - The access to slay another player. 
ban - The access to ban another player. 
chat - The access to use admin chat and or admin say commads. 
rcon - the access to execute commands the server console. 
map - The access to change maps. 
reservedslots - The access to reservedslots. 
immunity - Immunity from certain actions from other players, like kick. 

=How do I add the AdminInterface in my plugin=
This is only for those that have a admin plugin, and want their plugin to support the interface
Download the [http://www.sourcemod.net/forums/viewtopic.php?p=34909 Basic Admin Tool] source code, and look at BATInterface .cpp / .h and add it to your plugin. Remember you cannot change AdminInterface / AdminInterfaceListner class in the header file as the interface must be the same in all the admin plugins.