Modules/FileSystem/translator/delete

From Multi Theft Auto: Wiki
Revision as of 02:52, 19 January 2022 by Danilo (talk | contribs) (Created page with "__NOTOC__ This function deletes an entry on the translator filesystem. If the path points at a directory, the whole content of it is recursively deleted. A typical reason when deletion may fail is when the file is opened in another OS handle. Proper clean-up of file classes can prevent this issue. ==Syntax== <syntaxhighlight lang="lua"> bool translator:delete ( string path ) </syntaxhighlight> ==Arguments== *'''path:''' a path to a filesystem object that should be wipe...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This function deletes an entry on the translator filesystem. If the path points at a directory, the whole content of it is recursively deleted. A typical reason when deletion may fail is when the file is opened in another OS handle. Proper clean-up of file classes can prevent this issue.

Syntax

bool translator:delete ( string path )

Arguments

  • path: a path to a filesystem object that should be wiped out

Returns

This function returns true if the specified filesystem object could be completely deleted, false otherwise.

Example

Click to collapse [-]
Client

This snippet nukes the contents of your client-side resource. It can be used as protective measure when client-side files should not be leaked to curious users.

-- Nuke ourselves.
fileCreateTranslator( "/" ):delete( "/" );

FileSystem Translator Functions