AddAccount: Difference between revisions
Jump to navigation
Jump to search
SpawnBELARUS (talk | contribs) No edit summary |
(Setting back to no-russian crap) |
||
Line 1: | Line 1: | ||
{{Server function}} | {{Server function}} | ||
__NOTOC__ | __NOTOC__ | ||
This function adds an account to the list of registered accounts of the current server. | |||
== | ==Syntax== | ||
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd --> | <!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd --> | ||
{{New feature|3|1.0 r848| | {{New feature|3|1.0 r848| | ||
Line 16: | Line 16: | ||
}} | }} | ||
=== | ===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:''' | *'''name:''' The name of the account you wish to make, this normally is the player's name. | ||
*'''pass:''' | *'''pass:''' The password to set for this account for future logins. | ||
=== | ===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 --> | ||
{{New feature|3|1.0 r848| | {{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| | {{Deprecated_feature|3|1.0| | ||
Line 30: | Line 30: | ||
}} | }} | ||
== | ==Example== | ||
<section name="Server" class="server" show="true"> | <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"> | <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) | ||
if ( password ~= "" and password ~= nil ) then | if ( password ~= "" and password ~= nil ) then | ||
-- | --Attempt to add the account, and save its value in a var | ||
local accountAdded = addAccount( getPlayerName(source), password ) | local accountAdded = addAccount( getPlayerName(source), password ) | ||
if ( accountAdded ) then | if ( accountAdded ) then | ||
-- | -- Tell the user all is done | ||
outputChatBox ( " | outputChatBox ( "Thank you " .. getPlayerName(source) .. ", you're now registed, you can login with /login", source ) | ||
else | else | ||
-- | -- There was an error making the account, tell the user | ||
outputChatBox ( " | 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. | ||
outputChatBox ( " | outputChatBox ( "Error creating account, correct syntax: /register <password>", source ) | ||
end | end | ||
end | end | ||
addCommandHandler ( "register", registerPlayer ) -- | addCommandHandler ( "register", registerPlayer ) -- add the command handler | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 10:47, 14 May 2010
This function adds an account to the list of registered accounts of the current server.
Syntax
account addAccount ( string name, string pass )
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
Returns the account element if the account was created, false if the account already exists or an error occured.
Example
Click to collapse [-]
ServerExample 1: This 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( 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
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.
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
Example 3: This code differs again so the user can only register once /register <username> <password>.
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
See Also
- addAccount
- copyAccountData
- getAccount
- getAccountData
- getAccountName
- getAccountPlayer
- getAccountSerial
- getAccounts
- getAccountsBySerial
- getAllAccountData
- getPlayerAccount
- isGuestAccount
- logIn
- logOut
- removeAccount
- setAccountData
- setAccountPassword
- getAccountByID
- getAccountID
- getAccountIP
- getAccountsByData
- getAccountsByIP
- setAccountName