Ashita Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===== File Namespace =====

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

You can access these functions via:
<code lua>ashita.file.</code>

----
==== 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.)
<code lua>bool ashita.file.create_dir(path);</code>
  * **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.
<code lua>bool ashita.file.dir_exists(path);</code>
  * **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.
<code lua>bool ashita.file.file_exists(file);</code>
  * **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.
<code lua>bool ashita.file.get_dir(root, mask, subs);</code>
  * **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.
<code lua>string ashita.file.get_install_dir(langId, entityId);</code>
  * **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.

<html><div class="custom-info">
Language Ids:<br>
&nbsp;0 - Default (Use the default language of the current loaded client.<br>
&nbsp;1 - Japanese (Looks up registry information within PlayOnline.)<br>
&nbsp;2 - English (Looks up registry information within PlayOnlineUS.)<br>
&nbsp;3 - European (Looks up registry information within PlayOnlineEU.)<br>
<br>
Square Enix Entity Ids:<br>
&nbsp;0 - PlayOnline<br>
&nbsp;1 - Final Fantasy XI<br>
&nbsp;2 - Final Fantasy XI (Test Server)<br>
&nbsp;3 - Tetra Master<br>
</div></html>
Ashita Documentation

User Tools

Site Tools

Page Tools
