Lua API
On this page

filesystem Module

module

Provides access to a sandboxed filesystem. You can read / write / list files/directories within the sandbox. Useful for saving/loading settings or reading script resources like textures.

Not all types are directly as module fields. Some types are only returned by calling functions, or accessing class fields. For example, EventArg type classes are generally not ever directly exposed, because you'll never need to directly create them, they will always be provided to you as needed. Types that are not globally exposed won't be listed below, use the site navigation on the left to browser all defined types.

Tip

In most cases the name that a type is exposed as will match the type name, but there are some cases where the name has been changed to prevent conflicts.

In the tables below, you can see the types that are exposed directly, and the names they are expose as.

Methods:

GetCustom(dataDirectory: string, reason: string) : FileSystemAccess

Get a new FileSystemAccess object sandboxed to the script data directory.

Parameters:
NameTypeDefaultSummary
dataDirectorystring

The directory to request access to.

reasonstring

The reason you are requesting access. It's a good idea to tell the user what you are looking for so they can point to a custom directory if needed.

GetData() : FileSystemAccess

ss Get a new FileSystemAccess object sandboxed to the script data directory.

GetScript() : FileSystemAccess

Get a new FileSystemAccess object sandboxed to the script directory.