addNetworkHandler: Difference between revisions

← Older edit

addNetworkHandler (view source)

Revision as of 20:36, 19 November 2022

157 bytes removed , 19 November 2022

no edit summary

Mex

6,833

edits

@@ Line 1: / Line 1: @@
-{{ScriptItem
+{{ScriptItem2
+|name = addNetworkHandler
+|side = shared
+|type = function
+|games = iii vc sa iv
+|desc = add a handler for a custom network event that can be triggered via a server or client script.
+|arg1 = string networkEventName The name of the network event, case-insensitive.
+|arg2 = function handler The scripting function to call when the network event occurs.
+|return = void
+|freturn = void
+|note = Use [[triggerNetworkEvent|triggerNetworkEvent]] call a custom network event. Clients can only trigger server-side handlers, while the server can trigger a handler on either end.
 |offline = false
-|endpoint = shared
+|cb2arg1SS = Client client The client that triggered the network event.
-|type = function
+|cb2arg2SS = ... vararg The arguments that were triggered with the network event.
-|name = addNetworkHandler
+|cb2arg1CS = ... vararg The arguments that were triggered with the network event.
-|parameters = string networkEventName, function handler
-|parameter1 = string networkEventName The name of the network event, case-insensitive.
-|parameter2 = function handler The scripting function to call when the network event occurs.
-|callback2SyntaxSS = Client client, ...
-|callback2ParameterSS1 = Client client The client that triggered the network event.
-|callback2ParameterSS2 = ... vararg The arguments that were triggered with the network event.
-|callback2SyntaxCS = ...
-|callback2ParameterCS1 = ... vararg The arguments that were triggered with the network event.
-|return1 = void
-|returnFail1 = void
-|usage = add a handler for a custom network event that can be triggered via a server or client script.
-|notes = Use [[triggerNetworkEvent|triggerNetworkEvent]] call a custom network event. Clients can only trigger server-side handlers, while the server can trigger a handler on either end.
 |exampleJSCS = addNetworkHandler("walkToPos", function(civilian, x, y) {
      let walkToPos = new Vec2(x, y);