MTA:Eir/FileSystem/translator/absPathRoot - Revision history

Quiret at 23:27, 16 January 2022

2022-01-16T23:27:50Z

← Older revision		Revision as of 23:27, 16 January 2022
Line 4:		Line 4:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	string translator.absPathRoot ( string path )		string translator:absPathRoot ( string path )
	</syntaxhighlight>		</syntaxhighlight>

Line 22:		Line 22:
	-- Create our utility function.		-- Create our utility function.
	local function isPathValidForResource( path )		local function isPathValidForResource( path )
	return not ( resRoot.absPathRoot( path ) == false );		return not ( resRoot:absPathRoot( path ) == false );
	end		end

The GTA at 23:25, 29 January 2014

2014-01-29T23:25:41Z

← Older revision		Revision as of 23:25, 29 January 2014
Line 8:		Line 8:

	==Arguments==		==Arguments==
	*'''path:''' the path that should be resolved into a absolute path; can be nil to return the absolute location of the translator (on host filesystems such as NTFS or ext3)		*'''path:''' the path that should be resolved into an absolute path; can be nil to return the absolute location of the translator (on host filesystems such as NTFS or ext3)

	==Returns==		==Returns==

The GTA: Created page with "NOTOC This function resolves a specified path into its absolute version. The path is resolved from the translator root. This function can be used to get a unique version of a..."

2014-01-29T14:24:11Z

Created page with "__NOTOC__ This function resolves a specified path into its absolute version. The path is resolved from the translator root. This function can be used to get a unique version of a..."

New page

__NOTOC__
This function resolves a specified path into its absolute version. The path is resolved from the translator root. This function can be used to get a unique version of a path (without scripting symbols such as '..').

==Syntax==
<syntaxhighlight lang="lua">
string translator.absPathRoot ( string path )
</syntaxhighlight>

==Arguments==
*'''path:''' the path that should be resolved into a absolute path; can be nil to return the absolute location of the translator (on host filesystems such as NTFS or ext3)

==Returns==
This function returns the absolute version of the path that is passed to it, '''false''' if the specified path is not accessible by the translator.

==Example==
<section name="Client" class="client" show="true">
This snippet checks whether the path given to it is valid for the resource.
<syntaxhighlight lang="lua">
-- Get a handle to the resource instance directory.
local resRoot = fileCreateTranslator( "/" );

-- Create our utility function.
local function isPathValidForResource( path )
return not ( resRoot.absPathRoot( path ) == false );
end

-- Is the path inside of/valid for our resource? Should return false.
local myPathValidity = isPathValidForResource( "C:/Windows/System32/" );

outputChatBox( "the windows system directory is " .. ( myPathValidity and "" or "not " ) .. "valid." );
</syntaxhighlight>
</section>
{{:MTA:Eir/FileSystem/translator/functions}}

MTA:Eir/FileSystem/translator/absPathRoot - Revision history

Quiret at 23:27, 16 January 2022

The GTA at 23:25, 29 January 2014

The GTA: Created page with "__NOTOC__ This function resolves a specified path into its absolute version. The path is resolved from the translator root. This function can be used to get a unique version of a..."

The GTA: Created page with "NOTOC This function resolves a specified path into its absolute version. The path is resolved from the translator root. This function can be used to get a unique version of a..."