Multi Theft Auto: Wiki - User contributions [en]

GetPedWeaponSlot

2010-05-24T10:04:29Z

EXtrike:

__NOTOC__
{{Server client function}}
This function gets a ped's selected weapon slot.

==Syntax==
<syntaxhighlight lang="lua">
int getPedWeaponSlot ( ped thePed )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the ped to get the current weapon slot of.

===Returns===
Returns the selected weapon slot ID on success, ''false'' otherwise.
{{Weapon_Slots}}

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function(source)
local pedSlot = getPedWeaponSlot ( source )
if (pedSlot == 0) then
outputChatBox("Your weapon is not in your hands ;)", source)
end
end
</syntaxhighlight>
</section>

==See Also==
{{Ped functions}}

GetPedWeaponSlot

2010-05-24T10:03:58Z

EXtrike: /* Example */

GetPedWeaponSlot

2010-05-24T10:02:37Z

EXtrike: /* Example */

__NOTOC__
{{Server client function}}
This function gets a ped's selected weapon slot.

==Syntax==
<syntaxhighlight lang="lua">
int getPedWeaponSlot ( ped thePed )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the ped to get the current weapon slot of.

===Returns===
Returns the selected weapon slot ID on success, ''false'' otherwise.
{{Weapon_Slots}}

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function(source)
local pedSlot = getPedWeaponSlot ( source )
if (pedSlot == 0) then
outputChatBox("Weapons of you not in the hands ;)", source)
end
end
</syntaxhighlight>
</section>

==See Also==
{{Ped functions}}
[[Category:Needs Example]]

GetPedWeaponSlot

2010-05-24T10:02:12Z

EXtrike: /* Example */

__NOTOC__
{{Server client function}}
This function gets a ped's selected weapon slot.

==Syntax==
<syntaxhighlight lang="lua">
int getPedWeaponSlot ( ped thePed )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the ped to get the current weapon slot of.

===Returns===
Returns the selected weapon slot ID on success, ''false'' otherwise.
{{Weapon_Slots}}

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function(source)
local pedSlot = getPedWeaponSlot ( source )
if (pedSlot) == 0 then
outputChatBox("Weapons of you not in the hands ;)", source)
end
end
</syntaxhighlight>
</section>

==See Also==
{{Ped functions}}
[[Category:Needs Example]]

GetPedWeaponSlot

2010-05-24T10:01:49Z

EXtrike: /* Example */

__NOTOC__
{{Server client function}}
This function gets a ped's selected weapon slot.

==Syntax==
<syntaxhighlight lang="lua">
int getPedWeaponSlot ( ped thePed )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the ped to get the current weapon slot of.

===Returns===
Returns the selected weapon slot ID on success, ''false'' otherwise.
{{Weapon_Slots}}

==Example==
<syntaxhighlight lang="lua">
function(source)
local pedSlot = getPedWeaponSlot ( source )
if (pedSlot) == 0 then
outputChatBox("Weapons of you not in the hands ;)", source)
end
end
</syntaxhighlight>

==See Also==
{{Ped functions}}
[[Category:Needs Example]]

FileDelete

2010-05-24T09:58:12Z

EXtrike:

__NOTOC__
{{Server function}}
Deletes the specified file.

==Syntax==
<syntaxhighlight lang="lua">
bool fileDelete ( string filePath )
</syntaxhighlight>

===Required Arguments===
*'''filePath:''' The [[filepath]] of the file to delete in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.
:For example, if you want to delete a file name "myFile.txt" in the resource 'fileres', it can be deleted from another resource this way: ''fileDelete(":fileres/myFile.txt")''.
:If the file is in the current resource, only the file path is necessary, e.g. ''fileDelete("myFile.txt")''.

===Returns===
Returns ''true'' if successful, ''false'' otherwise (for example if there exists no file with the given name, or it does exist but is in use).

==Example==
<section name="Server" class="server" show="true">
This example will show us how to create a file "text.txt" spell it "This is a test file!", Close the file and delete it:
<syntaxhighlight lang="lua">
local newFile = fileCreate("test.txt") -- attempt to create a new file
if (newFile) then -- check if the creation succeeded
fileWrite(newFile, "This is a test file!") -- write a text line
fileClose(newFile) -- close the file once you're done with it
fileDelete(newFile) -- delete file
end
</syntaxhighlight>
</section>

==See Also==
{{File_functions}}

FileGetSize

2010-05-24T09:57:38Z

EXtrike:

__NOTOC__
{{Server function}}

Returns the total size in bytes of the given file.

==Syntax==
<syntaxhighlight lang="lua">
int fileGetSize ( file theFile )
</syntaxhighlight>

===Required Arguments===
*'''theFile:''' the file handle you wish to get the size of.

===Returns===
Returns the file size if successful, or ''false'' if an error occured (e.g. an invalid file handle was passed).

==Example==
<section name="Server" class="server" show="true">
In this example we will upload any (in the example config.xml) xml file and create a copy in a new folder with the name of copy-config.xml
<syntaxhighlight lang="lua">
function()
local newFile = fileCreate("test.txt") -- attempt to create a new file
if (newFile) then -- check if the creation succeeded
fileWrite(newFile, "This is a test file!") -- write a text line
local size = fileGetSize ( newFile ) -- get size
if size then
outputChatBox("Size of test.txt is: " .. size, source) -- output size
else
outputChatBox("Sorry, test.txt dont have size ;)", source)
end
fileClose(newFile) -- close the file once you're done with it
end
end
</syntaxhighlight>
</section>

==See Also==
{{File functions}}

FileGetSize

2010-05-24T09:56:32Z

EXtrike: /* Example */

FileGetSize

2010-05-24T09:56:15Z

EXtrike: /* Example */

__NOTOC__
{{Server function}}

Returns the total size in bytes of the given file.

==Syntax==
<syntaxhighlight lang="lua">
int fileGetSize ( file theFile )
</syntaxhighlight>

===Required Arguments===
*'''theFile:''' the file handle you wish to get the size of.

===Returns===
Returns the file size if successful, or ''false'' if an error occured (e.g. an invalid file handle was passed).

==Example==
<section name="Server" class="server" show="true">
In this example we will upload any (in the example config.xml) xml file and create a copy in a new folder with the name of copy-config.xml
<syntaxhighlight lang="lua">
function()
local newFile = fileCreate("test.txt") -- attempt to create a new file
if (newFile) then -- check if the creation succeeded
fileWrite(newFile, "This is a test file!") -- write a text line
local size = fileGetSize ( newFile ) -- get size
if size then
outputChatBox("Size of test.txt is: " .. size, source) -- output size
else
outputChatBox("Sorry, test.txt dont have size ;)", source)
fileClose(newFile) -- close the file once you're done with it
end
end
</syntaxhighlight>
</section>

==See Also==
{{File functions}}
[[Category:Needs Example]]

XmlCopyFile

2010-05-24T09:50:57Z

EXtrike: /* Example */

__NOTOC__
{{Server client function}}
This function copies all contents of a certain node in a XML document to a new document file, so the copied node becomes the new file's root node.

==Syntax==
<syntaxhighlight lang="lua">
xmlnode xmlCopyFile ( xmlnode nodeToCopy, string newFilePath )
</syntaxhighlight>

===Required Arguments===
*'''nodeToCopy:''' the [[xmlnode]] that is to be copied to a new document.
*'''newFilePath:''' the path of the file that is to be created, in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.
:For example, to create a file named 'newfile.xml' with myNode as the root node in the resource 'ctf', it can be done from another resource this way: ''xmlCopyFile(myNode, ":ctf/newfile.xml")''.
:If the file is to be in the current resource, only the file path is necessary, e.g. ''xmlCopyFile(myNode, "newfile.xml")''.

===Returns===
Returns a [[xmlnode]] if the node was successfully copied, ''false'' if invalid arguments were passed.

==Example==
<section name="Server" class="server" show="true">
In this example we will upload any (in the example config.xml) xml file and create a copy in a new folder with the name of copy-config.xml:
<syntaxhighlight lang="lua">
function()
local config = xmlLoadFile ( "config.xml" )
xmlCopyFile ( config, "copy/copy-config.xml" )
end
</syntaxhighlight>
</section>

==See Also==
{{XML_functions}}

FileDelete

2010-05-24T09:43:27Z

EXtrike: /* Example */

FileDelete

2010-05-24T09:41:24Z

EXtrike: /* Example */

__NOTOC__
{{Server function}}
Deletes the specified file.

==Syntax==
<syntaxhighlight lang="lua">
bool fileDelete ( string filePath )
</syntaxhighlight>

===Required Arguments===
*'''filePath:''' The [[filepath]] of the file to delete in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.
:For example, if you want to delete a file name "myFile.txt" in the resource 'fileres', it can be deleted from another resource this way: ''fileDelete(":fileres/myFile.txt")''.
:If the file is in the current resource, only the file path is necessary, e.g. ''fileDelete("myFile.txt")''.

===Returns===
Returns ''true'' if successful, ''false'' otherwise (for example if there exists no file with the given name, or it does exist but is in use).

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
local newFile = fileCreate("test.txt") -- attempt to create a new file
if (newFile) then -- check if the creation succeeded
fileWrite(newFile, "This is a test file!") -- write a text line
fileClose(newFile) -- close the file once you're done with it
fileDelete(newFile) -- delete file
end
</syntaxhighlight>
</section>

==See Also==
{{File_functions}}
[[Category:Needs Example]]

XmlCreateSubNode

2010-05-24T09:39:03Z

EXtrike: /* Example */

__NOTOC__
{{Server client function}}
{{Deprecated}}
This function creates a subnode for a specified XML node.

==Syntax==
<syntaxhighlight lang="lua">xmlnode xmlCreateSubNode ( xmlnode parentNode, string tagname )</syntaxhighlight>

===Required Arguments===
*'''parentNode:''' the [[xmlnode]] you want to create a subnode of.
*'''tagname:''' the type of the subnode that will be created.

===Returns===
Returns the created [[xmlnode]] if successful, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
We need to create a new node between the tags <config> and </ config>.
config.xml:
<syntaxhighlight lang="xml">
<config>
<newnode>somevalue</newnode>
</config>
</syntaxhighlight>
Lua code:
<syntaxhighlight lang="lua">
function()
config = xmlLoadFile("config.xml")
local newNode = xmlCreateSubNode ( config, "newnode" )
xmlNodeSetValue ( newNode, "somevalue" )
xmlSaveFile( config )
end
</syntaxhighlight>
</section>

==See Also==
{{XML functions}}

XmlCreateSubNode

2010-05-24T09:38:40Z

EXtrike: /* Example */

AddAccount

2010-04-18T07:54:23Z

EXtrike:

{{Server function}}
__NOTOC__
This function adds an account to the list of registered accounts of the current server.

==Syntax==

{{New feature|3|1.0 r848|
<syntaxhighlight lang="lua">
account addAccount ( string name, string pass )
</syntaxhighlight>
}}
{{Deprecated_feature|3|1.0|
<syntaxhighlight lang="lua">
bool addAccount ( string name, string pass )
</syntaxhighlight>
}}

===Required Arguments===

*'''name:''' The name of the account you wish to make, this normally is the player's name.
*'''pass:''' The password to set for this account for future logins.

===Returns===

{{New feature|3|1.0 r848|
Returns the ''account'' element if the account was created, ''false'' if the account already exists or an error occured.
}}
{{Deprecated_feature|3|1.0|
Returns ''true'' if the account was created, ''false'' if the account already exists or an error occured.
}}

==Example==
<section name="Server" class="server" show="true">
'''Example 1:''' This enables players to register on your server by using /register <password> in the chat window.
<syntaxhighlight lang="lua">
function registerPlayer ( source, commandName, password )
-- Check if the password field is blank or not (only blank if they didnt enter one)
if ( password ~= "" and password ~= nil ) then
--Attempt to add the account, and save its value in a var
local accountAdded = addAccount( getPlayerName(source), password )
if ( accountAdded ) then
-- Tell the user all is done
outputChatBox ( "Thank you " .. getPlayerName(source) .. ", you're now registed, you can login with /login", source )
else
-- There was an error making the account, tell the user
outputChatBox ( "Error creating account, contact the server admin", source )
end
else
-- There was an error in the syntax, tell the user the correct syntax.
outputChatBox ( "Error creating account, correct syntax: /register <password>", source )
end
end
addCommandHandler ( "register", registerPlayer ) -- add the command handler
</syntaxhighlight>

'''This code differs by allowing the user to change their username that they wish to use.'''

'''Example 2:''' This enables players to register on your server by using /register <username> <password> in the chat window.
<syntaxhighlight lang="lua">
function registerPlayer ( source, commandName, username, password )
if(password ~= "" and password ~= nil and username ~= "" and username ~= nil) then
local accountAdded = addAccount(username,password)
if(accountAdded) then
outputChatBox("Thank you " .. getPlayerName(source) .. ", you're now registed, you can login with /login",source)
else
outputChatBox("Error creating account, contact the server admin.",source)
end
else
outputChatBox("Error creating account, correct syntax: /register <nick> <pass>",source)
end
end
addCommandHandler ( "register", registerPlayer ) -- add the command handler
</syntaxhighlight>

'''Example 3:''' This code differs again so the user can only register once /register <username> <password>.
<syntaxhighlight lang="lua">
local bRegisteredOnce = false

function registerPlayer ( source, commandName, username, password )
if(password ~= "" and password ~= nil and username ~= "" and username ~= nil and bRegisteredOnce == false) then
local accountAdded = addAccount(username,password)
if(accountAdded) then
outputChatBox("Thank you " .. getPlayerName(source) .. ", you're now registed, you can login with /login",source)
bRegisteredOnce = true
else
outputChatBox("Error creating account, contact the server admin.",source)
end
else
if bRegisteredOnce == true then
outputChatBox("You already registered on this server!",source)
else
outputChatBox("Error creating account, correct syntax: /register <nick> <pass>",source)
end
end
end
addCommandHandler ( "register", registerPlayer ) -- add the command handler
</syntaxhighlight>
</section>

==See Also==

{{Account_functions}}

Template:Account functions

2010-04-18T07:53:29Z

EXtrike:

*[[addAccount]]
*[[copyAccountData]]
*[[getAccount]]
*[[getAccountData]]
*[[getAccountName]]
*[[getAccounts]]
*[[isGuestAccount]]
*[[logIn]]
*[[logOut]]
*[[removeAccount]]
*[[setAccountData]]
*[[setAccountPassword]]
{{New feature|3|1.0|
*[[getAccountPlayer]]
}}
{{Deprecated_feature|3|1.0|
*[[getAccountClient]]
}}

Template:Account functions

2010-04-18T07:53:10Z

EXtrike:

*[[RU/addAccount]]
*[[copyAccountData]]
*[[getAccount]]
*[[getAccountData]]
*[[getAccountName]]
*[[getAccounts]]
*[[isGuestAccount]]
*[[logIn]]
*[[logOut]]
*[[removeAccount]]
*[[setAccountData]]
*[[setAccountPassword]]
{{New feature|3|1.0|
*[[getAccountPlayer]]
}}
{{Deprecated_feature|3|1.0|
*[[getAccountClient]]
}}

RU/Server Scripting Functions

2010-04-18T07:52:48Z

EXtrike:

{{translate}}
<pageclass class="server"></pageclass>
Здесь приведены все [[event|функции скриптов]], выполняемые на '''серверной стороне''', которые уже встроены в мод. Для консультации по работе функций или событий посети [[Requested Functions and Events|эту страницу]].

Прошу заметить, что скриптовые функции могут быть расширены при загрузке в динамических модулях, которые обеспечивают новые функции, такие как доступ к базе данных MySQL. Эти функции не встроены в мод и требуют модуль чтобы загрузить для готовности.

Зайдите на [[Module functions|эту страницу]] для ознакомления с функциями, которые не встроены в мод, однако доступны для пользования.

'''Функции для работы на клиентской стороне вы можете найти здесь: [[RU/Client Scripting Functions|Клиентские Функции Скриптинга]].'''

==Функции аккаунта==
{{Account_functions}}

==Функции ACL==
{{ACL_functions}}

==Функции администрирования==
{{RU/Admin_functions}}

==Аудио функции==
{{Audio_functions}}

==Функции объявления==
{{Announce_functions}}

==Blip функции==
{{Blip_functions}}

==Функции камеры==
{{Camera functions}}

==Функции формы столкновения==
{{Collision shape functions}}

==Функции клиента==
{{Client functions}}

==Функции тела и одежды==
{{Clothes and body functions}}

==Функции курсора==
{{Cursor_functions}}

==Функции элементов==
{{Element functions}}

==Функции событий==
{{Event_functions}}

==Функции взрывов==
{{Explosion_functions}}

==Функции файлов==
{{File_functions}}

==Функции HTTP==
{{HTTP_functions}}

==Функции ввода==
{{Input_functions}}

==Функции карты==
{{Map_functions}}

==Функции маркеров==
{{Marker functions}}

==Функции объектов==
{{Object functions}}

==Функции пикапов==
{{Pickup functions}}

==Функции игрока==
{{Player functions}}

==Функции области радара==
{{Radar area functions}}

==Функции ресурсов==
{{Resource functions}}

==Серийные функции==
{{Serial functions}}

==Серверные функции==
{{Server functions}}

==Функции настройки реестра==
{{RU/Settings registry functions}}

==Функции SQL==
{{SQL_functions}}

==Функции команды==
{{Team functions}}

==Функции текста==
{{Text functions}}

==Полезные функции==
{{Utility functions}}

==Функции транспорта==
{{Vehicle functions}}

==Функции оружия==
{{RU/Weapon functions}}

==Функции мира==
{{RU/World functions}}

==Функции XML==
{{XML functions}}

==Устаревшие функции==
Access: [http://development.mtasa.com/index.php?title=Category:Depreciated <nowiki>[[Category:Depreciated]]</nowiki> ]<br>
''Note: dont change this, done purposely to keep this page from being included in the listing.''
[[en:Server Scripting Functions]]

RU/Server Scripting Functions

2010-04-18T07:52:29Z

EXtrike:

{{translate}}
<pageclass class="server"></pageclass>
Здесь приведены все [[event|функции скриптов]], выполняемые на '''серверной стороне''', которые уже встроены в мод. Для консультации по работе функций или событий посети [[Requested Functions and Events|эту страницу]].

Прошу заметить, что скриптовые функции могут быть расширены при загрузке в динамических модулях, которые обеспечивают новые функции, такие как доступ к базе данных MySQL. Эти функции не встроены в мод и требуют модуль чтобы загрузить для готовности.

Зайдите на [[Module functions|эту страницу]] для ознакомления с функциями, которые не встроены в мод, однако доступны для пользования.

'''Функции для работы на клиентской стороне вы можете найти здесь: [[RU/Client Scripting Functions|Клиентские Функции Скриптинга]].'''

==Функции аккаунта==
{{RU/Account_functions}}

==Функции ACL==
{{ACL_functions}}

==Функции администрирования==
{{RU/Admin_functions}}

==Аудио функции==
{{Audio_functions}}

==Функции объявления==
{{Announce_functions}}

==Blip функции==
{{Blip_functions}}

==Функции камеры==
{{Camera functions}}

==Функции формы столкновения==
{{Collision shape functions}}

==Функции клиента==
{{Client functions}}

==Функции тела и одежды==
{{Clothes and body functions}}

==Функции курсора==
{{Cursor_functions}}

==Функции элементов==
{{Element functions}}

==Функции событий==
{{Event_functions}}

==Функции взрывов==
{{Explosion_functions}}

==Функции файлов==
{{File_functions}}

==Функции HTTP==
{{HTTP_functions}}

==Функции ввода==
{{Input_functions}}

==Функции карты==
{{Map_functions}}

==Функции маркеров==
{{Marker functions}}

==Функции объектов==
{{Object functions}}

==Функции пикапов==
{{Pickup functions}}

==Функции игрока==
{{Player functions}}

==Функции области радара==
{{Radar area functions}}

==Функции ресурсов==
{{Resource functions}}

==Серийные функции==
{{Serial functions}}

==Серверные функции==
{{Server functions}}

==Функции настройки реестра==
{{RU/Settings registry functions}}

==Функции SQL==
{{SQL_functions}}

==Функции команды==
{{Team functions}}

==Функции текста==
{{Text functions}}

==Полезные функции==
{{Utility functions}}

==Функции транспорта==
{{Vehicle functions}}

==Функции оружия==
{{RU/Weapon functions}}

==Функции мира==
{{RU/World functions}}

==Функции XML==
{{XML functions}}

==Устаревшие функции==
Access: [http://development.mtasa.com/index.php?title=Category:Depreciated <nowiki>[[Category:Depreciated]]</nowiki> ]<br>
''Note: dont change this, done purposely to keep this page from being included in the listing.''
[[en:Server Scripting Functions]]

AddAccount

2010-04-18T07:26:21Z

EXtrike:

{{Server function}}
__NOTOC__
Эта функция добавляет учетную запись в список зарегистрированных счетов текущего сервера..

==Syntax==

{{New feature|3|1.0 r848|
<syntaxhighlight lang="lua">
account addAccount ( string name, string pass )
</syntaxhighlight>
}}
{{Deprecated_feature|3|1.0|
<syntaxhighlight lang="lua">
bool addAccount ( string name, string pass )
</syntaxhighlight>
}}

===Required Arguments===

*'''name:''' The name of the account you wish to make, this normally is the player's name.
*'''pass:''' The password to set for this account for future logins.

===Returns===

{{New feature|3|1.0 r848|
Returns the ''account'' element if the account was created, ''false'' if the account already exists or an error occured.
}}
{{Deprecated_feature|3|1.0|
Returns ''true'' if the account was created, ''false'' if the account already exists or an error occured.
}}

==Example==
<section name="Server" class="server" show="true">
'''Example 1:''' This enables players to register on your server by using /register <password> in the chat window.
<syntaxhighlight lang="lua">
function registerPlayer ( source, commandName, password )
-- Check if the password field is blank or not (only blank if they didnt enter one)
if ( password ~= "" and password ~= nil ) then
--Attempt to add the account, and save its value in a var
local accountAdded = addAccount( getPlayerName(source), password )
if ( accountAdded ) then
-- Tell the user all is done
outputChatBox ( "Thank you " .. getPlayerName(source) .. ", you're now registed, you can login with /login", source )
else
-- There was an error making the account, tell the user
outputChatBox ( "Error creating account, contact the server admin", source )
end
else
-- There was an error in the syntax, tell the user the correct syntax.
outputChatBox ( "Error creating account, correct syntax: /register <password>", source )
end
end
addCommandHandler ( "register", registerPlayer ) -- add the command handler
</syntaxhighlight>

'''This code differs by allowing the user to change their username that they wish to use.'''

'''Example 2:''' This enables players to register on your server by using /register <username> <password> in the chat window.
<syntaxhighlight lang="lua">
function registerPlayer ( source, commandName, username, password )
if(password ~= "" and password ~= nil and username ~= "" and username ~= nil) then
local accountAdded = addAccount(username,password)
if(accountAdded) then
outputChatBox("Thank you " .. getPlayerName(source) .. ", you're now registed, you can login with /login",source)
else
outputChatBox("Error creating account, contact the server admin.",source)
end
else
outputChatBox("Error creating account, correct syntax: /register <nick> <pass>",source)
end
end
addCommandHandler ( "register", registerPlayer ) -- add the command handler
</syntaxhighlight>

'''Example 3:''' This code differs again so the user can only register once /register <username> <password>.
<syntaxhighlight lang="lua">
local bRegisteredOnce = false

function registerPlayer ( source, commandName, username, password )
if(password ~= "" and password ~= nil and username ~= "" and username ~= nil and bRegisteredOnce == false) then
local accountAdded = addAccount(username,password)
if(accountAdded) then
outputChatBox("Thank you " .. getPlayerName(source) .. ", you're now registed, you can login with /login",source)
bRegisteredOnce = true
else
outputChatBox("Error creating account, contact the server admin.",source)
end
else
if bRegisteredOnce == true then
outputChatBox("You already registered on this server!",source)
else
outputChatBox("Error creating account, correct syntax: /register <nick> <pass>",source)
end
end
end
addCommandHandler ( "register", registerPlayer ) -- add the command handler
</syntaxhighlight>
</section>

==See Also==

{{Account_functions}}

FileDelete

2010-04-18T07:17:28Z

EXtrike: /* Example */

__NOTOC__
{{Server function}}
Deletes the specified file.

==Syntax==
<syntaxhighlight lang="lua">
bool fileDelete ( string filePath )
</syntaxhighlight>

===Required Arguments===
*'''filePath:''' The [[filepath]] of the file to delete in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.
:For example, if you want to delete a file name "myFile.txt" in the resource 'fileres', it can be deleted from another resource this way: ''fileDelete(":fileres/myFile.txt")''.
:If the file is in the current resource, only the file path is necessary, e.g. ''fileDelete("myFile.txt")''.

===Returns===
Returns ''true'' if successful, ''false'' otherwise (for example if there exists no file with the given name, or it does exist but is in use).

==Example==
<syntaxhighlight lang="lua">
local newFile = fileCreate("test.txt") -- attempt to create a new file
if (newFile) then -- check if the creation succeeded
fileWrite(newFile, "This is a test file!") -- write a text line
fileClose(newFile) -- close the file once you're done with it
fileDelete(newFile) -- delete file
end
</syntaxhighlight>

==See Also==
{{File_functions}}
[[Category:Needs Example]]