Points

The points system lets you define coordinate-based trigger zones. When a player enters, exits, or stays near a point, callbacks fire automatically.

---

Creating a Point

local point = KOJA.Client.points.new(properties)

Properties

Field	Type	Required	Description
coords	vector3	Yes	Centre of the zone
distance	number	Yes	Radius in metres
onEnter	function(self)	No	Called once when the player enters the zone
onExit	function(self)	No	Called once when the player exits the zone
nearby	function(self)	No	Called repeatedly (every ~300 ms) while the player is inside

Any additional fields you add become properties of the point object and are accessible in callbacks via self.

Returns CPoint — the point object.

---

Point Object

Property / Method	Description
point.id	Unique numeric ID
point.coords	vector3 position
point.distance	Radius
point.currentDistance	Distance from the player right now (only set when nearby)
point.isClosest	true when this is the closest active point
point:remove()	Removes the point and clears all callbacks

---

Examples

Simple Enter/Exit

local atm = KOJA.Client.points.new({
    coords   = vector3(100.0, 200.0, 30.0),
    distance = 2.0,

    onEnter = function(self)
        print('Near ATM')
    end,

    onExit = function(self)
        print('Left ATM')
    end,
})

Recurring Nearby Check

KOJA.Client.points.new({
    coords   = vector3(100.0, 200.0, 30.0),
    distance = 10.0,

    nearby = function(self)
        -- runs every ~300 ms while the player is within 10 m
        DrawMarker(1, self.coords.x, self.coords.y, self.coords.z, ...)
    end,
})

Custom Properties

local shop = KOJA.Client.points.new({
    coords    = vector3(25.0, -1335.0, 29.5),
    distance  = 3.0,
    shopType  = 'weapons',   -- custom field

    onEnter = function(self)
        print('Entered shop type:', self.shopType)
    end,
})

Removing a Point

local point = KOJA.Client.points.new({ ... })

-- later:
point:remove()

---

Static Methods

-- All registered points
local all = KOJA.Client.points.getAllPoints()

-- Points within their distance radius of the player right now
local nearby = KOJA.Client.points.getNearbyPoints()

-- The single closest point to the player
local closest = KOJA.Client.points.getClosestPoint()

---

SetInterval / ClearInterval

The points module also exposes interval helpers for recurring tasks.

local id = SetInterval(function()
    -- runs every 1000 ms
end, 1000)

-- Update the interval without stopping it
SetInterval(id, 2000)

-- Stop it
ClearInterval(id)

---

Resource Cleanup

Points created by a resource are automatically removed when that resource stops. No manual cleanup is needed.