Garry's Mod Wiki

Home / CompileFile

CompileFile

  function CompileFile( string path, boolean showError = true )
Search Github

Description

Attempts to compile the given file. If successful, returns a function that can be called to perform the actual execution of the script.

Arguments

1 string path
Path to the file, relative to the garrysmod/lua/ directory.
2 boolean showError = true
Decides whether or not a non-halting error should be thrown on compile failure.
This was recently added in version (2025.01.31). It might only be available on the Dev Branch right now.

Returns

1 function
The function which executes the script.

Example

Assuming our file is named example.lua and located in the garrysmod/lua/ directory, the following code would execute the script.

local example = CompileFile("example.lua") example()
Output: Hello!

Account Management

Special Pages

Wiki List