ExecuteClientScript: Difference between revisions

ExecuteClientScript (view source)

199 bytes added , 2 July 2022

no edit summary

1,544

edits

@@ Line 5: / Line 5: @@
 == Usage ==
+Equivalent to [https://zdoom.org/wiki/ACS_ExecuteAlways ACS_ExecuteAlways], except that it only executes the ''script'' with the given arguments for one ''client''. This is an efficient way of executing <tt>CLIENTSIDE</tt> scripts that should only need to be run by one client, or at least not by everyone, thereby reducing network traffic. NamedExecuteClientScript works the same way but for named scripts. If run offline, the script will be executed on the local machine like normal.
-Equivalent to [https://zdoom.org/wiki/ACS_ExecuteAlways ACS_ExecuteAlways], except that it only executes the ''script'' with the given arguments for one ''client''. This is an efficient way of executing <tt>CLIENTSIDE</tt> scripts that should only need to be run by one client, or at least not by everyone, thereby reducing network traffic. NamedExecuteClientScript works the same way but for named scripts. If run offline, the script will be executed on the local machine like normal.
+=== Parameters ===
+* ''script'': The number or name of the script to excecute.
+* ''client'': The client to execute the script on.
+* ''arg0'' .. ''arg3'': The arguments to be passed to the script.
-== Return Value ==
+=== Return value ===
 Returns 1 if the script could be executed successfully, or 0 if wasn't. The function might explicitly fail because either the client tried running this command in a network game or because the script doesn't have the <tt>CLIENTSIDE</tt> flag.