Garry's Mod Wiki

Home / file.Open

file.Open

  file_class file.Open( string fileName, string fileMode, string gamePath )
Search Github

Description

Attempts to open a file with the given mode.

When trying to open files with the following characteristics, it returns nil:

the file extension is ".db; .mdmp; .dmp" or the file is "server.cfg; autoexec.cfg; config.cfg; listenserver.cfg; mount.cfg"

Arguments

1 string fileName
The files name. See file.Write for details on filename restrictions when writing to files.
2 string fileMode
The mode to open the file in. Possible values are:

  • r - read mode.
  • w - write mode.
  • a - append mode.
  • rb - binary read mode.
  • wb - binary write mode.
  • ab - binary append mode.
3 string gamePath
The path to look for the files and directories in. See this list for a list of valid paths.

Returns

1 file_class File
The opened file object, or nil if it failed to open due to it not existing or being used by another process.

Example

Open a file in read only mode, reads a line, tells where the current file pointer is at and then closes the file handle.

local f = file.Open( "cfg/mapcycle.txt", "r", "MOD" ) print( f:ReadLine() ) print( f:ReadLine() ) print( f:Tell() ) f:Close()
Output:
// // Default mapcycle file for Garry's Mod. 45

Account Management

Special Pages

Wiki List