AddAccount: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(corrected some errors)
mNo edit summary
Line 1: Line 1:
__NOTOC__  
{{Server function}}
This function adds an account to the list of registered account of the current server.
__NOTOC__
This function adds an account to the list of registered accounts of the current server.


==Syntax==  
==Syntax==  
Line 10: Line 11:
===Required Arguments===  
===Required Arguments===  
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
*'''name:''' The name of the account you wish to make, this normally is the Players Name.
*'''name:''' The name of the account you wish to make, this normally is the player's name.
*'''pass:''' The password to set to this account for future logins.
*'''pass:''' The password to set for this account for future logins.
*'''level:''' The account level (see below for more detailed level values)
*'''level:''' The account level (see below for more detailed level values)


Line 17: Line 18:
You may specify any level here, normally the account level is used for future use such as creating an admin system.
You may specify any level here, normally the account level is used for future use such as creating an admin system.


You can check the current players access level with this command: [[getClientLevel]]
You can check the current player's access level with [[getClientLevel]].
 
 
<!-- Only include this section below if there are optional arguments -->


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns ''true'' if the account was created, ''false'' if the account allready exists, or if an error occoured.
Returns ''true'' if the account was created, ''false'' if the account already exists or an error occured.


==Example==  
==Example==  
Line 32: Line 30:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function registerPlayer ( source, commandName, password )
function registerPlayer ( source, commandName, password )
--Check if the password field is blank or not (only blank if they didnt enter one)
-- Check if the password field is blank or not (only blank if they didnt enter one)
if ( password ~= "" or password ~= nil ) then
if ( password ~= "" and password ~= nil ) then
--Attempt to add the account, and save its value in a var
--Attempt to add the account, and save its value in a var
local accountAdded = addAccount( getClientName(source), password, 0 )
local accountAdded = addAccount( getClientName(source), password, 0 )
if ( accountAdded ) then
if ( accountAdded ) then
--Tell the user its all done
-- Tell the user all is done
outputChatBox ( "Thankyou " .. getClientName(source) .. ", you're now registed, you can login with /login", source )
outputChatBox ( "Thank you " .. getClientName(source) .. ", you're now registed, you can login with /login", source )
else
else
--There was an error making the account, tell the user
-- There was an error making the account, tell the user
outputChatBox ( "Error Creating Account, Contact the server admin", source )
outputChatBox ( "Error creating account, contact the server admin", source )
end
end
else
else
--There was an error in the syntax, tell the user the correct syntax.
-- There was an error in the syntax, tell the user the correct syntax.
outputChatBox ( "Error Creating Account, correct syntax: /register <password>", source )
outputChatBox ( "Error creating account, correct syntax: /register <password>", source )
end
end
end
end
addCommandHandler ( "register", registerPlayer ) --add the command handler
addCommandHandler ( "register", registerPlayer ) -- add the command handler
</syntaxhighlight>
</syntaxhighlight>


Revision as of 14:58, 21 August 2007

This function adds an account to the list of registered accounts of the current server.

Syntax

bool addAccount ( string name, string pass, int level )

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.
  • level: The account level (see below for more detailed level values)

Level Notes: You may specify any level here, normally the account level is used for future use such as creating an admin system.

You can check the current player's access level with getClientLevel.

Returns

Returns true if the account was created, false if the account already exists or an error occured.

Example

In this example, it enables players to register on your server by using /register <password> in the chat window. 

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( getClientName(source), password, 0 )
		if ( accountAdded ) then
			--  Tell the user all is done
			outputChatBox ( "Thank you " .. getClientName(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

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/AddAccount?oldid=10825"