OnPlayerJoin: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
(Improve example, fix memory leak.)
 
(17 intermediate revisions by 16 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
This event is triggered when a player joins the server.
{{Server event}}
This event is triggered when a player joins the server. This event is not cancellable.


==Syntax==
==Parameters==
<syntaxhighlight lang="lua">
No parameters.
void onPlayerJoin (  )
</syntaxhighlight>


==Parameters==
==Source==
The '''source''' of this event is the player who joined.
The source of this event is the [[player]] who joined.


==Example==
==Example==
Line 15: Line 14:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- we register greetPlayer as a handler for the event
-- we register greetPlayer as a handler for the event
addEventHandler ( "onPlayerJoin", getRootElement(), "greetPlayer" )
function greetPlayer ( )
function greetPlayer ( )
-- we store the player's name
-- we store the player's name
local joinedPlayerName = getClientName ( source )
local joinedPlayerName = getPlayerName ( source )
local serverName = getServerName( )
-- and send him a greeting
-- and send him a greeting
outputChatBox ( "Welcome " ..joinedPlayerName.. " to the server!" , source, 255, 255, 255 )
outputChatBox ( "Welcome " .. joinedPlayerName .. " to ".. serverName .."!" , source, 255, 255, 255 )
end
end
addEventHandler ( "onPlayerJoin", root, greetPlayer )
</syntaxhighlight>
This example sets random color to every player who joins.
<syntaxhighlight lang="lua">
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)
</syntaxhighlight>
<section name="Example 1" class="server" show="true">
This example redirects any player joins to the server automatically to any other server, add the script for admin group.
<syntaxhighlight lang="lua">
function Redirect()
redirectPlayer (source, "server ip", "server port")
end    --End function
addEventHandler("onPlayerJoin", root, Redirect)
</syntaxhighlight>
</syntaxhighlight>
</section>


==See also==
{{See also/Server event|Player events}}
{{Event functions}}

Latest revision as of 21:55, 18 February 2022

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

Parameters

No parameters.

Source

The source of this event is the player who joined.

Example

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 )

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)
Click to collapse [-]
Example 1

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


Event functions


Retrieved from "https://wiki.multitheftauto.com/wiki/OnPlayerJoin?oldid=74101"