From f7ddf0e87b25b14f3693d539a5296d39cb084b0f Mon Sep 17 00:00:00 2001 From: mindaugasa Date: Fri, 11 Oct 2024 18:00:25 +0200 Subject: [PATCH 1/5] add info about xs file read in multiplayer --- docs/general/xs/functions.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/general/xs/functions.json b/docs/general/xs/functions.json index 99f5ec0..d2ce569 100644 --- a/docs/general/xs/functions.json +++ b/docs/general/xs/functions.json @@ -1349,7 +1349,7 @@ "desc": "Default: `#!cpp true`. If set to `#!cpp false`, this will overwrite any existing file with the same name." } ], - "desc": "Creates a new (or appends to an existing) `.xsdat` file with the same name as the RMS/scenario being played. After invoking this function, the writing functions can be used to write data to the file. Returns `#!cpp true` if the file was successfully created" + "desc": "Creates a new (or appends to an existing) `.xsdat` file with the same name as the RMS/scenario being played. After invoking this function, the writing functions can be used to write data to the file. Returns `#!cpp true` if the file was successfully created. In multiplayer all players files are read, and if any of them contain different data that can cause desync errors." }, { "name": "xsOpenFile", From 68906a702ad09dc9531cfcbb9c98bdb6ddc10362 Mon Sep 17 00:00:00 2001 From: mindaugasa Date: Fri, 11 Oct 2024 18:03:00 +0200 Subject: [PATCH 2/5] fixed read and write --- docs/general/xs/functions.json | 4 ++-- docs/general/xs/functions.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/general/xs/functions.json b/docs/general/xs/functions.json index d2ce569..251e9e6 100644 --- a/docs/general/xs/functions.json +++ b/docs/general/xs/functions.json @@ -1349,7 +1349,7 @@ "desc": "Default: `#!cpp true`. If set to `#!cpp false`, this will overwrite any existing file with the same name." } ], - "desc": "Creates a new (or appends to an existing) `.xsdat` file with the same name as the RMS/scenario being played. After invoking this function, the writing functions can be used to write data to the file. Returns `#!cpp true` if the file was successfully created. In multiplayer all players files are read, and if any of them contain different data that can cause desync errors." + "desc": "Creates a new (or appends to an existing) `.xsdat` file with the same name as the RMS/scenario being played. After invoking this function, the writing functions can be used to write data to the file. Returns `#!cpp true` if the file was successfully created. In a multiplayer game file is created for each player, and subsequent writes will be duplicated to each player." }, { "name": "xsOpenFile", @@ -1362,7 +1362,7 @@ "desc": "The name of the file to open, without the `.xsdat` extension" } ], - "desc": "Opens an existing `.xsdat`file in read only mode. After invoking this function, the reading functions can be used to read data from the file. Returns `#!cpp true` if the file was successfully opened" + "desc": "Opens an existing `.xsdat`file in read only mode. After invoking this function, the reading functions can be used to read data from the file. Returns `#!cpp true` if the file was successfully opened. In a multiplayer game all players files are read, and if any of them contain different data that can cause desync errors." }, { "name": "xsWriteString", diff --git a/docs/general/xs/functions.md b/docs/general/xs/functions.md index 9d53a31..c15c610 100644 --- a/docs/general/xs/functions.md +++ b/docs/general/xs/functions.md @@ -1055,7 +1055,7 @@ Parameters: 1. (Optional) `#!cpp bool append`: Default: `#!cpp true`. If set to `#!cpp false`, this will overwrite any existing file with the same name. -Creates a new (or appends to an existing) `.xsdat` file with the same name as the RMS/scenario being played. After invoking this function, the writing functions can be used to write data to the file. Returns `#!cpp true` if the file was successfully created +Creates a new (or appends to an existing) `.xsdat` file with the same name as the RMS/scenario being played. After invoking this function, the writing functions can be used to write data to the file. Returns `#!cpp true` if the file was successfully created. In a multiplayer game file is created for each player, and subsequent writes will be duplicated to each player. ### 6.3. xsGetDataTypeSize @@ -1110,7 +1110,7 @@ Parameters: 1. `#!cpp string filename`: The name of the file to open, without the `.xsdat` extension -Opens an existing `.xsdat`file in read only mode. After invoking this function, the reading functions can be used to read data from the file. Returns `#!cpp true` if the file was successfully opened +Opens an existing `.xsdat`file in read only mode. After invoking this function, the reading functions can be used to read data from the file. Returns `#!cpp true` if the file was successfully opened. In a multiplayer game all players files are read, and if any of them contain different data that can cause desync errors. ### 6.8. xsReadFloat From 4d1e4c032a37e1b7c4e5b937bf43efc74e42e2d4 Mon Sep 17 00:00:00 2001 From: mindaugasa Date: Fri, 11 Oct 2024 19:00:26 +0200 Subject: [PATCH 3/5] a --- docs/general/xs/functions.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/general/xs/functions.json b/docs/general/xs/functions.json index 251e9e6..4a9a233 100644 --- a/docs/general/xs/functions.json +++ b/docs/general/xs/functions.json @@ -1349,7 +1349,7 @@ "desc": "Default: `#!cpp true`. If set to `#!cpp false`, this will overwrite any existing file with the same name." } ], - "desc": "Creates a new (or appends to an existing) `.xsdat` file with the same name as the RMS/scenario being played. After invoking this function, the writing functions can be used to write data to the file. Returns `#!cpp true` if the file was successfully created. In a multiplayer game file is created for each player, and subsequent writes will be duplicated to each player." + "desc": "Creates a new (or appends to an existing) `.xsdat` file with the same name as the RMS/scenario being played. After invoking this function, the writing functions can be used to write data to the file. Returns `#!cpp true` if the file was successfully created. In a multiplayer game a file is created for each player, and subsequent writes will be duplicated to each player." }, { "name": "xsOpenFile", From bb52c60409e6343e5b3b73fc69828c581aba15a8 Mon Sep 17 00:00:00 2001 From: mindaugasa Date: Sat, 2 Nov 2024 12:10:23 +0100 Subject: [PATCH 4/5] rewording --- .idea/misc.xml | 2 +- docs/general/xs/functions.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.idea/misc.xml b/.idea/misc.xml index 2274029..ac111d0 100644 --- a/.idea/misc.xml +++ b/.idea/misc.xml @@ -3,5 +3,5 @@ - + \ No newline at end of file diff --git a/docs/general/xs/functions.json b/docs/general/xs/functions.json index 4a9a233..24ff6d1 100644 --- a/docs/general/xs/functions.json +++ b/docs/general/xs/functions.json @@ -1362,7 +1362,7 @@ "desc": "The name of the file to open, without the `.xsdat` extension" } ], - "desc": "Opens an existing `.xsdat`file in read only mode. After invoking this function, the reading functions can be used to read data from the file. Returns `#!cpp true` if the file was successfully opened. In a multiplayer game all players files are read, and if any of them contain different data that can cause desync errors." + "desc": "Opens an existing `.xsdat`file in read only mode. After invoking this function, the reading functions can be used to read data from the file. Returns `#!cpp true` if the file was successfully opened. In a multiplayer game, the file being read must exist for all players and contain the same data to avoid an out of sync error" }, { "name": "xsWriteString", From cbe52a4952bed69b4baec6f02a8ee95e1a456505 Mon Sep 17 00:00:00 2001 From: mindaugasa Date: Sat, 2 Nov 2024 12:11:37 +0100 Subject: [PATCH 5/5] ran script --- docs/general/xs/functions.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/general/xs/functions.md b/docs/general/xs/functions.md index c15c610..b3813ed 100644 --- a/docs/general/xs/functions.md +++ b/docs/general/xs/functions.md @@ -1055,7 +1055,7 @@ Parameters: 1. (Optional) `#!cpp bool append`: Default: `#!cpp true`. If set to `#!cpp false`, this will overwrite any existing file with the same name. -Creates a new (or appends to an existing) `.xsdat` file with the same name as the RMS/scenario being played. After invoking this function, the writing functions can be used to write data to the file. Returns `#!cpp true` if the file was successfully created. In a multiplayer game file is created for each player, and subsequent writes will be duplicated to each player. +Creates a new (or appends to an existing) `.xsdat` file with the same name as the RMS/scenario being played. After invoking this function, the writing functions can be used to write data to the file. Returns `#!cpp true` if the file was successfully created. In a multiplayer game a file is created for each player, and subsequent writes will be duplicated to each player. ### 6.3. xsGetDataTypeSize @@ -1110,7 +1110,7 @@ Parameters: 1. `#!cpp string filename`: The name of the file to open, without the `.xsdat` extension -Opens an existing `.xsdat`file in read only mode. After invoking this function, the reading functions can be used to read data from the file. Returns `#!cpp true` if the file was successfully opened. In a multiplayer game all players files are read, and if any of them contain different data that can cause desync errors. +Opens an existing `.xsdat`file in read only mode. After invoking this function, the reading functions can be used to read data from the file. Returns `#!cpp true` if the file was successfully opened. In a multiplayer game, the file being read must exist for all players and contain the same data to avoid an out of sync error ### 6.8. xsReadFloat