s&box docs
API ReferenceSandbox

FileSystemclass

A filesystem that can be accessed by the game.

object→FileSystem
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public static abstract sealed class Sandbox.FileSystem

Methods2

Showing 2 methods

public static Sandbox.BaseFileSystem CreateMemoryFileSystem()PUBLICSTATIC

Create a filesystem that exists only in memory

Returns:BaseFileSystem—

public static string NormalizeFilename(string filepath)PUBLICSTATIC

Normalizes given file path so the game's filesystem can understand it. Fixes slashes and lowercases the file path.

ParameterTypeDescription
filepathstringThe file path to normalize
Returns:stringThe normalized file path

Properties4

Showing 4 properties

public static Sandbox.KeyStore Sandbox.FileSystem.Cache { get; set; }PUBLICSTATICGETSET

A cached keystore that can be used for anything. This is stored in a global cache folder, and may be deleted at any time.

Returns:KeyStore—

public static Sandbox.BaseFileSystem Sandbox.FileSystem.Data { get; set; }PUBLICSTATICGETSET

A subset of `Sandbox.FileSystem.OrganizationData` for custom gamemode data.

Returns:BaseFileSystem—

public static Sandbox.BaseFileSystem Sandbox.FileSystem.Mounted { get; set; }PUBLICSTATICGETSET

All mounted content.

Returns:BaseFileSystem—

public static Sandbox.BaseFileSystem Sandbox.FileSystem.OrganizationData { get; set; }PUBLICSTATICGETSET

A filesystem for custom data, per gamemode's organization.

Returns:BaseFileSystem—

Related Guides

→File System→Audio→Recording API→Video→Api Whitelist→Storage (UGC)

FilePathAttribute.ctor()

Previous Page

Cache

Next Page

On this page

Methodspublic static Sandbox.BaseFileSystem CreateMemoryFileSystem()public static System.String NormalizeFilename(System.String filepath)Propertiespublic static Sandbox.KeyStore Sandbox.FileSystem.Cache { get; set; }public static Sandbox.BaseFileSystem Sandbox.FileSystem.Data { get; set; }public static Sandbox.BaseFileSystem Sandbox.FileSystem.Mounted { get; set; }public static Sandbox.BaseFileSystem Sandbox.FileSystem.OrganizationData { get; set; }Metadata