GetAccountName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
m (Edited language change)
Tag: Manual revert
 
(30 intermediate revisions by 21 users not shown)
Line 1: Line 1:
[[Category:Incomplete]]
{{Server function}}
[[Category:Need Syntax]]
__NOTOC__
 
This function retrieves the name of an [[account]].
__NOTOC__
This function is for blahblah.. not defined yet


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
INSERT SYNTAX HERE             
string getAccountName ( account theAccount )
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[account]]:getName|name|}}
===Required Arguments===  
===Required Arguments===  
*'''argumentName:''' description
*'''theAccount:''' The account you wish to get the name of.
 
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' descriptiona
*'''argumentName3:''' description


===Returns===
===Returns===
Returns ''true'' if blah, ''false'' otherwise.
Returns a string containing the account's name, ''false'' if the account does not exist or an invalid argument was passed to the function.


==Example==  
==Example==  
This example does...
This example announces into the console when a player logs into his account.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
function outputOnLogin ( previous_account, current_account, auto_login ) --when a player logs in
blabhalbalhb --abababa
outputConsole(getAccountName(previous_account).." Logged into "..getAccountName(current_account)) -- announce it into the console
--This line does this...
end
mooo
addEventHandler("onPlayerLogin",root,outputOnLogin ) --add an event handler
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{FunctionArea_Functions}}
{{Account_functions}}
 
[[ru:getAccountName]]
[[es:getAccountName]]
[[ar:getAccountName]]
[[pl:GetAccountName]]
[[zh-cn:GetAccountName]]

Latest revision as of 15:16, 8 June 2022

This function retrieves the name of an account.

Syntax

string getAccountName ( account theAccount )

OOP Syntax Help! I don't understand this!

Method: account:getName(...)
Variable: .name


Required Arguments

  • theAccount: The account you wish to get the name of.

Returns

Returns a string containing the account's name, false if the account does not exist or an invalid argument was passed to the function.

Example

This example announces into the console when a player logs into his account.

function outputOnLogin ( previous_account, current_account, auto_login ) --when a player logs in
	outputConsole(getAccountName(previous_account).." Logged into "..getAccountName(current_account)) -- announce it into the console
end
addEventHandler("onPlayerLogin",root,outputOnLogin ) --add an event handler

See Also