Client Events
Client Events
Section titled “Client Events”Add Zone
Section titled “Add Zone”Triggered when a new zone is created and should appear on the client
AddEventHandler('redzone:client:addZone', function(zoneData) -- a new zone was addedend)Event Data:
zoneData(table) - Serialized zone object
Update Zone
Section titled “Update Zone”Triggered when a zone’s data changes
AddEventHandler('redzone:client:updateZone', function(zoneData) -- zone was updatedend)Event Data:
zoneData(table) - Updated serialized zone object
Remove Zone
Section titled “Remove Zone”Triggered when a zone is removed
AddEventHandler('redzone:client:removeZone', function(zoneId) -- zone was removedend)Event Data:
zoneId(string | number) - ID of the removed zone
Set Zones
Section titled “Set Zones”Triggered on resource start to sync all active zones to the client
AddEventHandler('redzone:client:setZones', function(zones) -- initial zone syncend)Event Data:
zones(table) - Array of all active serialized zone objects
Leaderboard Update
Section titled “Leaderboard Update”Triggered to update the in-zone leaderboard HUD
AddEventHandler('redzone:client:leaderboardUpdate', function(leaderboard) -- leaderboard data updatedend)Event Data:
leaderboard(table) - Leaderboard payloadzoneId(string | number)players(table) - Sorted array of{ playerId, name, kills, deaths, streak }totalKills(number)durationType(string | nil) -'time'or'kills'duration(number)endTime(number | nil) - Unix timestamp (only fordurationType = 'time')currentPlayerId(number)
Zone End Results
Section titled “Zone End Results”Triggered when a zone ends, showing final results to players still in the area
AddEventHandler('redzone:client:zoneEndResults', function(results) -- zone endedend)Event Data:
results(table) - End results payloadzoneId(string | number)zoneName(string)topPlayers(table) - Top 10 players with{ playerId, name, kills, deaths, streak }totalKills(number)duration(number) - Total elapsed seconds