Docsv3.31.0
Back to API Reference
Class

FileDocumentSource

sealed
Inherits:DocumentSource

A file addressed as a root folder plus a relative path. Roots the platform exposes as folders load synchronously through FileTextSource; roots that are URLs (streaming assets on Android and on the web) download and deliver later, which needs the built-in Unity Web Request module — without it a URL location fails to load.

public DocumentPathRoot Root{ get; set }
public string Path{ get; set }
public TextFileEncoding Encoding{ get; set }
public FileTextBackend Backend{ get; set }
public bool IsEmpty{ get }

True when the source names nothing to load — an unset path or asset. A loader loads nothing from an empty source; Load on one throws.

public string ResolvedLocation{ get }

The full path or URL the source resolves to on this platform; empty without a path, since a root alone names no file.

public bool IsRemote{ get }

True when the resolved location is a URL, so the load is asynchronous.

public static string RootLocation(DocumentPathRoot root)

The root's folder or URL on this platform; empty for DocumentPathRoot.Absolute.

public static bool IsUrl(string location)

True when location is a URL rather than a file system path.

public override IDisposable Load(ScanProfile profile, Action<Rope> onLoaded)
Back to API Reference