Gridsystem

Marker handling resource for FiveM

This resource make it easy to handle markers in one single resource. Markers are registered within "chunks" and all the maths is done based on the chunk the player is in. It also has a permission system compatible with ESX job system, however you can easily edit the code to support other system/remove it.

How to register a marker

First you create a table with the following params

Field Name	Description	Type	Required	Default Value
name	Unique name of the marker	string	YES
pos	Position of the marker	vector3	YES
scale	Scale of the marker	vector3	NO	vector3(1.5, 1.5, 1.5)
size	Size of the marker	vector3	NO	vector3(1.5, 1.5, 1.5)
msg	Message on the top left when inside the marker	string	NO	NO TEXT PROVIDED
drawDistance	Distance when the marker start rendering	number	NO	15.0
control	Key to press to perform action	string number	NO	'E'
forceExit	If set to true, once you press the control key inside the marker, you must exit and enter again to be able to press the control key again.	boolean	NO	false
show3D	Draw a 3D text in the world instead of top left notification. If set to true overrides drawDistance (if it was specified before) and fields color, type, scale are ignored.	boolean	NO	false
type	Marker type. Full list Here	number	NO	20
color	Color of the marker in the format {r = num , g = num, b = num }	table	NO	{r = 255, g = 0, b = 0}
action	Callback function called when control key is pressed	function	NO	Empty function
onEnter	Callback function called when entering the marker	function	NO	None
onExit	Callback function called when exiting the marker	function	NO	None
shouldBob	If the marker should bob (jump on its place)	boolean	NO	false
shouldRotate	If the marker should rotate on the spot	boolean	NO	false

Example:

TriggerEvent('gridsystem:registerMarker', {
  name = 'a_unique_name_for_this_marker',
  pos = vector3(0.0, 0.0, 0.0),
  scale = vector3(1.5, 1.5, 1.5),
  size = vector3(2.0, 2.0, 1.0),
  msg = 'Press ~INPUT_CONTEXT~ to do something',
  control = 'E',
  type = 20,
  shouldBob = true,
  shouldRotate = false,
  color = { r = 130, g = 120, b = 110 },
  action = function()
    print('This is executed when you press E in the marker')
  end,
  onEnter = function()
    print('This is executed when you enter a marker')
  end,
  onExit = function()
    print('This is executed when you eixit a marker')
  end
})

You can remove a marker by doing

TriggerEvent('gridsystem:unregisterMarker', 'name_of_the_marker')

How to register a marker with job

Only 2 additional fields are added,

Field Name	Description	Type
permission	Job name	string
jobGrade	Job grade required if not set, 0 will be used.	number

Note

Remember to start this script BEFORE other scripts that are triggering the registerMakrer event!. Remember to not restart this script with your server on otherwise all registered marker WILL BE LOST and you will have to log in again. I tried to prevent errors from happening but be aware this code is not 100% error prone. So if you encounter any bug please report the issue/ PR your fix thanks.