Client

addSphere

Creates a spherical zone that detects when a player enters, exits, or stays inside.

Parameters

data table Zone configuration.

• coords vector3 Center position of the sphere.

• radius number Radius of the sphere.

• onEnter function Called once when the player enters the zone.

• onExit function Called once when the player leaves the zone.

• inside function Called repeatedly while the player is inside the zone.

Returns

zone table The created zone object.

Example

local zone = fjsf.addSphere({
    coords = vector3(200.0, -800.0, 30.0),
    radius = 5.0,
    onEnter = function(zone)
        print('Entered sphere zone', zone.id)
    end,
    inside = function(zone)
        print('Inside sphere zone')
    end,
    onExit = function(zone)
        print('Exited sphere zone')
    end
})

---

addCylinder

Creates a cylindrical zone with radius and height limits.

Parameters

data table Zone configuration.

• coords vector3 Center position of the cylinder.

• radius number Radius of the cylinder.

• height number Total height of the cylinder.

• onEnter function Called once when the player enters the zone.

• onExit function Called once when the player leaves the zone.

• inside function Called repeatedly while the player is inside the zone.

Returns

zone table The created zone object.

Example

local zone = fjsf.addCylinder({
    coords = vector3(250.0, -900.0, 35.0),
    radius = 4.0,
    height = 6.0,
    onEnter = function(zone)
        print('Entered cylinder')
    end,
    inside = function(zone)
        print('Inside cylinder')
    end,
    onExit = function(zone)
        print('Exited cylinder')
    end
})

---

addBox

Creates a box-shaped zone with optional rotation.

Parameters

data table Zone configuration.

• coords vector3 Center position of the box.

• size vector3 Width, length and height of the box.

• rotation number Rotation in degrees (Z axis).

• onEnter function Called once when the player enters the zone.

• onExit function Called once when the player leaves the zone.

• inside function Called repeatedly while the player is inside the zone.

Returns

zone table The created zone object.

Example

local zone = fjsf.addBox({
    coords = vector3(300.0, -1000.0, 30.0),
    size = vector3(6.0, 4.0, 3.0),
    rotation = 45,
    onEnter = function(zone)
        print('Entered box')
    end,
    inside = function(zone)
        print('Inside box')
    end,
    onExit = function(zone)
        print('Exited box')
    end
})

---

addPoly

Creates a polygon-shaped zone using multiple points.

Parameters

data table Zone configuration.

• points table<vector3> List of polygon corner points.

• thickness number Vertical thickness of the zone.

• onEnter function Called once when the player enters the zone.

• onExit function Called once when the player leaves the zone.

• inside function Called repeatedly while the player is inside the zone.

Returns

zone table The created zone object.

Example

local zone = fjsf.addPoly({
    points = {
        vector3(400.0, -1100.0, 30.0),
        vector3(410.0, -1100.0, 30.0),
        vector3(410.0, -1110.0, 30.0),
        vector3(400.0, -1110.0, 30.0),
    },
    thickness = 5.0,
    onEnter = function(zone)
        print('Entered poly')
    end,
    inside = function(zone)
        print('Inside poly')
    end,
    onExit = function(zone)
        print('Exited poly')
    end
})

---

removeZone

Removes an existing zone and stops all detection for it.

Parameters

zone table Zone object returned by one of the add functions.

Returns

Nothing.

Example

fjsf.removeZone(zone)

---

containsZone

Checks if specific coordinates are inside a zone.

Parameters

zone table Zone object.

coords vector3 World coordinates to check.

Returns

boolean true if the coordinates are inside the zone, otherwise false.

Example

local isInside = fjsf.containsZone(
    zone,
    GetEntityCoords(PlayerPedId())
)

print(isInside)