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 f1d1030..9643aaa 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 a multiplayer game a 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, the file being read must exist for all players and contain the same data to avoid an out of sync error" }, { "name": "xsWriteString", diff --git a/docs/general/xs/functions.md b/docs/general/xs/functions.md index 73c71d7..a70fea3 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 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 +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