Merge docs for 'added list_files, fixes #589'
This commit is contained in:
1 parent
6e5af5bfc8
commit
33bf24fa86
1 file changed
+14
-19
+14
-19
@@ -4571,13 +4571,15 @@ Available output types:
|
|||||||
### `read_file(resource, type)`
|
### `read_file(resource, type)`
|
||||||
### `delete_file(resource, type)`
|
### `delete_file(resource, type)`
|
||||||
### `write_file(resource, type, data, ...)`
|
### `write_file(resource, type, data, ...)`
|
||||||
|
### `list_files(resource, type)`
|
||||||
|
|
||||||
With the specified `resource` in the scripts folder, of a specific `type`, writes/appends `data` to it, reads its
|
With the specified `resource` in the scripts folder, of a specific `type`, writes/appends `data` to it, reads its
|
||||||
content, or deletes the resource.
|
content, deletes the resource, or lists other files under this resource.
|
||||||
|
|
||||||
Resource is identified by a path to the file.
|
Resource is identified by a path to the file.
|
||||||
A path can contain letters, numbers, characters `-`, `+`, or `_`, and a folder separator: `'/'`. Any other characters are stripped
|
A path can contain letters, numbers, characters `-`, `+`, or `_`, and a folder separator: `'/'`. Any other characters are stripped
|
||||||
from the name. Empty descriptors are invalid. Do not add file extensions to the descriptor - extensions are inferred
|
from the name. Empty descriptors are invalid, except for `list_files` where it means the root folder.
|
||||||
|
Do not add file extensions to the descriptor - extensions are inferred
|
||||||
based on the `type` of the file.
|
based on the `type` of the file.
|
||||||
|
|
||||||
Resources can be located in the app specific space, or a shared space for all the apps. Accessing of app-specific
|
Resources can be located in the app specific space, or a shared space for all the apps. Accessing of app-specific
|
||||||
@@ -4592,33 +4594,26 @@ specific data directory is under `world/scripts/foo.data/...`, and shared data s
|
|||||||
|
|
||||||
The default no-name app, via `/script run` command can only save/load/read files from the shared space.
|
The default no-name app, via `/script run` command can only save/load/read files from the shared space.
|
||||||
|
|
||||||
Functions return `null` if an error is encounter or no file is present (for read and delete operations). Returns `true`
|
Functions return `null` if an error is encounter or no file is present (for read, list and delete operations). Returns `true`
|
||||||
for success writes and deletes, and requested data, based on the file type, for read operations.
|
for success writes and deletes, and requested data, based on the file type, for read operations. It returns list of files
|
||||||
|
for folder listing.
|
||||||
NBT files can be written once as they an store one tag at a time. Consecutive writes will overwrite previous data.
|
|
||||||
|
|
||||||
Write operations to text files always result in appending to the existing file, so consecutive writes will increase
|
|
||||||
the size of the file and add data to it. Since files are closed after each write, sending multiple lines of data to
|
|
||||||
write is beneficial for writing speed. To send multiple packs of data, either provide them flat or as a list in the
|
|
||||||
third argument.
|
|
||||||
* `write_file('temp', 'text', 'foo', 'bar', 'baz')` or
|
|
||||||
* write_file('temp', 'text', l('foo', 'bar', 'baz'))
|
|
||||||
|
|
||||||
To log a single line of string
|
Supported values for resource `type` are:
|
||||||
|
|
||||||
Supported values for resource `type` is:
|
|
||||||
* `nbt` - NBT tag
|
* `nbt` - NBT tag
|
||||||
* `text` - text resource with automatic newlines added
|
* `text` - text resource with automatic newlines added
|
||||||
* `raw` - text resource without implied newlines
|
* `raw` - text resource without implied newlines
|
||||||
* `shared_nbt`, `shared_text`, `shared_raw` - shared versions of the above
|
* `folder` - for `list_files` only - indicting folder listing instead of files
|
||||||
|
* `shared_nbt`, `shared_text`, `shared_raw`, `shared_folder` - shared versions of the above
|
||||||
|
|
||||||
NBT files have extension `.nbt`, store one NBT tag, and return a NBT type value. Text files have `.txt` extension,
|
NBT files have extension `.nbt`, store one NBT tag, and return a NBT type value. Text files have `.txt` extension,
|
||||||
stores multiple lines of text and returns lists of all lines from the file. With `write_file`, multiple lines can be
|
stores multiple lines of text and returns lists of all lines from the file. With `write_file`, multiple lines can be
|
||||||
sent to the file at once. The only difference between `raw` and `text` types are automatic newlines added after each
|
sent to the file at once. The only difference between `raw` and `text` types are automatic newlines added after each
|
||||||
record to the file.
|
record to the file. Since files are closed after each write, sending multiple lines of data to
|
||||||
|
write is beneficial for writing speed. To send multiple packs of data, either provide them flat or as a list in the
|
||||||
|
third argument.
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
write_file('foo', 'shared_text, l('one', 'two'));
|
write_file('foo', 'shared_text, ['one', 'two']);
|
||||||
write_file('foo', 'shared_text', 'three\n', 'four\n');
|
write_file('foo', 'shared_text', 'three\n', 'four\n');
|
||||||
write_file('foo', 'shared_raw', 'five\n', 'six\n');
|
write_file('foo', 'shared_raw', 'five\n', 'six\n');
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user