This shows you the differences between two versions of the page.
Both sides previous revision Previous revision | |||
addons:functions:file [2017/04/21 21:54] atom0s |
addons:functions:file [2017/04/22 00:10] (current) |
||
---|---|---|---|
Line 4: | Line 4: | ||
You can access these functions via: | You can access these functions via: | ||
- | <code lua>ashita.file.</code> | + | <sxh lua>ashita.file.</sxh> |
---- | ---- | ||
Line 11: | Line 11: | ||
Creates a directory on the clients system. (Any sub-directories upto the end folder that are not present will also be created.) | 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> | + | <sxh lua>bool ashita.file.create_dir(path);</sxh> |
* **Parameters** | * **Parameters** | ||
* path - (string) The full path to create. | * path - (string) The full path to create. | ||
Line 22: | Line 22: | ||
Determines if the given path exists. | Determines if the given path exists. | ||
- | <code lua>bool ashita.file.dir_exists(path);</code> | + | <sxh lua>bool ashita.file.dir_exists(path);</sxh> |
* **Parameters** | * **Parameters** | ||
* path - (string) The full path to check. | * path - (string) The full path to check. | ||
Line 32: | Line 32: | ||
Determines if the given file exists. | Determines if the given file exists. | ||
- | <code lua>bool ashita.file.file_exists(file);</code> | + | <sxh lua>bool ashita.file.file_exists(file);</sxh> |
* **Parameters** | * **Parameters** | ||
* file - (string) The full path to the file to check. | * file - (string) The full path to the file to check. | ||
Line 43: | Line 43: | ||
Obtains and returns a directories contents. | Obtains and returns a directories contents. | ||
- | <code lua>bool ashita.file.get_dir(root, mask, subs);</code> | + | <sxh lua>bool ashita.file.get_dir(root, mask, subs);</sxh> |
* **Parameters** | * **Parameters** | ||
* root - (string) The path to the directory to obtain the contents of. | * root - (string) The path to the directory to obtain the contents of. | ||
Line 57: | Line 57: | ||
Obtains the install path to a given Square Enix entity. | Obtains the install path to a given Square Enix entity. | ||
- | <code lua>string ashita.file.get_install_dir(langId, entityId);</code> | + | <sxh lua>string ashita.file.get_install_dir(langId, entityId);</sxh> |
* **Parameters** | * **Parameters** | ||
* langId - (number) The language id used for the proper PlayOnline registry key to lookup within. | * langId - (number) The language id used for the proper PlayOnline registry key to lookup within. |