Skip to content

Commit

Permalink
Merge pull request #11 from mardaravicius/add-info-about-xs-file-read…
Browse files Browse the repository at this point in the history
…-in-mp

Add info about xs file read/write in mp
  • Loading branch information
Divy1211 authored Nov 2, 2024
2 parents 2b18fe3 + cbe52a4 commit c2fdf0b
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .idea/misc.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/general/xs/functions.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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",
Expand Down
4 changes: 2 additions & 2 deletions docs/general/xs/functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down

0 comments on commit c2fdf0b

Please sign in to comment.