onPlayerConnect | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

onPlayerConnect

Client-side
Server-side
Shared

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

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

Canceling

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.

Code Examples

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)
  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.')
    return
  end
  -- output some data about the player
  outputChatBox(playerNick.." just connected to the server.")
  outputChatBox("IP: "..playerIP.." / Username: "..playerUsername.." / Serial: "..playerSerial)
end


--add the playerConnect function as a handler for onPlayerConnect
addEventHandler("onPlayerConnect", root, playerConnect)

See Also

Player Events
Player Functions
Reference