SCriPt Reference - tayjay/SCriPt GitHub Wiki

Assembly Documentation: SCriPt.LabAPI

Generated on: 22/08/2025 08:54:23

SCriPt.LabAPI.API.Lua.Proxies.ProxyAdminToy

  • Kind: Class

Properties

Name Type Get Set Static
IsStatic bool public public
MovementSmoothing byte public public
Position UnityEngine.Vector3 public public
Rotation UnityEngine.Quaternion public public
Scale UnityEngine.Vector3 public public
SyncInterval float public public

Methods

Name Signature Returns Modifiers
Spawn Spawn() void public

SCriPt.LabAPI.API.Lua.Proxies.ProxyCapybaraToy

  • Kind: Class
  • Base Type: SCriPt.LabAPI.API.Lua.Proxies.ProxyAdminToy

Properties

Name Type Get Set Static
CollidersEnabled bool public public

SCriPt.LabAPI.API.Lua.Proxies.ProxyDummy

  • Kind: Class
  • Base Type: SCriPt.LabAPI.API.Lua.Proxies.ProxyPlayer

SCriPt.LabAPI.API.Lua.Proxies.ProxyPlayer

  • Kind: Class

Properties

Name Type Get Set Static
ArtificialHealth float public public
ConnectionToClient Mirror.NetworkConnectionToClient public
CurrentItem LabApi.Features.Wrappers.Item public public
CurrentlySpectating LabApi.Features.Wrappers.Player public
DisplayName string public public
DoNotTrack bool public
Emotion PlayerRoles.FirstPersonControl.Thirdperson.Subcontrollers.EmotionPresetType public public
Faction PlayerRoles.Faction public
Gravity UnityEngine.Vector3 public public
Health float public public
HumeShield float public public
IpAddress string public
IsAlive bool public
IsDead bool public
IsDummy bool public
IsHost bool public
IsHuman bool public
IsScp bool public
IsSpeaking bool public
LifeId int public
MaxArtificialHealth float public public
MaxHealth float public public
PlayerId int public
Position UnityEngine.Vector3 public public
Role PlayerRoles.RoleTypeId public
Room LabApi.Features.Wrappers.Room public
Rotation UnityEngine.Quaternion public public
UserId string public
Zone MapGeneration.FacilityZone public

Methods

Name Signature Returns Modifiers
DisableEffect DisableEffect(string effectName) void public
EnableEffect EnableEffect(string effectName, byte intensity, float duration) void public
GetPermissions GetPermissions() string[] public
Jump Jump() void public
Jump Jump(float force) void public
Move Move(UnityEngine.Vector3 delta) void public
SendConsoleMessage SendConsoleMessage(string message, string color = "green") void public
SendHint SendHint(string message, float duration = 5) void public
SendHitMarker SendHitMarker(float size = 1) void public
SetRole SetRole(PlayerRoles.RoleTypeId newRole, PlayerRoles.RoleChangeReason reason = RemoteAdmin, PlayerRoles.RoleSpawnFlags flags = All) void public
Test Test() void public

SCriPt.LabAPI.API.Lua.Objects.LuaCustomCommand

  • Kind: Class

Properties

Name Type Get Set Static
Aliases string[] public
Command string public
Description string public

Methods

Name Signature Returns Modifiers
Execute Execute(System.ArraySegment<string> arguments, CommandSystem.ICommandSender sender, out string response) bool public
Register Register() void public
Unregister Unregister() void public

SCriPt.LabAPI.API.Lua.Objects.LuaCustomData

  • Kind: Class

Fields

Name Type Modifiers
table MoonSharp.Interpreter.DynValue public

Properties

Name Type Get Set Static
Item MoonSharp.Interpreter.DynValue public public

Methods

Name Signature Returns Modifiers
Load Load(string key) MoonSharp.Interpreter.DynValue public
Save Save(string key, MoonSharp.Interpreter.DynValue value) void public

SCriPt.LabAPI.API.Lua.Objects.LuaCustomSettings

  • Kind: Class

Fields

Name Type Modifiers
SettingsTable MoonSharp.Interpreter.Table public

Properties

Name Type Get Set Static
Item MoonSharp.Interpreter.DynValue public public

Methods

Name Signature Returns Modifiers
Activate Activate() void public
Deactivate Deactivate() void public

SCriPt.LabAPI.API.Lua.Objects.LuaModule

  • Kind: Class
  • Base Type: MoonSharp.Interpreter.Table

Properties

Name Type Get Set Static
Name string public
Priority int public

Methods

Name Signature Returns Modifiers
LoadModule LoadModule() void public
UnloadModule UnloadModule() void public

SCriPt.LabAPI.API.Lua.Objects.ScriptHandler

  • Kind: Class
  • Base Type: MoonSharp.Interpreter.Script

Fields

Name Type Modifiers
Coroutines SCriPt.LabAPI.API.Lua.Globals.GlobalCoroutines public
CustomCommands System.Collections.Generic.List<SCriPt.LabAPI.API.Lua.Objects.LuaCustomCommand> public
CustomSettings System.Collections.Generic.List<SCriPt.LabAPI.API.Lua.Objects.LuaCustomSettings> public
Modules System.Collections.Generic.List<SCriPt.LabAPI.API.Lua.Objects.LuaModule> public

Properties

Name Type Get Set Static
Name string public public

Methods

Name Signature Returns Modifiers
Create Create(string path, MoonSharp.Interpreter.CoreModules sandbox) SCriPt.LabAPI.API.Lua.Objects.ScriptHandler static public
CreateFromCommand CreateFromCommand(string command, MoonSharp.Interpreter.CoreModules sandbox) SCriPt.LabAPI.API.Lua.Objects.ScriptHandler static public
ExecuteLoad ExecuteLoad() void public
ExecuteUnload ExecuteUnload() void public
SetupAPI SetupAPI() void public

SCriPt.LabAPI.API.Lua.Globals.GlobalAdminToys

  • Kind: Class

Methods

Name Signature Returns Modifiers
SpawnCapybara SpawnCapybara(UnityEngine.Vector3 position, UnityEngine.Quaternion rotation = null, UnityEngine.Vector3 scale = null, bool collidable = true) LabApi.Features.Wrappers.CapybaraToy static public
SpawnLightSource SpawnLightSource(UnityEngine.Vector3 position, float intensity = 1, System.Nullable<UnityEngine.Color> color = null, float range = 10) LabApi.Features.Wrappers.LightSourceToy static public
SpawnPrimitiveObject SpawnPrimitiveObject(UnityEngine.PrimitiveType type, UnityEngine.Vector3 position, UnityEngine.Quaternion rotation = null, UnityEngine.Vector3 scale = null, UnityEngine.Color color = null, bool collidable = true) LabApi.Features.Wrappers.PrimitiveObjectToy static public
SpawnShootingTarget SpawnShootingTarget(UnityEngine.Vector3 position, UnityEngine.Quaternion rotation = null, UnityEngine.Vector3 scale = null) LabApi.Features.Wrappers.ShootingTargetToy static public
SpawnSpeaker SpawnSpeaker(UnityEngine.Vector3 position, UnityEngine.Quaternion rotation = null, UnityEngine.Vector3 scale = null) LabApi.Features.Wrappers.SpeakerToy static public
SpawnText SpawnText(UnityEngine.Vector3 position, UnityEngine.Quaternion rotation, string text) LabApi.Features.Wrappers.TextToy static public

SCriPt.LabAPI.API.Lua.Globals.GlobalCassie

  • Kind: Class

Properties

Name Type Get Set Static
IsSpeaking bool public yes

Methods

Name Signature Returns Modifiers
GetAllWords GetAllWords() string[] static public
GlitchyMessage GlitchyMessage(string message, float glitchChance, float jamChance) void static public
IsValidWord IsValidWord(string word) bool static public
Message Message(string message, bool isHeld = false, bool isNoisy = true, bool isSubtitles = false) void static public

SCriPt.LabAPI.API.Lua.Globals.GlobalCoroutines

  • Kind: Class

Properties

Name Type Get Set Static
Handles System.Collections.Generic.List<MEC.CoroutineHandle> public
Owner SCriPt.LabAPI.API.Lua.Objects.ScriptHandler public
WaitForOneFrame float public

Methods

Name Signature Returns Modifiers
CallContinuously CallContinuously(float timeframe, MoonSharp.Interpreter.Closure closure) MEC.CoroutineHandle public
CallContinuously CallContinuously(float timeframe, MoonSharp.Interpreter.Closure closure, object[] args) MEC.CoroutineHandle public
CallCoroutine CallCoroutine(MoonSharp.Interpreter.Closure closure) MEC.CoroutineHandle public
CallCoroutine CallCoroutine(MoonSharp.Interpreter.Closure closure, object[] args) MEC.CoroutineHandle public
CallDelayed CallDelayed(float delay, MoonSharp.Interpreter.Closure closure) MEC.CoroutineHandle public
CallDelayed CallDelayed(float delay, MoonSharp.Interpreter.Closure closure, object[] args) MEC.CoroutineHandle public
CallPeriodically CallPeriodically(float timeframe, float period, MoonSharp.Interpreter.Closure closure) MEC.CoroutineHandle public
CallPeriodically CallPeriodically(float timeframe, float period, MoonSharp.Interpreter.Closure closure, object[] args) MEC.CoroutineHandle public
Kill Kill(MEC.CoroutineHandle handle) void public
KillAll KillAll() void public
KillCoroutine KillCoroutine(MEC.CoroutineHandle handle) void public
RunCoroutine RunCoroutine(MoonSharp.Interpreter.Closure closure) MEC.CoroutineHandle public
RunCoroutine RunCoroutine(MoonSharp.Interpreter.Closure closure, object[] args) MEC.CoroutineHandle public
WaitForSeconds WaitForSeconds(float seconds) float public

SCriPt.LabAPI.API.Lua.Globals.GlobalData

  • Kind: Class

Properties

Name Type Get Set Static
CustomData System.Collections.Generic.Dictionary<string, SCriPt.LabAPI.API.Lua.Objects.LuaCustomData> public public yes

Methods

Name Signature Returns Modifiers
Get Get(string name) SCriPt.LabAPI.API.Lua.Objects.LuaCustomData static public
LoadFromDisk LoadFromDisk() void static public
SaveDataToDisk SaveDataToDisk(string name) void static public
SaveDataToDisk SaveDataToDisk(SCriPt.LabAPI.API.Lua.Objects.LuaCustomData data) void static public

SCriPt.LabAPI.API.Lua.Globals.GlobalDeadmanSwitch

  • Kind: Class

Properties

Name Type Get Set Static
IsDeadmanSwitchEnabled bool public public yes
TimeLeft float public public yes

Methods

Name Signature Returns Modifiers
Disable Disable() void static public
Enable Enable() void static public
Initiate Initiate(float addDelay = 0) void static public

SCriPt.LabAPI.API.Lua.Globals.GlobalDecon

  • Kind: Class

Methods

Name Signature Returns Modifiers
Disable Disable() void static public
Force Force() void static public
Reset Reset() void static public

SCriPt.LabAPI.API.Lua.Globals.GlobalDummy

  • Kind: Class

Properties

Name Type Get Set Static
Dummies System.Collections.Generic.List<LabApi.Features.Wrappers.Player> public
Owner SCriPt.LabAPI.API.Lua.Objects.ScriptHandler public

Methods

Name Signature Returns Modifiers
Action Action(LabApi.Features.Wrappers.Player dummy, string action) float public
ActionSequence ActionSequence(LabApi.Features.Wrappers.Player dummy, MoonSharp.Interpreter.Table sequence) void public
GetDummyActions GetDummyActions(LabApi.Features.Wrappers.Player dummy) MoonSharp.Interpreter.Table public
Remove Remove(LabApi.Features.Wrappers.Player dummy) LabApi.Features.Wrappers.Player public
Spawn Spawn(string name) LabApi.Features.Wrappers.Player public

SCriPt.LabAPI.API.Lua.Globals.GlobalEvents

  • Kind: Class

Properties

Name Type Get Set Static
Doctor SCriPt.LabAPI.Handlers.LuaScp049Events public yes
Dog SCriPt.LabAPI.Handlers.LuaScp939Events public yes
Larry SCriPt.LabAPI.Handlers.LuaScp106Events public yes
Objective SCriPt.LabAPI.Handlers.LuaObjectiveEvents public yes
Peanut SCriPt.LabAPI.Handlers.LuaScp173Events public yes
Player SCriPt.LabAPI.Handlers.LuaPlayerEvents public yes
Scp049 SCriPt.LabAPI.Handlers.LuaScp049Events public yes
Scp0492 SCriPt.LabAPI.Handlers.LuaScp0492Events public yes
Scp079 SCriPt.LabAPI.Handlers.LuaScp079Events public yes
Scp096 SCriPt.LabAPI.Handlers.LuaScp096Events public yes
Scp106 SCriPt.LabAPI.Handlers.LuaScp106Events public yes
Scp127 SCriPt.LabAPI.Handlers.LuaScp127Events public yes
Scp173 SCriPt.LabAPI.Handlers.LuaScp173Events public yes
Scp3114 SCriPt.LabAPI.Handlers.LuaScp3114Events public yes
Scp914 SCriPt.LabAPI.Handlers.LuaScp914Events public yes
Scp939 SCriPt.LabAPI.Handlers.LuaScp939Events public yes
Server SCriPt.LabAPI.Handlers.LuaServerEvents public yes
ShyGuy SCriPt.LabAPI.Handlers.LuaScp096Events public yes
Skeleton SCriPt.LabAPI.Handlers.LuaScp3114Events public yes
Warhead SCriPt.LabAPI.Handlers.LuaWarheadEvents public yes
Zombie SCriPt.LabAPI.Handlers.LuaScp0492Events public yes

SCriPt.LabAPI.API.Lua.Globals.GlobalLobby

  • Kind: Class

Properties

Name Type Get Set Static
IsInLobby bool public
IsLocked bool public public
TimeLeft float public public

Methods

Name Signature Returns Modifiers
Lock Lock() void static public
Unlock Unlock() void static public

SCriPt.LabAPI.API.Lua.Globals.GlobalNew

  • Kind: Class

Fields

Name Type Modifiers
Color System.Func<float, float, float, float, UnityEngine.Color> static public
Quaternion System.Func<float, float, float, float, UnityEngine.Quaternion> static public
Vector2 System.Func<float, float, UnityEngine.Vector2> static public
Vector3 System.Func<float, float, float, UnityEngine.Vector3> static public

SCriPt.LabAPI.API.Lua.Globals.GlobalPlayers

  • Kind: Class

Properties

Name Type Get Set Static
List System.Collections.Generic.IReadOnlyCollection<LabApi.Features.Wrappers.Player> public yes

Methods

Name Signature Returns Modifiers
All All() System.Collections.Generic.IReadOnlyCollection<LabApi.Features.Wrappers.Player> static public
ById ById(int id) LabApi.Features.Wrappers.Player static public
ByName ByName(string name) LabApi.Features.Wrappers.Player static public
ByNetId ByNetId(int netId) LabApi.Features.Wrappers.Player static public
ByReferenceHub ByReferenceHub(ReferenceHub hub) LabApi.Features.Wrappers.Player static public
ByRole ByRole(PlayerRoles.RoleTypeId role) System.Collections.Generic.IReadOnlyCollection<LabApi.Features.Wrappers.Player> static public
ByTeam ByTeam(PlayerRoles.Team team) System.Collections.Generic.IReadOnlyCollection<LabApi.Features.Wrappers.Player> static public
ByUserId ByUserId(string id) LabApi.Features.Wrappers.Player static public
ByZone ByZone(MapGeneration.FacilityZone zone) System.Collections.Generic.IReadOnlyCollection<LabApi.Features.Wrappers.Player> static public
Random Random() LabApi.Features.Wrappers.Player static public

SCriPt.LabAPI.API.Lua.Globals.GlobalRound

  • Kind: Class

Properties

Name Type Get Set Static
CanRoundEnd bool public yes
InProgress bool public yes
IsEnded bool public yes
IsLocked bool public yes

Methods

Name Signature Returns Modifiers
End End() void static public
Lock Lock() void static public
Restart Restart() void static public
Start Start() void static public
Unlock Unlock() void static public

SCriPt.LabAPI.API.Lua.Globals.GlobalSCriPt

  • Kind: Class

Methods

Name Signature Returns Modifiers
AddStaticGlobal AddStaticGlobal(string typeName, string globalName = null) void public
Command Command(LabApi.Features.Enums.CommandType type, string name, string[] aliases, string description, string permission, MoonSharp.Interpreter.Closure execute) SCriPt.LabAPI.API.Lua.Objects.LuaCustomCommand public
Docs Docs(object obj) string public
Global Global(string name, int priority = 1) SCriPt.LabAPI.API.Lua.Objects.LuaModule public
Mod Mod(string name, int priority = 3) SCriPt.LabAPI.API.Lua.Objects.LuaModule public
Module Module(string name, int priority = 3) SCriPt.LabAPI.API.Lua.Objects.LuaModule public
RegisterType RegisterType(string typeName) void public
Settings Settings(MoonSharp.Interpreter.Table table, MoonSharp.Interpreter.Closure callback) SCriPt.LabAPI.API.Lua.Objects.LuaCustomSettings public

SCriPt.LabAPI.API.Lua.Globals.GlobalServer

  • Kind: Class

Properties

Name Type Get Set Static
FriendlyFire bool public public yes
IdleModeAvailable bool public public yes
IpAddress string public yes
MaxPlayers int public yes
Name string public yes
PauseIdleMode bool public public yes
PlayerCount int public yes
Port int public yes
RemoteAdmins System.Collections.Generic.List<LabApi.Features.Wrappers.Player> public yes
Tps double public yes
IdleModeActive bool public

Methods

Name Signature Returns Modifiers
LACommand LACommand(string command) string static public
RACommand RACommand(string command) string static public
RACommandAs RACommandAs(string command, LabApi.Features.Wrappers.Player player) string static public
Restart Restart() void static public
SendBroadcast SendBroadcast(string message, ushort duration = 5) void static public
Shutdown Shutdown() void static public

SCriPt.LabAPI.API.Lua.Globals.GlobalSettings

  • Kind: Class

Methods

Name Signature Returns Modifiers
Button Button(string label, string buttonText, string hint = null) UserSettings.ServerSpecific.SSButton static public
Dropdown Dropdown(string label, string[] options, int selectedIndex = 0, string hint = null) UserSettings.ServerSpecific.SSDropdownSetting static public
GetSettingOfPlayer GetSettingOfPlayer(LabApi.Features.Wrappers.Player player, int id) UserSettings.ServerSpecific.ServerSpecificSettingBase static public
GroupHeader GroupHeader(string label, string hint = null) UserSettings.ServerSpecific.SSGroupHeader static public
Keybind Keybind(string label, UnityEngine.KeyCode defaultKey = None, string hint = null) UserSettings.ServerSpecific.SSKeybindSetting static public
Plaintext Plaintext(string label, string content, string hint = null, TMPro.TMP_InputField+ContentType contentType = Standard) UserSettings.ServerSpecific.SSPlaintextSetting static public
RegisterTypes RegisterTypes() void static public
Slider Slider(string label, float minValue, float maxValue, float defaultValue, string hint = null) UserSettings.ServerSpecific.SSSliderSetting static public
TextArea TextArea(string content) UserSettings.ServerSpecific.SSTextArea static public
TwoButtons TwoButtons(string label, string buttonAText, string buttonBText, bool defaultIsB = false, string hint = null) UserSettings.ServerSpecific.SSTwoButtonsSetting static public

SCriPt.LabAPI.API.Lua.Globals.GlobalTime

  • Kind: Class

Properties

Name Type Get Set Static
RoundDuration double public
RoundTimeSpan System.TimeSpan public
ServerDateTimeLocal System.DateTime public
ServerDateTimeUtc System.DateTime public
ServerTimeLocal long public
ServerTimeUtc long public

Methods

Name Signature Returns Modifiers
MillisecondsToTimeSpan MillisecondsToTimeSpan(long milliseconds) System.TimeSpan public
SecondsToTimeSpan SecondsToTimeSpan(double seconds) System.TimeSpan public

SCriPt.LabAPI.API.Lua.Globals.GlobalWarhead

  • Kind: Class

Properties

Name Type Get Set Static
CooldownTime double public public yes
DetonationTime float public public yes
LeverStatus bool public public yes

Methods

Name Signature Returns Modifiers
Lock Lock() void static public
Shake Shake() void static public
Start Start() void static public
Stop Stop() void static public
Unlock Unlock() void static public

SCriPt.LabAPI v0.5.3 | A plugin by TayTay | Give it a ⭐ to show your support

⚠️ **GitHub.com Fallback** ⚠️