SendServerData: Difference between revisions

Latest revision as of 05:39, 3 February 2023

This function was added in v1.6 beta and will not work on previous versions.

Description:
This will send data( results in calling onClientScriptData of squirrel-server )

Parameters:

(data)

data: A blob which is written with one or more of WriteByte, WriteInt, WriteFloat and WriteString.

Return Values:
true on success, false on failure( instead of blob, some other instance of a class is passed )

Example

local b=blob();
WriteInt(b, 1000);
WriteByte(b, 100);
WriteFloat(b, 356.456);
WriteString(b, "Hello");
SendServerData(b);

The following functions may be helpful as they relate to this function in one way or another.

@@ Line 5: / Line 5: @@
 desc=This will send data( results in calling onClientScriptData of squirrel-server )|
 params=<syntaxhighlight lang="lua">(data)</syntaxhighlight>
-<poem>::data: The blob which needs to be formatted as below.</poem>|
+<poem>::data: A blob which is written with one or more of [[WriteByte]], [[WriteInt]], [[WriteFloat]] and [[WriteString]].
+</poem>|
 example=
-<poem>Input npcscript</poem>
 <source lang="lua">
 local b=blob();
+WriteInt(b, 1000);
-b.writen( swap4(16), 'i' );
+WriteByte(b, 100);
+WriteFloat(b, 356.456);
-b.writen( 1234, 'i' );
+WriteString(b, "Hello");
-b.writen( 10, 'b' ); //b - byte
-b.writen( swap2(5), 'w' ); //w - word
-b.writen('h','c');  //c - signed char
-b.writen('e','c');
-b.writen('l','c');
-b.writen('l','c');
-b.writen('o','c');
-b.writen(100.789, 'f'); //f float
 SendServerData(b);
-</source>
+</source>|
-<poem>Output from server</poem>
+retvals=true on success, false on failure( instead of blob, some other instance of a class is passed )|
-<source lang="lua">
+relfuncs=*[[onServerData]]
-function onClientScriptData(p){
-print(Stream.ReadInt());print(Stream.ReadByte());
-print(Stream.ReadString());print(Stream.ReadFloat());
-}
-[SCRIPT]  1234
-[SCRIPT]  10
-[SCRIPT]  hello
-[SCRIPT]  100.789</source>|
-relfuncs=*[[SendCommand]]
 }}