File: 02-files.md

package info (click to toggle)
openmohaa 0.82.1%2Bdfsg-2
  • links: PTS, VCS
  • area: contrib
  • in suites: forky, sid
  • size: 34,220 kB
  • sloc: cpp: 315,720; ansic: 275,789; sh: 312; xml: 246; asm: 141; makefile: 7
file content (43 lines) | stat: -rw-r--r-- 1,162 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# Reading and writing files.

Functions are provided trough scripting functions that start with `fs_`. Older file-related scripting functions will be deprecated in the future for safety and security reasons.

For a list of scripting functions, check the `fs_` ScriptThread functions in the **Game Module Classes**, and functions in the class `FSFile`.

## Examples

### Reading files

Here is an example on how to read files:

```cpp
main:
    // This will read test_file.txt using the engine file API.
    // The file can either be in a pk3 file, or in one of the main folders of the game.
    local.content = fs_read_content "test_file.txt"

    // Prints its content
    println ("File content: " + local.content)
end
```

### Writing files

Here is an example on how to write to a file:

```cpp
main:
    local.content = "Hello, world!"

    // Create (or replace) a file with the specified content
    fs_write_content "test_file.txt" local.content

    // The file will only have:
    // Hello, world!
    // Read it back
    local.content = fs_read_content "test_file.txt"

    // Prints its content
    println ("File content: " + local.content)
end
```