File:SetVehicleDirtEnabled-true.png

2026-01-01T18:46:09Z

IManGaaX:

2025-11-10T19:56:52Z

IManGaaX: correct mistakes

{{Useful Function}}
<lowercasetitle></lowercasetitle> __NOTOC__
This code implements an [[event]] that is triggered when the [[player]] enters a new area on the map.

==Parameters==
<syntaxhighlight lang="lua">
string oldZone, string newZone
</syntaxhighlight>
*'''oldZone:''' old zone of [[player]].
*'''newZone:''' new zone of [[player]].

==Source==
The [[event system#Event source|source]] of this event is the player whose zone was changed.

==Code==
<section name="Shared" class="both" show="true">
<syntaxhighlight lang="lua">
local playersZone = {}
local zoneEventName = (localPlayer and "onClientPlayerZoneChange" or "onPlayerZoneChange") -- client = "onClientPlayerZoneChange" — server = "onPlayerZoneChange"
local zoneCitiesOnly = false -- only major cities?

local function checkPlayersZone()
local playersTable = getElementsByType("player")

for playerID = 1, #playersTable do
local playerElement = playersTable[playerID]
local playerX, playerY, playerZ = getElementPosition(playerElement)
local playerZoneNow = getZoneName(playerX, playerY, playerZ, zoneCitiesOnly)
local playerZoneSaved = playersZone[playerElement]
local playerZoneNeedsUpdate = (playerZoneSaved and playerZoneSaved ~= playerZoneNow)

if (playerZoneNeedsUpdate) then
triggerEvent(zoneEventName, playerElement, playerZoneSaved, playerZoneNow)
end

playersZone[playerElement] = playerZoneNow
end
end
addEvent(zoneEventName, false) -- disable remote triggering so players couldn't trigger this event on server (& vice-versa)
setTimer(checkPlayersZone, 1000, 0)

local function clearPlayersZone()
playersZone[source] = nil
end
addEventHandler(localPlayer and "onClientPlayerQuit" or "onPlayerQuit", root, clearPlayersZone)
</syntaxhighlight>
</section>

'''Author:''' [[User:IManGaaX|Youssef Maged (iManGaaX)]]

==Examples==
This example will make label with the full zone name of the player, '''onPlayerZoneChange''' is function is change the label text to new zone when the player enter a new zone.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local myCurrentZoneLabel

addEventHandler("onClientResourceStart", resourceRoot, function()
local px, py, pz = getElementPosition(localPlayer)
local firstZone = getZoneName(px, py, pz)
myCurrentZoneLabel = guiCreateLabel(0, 0, 0.20, 0.02, firstZone, true)
end)

addEventHandler("onClientPlayerZoneChange", root, function(_, newZone)
if (source == localPlayer) then
guiSetText(myCurrentZoneLabel, newZone)
end
end)
</syntaxhighlight>
</section>
This example will out put in the chat the new zone full name when the player enter a new zone.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addEventHandler("onPlayerZoneChange", root, function(oldZone, newZone)
outputChatBox("Your Zone is Changed from "..(oldZone).." to "..(newZone)..".", source, 255, 255, 0)
end)
</syntaxhighlight>
</section>

==See Also==

{{Useful_Functions}}