NetworkEvent
Inherits from Instance
NetworkEvents are events that can be called to communicate between server and client. NetMessages are the class used for sharing data between server and client when sending NetworkEvents.
Summary
Methods
InvokeServer:voidInvokeClients:voidInvokeClient:void
Events
InvokedClient:voidInvokedServer:void
Methods
InvokeServer
NetworkEvent:InvokeServer(message: NetMessage)
Parameters:
| Parameter | Type | Default | Description |
|---|---|---|---|
message | NetMessage | - |
Sends a network event to the server from the client.
Example
-- netEvent defined somewhere else in the code
local message = NetMessage.New()
message.AddString("key", "value")
netEvent.InvokeServer(message)
InvokeClients
NetworkEvent:InvokeClients(message: NetMessage)
Parameters:
| Parameter | Type | Default | Description |
|---|---|---|---|
message | NetMessage | - |
Sends a network event to all players from the server.
Example
local message = NetMessage.New()
message.AddString("key", "value")
netEvent.InvokeClients(message)
InvokeClient
NetworkEvent:InvokeClient(message: NetMessage, player: Player)
Parameters:
| Parameter | Type | Default | Description |
|---|---|---|---|
message | NetMessage | - | |
player | Player | - |
Sends a network event to a specific player from the server.
Example
local message = NetMessage.New()
message.AddString("key", "value")
netEvent.InvokeClient(message, game["Players"]["willemsteller"])
Events
InvokedClient
NetworkEvent.InvokedClient(sender: nil, netmsg: NetMessage)
Parameters:
| Parameter | Type | Default | Description |
|---|---|---|---|
sender | nil | - | |
netmsg | NetMessage | - |
Fires when the client receives a message from the server.
Example
netEvent.InvokedClient:Connect(function (sender, message)
local value = message:GetString("key")
end)
InvokedServer
NetworkEvent.InvokedServer(sender: Player, netmsg: NetMessage)
Parameters:
| Parameter | Type | Default | Description |
|---|---|---|---|
sender | Player | - | |
netmsg | NetMessage | - |
Fires when the server receives a message from the client.
Example
netEvent.InvokedServer:Connect(function (sender, message)
local value = message:GetString("key")
end)