SCP: Classified Site Plugin API
  • Quick Start
  • DOCS
    • Folder Structure
    • Creating Plugin Project
    • Creating New Player Class
    • Creating New Item Class
    • Creating New Room Event
    • Creating Additional Networked Class
    • Creating New Admin Panel Menu
    • Abilities
    • Replacing Game Logic
    • Plugin Classes/Game Classes Limitations
  • ID's
    • Inventory Image ID
    • Material ID
    • Team ID
    • Hook ID
  • Game C# Classes
    • ACES
    • AdminPanel
    • Button
    • Config
    • CustomLogger
    • DamageHandler
    • DeadBox
    • DoorManager
    • HitBox
    • HookManager
    • IInteractable
    • InputController
    • ItemPickup
    • Lever
    • NetRoom
    • NetworkedButton
    • NetworkedEvent
    • Player
    • PlayerUtilities
    • ResourcesManager
    • ScriptHelper
    • Trigger
    • UIManager
    • Door
    • SupportManager
    • RoundManager
    • Elevator
  • Another C# Classes
    • Rooms
    • Player Classes
    • Items
    • Admin Panel
Powered by GitBook
On this page
  • Usage
  • Map Generator
  • Generator Overcharge
  • Alpha Warhead
  • Door
  • Elevator
  • LCZ Decontamination
  • HCZ Power Generator
  • Round Canvas
  • Round Manager
  • Support Manager
  • Player Classes
  • Network Manager
  • Room
  • Network Manager
  1. ID's

Hook ID

Under work, some information can be inaccurate

Usage

Hooks can be called on Server or Client if they exist on Server/Client side. If you want to call hook, then you must use HookManager.Run(string hookName, params object[] args). If you want to bind your function to hook, then you must use HookManager.Add(GameObject gameObject, string hookName, System.Action<object[]> func).

Map Generator

[1.1][SERVER] onMapGenerationComplete() - called when map generation is completed.

Generator Overcharge

[1.1][SERVER] onPowerGeneratorEnabled() - called when generator is successfully started.

Alpha Warhead

[SERVER] onAWPanelPress() - called when red button pressed.

[SERVER] onAWLeverFlip(bool state) - called when lever flipped in HC_Nuke room.

[SERVER] onAPAWState(bool state) - called when admin panel request to disable/enable warhead.

[SERVER] onAPAWDetonate() - called when admin panel called to instantly detonate warhead.

[SERVER] onAWDetonate() - called when alpha warhead detonated, not called after onAPAWDetonate hook.

[SERVER] onAWReady() - called when warhead was restarted.

[SERVER] onAWResume(float time) - called when warhead was resumed.

[SERVER] onAWStart(float time) - called when warhead was started, not resumed.

[SERVER] onAWCancel() - called when warhead detonation was canceled.

[1.1][SERVER/CLIENT] onAWDetonationInevitable() - called when warhead timer reach 10 seconds.

Door

[SERVER] LockDoors() - called when admin panel request to lock doors.

[SERVER] UnlockDoors() - called when admin panel request to unlock doors.

Elevator

[SERVER] onElevatorTeleport(Elevator caller, Player teleported) - called when elevator(caller) teleport player(teleported).

[SERVER] onElevatorUse(string elevatorID) - called when player request elevator to change floor.

LCZ Decontamination

[SERVER] onLCZDecontPrepare() - called when LCZ prepare decontamination.

[SERVER] onLCZDecontStart() - called when LCZ start decontamination timer.

[SERVER] onLCZDecontTick(float time) - called when when LCZ Decontamination reaches a certain period of time(10,5,1... mins).

[SERVER] onLCZDecontEvac() - called when when LCZ start evacuation procedure.

[SERVER] onLCZDecontBegun() - called when when LCZ locked down.

[SERVER] onAPLCZClose() - called when admin panel request to lock down LCZ.

HCZ Power Generator

[SERVER] onPowerGeneratorEnabled() - called when power generator enabled.

Round Canvas

[SERVER] startRoundPanel() - called when admin panel requested to start round.

[SERVER] startRound() - called after round start timer reaches zero.

Round Manager

[SERVER] onRoundEnd() - called when round was ended.

[SERVER] NRServer() - called when server prepare fast restart(config "use_fast_restart" must be enabled).

[SERVER] onRoundStart() - called when round was started.

[SERVER] RestartRoundAP() - called when admin panel request to restart round.

Support Manager

[SERVER] onSupportRequest(string type) - called when support spawn was requested, type can be "MTF" or "CI".

[SERVER] onSupportSpawned(string type) - called when support spawned, type can be "MTF" or "CI".

[SERVER] onSupportDeclined() - called when support request declined.

[SERVER] onSupportApproved(float time) - called when support request approved, return time after which support will be spawned.

Player Classes

[SERVER] onClassDEscape(Player caller) - called when player escapes from facility as Class-D.

[SERVER] onScientistEscape(Player caller) - called when player escapes from facility as Scientist.

Network Manager

[CLIENT] onServerDisconnect() - called when player disconnects from server.

[SERVER] onPlayerConnected(NetworkConnectionToPlayer connection) - called when player connects to server.

[SERVER] onPlayerDisconnected(NetworkConnectionToPlayer connection) - called when player disconnects to server.

Room

[CLIENT] onRoomEntered(GameObject room, GameObject connectedRooms) - called when player enters to room.

Network Manager

[SERVER] onPlayerCreated(Player player) - called when player object created.

[SERVER] onPlayerSetClass(Player player) - called when player change player class.

[SERVER] onPlayerDeath(Player player, DamageHandler damage) - called when player dies.

[SERVER/CLIENT] onPlayerTeleported(Player player) - called when player teleports.

PreviousTeam IDNextACES

Last updated 2 months ago