Ashita Documentation

The file namespace contains functions that interact with files and folders on the clients system.

You can access these functions via:

ashita.file.

Creates a directory on the clients system. (Any sub-directories upto the end folder that are not present will also be created.)

bool ashita.file.create_dir(path);

• Parameters
  • path - (string) The full path to create.
• Returns
  • bool - True on success, false otherwise.

Determines if the given path exists.

bool ashita.file.dir_exists(path);

• Parameters
  • path - (string) The full path to check.
• Returns
  • bool - True if the path exists, false otherwise.

Determines if the given file exists.

bool ashita.file.file_exists(file);

• Parameters
  • file - (string) The full path to the file to check.
• Returns
  • bool - True if the file exists, false otherwise.

Obtains and returns a directories contents.

bool ashita.file.get_dir(root, mask, subs);

• Parameters
  • root - (string) The path to the directory to obtain the contents of.
  • mask - (string) The mask to use while obtaining the contents. (Optional, default is '*'.)
  • subs - (bool) True if sub-directories are included in the results, false otherwise. (Optional, default is false.)
• Returns
  • table - The results on success, nil otherwise.

If only the root path is given to this function, it will return a table containing a list of folders found within the given directory. If a mask is given, the function will instead return any file/folder that matches the mask given.

Obtains the install path to a given Square Enix entity.

string ashita.file.get_install_dir(langId, entityId);

• Parameters
  • langId - (number) The language id used for the proper PlayOnline registry key to lookup within.
  • entityId - (number) The entity id of the Square Enix product to lookup the install path to.
• Returns
  • string - The path to the entity if found, nil otherwise.