===== File Namespace =====
The file namespace contains functions that interact with files and folders on the clients system.
You can access these functions via:
ashita.file.
----
==== ashita.file.create_directory ====
==== ashita.file.create_dir ====
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.
----
==== ashita.file.directory_exists ====
==== ashita.file.dir_exists ====
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.
----
==== ashita.file.file_exists ====
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.
----
==== ashita.file.get_directory ====
==== ashita.file.get_dir ====
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.//
----
==== ashita.file.get_install_dir ====
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.
Language Ids:
0 - Default (Use the default language of the current loaded client.
1 - Japanese (Looks up registry information within PlayOnline.)
2 - English (Looks up registry information within PlayOnlineUS.)
3 - European (Looks up registry information within PlayOnlineEU.)
Square Enix Entity Ids:
0 - PlayOnline
1 - Final Fantasy XI
2 - Final Fantasy XI (Test Server)
3 - Tetra Master