TriggerLatentServerEvent
Jump to navigation
Jump to search
This function is the same as triggerServerEvent except the transmission rate of the data contained in the arguments can be limited and other network traffic is not blocked while the data is being transferred.
Syntax
bool triggerLatentServerEvent ( string event, [int bandwidth=5000, bool persist=false,] element theElement, [arguments...] )
Required Arguments
- event: The name of the event to trigger server-side. You should register this event with addEvent and add at least one event handler using addEventHandler.
- theElement: The element that is the source of the event. This could be another player, or if this isn't relevant, use the root element.
Optional Arguments
- bandwidth: The bytes per second rate to send the data contained in the arguments.
- persist: A bool indicating whether the transmission should be allowed to continue even after the resource that triggered it has since stopped.
- arguments...: A list of arguments to trigger with the event. You can pass any Lua data type (except functions). You can also pass elements. The total amount of data should not exceed 100MB.
Returns
Returns true if the event trigger has been sent, false if invalid arguments were specified.
Example
Click to collapse [-]
Clientif fileExists("text.txt") file = fileOpen("test.txt") --Open a file (you can create it yourself). local data = fileRead(file,100*1024*1024) --Max 100 MB fileClose(file) --Close File triggerLatentServerEvent("onReadFile",5000,false,root,data) --trigger end
Click to collapse [-]
ServeraddEvent("onReadFile",true) addEventHandler("onReadFile",root,function(data) local file = fileCreate("text.txt") --Save "data" into "text.txt" fileWrite(file,data) fileClose(file) end)
Requirements
Minimum server version | n/a |
---|---|
Minimum client version | 1.3.0-9.03772 |
Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.3.0-9.03772" />
See Also
- triggerLatentServerEvent
- triggerServerEvent
- Shared
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled