File

Show Deprecated
Not Creatable
Not Replicated

An object that represents an asset loaded from a file on a local disk. Files generate a temporary asset ID in the form rbxtemp:// which can be used in Studio without uploading the asset, but will be destroyed when the File is destroyed or when the Studio session ends. Temporary asset IDs are not shared across collaborative sessions.

The default Name of a File instance will be the filename on disk, excluding the path but including the extension.

Summary

Properties

  • Hidden
    Read Only
    Not Replicated
    Read Parallel

    The size of the file on disk, in bytes.

Methods

Properties

Size

Hidden
Read Only
Not Replicated
Read Parallel
Plugin Security

The file size (in bytes) of the local file associated with this File.

Methods

GetBinaryContents

Plugin Security

This function is used to read the contents of the File as a raw binary string. This allows the file to be uploaded to web endpoints, or to be processed by plugins.


Returns

A raw binary string representation of the File contents.

GetTemporaryId

ContentId
Plugin Security

This function is used to retrieve a temporary asset ID associated with the File. The ID can be used like rbxassetid://, for example it can be assigned to the Image property of an ImageLabel.

Throws an error if the file does not exist on disk.


Returns

ContentId

The temporary asset id.

Events