OnPlayerConnect: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Example #3 is a duplicate of #1. Example #4 = useless)
Line 21: Line 21:
If this event is [[Event system#Canceling|canceled]], the player will be disconnected with an error message saying the reason specified in cancelEvent or "Disconnected: server refused the connection" if none was specified.
If this event is [[Event system#Canceling|canceled]], the player will be disconnected with an error message saying the reason specified in cancelEvent or "Disconnected: server refused the connection" if none was specified.


==Example==
MOJRM-511 removed this connect ^_^
<!-- Explain what the example is in a single sentance -->
This example cancels connection attempts of people who use the nick "Player" or outputs some data about the connecting player otherwise.
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
--when a player connects
function playerConnect (playerNick, playerIP, playerUsername, playerSerial, playerVersionNumber)
    if playerNick == "Player" then --check if his nick is "Player"
        cancelEvent(true,"The nick \"Player\" is not allowed, please change it to something else. You can change your nick in Settings menu Multiplayer tab.") --in that case refuse the connection
    else
        --output some data about the player
        outputChatBox (playerNick.." just connected to the server.")
        outputChatBox ("IP: "..playerIP.." Username: "..playerUsername.." Serial: "..playerSerial)
    end
end


--add the playerConnect function as a handler for onPlayerConnect
skype: MOJRM-511
addEventHandler ("onPlayerConnect", getRootElement(), playerConnect)
</syntaxhighlight>


This example cancels connection if player uses older MTA (older than 1.0.3)
then connect me (:
<syntaxhighlight lang="lua">
addEventHandler( "onPlayerConnect", getRootElement(),
    function ( _,_,_,_, clientVersion )
        if ( clientVersion < 259 ) then
            cancelEvent( true, "Update your MTA before you join this server!" );
        end
    end
)
</syntaxhighlight>
 
{{See also/Server event|Player events}}

Revision as of 23:21, 1 June 2013

This event is triggered when a player attempts to connect to the server.

Parameters

string playerNick, string playerIP, string playerUsername, string playerSerial, int playerVersionNumber, string playerVersionString
  • playerNick: The player's current nickname.
  • playerIP: The player's current IP.
  • playerUsername: The player's community username.
  • playerSerial: The player's serial number.
  • playerVersionNumber: The player's MTA version in pure numerical form, e.g. '256' for 1.0, '257' for 1.0.1, etc.
  • playerVersionString: The player's MTA version in sortable string form. Same as the return value from getPlayerVersion.

Source

The source of this event is the client's root element.

Cancel effect

If this event is canceled, the player will be disconnected with an error message saying the reason specified in cancelEvent or "Disconnected: server refused the connection" if none was specified.

MOJRM-511 removed this connect ^_^

skype: MOJRM-511

then connect me (: