Skip to Content

Remote

Named event channel between server scripts and client scripts.

local Remote = game:GetService("Remote")

Events are identified by a string name. Arguments may be numbers, strings, booleans or Vector3 values.

local Remote = game:GetService("Remote")
local Input = game:GetService("Input")

Input.KeyDown:Connect(function(key)
	if key == "E" then
		Remote:FireServer("Wave", "hello")
	end
end)

Validate on the server

Clients are untrusted. A modified client can send any event name with any arguments, so the server must validate every request before acting on it.

Methods

FireClient

Remote:FireClient(player: Player, name: string, ...)

Fires a named event to one client. Server only.

FireAllClients

Remote:FireAllClients(name: string, ...)

Fires a named event to all clients. Server only.

FireServer

Remote:FireServer(name: string, ...)

Fires a named event to the server. Client only.

Events

OnServerEvent

Remote.OnServerEvent(player: Player, name: string, ...)

Fires when a client calls FireServer. The sending player is always the first argument. Server only.

OnClientEvent

Remote.OnClientEvent(name: string, ...)

Fires when the server calls FireClient or FireAllClients. Client only.

Remote.OnClientEvent:Connect(function(name)
	if name == "Flash" then
		game:GetService("Effects"):Flash(Color3.fromRGB(255, 255, 255))
	end
end)

On this page