Synapse API

Synapse

Version : Gives you the Current Version of Synapse as a string

VersionNumber : Gives you the Current Version of Synapse as a number

Plugins : Gives you a List of all Plugins on the Server

---

Log

Info(String message) : Send an info message in the ServerConsole

Warn(String message) : Send an warn message in the ServerConsole

Error(String message) : Send an error message in the ServerConsole

---

Map

FriendlyFire : Activates/Deactivates the FriendlyFire on the server

Lifts : Gives you a list of all lifts

Rooms : Gives you a list of all rooms

IntercomText : Get/Set the text displayed in the intercom

ActivatedGenerators : How many generators are activated?

GetDoorPos(String doorname) : Gives the position of the door with that name

GetRidPos(String ridname) : Gives you the position of the cubes you can see when you write "showrids" in the console

GetRoomPos(string name) : Gives the position of the room with that name

GetRandomSpawnPoint(RoleType roleType) : Gives you a random spawnpoint of the Role

CassieMessage(string msg, bool makeHold, bool makeNoise) : Sends a Cassie Message

SpawnItem(ItemType itemType, float durability, Vector3 position, Quaternion rotation = default, int sight = 0, int barrel = 0, int other = 0)) : Spawns a Item on the Map

SpawnItem(ItemType itemType, float durability, Vector3 position, Vector3 scale, Quaternion rotation = default, int sight = 0, int barrel = 0, int other = 0) : Spawns a Item on the Map with a specific scale

SpawnWorkStation(Vector3 position,Vector3 rotation,Vector3 size) : Spawns a WorkStation on the Map

SpawnRagdoll(Vector3 Position,RoleType role,string killer = "World") : Spawns a Ragdoll on the Map

IsGroupAllowed(String groupname, String permission) : Has the group the permission?

Broadcast(String message, int duration) : Gives all players a broadcast

ClearBroadcasts() : Clear all broadcasts from all players

TurnOffAllLights(int duration, bool onlyHeavy = false) : Deactivates the lights

---

Decontamination

Controller : Gives you the Decontamination Controller

IsDecontaminationDisabled : Is the Decontamination Countdown disabled?

IsDecontaminationInProgress : Is the Decontamination in Progress?

StartDecontamination() : Starts the Decontamination

---

Round

RoundLenght : The time since the Round started

StartedTime : The time the Round started

IsStarted : Is the Round started?

IsLocked : Get/Sets if the Round is locked

IsLobbyLocked : Get/Sets if the Lobby is locked

Escaped_Ds : The Amount of escaped ClassD`s

Escaped_Scientists : The Amount of escaped Scientists

Kills_by_Scps : The Amount of kills by Scps

Changed_into_Zombies : The Amount of persons changed into Zombies

Restart() : Restarts the Round

Start() : Starts the Round

MTFRespawn(bool IsCI) : Spawns Mtf/Chaos

---

Server

Host : Gives you the Player object of the Server

Name : Get/Sets the ServerName

Port : Get/Sets the Port of the Server

SendSpawnMessage : SpawnMessage MethodInfo

Broadcast : The Broadcast object of the Server

BanPlayer : The BanPlayer object of the Server

Console : Gives you the ServerConsole

RaCommandHandler : The RemoteAdmin Command Handler

GameCoreCommandHandler : The ServerConsole Command Handler

ClientCommandHandler : The Client Command Handler of Scp:SL

GetObjectsOf<UnityObject>() : Gives you a list of all objects with this Type

GetMethodHash(Type invokeClass, string methodName) : Gives you the MethodHash

---

Warhead

Controller : Gives you the Decontamination Controller

NukesitePanel : Gives you the NukesiktePanel

LeverStatus : Get / Set the LeverStatus

DetonationTimer : The Time to Detonation

IsNukeDetonated : Is the Nuke Detonated?

IsNukeInProgress : Is the Nuke in Progress?

StartNuke() : Starts the Nuke

StopNuke() : Stops the Nuke

DetonateNuke() Detonates the Nuke

Shake() : Shakes the Screen for all player like when the Nuke explodes

---

Jail

An object which contains Information about the Jail State of a Player

IsJailed : Is the Player currently in Jail?

Player : The Player object which are Jailed (or not Jailed)

Admin : The Player object of the Admin which Jailed the Player

Role : The Role the Player will get after he gets Unjailed

Position : The Position the Player will get after he gets Unjailed

Items : The Items the Player will get after he gets Unjailed

Health : The Health the Player will get after he gets Unjailed

DoJail : Jails the Player

UnJail : Unjails the Player

Room

An object which represents a room on the map

Name : The name of the room

Transform : The transform of the room

Position : The position of the room

Zone : The ZoneType in which the room is

Player

A object which represents a player.

StaticMethods and variables(you can alway access them with Player.Method())

Host : Gives you the Server as PlayerObject

GetAllPlayers() : Gives you all Players on the Server

GetPlayer(int id) : Gives you the Player with that PlayerID

GetPlayer(string arg) : Gives you the Player with that PlayerID,UserID or nickname

ObjectMethods and variables(you need to access them a object)

It contains almost every component from ReferenceHub.

CommandSender : The CommandSender object of the Player

NickName : The name of the player

DisplayName : Get / Set the Displayed Name of the User

PlayerId : The PlayerId of the player (The Id you can see in RemoteAdmin)

UserId : The UserId of the player (@steam, @discord, etc.)

CustomUserId : A possible second id.

IpAddress : The Ip address of the player

NoClip : Get / Set the user into noclip

OverWatch : Get / Set the Overwatch Status

Bypass : Get / Set the Players Bypassmode.

GodMode : Get / Set the Players GodMode

Scale : Modify the size of the Player

Position : The position of the player

RotationVector : The rotation vector of the player

Rotation : The rotation of the player

Health : The health of the player

MaxHealth : The maximum health a player can get

ArtificialHealth : The extra health of the Player (AP)

MaxArtificialHealth : The maximum ArtificialHealth a player can get

Role : The RoleType of the player

Team : The team of the player

Side : The "Side" the player is on (ClassDs are on TeamChaos, Scientists are on Team MTF)

Room : The Room where the player currently is

Connection : The NetworkConnection of the player (often used by vanilla methods)

Items : All items the player has

Cuffer : The person who cuffed the player (maybe be null, if set to null, uncuffed)

Ammo5 : How much Ammo5 has the player

Ammo7 : How much Ammo7 has the player

Ammo9 : How much Ammo9 has the player

Rank : The UserGroup the player is in

GroupName : The name of the group the user has

RankColor : The color of the rank (Note: This will not change the permissions)

RankName : The name which is shown (Note: This will not change the permissions)

Permission : The Permission of the User

IsMuted : Is the player muted

IsIntercomMuted : Is the player muted in the intercom

Camera : The current camera the player uses (Scp079 only, if not null)

Ping : Gives you the Ping of the Player to the Server

RotationFloat : The rotation float of the player

IsCuffed : Is the player cuffed?

IsReloading : Is the player reloading right now?

IsZooming : Is the player currently scoping

IsDead : Is the player dead

Jail : The Jail object of the Player

UnitName : Gets/Sets the UnitName of the Player

DoNotTrack : If the Client sends a DnT Signal, useful for storing data

Kick(string message) : Kicks the player

Ban(int duration, string reason) : Bans the player

Kill(DamageTypes.DamageType damageType = default) : Kills a player

CheckPermission(string permission) : Checks if the user has permission Example: ev.Player.CheckPermission(ab.command)

GiveTextHint(string message, float duration = 5f) : Gives the player a text hint on his screen

ClearBroadcasts() : Clear all Broadcast the Player has currently

Broadcast(ushort time, string message) : Sends a broadcast to the player

InstantBroadcast(ushort time, string message) : Clear all previous broadcasts and send the broadcast instant to the player

SendConsoleMessage(string message, string color) : Send a message in the console of the player

SendRAConsoleMessage(string message, bool success = true, RaCategory type = RaCategory.None) : Sends a message in the Text based Remote Admin of the Player

ShowTag(bool global = false) : Shows everyone the RankName the player has

HideTag() : Hides for normal player the RankName the player has

GiveItem(ItemType itemType, float duration = float.NegativeInfinity, int sight = 0, int barrel = 0, int other = 0) : Gives the player a item

DropAllItems() : Drops the Entire Inventory of the Player

DropItem(Inventory.SyncItemInfo item) : Drops a Item from the PlayerInventory

ClearInventory() : Clears the players Inventory

GiveEffect(Synapse.Api.Effects effect, byte intensity = 1, float duaration = -1f) : Gives the player an effect

RaLogin() : Allow the player to open the RemoteAdmin-Interface

RaLogout() : Denies the access to the RemoteAdmin-Interface

Hurt(int amount, DamageTypes.DamageType damagetype = default,Player attacker = null) : Hurts the Player

SendToServer(ushort port) : Sends the Player to a server in the same Network with this port(if such a server not exist he will be disconnected)

DimScreen() : Makes the Screen of the Player for the entire Round black

ShakeScreen(bool achieve = false) : Shakes the Screen of the Player like when the Warhead explodes

Enums

• RaCategory
  • None
  • PlayerInfo
  • ServerEvents
  • DoorsManagement
  • AdminTools
  • ServerConfigs
  • PlayersManagement
• ZoneType
  • Surface
  • Entrance
  • HeavyContainment
  • LightContainment
  • Unspecified
• Effects
  • Amnesia: The Player can't open his inventory and reload his weapons
  • Asphyxiated: Quickly drains stamina then health if there is none left
  • Bleeding: Damage-over time starting high and getting low. Ticks every 5s.
  • Blinded: Applies extreme screen blur
  • Burned: Slightly increases all damage taken
  • Concussed: Blurs the screen as the Player turns
  • Corroding: Teleports to the pocket dimension and drains hp until he escapes
  • Deafened: Heavily muffles all sounds
  • Decontaminating: Remove 10% of max health each second
  • Disabled: Slows all movement
  • Ensnared: Prevents all movement
  • Exhausted: Laves stamina capacity and regeneration rate
  • Flashed: Flash the Player
  • Hemorrhage: Sprinting drains 2 hp/s
  • Invigorated: Infinite stamina
  • Panic: Slightly increases stamina consumption
  • Poisoned: Damage-over time starting low and rising high. Ticks every 5s.
  • Scp207: The Player will walk faster
  • Scp268: The Player cant be seen by other entities. He need do activate Scp268 in his inventory
  • SinkHole: Slows down players but not SCP's
  • Visuals939: The vision of SCP-939