Documentation

Read File Contents - Open Dev Kit Documentation

Open Dev Kit Documentation :: General :: Filesystem :: Read File Contents

Root.Filesystem.FileReadString(
  Path String,
  Offset Integer,
  Bytes Integer
) String
Returns the entire contents of a file as a string

Parameters

Path String
Location of the file being read
Offset Integer
Position (in bytes) to begin reading from; 0 for the beginning of the file, and a negative value will begin from the end of the file
Bytes Integer
Maximum number of bytes that will be read from the file

Return Value

String

Lua Usage

local string = filesystem:FileReadString(path, offset, bytes)

If you think anything is missing, please feel free to: submit documentation feedback on this page