Skip to content

For Server Admins

Jump to bottom
SwiftKraft edited this page Jan 22, 2024 · 32 revisions

Welcome, Server Admins and Owners!

Overview

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.

Targeters

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) 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.
  • @DEAD - All players that are in Spectator.
  • @HUMAN - All humans.
  • @SCP - All players of the SCP faction.
  • @MTF - All MTF Operatives and Guards.
  • @CI - All Chaos Insurgents.
  • @SCI - All Scientists.
  • @CD - All Class D Personnel.
  • @FLA - All instances of SCP-1507 (Pink Flamingos). (TEMPORARILY DISABLED)
  • @ARMED - All humans that have a firearm in their inventory.
  • @UNARMED - All humans that have no firearms in their inventory.
  • @INVFULL - All humans that have a full inventory.
  • @INVEMPTY - All humans that have an empty inventory.

Custom Items

To give a CustomItem 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. CustomItemIDs are separate from item IDs, they are registered upon plugin load, each plugin may add different custom items with different CustomItemIDs, 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 CustomItem with the ID debug_gun to the player with the PlayerID of 2.

You can also use Targeters to give a group of players CustomItems, like this:

customitem debug_gun @MTF

This will give all MTF operatives and Guards the CustomItem with the ID debug_gun.

To check what a CustomItem 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 CustomItem. This will display information about the CustomItem, if you are holding nothing, it will display the info of the first CustomItem 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 <CustomItemID> in your remote admin to check an item directly without having it in your inventory.

Spawners

Here is a list of commands for spawners and a brief description of what they do:

  • addsp <SpawnerType> <Timer> <CustomData> #Adds a spawner at your current location.
  • editsp <SpawnerID> <CustomData> #Edits the custom data of a spawner.
  • infosp <SpawnerID> #Displays the detailed info of a spawner.
  • listsp #Displays all spawners and their ID.
  • listsptypes #Displays all spawner types.
  • delsp <SpawnerID> #Deletes a spawner.
  • togglesp <SpawnerID> [true/false] #Pauses or unpauses a spawner.
  • clearsp #Deletes all spawners.
  • toggleallsp <true/false> #Toggles all spawners on or off.

Spawner Types

The implemented SpawnerTypes for the base API are as follows:

Different SpawnerTypes have different CustomData needed for them to function.

ITEM Spawners

For ITEM Spawners, you need to input a item ID or a CustomItemID in order for it to spawn things. For example:

addsp ITEM 1 0

This command will create a spawner that spawns a Janitor Keycard every 1 second at your current location (Which is around 1 unit below your camera, at your player's center of mass)

addsp ITEM 1 debug_gun

This command will create a spawner that spawns a CustomItem with the ID debug_gun at your current location.

ROLE Spawners

For ROLE Spawners, you need to input a RoleID and optionally, a pool RoleID or Targeter. For example:

addsp ROLE 1 0/2

This command will create a spawner that sets a random Spectator to SCP-173 every 1 second. The first number in the 0/2 is the RoleID for the spawnee, and the second number is for the pool of players it should pull from, identified based on their current role. In this case, it is 2, which is the RoleID for Spectator.

The same format will apply to Targeters. Such as:

addsp ROLE 1 0/@ALL

This command will do the same thing as the previous, except that it will choose a random player from all the players on the server that is currently not the role it is trying to spawn them as. Which is SCP-173 (RoleID 0) in this case.

You can also just input a RoleID like follows:

addsp ROLE 1 0

The spawner will default to spawning Spectators in if no secondary value is provided after the /, or if the / is nonexistent.

Clone this wiki locally