Triggering events
Triggering local events
To trigger a server event from inside a server-side script, or trigger a client event from inside a client-side script, use the TriggerEvent() (or for JS, emit()) function.
Example
Lua
TriggerEvent("eventName", eventParam1, eventParam2)
C#
TriggerEvent("eventName", eventParam1, eventParam2);
JS
emit("eventName", eventParam1, eventParam2);
Triggering server events
There are currently two different ways to trigger a server event from inside a client script.
For smaller transactions the you should use TriggerServerEvent, while for larger transactions (which contain more data) TriggerLatentServerEvent would be more optimal.
Example
Lua
TriggerServerEvent("eventName", eventParam1, eventParam2)
C#
TriggerServerEvent("eventName", eventParam1, eventParam2);
JS
emitNet("eventName", eventParam1, eventParam2);
Triggering latent server events
Latent events should be used when needing to transfer a large amount of data from client -> server, as latent events do not block the entire network channel, unlike TriggerServerEvent.
Latent events take an extra paramater ‘bps’ which stands for ‘bytes per second’, this defines how fast it should send data to the server.
Lua
TriggerLatentServerEvent("eventName", bps, eventParam1, eventParam2)
C#
TriggerLatentServerEvent("eventName", bps, eventParam1, eventParam2);
JS
TriggerLatentServerEvent("eventName", bps, eventParam1, eventParam2);
Triggering client events
The same is applicable for triggering client events.
Client events use TriggerClientEvent and TriggerLatentClientEvent respectively, unlike server events you have to specify which users you want to send them to, or -1 for all connected users.
Lua
-- Use -1 for "targetPlayer" if you want the event to trigger on all connected clients.
TriggerClientEvent("eventName", targetPlayer, eventParam1, eventParam2)
C#
// Method one. Trigger an event directly on a client source.
player.TriggerEvent("eventName", eventParam1, eventParam2);
// Method two. Trigger an event for everyone on the server.
// Note you do not need to specify a target of -1 for C#.
TriggerClientEvent("eventName", eventParam1, eventParam2);
// Method three. Again, triggering an event directly on a client source (like method one),
// but using the TriggerClientEvent native function instead.
TriggerClientEvent(player, "eventName", eventParam1, eventParam2);
JS
// Use -1 for "targetPlayer" if you want the event to trigger on all connected clients.
emitNet("eventName", targetPlayer, eventParam1, eventParam2);
Triggering latent client events
Latent events should be used when needing to transfer a large amount of data from server -> client, as latent events do not block the clients entire network channel, unlike TriggerClientEvent.
This is important for timeout functionality, as sending a large amount of data blocks the network for the client, and if blocked for too long, will result in the client timing out.
Latent events take an extra paramater ‘bps’ which stands for ‘bytes per second’, this defines how fast it should send data to the client.
Lua
-- Use -1 for "targetPlayer" if you want the event to trigger on all connected clients.
TriggerLatentClientEvent("eventName", targetPlayer, bps, eventParam1, eventParam2)
C#
// Method one. Trigger an event directly on a client source.
player.TriggerLatentEvent("eventName", bps, eventParam1, eventParam2);
// Method two. Trigger an event for everyone on the server.
TriggerLatentClientEvent("eventName", bps, eventParam1, eventParam2); // Note you do not need to specify a target of -1.
// Method three. Again, triggering an event directly on a client source (like method one),
// but using the TriggerLatentClientEvent function instead.
TriggerLatentClientEvent(player, "eventName", bps, eventParam1, eventParam2);
JS
// Use -1 for "targetPlayer" if you want the event to trigger on all connected clients.
TriggerLatentClientEvent("eventName", targetPlayer, bps, eventParam1, eventParam2);