RemoteEvent

Show deprecated

A RemoteEvent is designed to provide a one-way message between the server and clients, allowing Script|Scripts to call code in LocalScript|LocalScripts and vice-versa. This message can be directed from one client to the server, from the server to a particular client, or from the server to all clients.

In order for both the server and clients to utilize a remote event, the RemoteEvent object itself must be in a place where both sides can see it. As such, we recommend that you store the RemoteEvent inside of ReplicatedStorage, although in some cases it’s appropriate to store it in the workspace or inside a Tool.

If you need the result of the call, you should use a RemoteFunction instead. Otherwise a remote event is recommended since it will minimize network traffic/latency and won't yield the script to wait for a response. See Articles/Remote Functions and Events|Remote Functions and Events for more info.

Properties

Inherited from Instance: Show Hide





	


bool


                    
                      Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.





	


string


                    
                      ClassName


                       
                          [ReadOnly]


                       
                          [NotReplicated]

A read-only string representing the class this Instance belongs to

int


                    
                      DataCost


                       
                          [Hidden]


                       
                          [ReadOnly]


                       
                          [NotReplicated]


                       
                         [Deprecated]

The cost of saving the instance using data persistence.





	


string


                    
                      Name

A non-unique identifier of the Instance





	
		
	


Instance


                    
                      Parent


                       
                          [NotReplicated]

Determines the hierarchical parent of the Instance





	


bool


                    
                      RobloxLocked


                       
                          [Hidden]

A deprecated property that used to protect CoreGui objects





	


int64


                    
                      SourceAssetId


                       
                          [Hidden]


                       
                          [NotReplicated]





	


bool


                    
                      archivable


                       
                          [Hidden]


                       
                          [NotReplicated]


                       
                         [Deprecated]





	


string


                    
                      className


                       
                          [ReadOnly]


                       
                          [NotReplicated]


                       
                         [Deprecated]

Functions






void


                      
                        FireAllClients
                        
                          (
                          
                            
                              
                              
                              




Tuple

                              arguments
                            
                            
                          
                          )

Fires the RemoteEvent/OnClientEvent event for each client.






void

Fires RemoteEvent/OnClientEvent for the specified player.






void

Fires the RemoteEvent/OnServerEvent event on the server using the arguments specified with an additional player argument at the beginning.

Inherited from Instance: Show Hide






void


                        
                          ClearAllChildren
                          
                            (
                            
                            )

This function destroys all of an Instance’s children.






Instance

Create a copy of an object and all its descendants, ignoring objects that are not Instance/Archivable|Archivable






void

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections, and calls Destroy on all children.






Instance


                        
                          FindFirstAncestor
                          
                            (
                            
                              
                                
                                
                                




string

                                name
                              
                              
                            
                            )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.






Instance


                        
                          FindFirstAncestorOfClass
                          
                            (
                            
                              
                                
                                
                                




string

                                className
                              
                              
                            
                            )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.






Instance


                        
                          FindFirstAncestorWhichIsA
                          
                            (
                            
                              
                                
                                
                                




string

                                className
                              
                              
                            
                            )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.






Instance


                        
                          FindFirstChild
                          
                            (
                            
                              
                                
                                
                                




string

                                name
                              
                              
                                ,
                              
                            
                              
                                
                                
                                




bool

                                recursive
                              
                              
                            
                            )

Returns the first child of the Instance found with the given name.






Instance


                        
                          FindFirstChildOfClass
                          
                            (
                            
                              
                                
                                
                                




string

                                className
                              
                              
                            
                            )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.






Instance


                        
                          FindFirstChildWhichIsA
                          
                            (
                            
                              
                                
                                
                                




string

                                className
                              
                              
                                ,
                              
                            
                              
                                
                                
                                




bool

                                recursive
                              
                              
                            
                            )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.






Instance


                        
                          FindFirstDescendant
                          
                            (
                            
                              
                                
                                
                                




string

                                name
                              
                              
                            
                            )

Returns the first descendant found with the given Instance/Name.






Actor

Returns the Actor associated with the Instance, usually the first Actor ancestor






Variant


                        
                          GetAttribute
                          
                            (
                            
                              
                                
                                
                                




string

                                attribute
                              
                              
                            
                            )

Returns the attribute which has been assigned to the given name






RBXScriptSignal


                        
                          GetAttributeChangedSignal
                          
                            (
                            
                              
                                
                                
                                




string

                                attribute
                              
                              
                            
                            )

Returns an event that fires when the given attribute changes






Dictionary


                        
                          GetAttributes
                          
                            (
                            
                            )

Returns a dictionary of string → variant pairs for each of the Instance|Instance’s attributes






Objects


                        
                          GetChildren
                          
                            (
                            
                            )

Returns an array containing all of the Instance’s children.






string


                        
                          GetDebugId
                          
                            (
                            
                              
                                
                                
                                




int

                                scopeLength
                              
                              
                            
                            )


                            
                              [NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.






Array


                        
                          GetDescendants
                          
                            (
                            
                            )


                            
                              [CustomLuaState]

Returns an array containing all of the descendants of the instance






string


                        
                          GetFullName
                          
                            (
                            
                            )

Returns a string describing the Instance’s ancestry.






RBXScriptSignal


                        
                          GetPropertyChangedSignal
                          
                            (
                            
                              
                                
                                
                                




string

                                property
                              
                              
                            
                            )

Get an event that fires when a given property of an object changes.






bool


                            
                              [CustomLuaState]

Returns true if an Instance’s class matches or inherits from a given class






bool


                        
                          IsAncestorOf
                          
                            (
                            
                              
                                
                                
                                




Instance

                                descendant
                              
                              
                            
                            )

Returns true if an Instance is an ancestor of the given descendant.






bool


                        
                          IsDescendantOf
                          
                            (
                            
                              
                                
                                
                                




Instance

                                ancestor
                              
                              
                            
                            )

Returns true if an Instance is a descendant of the given ancestor.






void


                            
                               [Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.






void


                        
                          SetAttribute
                          
                            (
                            
                              
                                
                                
                                




string

                                attribute
                              
                              
                                ,
                              
                            
                              
                                
                                
                                




Variant

                                value
                              
                              
                            
                            )

Sets the attribute with the given name to the given value






Instance


                        
                          WaitForChild
                          
                            (
                            
                              
                                
                                
                                




string

                                childName
                              
                              
                                ,
                              
                            
                              
                                
                                
                                




double

                                timeOut
                              
                              
                            
                            )


                            
                              [CustomLuaState]


                            
                              [CanYield]

Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.






Objects


                            
                               [Deprecated]

Returns an array of the object’s children.






Instance


                            
                               [Deprecated]






void


                            
                               [Deprecated]






Instance


                        
                          findFirstChild
                          
                            (
                            
                              
                                
                                
                                




string

                                name
                              
                              
                                ,
                              
                            
                              
                                
                                
                                




bool

                                recursive
                              
                              
                            
                            )


                            
                               [Deprecated]






Objects


                        
                          getChildren
                          
                            (
                            
                            )


                            
                               [Deprecated]






bool


                            
                               [Deprecated]


                            
                              [CustomLuaState]






bool


                        
                          isDescendantOf
                          
                            (
                            
                              
                                
                                
                                




Instance

                                ancestor
                              
                              
                            
                            )


                            
                               [Deprecated]






void


                            
                               [Deprecated]

Events






RBXScriptSignal


                      
                        OnClientEvent
                        
                          (
                          
                            
                              
                              
                              




Tuple

                              arguments
                            
                            
                          
                          )

Fires listening functions in LocalScript when either RemoteEvent/FireClient or RemoteEvent/FireAllClients is called from a Script.






RBXScriptSignal


                      
                        OnServerEvent
                        
                          (
                          
                            
                              
                              
                              




Player

                              player
                            
                            
                              ,
                            
                          
                            
                              
                              
                              




Tuple

                              arguments
                            
                            
                          
                          )

Fires listening functions in Script when RemoteEvent/FireServer is called from a LocalScript.

Inherited from Instance: Show Hide






RBXScriptSignal


                        
                          AncestryChanged
                          
                          (
                            
                              
                                
                                
                                




Instance

                                child
                              
                              
                                ,
                              
                            
                              
                                
                                
                                




Instance

                                parent
                              
                              
                            
                          )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.






RBXScriptSignal


                        
                          AttributeChanged
                          
                          (
                            
                              
                                
                                
                                




string

                                attribute
                              
                              
                            
                          )

Fires whenever an attribute is changed on the Instance






RBXScriptSignal

Fired immediately after a property of an object changes.






RBXScriptSignal

Fires after an object is parented to this Instance.






RBXScriptSignal


                        
                          ChildRemoved
                          
                          (
                            
                              
                                
                                
                                




Instance

                                child
                              
                              
                            
                          )

Fires after a child is removed from this Instance.






RBXScriptSignal


                        
                          DescendantAdded
                          
                          (
                            
                              
                                
                                
                                




Instance

                                descendant
                              
                              
                            
                          )

Fires after a descendant is added to the Instance






RBXScriptSignal


                        
                          DescendantRemoving
                          
                          (
                            
                              
                                
                                
                                




Instance

                                descendant
                              
                              
                            
                          )

Fires immediately before a descendant of the Instance is removed.






RBXScriptSignal

Fires immediately before the instance is destroyed via Instance/Destroy.






RBXScriptSignal


                        
                           [Deprecated]

Code Samples

RemoteEvents: Server to a Single Client

The server can send messages to the client through remote events in two ways: it can send a message to an individual client or it can send a message to every client at the same time.

In order to send a message to a single client, the FireClient function should be called from the server via a Script.

To listen for the message on the client, a LocalScript needs to connect a function to the OnClientEvent event of the RemoteEvent.

			
				RemoteEvents: Server to a Single Client

				Expected Output
			
				Expand
				
			-- Script

local Players = game:GetService("Players")
 
local welcomePlayerEvent = Instance.new("RemoteEvent")
welcomePlayerEvent.Parent = game.ReplicatedStorage
welcomePlayerEvent.Name = "WelcomePlayerEvent"
 
local function onPlayerAdded(player)
	welcomePlayerEvent:FireClient(player)
end
 
Players.PlayerAdded:Connect(onPlayerAdded)

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

--LocalScript 

local Players = game:GetService("Players")
local ReplicatedStorage = game:GetService("ReplicatedStorage")
 
local player = Players.LocalPlayer
local welcomePlayerEvent = ReplicatedStorage:WaitForChild("WelcomePlayerEvent")
local playerGui = player:WaitForChild("PlayerGui")
 
local welcomeScreen = Instance.new("ScreenGui")
welcomeScreen.Parent = playerGui
local welcomeMessage = Instance.new("TextLabel")
welcomeMessage.Size = UDim2.new(0, 200, 0, 50)
welcomeMessage.Parent = welcomeScreen
welcomeMessage.Visible = false
welcomeMessage.Text = "Welcome to the game!"
 
local function onWelcomePlayerFired()
	welcomeMessage.Visible = true
	wait(3)
	welcomeMessage.Visible = false
end
 
welcomePlayerEvent.OnClientEvent:Connect(onWelcomePlayerFired)
		
				Copy Code
			
				Light Theme

RemoteEvents: Client to Server

In order for a client to send a message to the server, it needs to fire the RemoteEvent with the function RemoteEvent/FireServer in a LocalScript.

The server meanwhile needs to connect a function to the OnServerEvent of the RemoteEvent.

When a client calls the FireServer function, any functions on the server that are connected to OnServerEvent will fire. Note that this is not immediate - the network connection between the client and server will determine how quickly this happens.

When firing a RemoteEvent from a client to the server, data can be included in the firing. By default, the functions connected to OnServerEvent will be passed the player who fired the event as the first parameter. If any other arguments are provided in the FireServer function, they will also be included in OnServerEvent after the player argument.

			
				RemoteEvents: Client to Server

				Expected Output
			
				Expand
				
			-- LocalScript
 
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local createPartEvent = ReplicatedStorage:WaitForChild("CreatePartEvent")
 
createPartEvent:FireServer(BrickColor.Green(), Vector3.new(10, 20, 0))

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

-- Script
 
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local createPartEvent = Instance.new("RemoteEvent", ReplicatedStorage)
createPartEvent.Name = "CreatePartEvent"
 
local function onCreatePartFired(player, color, position)
	print(player.Name, "wants to create a part")
	local newPart = Instance.new("Part")
	newPart.BrickColor = color
	newPart.Position = position
	newPart.Parent = game.Workspace
end
 
createPartEvent.OnServerEvent:Connect(onCreatePartFired)
		
				Copy Code
			
				Light Theme

RemoteEvents: Server to Multiple Clients

The server can send messages to the client through remote events in two ways: it can send a message to an individual client or it can send a message to every client at the same time.

To fire a message to all clients, the server needs to call RemoteEvent/FireAllClients. Note that in this case a player does not have to be passed into the arguments (as the function fires the remote event on all of the connected clients).

To listen for this event, each client needs to connect a function to OnClientEvent.

			
				RemoteEvents: Server to Multiple Clients

				Expected Output
			
				Expand
				
			-- Script

local Players = game:GetService("Players")
 
local newPlayerEvent = Instance.new("RemoteEvent")
newPlayerEvent.Parent = game.ReplicatedStorage
newPlayerEvent.Name = "NewPlayer"
 
local function onPlayerAdded(player)
	newPlayerEvent:FireAllClients()
end
 
Players.PlayerAdded:Connect(onPlayerAdded)

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

--LocalScript (for each client)

local Players = game:GetService("Players")
local ReplicatedStorage = game:GetService("ReplicatedStorage")
 
local player = Players.LocalPlayer
local newPlayerEvent = ReplicatedStorage:WaitForChild("NewPlayerEvent")
local playerGui = player:WaitForChild("PlayerGui")
 
local welcomeScreen = Instance.new("ScreenGui")
welcomeScreen.Parent = playerGui
local newPlayerMessage = Instance.new("TextLabel")
newPlayerMessage.Size = UDim2.new(0, 200, 0, 50)
newPlayerMessage.Parent = welcomeScreen
newPlayerMessage.Visible = false
newPlayerMessage.Text = "A new player has joined the game!"
 
local function onNewPlayerFired()
	newPlayerMessage.Visible = true
	wait(3)
	newPlayerMessage.Visible = false
end
 
newPlayerEvent.OnClientEvent:Connect(onNewPlayerFired)
		
				Copy Code
			
				Light Theme

PlayerScripts RemoteFunction

RemoteEvent

RemoteEvent

Properties

Functions

FireAllClients ( Tuple arguments )

FireClient ( Player player , Tuple arguments )

FireServer ( Tuple arguments )

ClearAllChildren ( )

Clone ( )

Destroy ( )

FindFirstAncestor ( string name )

FindFirstAncestorOfClass ( string className )

FindFirstAncestorWhichIsA ( string className )

FindFirstChild ( string name , bool recursive )

FindFirstChildOfClass ( string className )

FindFirstChildWhichIsA ( string className , bool recursive )

FindFirstDescendant ( string name )

GetActor ( )

GetAttribute ( string attribute )

GetAttributeChangedSignal ( string attribute )

GetAttributes ( )

GetChildren ( )

GetDebugId ( int scopeLength )

GetDescendants ( )

GetFullName ( )

GetPropertyChangedSignal ( string property )

IsA ( string className )

IsAncestorOf ( Instance descendant )

IsDescendantOf ( Instance ancestor )

Remove ( )

SetAttribute ( string attribute , Variant value )

WaitForChild ( string childName , double timeOut )

children ( )

clone ( )

destroy ( )

findFirstChild ( string name , bool recursive )

getChildren ( )

isA ( string className )

isDescendantOf ( Instance ancestor )

remove ( )

Events

OnClientEvent ( Tuple arguments )

OnServerEvent ( Player player , Tuple arguments )

AncestryChanged ( Instance child , Instance parent )

AttributeChanged ( string attribute )

Changed ( string property )

ChildAdded ( Instance child )

ChildRemoved ( Instance child )

DescendantAdded ( Instance descendant )

DescendantRemoving ( Instance descendant )

Destroying ( )

childAdded ( Instance child )

Code Samples

RemoteEvents: Server to a Single Client

RemoteEvents: Client to Server

RemoteEvents: Server to Multiple Clients

FireAllClients ( `Tuple` arguments )

FireClient ( `Player` player , `Tuple` arguments )

FireServer ( `Tuple` arguments )

FindFirstAncestor ( `string` name )

FindFirstAncestorOfClass ( `string` className )

FindFirstAncestorWhichIsA ( `string` className )

FindFirstChild ( `string` name , `bool` recursive )

FindFirstChildOfClass ( `string` className )

FindFirstChildWhichIsA ( `string` className , `bool` recursive )

FindFirstDescendant ( `string` name )

GetAttribute ( `string` attribute )

GetAttributeChangedSignal ( `string` attribute )

GetDebugId ( `int` scopeLength )

GetPropertyChangedSignal ( `string` property )

IsA ( `string` className )

IsAncestorOf ( `Instance` descendant )

IsDescendantOf ( `Instance` ancestor )

SetAttribute ( `string` attribute , `Variant` value )

WaitForChild ( `string` childName , `double` timeOut )

findFirstChild ( `string` name , `bool` recursive )

isA ( `string` className )

isDescendantOf ( `Instance` ancestor )

OnClientEvent ( `Tuple` arguments )

OnServerEvent ( `Player` player , `Tuple` arguments )

AncestryChanged ( `Instance` child , `Instance` parent )

AttributeChanged ( `string` attribute )

Changed ( `string` property )

ChildAdded ( `Instance` child )

ChildRemoved ( `Instance` child )

DescendantAdded ( `Instance` descendant )

DescendantRemoving ( `Instance` descendant )

childAdded ( `Instance` child )