OnServerInvoke

Unsafe

For thread safety, this property is not safe to read in an unsynchronized thread.

Expected return type: Tuple

Description:

The function called when RemoteFunction/InvokeServer is called. This callback should be set from a Script.
When the bound function returns, the returned values are sent back to the calling client.

This is used to retrieve remote events fired by the client and intended for the server. This event is in place to provide a method for communicating between the client and server, which is well documented in [this][1] article.

To fire from the server to the client, you should use RemoteFunction/InvokeClient and RemoteFunction/OnClientInvoke.

Parameters

Name	Type	Default	Description
Name player	Type Instance	Default	Summary The `Player` corresponding to the client where the `RemoteFunction/InvokeServer` function call originated from.
Name arguments	Type Tuple	Default	Summary Arguments passed to `RemoteFunction/InvokeServer` are passed to the function.

Expected return type:

Return Type	Summary
Return Type Tuple	Summary Values returned by the function are returned by `RemoteFunction/InvokeServer` (back to the client).

Code Samples

RemoteFunctions: Client to Server

When a client wants to use a remote function, it will invoke the server with the RemoteFunction/InvokeServer function within a LocalScript.

The server listens for this function to be invoked by binding a function to RemoteFunction/OnServerInvoke using the assignment operator =, and not with an event within a Script. When the server is invoked, it will execute the bound function.

			
				RemoteFunctions: Client to Server

				Expected Output
			
				Expand
				
			-- LocalScript
 
local ReplicatedStorage = game:GetService("ReplicatedStorage")
 
local createPartRequest = ReplicatedStorage:WaitForChild("CreatePartRequest")
 
local newPart = createPartRequest:InvokeServer()
print("The server created this part for me:", newPart)

-- ==================================================

-- Script
 
local ReplicatedStorage = game:GetService("ReplicatedStorage")
 
local createPartRequest = Instance.new("RemoteFunction")
createPartRequest.Parent = ReplicatedStorage
createPartRequest.Name = "CreatePartRequest"
 
local function onCreatePartRequested(player)
	print(player.Name, "wants to create a new part")
	local newPart = Instance.new("Part")
	newPart.Parent = game.Workspace
	return newPart
end
 
createPartRequest.OnServerInvoke = onCreatePartRequested
		
				Copy Code
			
				Light Theme

OnServerInvoke

Parameters

player

arguments

Expected return type:

Tuple

Code Samples

RemoteFunctions: Client to Server