API reference
Preparing search index…

Native-owned Rml::FileInterface with a filesystem root or custom callbacks.

Select before initialization. Native retains selected callback owners; unselected cycles are collectible. File roots try root + relative path first, then the original path. A selected provider cannot be replaced by an inconsistent initialise fileRoot. Shutdown closes and invalidates files and interfaces, including unused setup objects.

Source & inheritance
Member directory8

Constructors

Methods

Constructors

Methods

  • Load all bytes through Native LoadFile.

    Parameters

    path
    string

    Source file path.

    Returns

    null | Uint8Array

    Owned byte snapshot, or null when unavailable.

    Matches upstream default LoadFile: a short read logs a warning and keeps unread bytes zero-filled. An empty file still calls Read with size zero.

    Source & inheritance
  • Open a file through Rml::FileInterface::Open.

    Parameters

    path
    string

    File path.

    Returns

    null | FileHandle

    Checked file token, or null when unavailable.

    Source & inheritance
  • Read at most size bytes into output through Native Read.

    Parameters

    output
    Uint8Array

    Fixed attached byte array.

    size
    number

    Maximum bytes, no larger than output.length.

    file

    Open token.

    Returns

    number

    Actual bytes read.

    Source & inheritance

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0