Gamemode.CompletedIncomingStream
From GMod Wiki
| Event Hook | |
| Hook Name | CompletedIncomingStream |
| Syntax | GM:CompletedIncomingStream( Player pl , String handler, Number id, String rawdata, procdata ) |
| Description | Called when the client or server has completed receiving a stream. Use this to block unwanted data. Procdata can be a number of different types of data. pl is serverside only. |
| Returns | Nil |
| Lua State | 
|
| BBCode | [b][url=wiki.garrysmod.com/?title=Gamemode.CompletedIncomingStream]Gamemode.CompletedIncomingStream [img]http://wiki.garrysmod.com/favicon.ico[/img][/url][/b] |
Examples
| Description | Block any streams that contain certain keywords. |
|---|---|
| Used on |  |
| Code | function GM:CompletedIncomingStream( pl, handler, id, rawdata, procdata ) if string.find( rawdata, "exploit code" ) != nil then return false end return true end |
| Output | The stream is blocked if the raw data contains "exploit code" anywhere in it.. |
| Description | Check to see if a stream finished sending to the client. |
|---|---|
| Used on |  |
| Code | if SERVER then function SendStream() datastream.StreamToClients( player.GetAll(), "TestHook", { "TestString", 44 } ) end end if CLIENT then function CheckFinished( handler, id, rawdata, procdata ) if handler == "TestHook" then print( "Test Hook Stream Received" ) end end hook.Add( "CompletedIncomingStream", "CheckFinished", CheckFinished ) end |
| Output | Prints "Test Hook Stream Received" to console once the client receives the stream. Something will have to call the function on the server, of course. Make sure to remove the pl argument from the hook when using this on the client. |
Additional Notes
- Part of the datastream module.
- Returning false does nothing clientside.
- You should only use this for stream blocking if you need the data to block the stream. Otherwise use gamemode.AcceptStream
- This function really has no use clientside.
