This shows you the differences between two versions of the page.
addons:functions:file [2017/04/21 21:41] atom0s created |
addons:functions:file [2017/04/22 00:10] |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ===== 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 ==== | ||
- | |||
- | ---- | ||
- | ==== ashita.file.get_install_dir ==== |