Territories

This script features a territory control system that uses points to determine which gang dominates a specific area. It uses GTA native zones; custom zones (or polyzones) are not supported. Points are gained or lost through various in-game events, you also have client exports you can trigger from your own scripts.

You can find a list of default events that triggers the add/removal of zone points in server/editable/_territories.lua I don't list them here to prevent any possible metagaming.

You can hide the left leaderboard in config/territories.lua

Territory Colors

Gangs can set their own territory color in Settings tab > Gang Color, this option will also change the UI color to match their gang style.

Exports

getZone()

Retrieves the gang that controls the zone where player is standing.
returns
result: string | false Gang name or false if the zone isn't controlled by any gang
local controlled = exports['av_gangs']:getZone()
print(controlled)

myZone()

Returns true if the current zone is controlled by the player gang or false.
returns
result:boolean
local myZone = exports['av_gangs']:myZone()
print(myZone)

addZoneXP(amount)

Add the desired points to the zone where the player is standing.
params:
amount:number Amount of points to add to zone.
local toAdd = 10
exports['av_gangs']:addZoneXP(toAdd) -- will add 10 points to current zone

removeZoneXP(amount)

Remove points to the zone where the player is standing.
params:
amount:number Amount of points to remove from zone
local toRemove = 5
exports['av_gangs']:removeZoneXP(toRemove) -- will remove 5 points to zone

Zone names can only be retrieved client side, here's a list of names: https://docs.fivem.net/natives/?_0xCD90657D4C30E1CA

addZonePoints(gang,zone,amount)

Add points for a gang to a specific zone.
params:
gang:string Gang name
zone:string Zone name
amount:number Amount of points to add to territory
returns
result:boolean
local gang = 'lossantosvagos'
local zone = 'DAVIS'
local amount = 10
local added = exports['av_gangs']:addZonePoints(gang,zone,amount)
print('added?', added)

removeZonePoints(gang,zone,amount)

Remove gang points from a territory.
params:
gang:string Gang name
zone:string Zone name
amount:number Amount of points to remove
returns:
result:boolean
local gang = "lossantosvagos"
local zone = "DAVIS"
local amount = 5
local removed = exports['av_gangs']:removeZonePoints(gang,zone,amount)
print('removed?', removed)

getZoneGang(zone)

Returns the gang with the most points in the zone.
params:
zone:string Zone name
returns:
gang:null | string Returns the gang name or null if zone does not exist or zone isn't controlled by anyone.
local zone = "VINE"
local topGang = exports['av_gangs']:getZoneGang(zone)
print('topGang?', topGang)

Last updated 2 months ago