This event is triggered when a player joins the server. This event is not cancellable.

Parameters

This event does not pass any parameters to the handler function.

Source

element: The source of this event is the player who joined.

Code Examples

Example 1 Example 2 Example 3

server

This example gets the joined client's name and sends him a welcome message including his name.

-- we register greetPlayer as a handler for the event
function greetPlayer ( )
  -- we store the player's name
  local joinedPlayerName = getPlayerName ( source )
  local serverName = getServerName( )
  -- and send him a greeting
  outputChatBox ( "Welcome " .. joinedPlayerName .. " to ".. serverName .."!" , source, 255, 255, 255 )
end
addEventHandler ( "onPlayerJoin", root, greetPlayer )

server

This example sets random color to every player who joins.

local chatColors = {} -- Create a table to save the color

function onPlayerJoin()
  -- Create a table to add rgb values, index will be the player element

  chatColors[source] = {math.random(50, 255), math.random (50, 255), math.random (50, 255)}
end
addEventHandler("onPlayerJoin", root, onPlayerJoin)

function onPlayerChat(playerMessage, messageType)
  local normalMessage = messageType == 0

  if not normalMessage then
    return false -- If it's not normal type message, cancel code execution
  end

  local playerName = getPlayerName(source) -- Get player name
  local playerColors = chatColors[source] -- Get player stored colors
  local colorR, colorG, colorB = playerColors[1], playerColors[2], playerColors[3] -- Store them into different variables

  outputChatBox(playerName..": #E0D0B0"..playerMessage, root, colorR, colorG, colorB, true) -- Output our message
  cancelEvent()
end
addEventHandler("onPlayerChat", root, onPlayerChat)

function onPlayerQuit()
  chatColors[source] = nil -- Clear stored data to avoid memory leaks
end
addEventHandler("onPlayerQuit", root, onPlayerQuit)

server

This example redirects any player joins to the server automatically to any other server, add the script for admin group.

function Redirect()
redirectPlayer (source, "server ip", "server port")
end    --End function
addEventHandler("onPlayerJoin", root, Redirect)

See Also

Player Events

• onClientPlayerChangeNick
• onClientPlayerDamage
• onClientPlayerChoke
• onClientPlayerHeliKilled
• onClientPlayerJoin
• onClientPlayerPickupLeave
• onClientPlayerQuit
• onClientPlayerPickupHit
• onClientPlayerRadioSwitch
• onClientPlayerHitByWaterCannon
• onClientPlayerSpawn
• onClientPlayerStealthKill
• onClientPlayerStuntFinish
• onClientPlayerStuntStart
• onClientPlayerVehicleEnter
• onClientPlayerTarget
• onClientPlayerVehicleExit
• onClientPlayerVoiceResumed
• onClientPlayerVoicePause
• onClientPlayerVoiceStart
• onClientPlayerVoiceStop
• onClientPlayerWasted
• onClientPlayerWeaponFire
• onClientPlayerWeaponSwitch
• onPlayerACInfo
• onPlayerBan
• onPlayerChangeNick
• onPlayerChangesProtectedData
• onPlayerChangesWorldSpecialProperty
• onPlayerChat
• onPlayerClick
• onPlayerCommand
• onPlayerConnect
• onPlayerContact
• onPlayerDamage
• onPlayerDiscordJoin
• onPlayerLogin
• onPlayerLogout
• onPlayerDetonateSatchels
• onPlayerMarkerHit
• onPlayerMarkerLeave
• onPlayerJoin
• onPlayerModInfo
• onPlayerMute
• onPlayerNetworkStatus
• onPlayerPickupUse
• onPlayerPickupLeave
• onPlayerPickupHit
• onPlayerProjectileCreation
• onPlayerPrivateMessage
• onPlayerScreenShot
• onPlayerQuit
• onPlayerSpawn
• onPlayerStealthKill
• onPlayerTarget
• onPlayerTeamChange
• onPlayerTeleport
• onPlayerTriggerEventThreshold
• onPlayerTriggerInvalidEvent
• onPlayerUnmute
• onPlayerVehicleExit
• onPlayerVehicleEnter
• onPlayerVoiceStart
• onPlayerVoiceStop
• onPlayerWasted
• onPlayerWeaponFire
• onPlayerWeaponReload
• onPlayerWeaponSwitch

Player Functions

• countPlayersInTeam
• forcePlayerMap
• getControlState
• getPlayerBlurLevel
• getPlayerFromName
• getPlayerMoney
• getPlayerName
• getPlayerNametagColor
• getPlayerNametagText
• getPlayerPing
• getPlayerScriptDebugLevel
• getPlayerSerial
• getPlayerTeam
• getPlayerWantedLevel
• getPlayersInTeam
• givePlayerMoney
• isPlayerMapForced
• isPlayerNametagShowing
• isVoiceEnabled
• setControlState
• setPlayerBlurLevel
• setPlayerHudComponentVisible
• setPlayerMoney
• setPlayerNametagColor
• setPlayerNametagShowing
• setPlayerNametagText
• takePlayerMoney
• getLocalPlayer
• getPlayerHudComponentProperty
• getPlayerMapBoundingBox
• getPlayerMapOpacity
• isPlayerCrosshairVisible
• isPlayerHudComponentVisible
• isPlayerMapVisible
• resetBlurLevel
• resetPlayerHudComponentProperty
• setPlayerHudComponentProperty
• getAlivePlayers
• getDeadPlayers
• getPlayerACInfo
• getPlayerAnnounceValue
• getPlayerCount
• getPlayerIP
• getPlayerIdleTime
• getPlayerVersion
• getRandomPlayer
• isPlayerMuted
• redirectPlayer
• resendPlayerACInfo
• resendPlayerModInfo
• setPlayerAnnounceValue
• setPlayerMuted
• setPlayerName
• setPlayerScriptDebugLevel
• setPlayerTeam
• setPlayerVoiceBroadcastTo
• setPlayerVoiceIgnoreFrom
• setPlayerWantedLevel
• spawnPlayer
• takePlayerScreenShot

Reference

• Scripting Events