Repository navigation
For Server Admins
Welcome, Server Admins and Owners!
This page will go over all of the functions and commands the base API Plugin will offer, so that you can effectively use this plugin and the other plugins that depend on it.
What are Targeters you ask? Well, it is very simple. Here is an example of it:
cust debug_gun @ALL
This command gives every single player on the server a debug_gun.
The Targeter can be entered into commands that support it to apply the command to a group of players that fit the Targeter's criteria. @ALL simply applies the command to all the players. But there can be multiple types of Targeters that have a lot of specific uses. You can use the targeterslist (or tlist for short) // Not implemented yet command to list all of them and see what they do. The Targeters that are in the base API are as follows:
- @ALL - All players currently connected to the server.
- @ALIVE - All players currently alive. // Not implemented yet
- @HUMAN - All humans.
- @SCP - All players of the SCP faction (Excluding SCP-1507 instances).
- @MTF - All MTF operative and Guards.
- @CI - All Chaos Insurgents.
- @SCI - All Scientists.
- @CD - All Class D Personnel.
- @FLA - All instances of SCP-1507 (Pink Flamingos).
- @ARMED - All humans that have a firearm in their inventory.
- @UNARMED - All humans that have no firearms in their inventory.
To give a Custom Item to a player or a group of players, you can type customitem <Custom Item ID> [Target] (or cust for short) in your text-based Remote Admin panel. Custom Item IDs are separate from item IDs, they are registered upon plugin load, each plugin may add different custom items with different Custom Item IDs, so make sure to check them with customitemlist (or clist for short).
This command requires the permission to give items.
Here is an example of how to use the command:
customitem debug_gun 2
This will give the Custom Item with the ID debug_gun to the player with the Player ID of 2.
You can also use Targeters to give a group of players Custom Items, like this:
customitem debug_gun @MTF
This will give all MTF operatives and Guards the Custom Item with the ID debug_gun.
To check what a custom item does (or what the developer describes it does), you can open your client console (the console that you can access by pressing the ~ key) and type .info while holding the Custom Item. This will display information about the Custom Item, if you are holding nothing, it will display the info of the first Custom Item in your inventory based on the order of your items, regular players can also do this with their client console as well.
You may also do info <Custom Item ID> in your remote admin to check an item directly without having it in your inventory. // Not implemented yet