File
file.delete
Shared
Deletes a specified file
Syntax
local status = file.delete(path)Prefix the path with :resourcename to access files from another running resource.
- Local path — resolves relative to the current resource's directory
- Cross-resource path — prefix with
:resourcenameto resolve relative to another running resource's directory - Example —
:resource_a/files/images/test.pngaccessesfiles/images/test.pnginsideresource_a
Parameters
| Type | Name | Description |
|---|---|---|
string | path | File path to delete |
Returns
| Type | Name | Description |
|---|---|---|
bool | status | true on successful execution, or false on failure |
Examples
engine.print("info", "File deleted:", file.delete("files/images/test.png"))engine.print("info", "File deleted:", file.delete(":resource_a/files/images/test.png"))