OnClientConnectionRequest: Difference between revisions
From Onset Developer Wiki
Created page with "{{Info|Event|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|OnClientConnectionRequest}} {{FuncParameters}} == Example == __EDIT_ME__ {{RelatedFunctions}} {{Serv..." |
No edit summary |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{Info|Event|Server|1.0}} | {{Info|Event|Server|1.0}} | ||
{{FuncDescription| | {{FuncDescription|Early callback of when a client tries to connect to the server. Client is not fully authorized by the server in this state. You can return '''false''' in this event to disconnect the client immediately.}} | ||
{{FuncSyntax|OnClientConnectionRequest}} | {{FuncSyntax|OnClientConnectionRequest(ip, port)}} | ||
{{FuncParameters}} | {{FuncParameters}} | ||
{{FuncParam|ip|IP address of the client connecting.}} | |||
{{FuncParam|port|Port of the client connecting. This is not the server port.}} | |||
== Example == | == Example == | ||
<syntaxhighlight lang="Lua> | |||
AddEvent("OnClientConnectionRequest", function(ip, port) | |||
-- you can check for blacklisted IP and return false to stop them! | |||
end) | |||
</syntaxhighlight> | |||
{{RelatedFunctions}} | {{RelatedFunctions}} | ||
*[[OnClientConnectionRequest]] | |||
*[[OnPlayerServerAuth]] | |||
*[[OnPlayerJoin]] |
Latest revision as of 11:29, 1 September 2020
Description
Early callback of when a client tries to connect to the server. Client is not fully authorized by the server in this state. You can return false in this event to disconnect the client immediately.
Syntax
OnClientConnectionRequest(ip, port)
Parameters
- ip
IP address of the client connecting. - port
Port of the client connecting. This is not the server port.
Example
AddEvent("OnClientConnectionRequest", function(ip, port)
-- you can check for blacklisted IP and return false to stop them!
end)