Modules/FileSystem/translator/exists: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ This function checks whether a specified file exists on a MTA:Eir FileSystem translator. ==Syntax== <syntaxhighlight lang="lua"> bool translator:exists ( string filePath ) </syntaxhighlight> ==Arguments== *'''filePath:''' the path to the file that should exist ==Returns== This function returns '''true''' if the given path points to a valid file instance on a FileSystem, '''false''' otherwise. ==Example== <section name="Client" class="client" show="true"> T...")
 
No edit summary
 
Line 1: Line 1:
<pageclass class="#3c82c8" subcaption="Translator function"></pageclass>
__NOTOC__
__NOTOC__
This function checks whether a specified file exists on a MTA:Eir FileSystem translator.  
This function checks whether a specified file exists on a MTA:Eir FileSystem translator.  

Latest revision as of 03:24, 23 January 2022

This function checks whether a specified file exists on a MTA:Eir FileSystem translator.

Syntax

bool translator:exists ( string filePath )

Arguments

  • filePath: the path to the file that should exist

Returns

This function returns true if the given path points to a valid file instance on a FileSystem, false otherwise.

Example

Click to collapse [-]
Client

This snippet checks whether a file exists on the client. Otherwise, the file is created.

-- Attempt to get a link to our resource directory.
local resRoot = fileCreateTranslator( "/" );

if not ( resRoot ) then
    outputDebugString( "could not link the resource instance directory" );
    return false;
end

-- Check file existence.
local fileName = "someFile.txt";

if not ( resRoot:exists( fileName ) ) then
    local fileHandle = resRoot:open( fileName, "wb+" );

    -- Write our watermark!
    fileHandle:write( "this file is legit." );
end

FileSystem Translator Functions

FileSystem File Functions