on_player_leave

on_player_leave(player)

An event which runs when a player leaves the game.

This function may only be called from within the events.lua file, and must be returned in a table at the end of the file.

The player parameter will be accessible for the duration of the function. However the player entity will be removed before any messages can be sent to it.

Parameters:

Name	Type	Description
player	Entity	The leaving player's entity.

Example:

When the player leaves, message a nearby entity.

-- events.lua
local function on_player_leave(player)
	local nearbyEntities = player:GetNearbyEntities(64)
	local msg_data = {
		player_id = player.ID, 
		from = {X=chunk.X, Y=chunk.Y}
	}
	
	api.entity.Message(nearbyEntities["1"].ID, msg_data)
end

-- entity_type_name.lua
local function message(self, msg)
	print("Player "..msg.Data.player_id.." has left. "..
		"They were at chunk: ("..msg.Data.from.X..","..msg.Data.from.Y..")")
end

-- Prints:
-- Player e2e838b4-a250-4a89-9f1d-acae063201b8 has left. They were at chunk (2,3)