diff --git a/docs/IO-API-for-Modules.md b/docs/IO-API-for-Modules.md index 0e37ad45985..1bb4d450df1 100644 --- a/docs/IO-API-for-Modules.md +++ b/docs/IO-API-for-Modules.md @@ -1,14 +1,14 @@ I/O API for Modules ================= -To protect the user's system, you cannot use `java.io.File` directly, however a bunch of modules may need access to files. Finally, this feature allow modules to have **limited** access to files. Basically, there are two file operations allowed, `readFile` and `writeFile`, both of them works under the `Terasology/sandbox` directory. Take a look on the instructions bellow to learn how to use them. +To protect the user's system, you cannot use `java.io.File` directly, however a bunch of modules may need access to files. Finally, this feature allow modules to have **limited** access to files. Basically, there are two file operations allowed, `readFile` and `writeFile`, both of them works under the `Terasology/sandbox` directory. This does not allow to create directories. Take a look on the instructions bellow to learn how to use them. 1. The first step is to import and initialize the sandbox file manager where you need it, for this you can do the following: ```java SandboxFileManager sandboxFileManager = new SandboxFileManager(); ``` 2. Second, create a consumer. We have two different types of consumers. -* Read file consumer: +* Write file consumer: ```java // put whatever you need here byte[] someBytes = new byte[2]; @@ -21,7 +21,7 @@ Consumer consumer = outputStream -> { } }; ``` -* Write file consumer: +* Read file consumer: ```java Consumer consumer = inputStream -> { try { @@ -46,4 +46,4 @@ sandboxFileManager.readFile("file.txt", consumer); sandboxFileManager.writeFile("file.txt", consumer); ``` -Finally, if you wrote any file, you can see them in `Terasology/sandbox` directory. :smiley: \ No newline at end of file +Finally, if you wrote any file, you can see them in `Terasology/sandbox` directory. :smiley: