ACSUtils Wiki

An ACS library for ZDoom-based ports

User Tools

Site Tools

Trace:
functions:sendstring

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
Last revisionBoth sides next revision
functions:sendstring [2016/10/18 20:47] – created korshunfunctions:sendstring [2016/10/19 00:24] – korshun
Line 1: Line 1:
 ====== Sending strings from server to client ====== ====== Sending strings from server to client ======
 +
 +===== Sending strings =====
 +''ACS_SendString(int scriptnum, str s)''
 +
 +''ACS_NamedSendString(str scriptname, str s)''
 +
 +These functions will launch the specified clientside script and send the string to it. For example:
 +
 +<code>
 +ACS_SendString(123, "Hello there");
 +ACS_NamedSendString("myscript", "A test string");
 +</code>
 +
 +Maximum string size is unlimited, but the larger it is, the more the server will lag while sending it.
 +
 +<note warning>These functions may **not** be used to launch **serverside** scripts, unless in singleplayer. Doing so will result in a [[.error|ProgramError]]. 
 +
 +Test your mods on a server (this is recommended for many other reasons too).</note>
 +<note important>If multiple SendStrings are done in a row, the scripts may be launched either in order or **in reverse order**. Whether one order or the other will be used is unspecified.</note>
 +<note important>Zandronum 2.1.2 doesn't support named scripts at all.</note>
 +===== Receiving strings =====
 +
 +To receive a string, the receiving script must be like this:
 +
 +<code>
 +script 123 (int a, int b, int c, int d) CLIENTSIDE
 +{
 + if (!ReceiveString(a, b, c, d))
 + terminate;
 +
 +        // Insert your code here. The string can now be retrieved using GetReceivedString().
 + Log(s:"Received string: ", s:GetReceivedString());
 +}
 +</code>
 +
 +Use ''GetReceivedString()'' to retrieve the string that has just been received.
 +
  
  
  

Page Tools

Flag Counter