OnPlayerConnect: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Added, "Player has connected the Server")
m (I make test and now i know that source this event is getRootElement() Sorry for my bad English)
Line 16: Line 16:
''Extra parameter from 1.0.4 onwards:''
''Extra parameter from 1.0.4 onwards:''
*'''playerVersionString''': The player's MTA version in sortable string form. Same as the return value from [[getPlayerVersion]].
*'''playerVersionString''': The player's MTA version in sortable string form. Same as the return value from [[getPlayerVersion]].
==Source==
The [[event system#Event source|source]] of this event is the client's [[root element]].


==Cancel effect==
==Cancel effect==

Revision as of 00:05, 11 December 2010

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.

Extra parameter from 1.0.2 onwards:

  • playerVersionNumber: The player's MTA version in pure numerical form, e.g. '256' for 1.0, '257' for 1.0.1, etc.

Extra parameter from 1.0.4 onwards:

  • 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.

Example

Click to collapse [-]
Server

This example cancels connection attempts of people who use the nick "Player" or outputs some data about the connecting player otherwise. 

--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
addEventHandler ("onPlayerConnect", getRootElement(), playerConnect)


Click to collapse [-]
Server

This example cancels connection if player uses older MTA (older than 1.0.3) 

addEventHandler( "onPlayerConnect", getRootElement(),
    function ( _,_,_,_, clientVersion )
        if ( clientVersion < 259 ) then
            cancelEvent( true, "Update your MTA before you join this server!" );
        end
    end
)


Click to collapse [-]
Server

This example show the player in the Chatbox if connect the Server 

function playerConnect(playerNick, playerIP, playerUsername, playerSerial, playerVersionNumber)
    outputChatBox("* " .. playerNick .. " has connected the Server.", getRootElement(), 255, 100, 100, false)
    -- Show the Player Connect the Server, for all Users good
end
addEventHandler("onPlayerConnect", getRootElement(), playerConnect)

See Also

Player events


Event functions


Retrieved from "https://wiki.multitheftauto.com/wiki/OnPlayerConnect?oldid=24706"