Files documentation

Introductions

The 'files' API is what gives lua programs the ability to interact with the parent computers folders, partitions and disks or generate file headers, it is not the API for the files themselves, to read/write/append to files, view the file header documentation.

File paths are usually in the following format: "(partition):/(filename).(extension)" or "(partition):/(directory)/(filename).(extension)", and the disk number to operate on is a separate parameter, starting at zero

The file system also contains the ability to interface with multiple disks, disk 0 is the home disk containing the computers internal files, and has appropriate restrictions.
some disks are 'bootable' and contain an entrypoint for execution of the disks program contents, home disks with an entrypoint to a non-existent file will fail to boot, and disks that contain an entrypoint can be crafted into the home disk of a new computer block.

The files api exists in the global space as "files" or "_G.files"

Lookup table

getPartitions(disk = 0)

Returns a list of partition names belonging to the filesystem

getPartition(name, disk = 0)

Gets a table of data relating to the partition named, if it exists

createPartition(name, disk = 0)

Creates a non-hidden, writable partition with the given name, if available. And indicates if the partition was created

deletePartition(name, disk = 0)

Attempts to delete a partition with the given name

setPartitionHidden(name, state, disk = 0)

Sets the given partition's hidden state to that given, if it exists. Notes that being hidden has no effect itself and is more individual programs to process (so completely useless, but I already added it so whatever).

setPartitionReadOnly(name, disk = 0)

Mark the given partition as read only, after its contents won't be editable

open(path, mode='r', disk = 0)

Opens up a file header for the file at the path, which uses the mode provided to set the rules of interaction with the file

file modes can be confusing, you can find a lookup table for every possible file mode here!

getChildren(path, disk = 0)

Returns a list of the paths of the files inside the directory indicated by the parameters

makeDir(path, disk = 0)

Attempts to make directory at the path

exists(path, disk = 0)

Checks if the path contains data

isFile(path, disk = 0)

Checks if the file first exists and then is a file / not a directory

isDir(path, disk = 0)

Checks if the file first exists and then is not a file / a directory

delete(path, disk = 0)

Attempts to delete the data at the path and returns if the operation was a success

getNumberOfDisks()

Counts the amount of disks on the system

getDisks()

Counts the numbers of the disks on the system

getDiskID(disk)

Gets the UUID of the disk

removeDisk(disk)

Attempts to detach the disk, will always fail to delete the home disk

getBootPath(disk)

Gets the entrypoint for a disk or nil if the disk is not bootable

setBoot(entrypoint, disk)

Attempts to set the boot data of a disk, will preform an additional safety check to ensure the entrypoint exists exclusively for the home disk

setBoot(disk)

Attempts to remove boot information from a disk, will always fail for the home disk