Mohab: Added redirect for arabic page

2025-04-09T02:30:39Z

Added redirect for arabic page

← Older revision		Revision as of 02:30, 9 April 2025
Line 89:		Line 89:
	* {{Useful_Functions\|Utility}}		* {{Useful_Functions\|Utility}}

			[[ar:createDirectory]]
	[[Category:Useful_Functions]]		[[Category:Useful_Functions]]

Mohab: This function creates a directory in the resource's file system

2025-04-09T01:49:37Z

This function creates a directory in the resource's file system

New page

__NOTOC__
{{Useful_Function}}
This function creates a directory at the specified path within the resource's file system. In MTASA, directories are implicitly created by creating a file within them, and this function handles that process automatically by creating and then removing a temporary file.

==Syntax==
<syntaxhighlight lang="lua">bool createDirectory ( string directoryPath )</syntaxhighlight>

===Required Arguments===
*'''directoryPath:''' A string representing the path of the directory to create, relative to the resource's root folder (e.g., "myfolder" or "myfolder/subfolder").

===Returns===
Returns ''true'' if the directory was successfully created, ''false'' if the creation failed or if invalid arguments were passed.

==Code==
'''Directory Creation Utility'''

<syntaxhighlight lang="lua">
function createDirectory(directoryPath)
-- Check if directoryPath is provided and is a string
if not directoryPath or type(directoryPath) ~= "string" then
outputDebugString("Error: Invalid directory path provided", 1)
return false
end

-- Ensure the path ends with a forward slash
if not directoryPath:match("/$") then
directoryPath = directoryPath .. "/"
end

-- MTASA file system requires a file to implicitly create the directory
local tempFilePath = directoryPath .. "temp.txt"
local file = fileCreate(tempFilePath)

if file then
-- Write something to the file (optional, but good practice to ensure creation)
fileWrite(file, "Temporary file to create directory")
fileClose(file)

-- Delete the temporary file to keep the directory clean
fileDelete(tempFilePath)

outputDebugString("Directory created: " .. directoryPath)
return true
else
outputDebugString("Failed to create directory: " .. directoryPath, 1)
return false
end
end
</syntaxhighlight>

<section name="Function source" class="server" show="true">
This function is a simple and efficient way to create directories in MTASA. It uses the MTASA file system’s behavior of implicitly creating directories when a file is created within them. A temporary file is created and then deleted to leave the directory empty and ready for use.
</section>

==Usage==
This example shows how to call the `createDirectory` function to create a directory and provide feedback in the server console.
<syntaxhighlight lang="lua">
-- Create a directory called "logs" in the resource folder
local success = createDirectory("logs")
if success then
outputConsole("Directory 'logs' was created successfully!")
else
outputConsole("Failed to create directory 'logs'.")
end

-- Create a nested directory structure
local nestedSuccess = createDirectory("data/user/files")
if nestedSuccess then
outputConsole("Nested directory 'data/user/files' was created successfully!")
else
outputConsole("Failed to create nested directory 'data/user/files'.")
end
</syntaxhighlight>

==Notes==
* This function must be written in a server-side script because file system operations like `fileCreate`, `fileWrite`, `fileClose`, and `fileDelete` are restricted to server-side in MTASA for security and synchronization reasons.
* The directory path is relative to the resource's root folder (e.g., `:resourceName/directoryPath/`).
* Ensure the resource has appropriate file permissions in the `meta.xml` file:
<syntaxhighlight lang="xml">
<meta>
<script src="yourscript.lua" type="server" />
<file src="*" />
</meta>
</syntaxhighlight>

''Author'': Mohab

==See Also==
* {{Useful_Functions|Utility}}

[[Category:Useful_Functions]]

CreateDirectory - Revision history

Mohab: Added redirect for arabic page

Mohab: This function creates a directory in the resource's file system