GetPlayerUserName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Better see also template)
 
(6 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server function}}
{{Server client function}}
This function returns the community.mtasa.com (or mtabeta.com)-Account of the specified user.
{{MessageBox|
  bordercolorhex = FF0000 |
  bgcolorhex = FFBFBF |
  image = File:Emblem-important.png |
  message = This function is deprecated. This means that its use is discouraged. |
  subtext = MTA Community accounts were dropped in favor of [[serial|serials]] for identifying players. |
}}
 
This function returns the community.mtasa.com (or mtabeta.com) account of the specified user.


==Syntax==
==Syntax==
Line 9: Line 17:
</syntaxhighlight>  
</syntaxhighlight>  
===Required Arguments===  
===Required Arguments===  
*'''thePlayer:''' The Player whose MTA account username you want to retrieve
*'''thePlayer:''' The [[player]] whose MTA account username you want to retrieve.


===Returns===
===Returns===
Line 20: Line 28:
</syntaxhighlight>  
</syntaxhighlight>  
===Returns===
===Returns===
A ''string'' value containing the local MTA accounts username or ''false'' if no account exists for the local player.
A ''string'' value containing local player's MTA account username or ''false'' if no account exists for the local player.
</section>
</section>


==Example==
==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function outputMTAAccount ( sourcePlayer )
function outputMTAAccount ( sourcePlayer )
Line 29: Line 38:
         if ( sourcePlayer ) then
         if ( sourcePlayer ) then
                 local mtaaccount = getPlayerUserName( sourcePlayer )
                 local mtaaccount = getPlayerUserName( sourcePlayer )
                 if( mtaaccount ) then
                 if ( mtaaccount ) then
                         outputChatBox("Your community.mtasa.com-Account is " .. mtaaccount, sourcePlayer )
                         outputChatBox("Your community.mtasa.com account is " .. mtaaccount, sourcePlayer )
                 else
                 else
                         outputChatBox("Can't find an account for you.", sourcePlayer )
                         outputChatBox("Can't find an account for you.", sourcePlayer )
Line 39: Line 48:


-- register outputMTAAccount as a handler for the mta-account command
-- register outputMTAAccount as a handler for the mta-account command
addCommandHandler ( "mta-account", outputMTAAccount )
addCommandHandler ( "mtaaccount", outputMTAAccount )
</syntaxhighlight>
</syntaxhighlight>  
</section>
 
==See Also==
{{Player functions}}

Latest revision as of 17:04, 21 April 2016

Emblem-important.png This function is deprecated. This means that its use is discouraged.

MTA Community accounts were dropped in favor of serials for identifying players.

This function returns the community.mtasa.com (or mtabeta.com) account of the specified user.

Syntax

Click to collapse [-]
Server
string getPlayerUserName ( player thePlayer )

Required Arguments

  • thePlayer: The player whose MTA account username you want to retrieve.

Returns

A string value containing the MTA account username or false if no account exists for the player.

Click to collapse [-]
Client
string getPlayerUserName ()

Returns

A string value containing local player's MTA account username or false if no account exists for the local player.

Example

Click to collapse [-]
Server
function outputMTAAccount ( sourcePlayer )
        -- if the command was triggered by an ingame player
        if ( sourcePlayer ) then
                local mtaaccount = getPlayerUserName( sourcePlayer )
                if ( mtaaccount ) then
                        outputChatBox("Your community.mtasa.com account is " .. mtaaccount, sourcePlayer )
                else
                        outputChatBox("Can't find an account for you.", sourcePlayer )
                end
        end
end


-- register outputMTAAccount as a handler for the mta-account command
addCommandHandler ( "mtaaccount", outputMTAAccount )

See Also