ReadFile¶

Read binary-safe file contents, or nil and an error.

Signature¶

ReadFile(path)

Contract and usage¶

`ReadFile(path)`¶

Alias: gos.file.read(path).

Returns binary-safe file contents, or nil, error if the path is rejected or the read fails.

local text, error = ReadFile(CACHE_PATH .. "state.txt")

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