Events - tayjay/SCriPt GitHub Wiki

Events can be subscribed to in order to run code when a certain action is taken in game. To use this, you need to create a function that will accept the arguments given by the event

function MyFunction(args) -- If the event table below has values
    -- Do something
end

function MyFunction() -- If the event table below has no values
    -- Do something
end

Then you can subscribe/unsubscribed to the event like so

Events.Item.KeycardInteracting:add(MyFunction)
Events.Item.KeycardInteracting:remove(MyFunction)

When the event is triggered, your function will be called. Information on what arguments are passed to the function can be found in the event's documentation below.

Some events have an alias associated. For example, Events.Scp049... can also be accessed as Events.Doctor...

Some events have an IsAllowed argument. If you set this to false, the action will be blocked. This is useful for preventing certain actions from happening. Events that don't include this variable are usuall called after the event has occured. You can usually tell by the 'tense' of the event name.

Events related to the in-game announcer.

Events.Cassie.*

Called before CASSIE broadcasts an announcement to the facility

Events related to commands being received and executed.

Events.Command.*

The server received a command from RemoteAdmin

The server has processed and is returning the result of a RemoteAdmin command

A local admin command has been received

Responding to local admin command

A player has sent a command to the server using the ~ terminal

The server is responding to the player's ~ command

Events.Item.*

A player's Ammo count is changing

A player is attempting to change their weapon attachments

The server has receieved the players prefered attachments

A player is trying to use a Keycard

A player is attempting to swing the Jailbird

A player is attempting to charge the Jailbird (Right-click)

The battery from a radio on the ground is trying to drain

Events.Map.*

Placing a bullet hole decal on the map

Placing blood on the map

The current state of LCZ Decon is being announced

CASSIE is attempting to announce an SCP has died.

CASSIE is attempting to announce NTF has arrived

A player is attempting to turn on a generator

The map is attempting to decontaminate LCZ. Locking elevators and hurting players in the zone.

A grenade is attempting to explode.

Trying to spawn an item in the facility

Choosing what will be placed in a locker. This is called during facility generation.

The facility has completed being built based off the seed. There are no arguments to this event.

A grenade pickup in the facility is trying to arm.

A grenade pickup in the facility has been armed.

Attempting to turn off all lights in a room

A pickup has been added to the facility

A pickup has been removed from the facility

Attempting to spawn the Helicoptor or Choas car.

Events.Player.*

The player has attempted to connect to the server

Checking if a player has a reserved slot on the server based on their UserId (#####@steam for example)

Attempting to kick a player from the server

A player has been kicked

Attempting to ban a player from the server

A player has been banned

Trying to give a player an achivement

A player is trying to use an item

A player is on the last frame of using an item

A player has finished using an item.

A player has attempted to stop using an item.

A player has stopped using an item.

A player has interacted with a door or object in the facility

A ragdoll of a decesed player has been spawned.

A player is pressing the warhead button on surface

A player is trying to turn on a weapon workstation

A player has walked away from a weapon workstation

A player has joined the server

A player's authentication has been verified by the central server

A player has left the server

A player's instance on the server has been destroyed following their departure

A player is attempting to attack another player.

A player has attacked and hurt another player

A player is about to die.

A player has died.

A player is changing to a new role. Careful: if you plan to change this, only change NewRole. Changing the role of the player directly will result in an infinte loop.

A player has thrown a projectile (Grenade, Throwable SCPs, etc.)

A player has sent a throwing request to the server. This could include starting, canceling, or throwing. Modifying this value will desync the client.

A player is trying to drop an item from their inventory

A player has dropped an item from their inventory

A player has dropped nothing, whatever that means.

A player is trying to pickup an item from the facility.

An player is attempting to handcuff another player.

A player is attempting to remove the handcuffs from another player

A player is trying to talk on the intercom in Entrance.

A player has shot their gun

A player is about to shoot their gun

Scp106 is attempting to teleport a player to his Pocket Dimension

A player is successfully escapting the Pocket Dimension.

A player is unsuccessfully escaping the Pocket Dimension

A player has entered a kill cude/plane

A player is trying to reload their gun

A player is attempting to spawn into the facility

A player has been spawned into the faciliity

A player is trying to change their held item

A player is trying to change their held item

Attempting to change the user group a player is in.

A player is trying to interact (Open/Close/Unlock) with a door.

A player is trying to interact (Call/Send) an elevator

A player is attempting to interact (Open/Close/Unlock) a Locker. This includes SCP, Weapon, and standard lockers

A tesla gate is attempting to shock in the presence of a player

A player is unlocking a generator in HCZ

A player is opening the door on a generator

A player is closing the door on a generator

A player is turning on a generator

A player is turning off a generator

A player is receiving a status effect

Attempting to mute a player

Attempting to remove the mute on a player

Attempting to drain the battery of a radio a player is holding

A player is trying to change the range on their held radio

"Short", "Medium", "Long", "Ultra"

A player is using a MicroHID and is attempting to drain energy.

A player is trying to drop ammo

A player has dropped ammo

A player is trying to interact with a shooting target

A player is damaing a shooting target

A player is flipping a coin

A player has turned on/off their held flashlight

A player is trying to unload the clip from their gun (Holding reload)

A player is trying to ADS

A player is trying to turn on/off the flashlight on their gun, if available.

A player is trying to shoot their gun with no ammo

A player is trying to talk in-game

A player is making a noise that SCP-939 can see

A player is trying to Jump

A player has landed on the ground.

A player is using a radio to talk to other players.

A player is trying to change their Move State (Walking/Running/Sneaking)

A spectator is changing the player they are spectating. Haven't had luck with preventing or changing this.

A player has pressed the NoClip keybind. This triggers regardless of player permissions but is blocked if they don't have it. Input can be taken and used for other purposes.

An admin is changing to the Overwatch role to keep an eye on the game.

A player is trying to turn on/off their Radio

Called before a player searches a Pickup.

A player is trying to send a message to the Admin Chat

A player is damaging a window

A player is damaging a door

An item has been added to a player's inventory

An item has been removed from a player's inventory

Invoked before KillPlayer is called.

A player has entered an environmental hazard such as SCP244, amnesia cloud, 106 sinkhole, and 173 tantrum

A player is still inside an environmental hazard

A player is leaving an environmental hazard

Trying to change the nickname of a player

A player is changing their danger state, from SCP-1853

Events.Scp049.* or Events.Doctor.*

Doctor's Recall ability is finishing

Doctor's Recall ability is starting

Doctor activating their sense ability

Doctor is using teh Call ability

Doctor is attempting to attack

Events.Scp0492.* or Events.Zombie.*

The bloodlust ability is being activated for a zombie

A zombie has consumed a corpse

A zombe is trying to consume a corpse.

Events.Scp079.* or Events.Computer.* or Events.Camera.*

Computer is trying to change camera

Computer is recieving experience point

Computer is leveling up

Computer trying to activate a telsa gate

Computer is interating with a door

Computer is using an elevator to change floors

Computer is locking down a room

Computer is trying to talk to local players

Computer has been recontained

Computer is trying to ping to other SCPs

Computer has blacked out a room

Computer has blacked out a zone

Events.Scp096.* or Events.ShyGuy.*

Shy Guy is trying to enrage

Shy Guy is trying to calm down after raging

Attemping to add a visible target for Shy Guy while he is enraged

Shy Guy is trying to open a gate

Shy Guy is trying to use the Charge ability while enraged

Shy Guy is trying to use the Try not to cry ability

Events.Scp106.* or Events.Larry.* or Events.OldMan.*

Larry is attacking a player

Larry is attempting to teleport using the hunter atlas

Larry is attempting to stalk (Go underground)

Larry is attempting to resurface from stalking

Events.Scp173 .* or Events.Peanut.*

Forcing players near Peanut to blink

Peanut is attempting to teleport nearby

Peanut is trying to place tantrum on the ground

Peanut is trying to speed up

Events.Scp244 .* or Events.Vase.*

Vase is being activated and placed on the ground

Vase is being damaged

Vase is being opened on the ground and activated

Events.Scp330 .* or Events.Candy.*

A player interacting with the candy bowl in LCZ

A player is dropping a candy bag with the selected candy

A player is eating a candy

A player has finished eating a candy and has received the effects

Events.Scp914.*

Attemping to upgrade a pickup inside 914

Attempting to upgrade an item in a player's inventory inside 914

Attempting to upgrade and move a player to the output inside 914

A player is turning on 914

A player is chaning the setting of 914 (Coarse, Rough, 1to1, Fine, Very Fine)

Events.Scp939.* or Events.Dog.*

Dog is crouching and trying to focus in

Dog is trying to pounce after crouching

Dog is trying to place her amnestic cloud

Dog is playing a voiceclip from a player

Server is saving a voice clip of a consenting player for the dog

Dog is playing a generic sound

Dog has slashed at a player

Confirming before dog is able to see a player

Events.Scp3114.* or Events.Skeleton.*

Skeleton is consuming a corpse to change it's disguise

Skeleton has changed to a new appearance

Skeleton is trying to interact with a body to disguise

Skeleton has revealed its true form

Skeleton is trying to remove its disguise

A random voiceline is playing from the Skeleton

Events.Server.*

The lobby has started and server is ready to accept players

Players have been given their roles and the round has begun

Confirming if round ending critera is met

The round has ended, showing end of round card

Round is restarting, called after round end timer has completed or manually by admin

A player is reporting a cheater

The team with the most tickets is respawning as part of the 5 minute respawn timer.

Choosing a unit name/number for an NTF group

A player is sending a complaint about a player to the local server administrators.

Invoked before choosing the Team than player will get.

Invoked before selecting the team that will respawn

Invoked after the "reload configs" command is ran.

Invoked after the "reload translations" command is ran.

Invoked after the "reload gameplay" command is ran.

Invoked after the "reload remoteadminconfigs" command is ran.

Invoked after the "reload plugins" command is ran.

Invoked after the "reload permissions" command is ran.

Events.Warhead.* or Events.Nuke.*

Invoked before stopping the warhead.

Invoked before starting the warhead.

Invoked before changing the warhead lever status.

Invoked after the warhead has been detonated.

Invoked before detonating the warhead.