Emit Client
A module to optimize your trigger events server <> client.
Configuration Variables (Convars)
| Convar | Side | Type | Default | Description |
|---|---|---|---|---|
jo_libs:emit:bps | Client | Integer | 20000 | Default bit/s for latent events |
JO Functions
jo.emit.isEventInProgress()
A function to check if an event is currently getting data with emit module
Syntax
lua
jo.emit.isEventInProgress(eventName)Parameters
eventName : string
Example
lua
print(jo.emit.isEventInProgress('YourEventName'))
-- Expected outfit : `true` if the event is not fully received yet.jo.emit.triggerClient()
A function to trigger client(s)
Syntax
lua
jo.emit.triggerClient(eventName, source, ...)Parameters
eventName : string
The event name
source : integer|table
The player ID or list of players ID
... : any
Other arguments
jo.emit.triggerServer()
A function to trigger the server
Syntax
lua
jo.emit.triggerServer(eventName, ...)Parameters
eventName : string
The event name
... : any
Other arguments
Example
lua
local data = "MyData"
jo.emit.triggerServer('YourEventName', data)jo.emit.triggerServer.latent()
A function to trigger the server with limited bandwith
Syntax
lua
jo.emit.triggerServer.latent(eventName, ...)Parameters
eventName : string
The event name
... : any
Other arguments
Example
lua
local data = {}
for i = 1, 100000 do
data[i] = i
end
jo.emit.triggerServer.latent("YourEventName", data)jo.emit.updateBps()
A function to update the bit/s of emit module
The default bitrate is 20.000 bit/s
Syntax
lua
jo.emit.updateBps(bps)Parameters
bps : integer
bit/s
Example
lua
jo.emit.updateBps(3000)