Skip to content

WriteFile

Write or append bytes in approved roots, creating missing parent directories.

Signature

WriteFile(text, path, mode)

Contract and usage

WriteFile(text, path, mode?)

Alias: gos.file.write(text, path, mode?).

Returns true on success or false, error. Missing parent directories are created for a valid write path. Modes w and wb truncate an existing file; a and ab append. The default is w. All four modes write bytes without text conversion. Writes are not atomic: failure can leave a truncated or partially written file.

local ok, error = WriteFile("ready", CACHE_PATH .. "state.txt", "w")

Root Constants

Each path ends with the platform directory separator:

SCRIPT_PATH
COMMON_PATH
SPRITE_PATH
FONTS_PATH
SOUNDS_PATH
CACHE_PATH

SCRIPT_PATH is the current entry script's directory; COMMON_PATH is the configured shared-module root. To find their actual values, run the status panel and open its Log tab. Open Folder opens the active-script directory. Shared modules need not be beside a portable entry script; use COMMON_PATH instead of guessing a path.

Relative file paths resolve from SCRIPT_PATH. File operations must stay inside the approved roots; network-share and device paths are rejected.

File Helpers

Global helpers and their gos.file aliases have identical arguments and results. An omitted error return becomes nil in a two-variable assignment.

Full modules and files contract