Commands and Exports — Safezone Creator | Quasar Store

Commands#

Safezone Creator registers a single command. Everything else is done in the creator it opens.

Command	Where	Description
`/safezonecreator`	In game	Opens the creator. Framework admins and the jobs in `Config.CreatorJobs` only — anybody else is told they do not have permission. The check is made on the server every time, and again on every save and delete.

There is no console command and no default keybind: zones are drawn in the world, so the creator needs a player in game. Who may open it is covered in Installation.

Client Events#

Safezone Creator does not need exports to be driven from your scripts: it tells them what is happening. Two client events fire on the player's own machine as they cross a zone's border, each carrying the zone — its full data, described below. Use them to hide a HUD, pause a job, stop a robbery from starting, or refuse any action of your own inside a safe zone.

safezone:enteredZone

Fired once when the player walks, drives or falls into a safe zone.

lua

AddEventHandler('safezone:enteredZone', function(zone)
    print(('Entered safe zone %s (#%s)'):format(zone.label, zone.id))
end)

safezone:leftZone

Fired once when the player leaves it.

lua

AddEventHandler('safezone:leftZone', function(zone)
    print(('Left safe zone %s'):format(zone.label))
end)

Example: is the player in a safe zone?

Zones can overlap, so count entries rather than keeping a single true/false — otherwise leaving one zone while still standing in another reads as being outside.

lua

local zonesInside = 0

AddEventHandler('safezone:enteredZone', function()
    zonesInside = zonesInside + 1
end)

AddEventHandler('safezone:leftZone', function()
    zonesInside = math.max(zonesInside - 1, 0)
end)

function IsInSafeZone()
    return zonesInside > 0
end

-- in your own action
if IsInSafeZone() then
    return lib.notify({ type = 'error', description = 'You cannot do that in a safe zone.' })
end

The Zone Object#

What both events receive — the zone as it was saved in the creator:

Field	Type	Holds
`id`	number	The zone's number in the database.
`label`	string	Its name.
`zone.points`	table	The corners, each with `x`, `y` and `z`.
`zone.thickness`	number	The zone's height, in metres.
`blip`	table	`enable`, `label`, `sprite`, `color`, `scale` and `coords`.
`heal_on_enter`	boolean	Whether the zone heals.
`show_area`	boolean	Whether its outline is drawn in the world.
`enable_notification`	boolean	Whether players are told they entered and left.
`vehicle_speed_limit_kmh`	number	The speed limit; `0` when there is none.
`job` · `job_grades`	table · table	The exempt jobs, and their exempt grades keyed by job name. `nil` when none.
`gang` · `gang_grades`	string · table	The exempt gang and its exempt grades. `nil` when none.
`bypass_items`	table	The weapon names anybody may use inside. `nil` when none.

Network Events#

The server keeps every client's copy of the zones up to date with these events. They are listed so you recognise them in a log — not to be triggered by hand.

Event	Direction	Sent when
`safezone:playerConnected`	Client → server	The player's interface has loaded; it asks for the zones.
`safezone:setZones`	Server → client	The answer: every zone on the server.
`safezone:addZone`	Server → all clients	A zone was created.
`safezone:updateZone`	Server → all clients	A zone was edited.
`safezone:removeZone`	Server → all clients	A zone was deleted. Carries the zone's id.
`safezone:notification`	Server → client	The server shows a player a message.

A client script of yours can also listen to safezone:setZones, safezone:addZone, safezone:updateZone and safezone:removeZone with RegisterNetEvent to keep its own list of where the safe zones are — to draw them on a custom map, for example.

Commands#

Safezone Creator registers a single command. Everything else is done in the creator it opens.

Command	Where	Description
`/safezonecreator`	In game	Opens the creator. Framework admins and the jobs in `Config.CreatorJobs` only — anybody else is told they do not have permission. The check is made on the server every time, and again on every save and delete.

There is no console command and no default keybind: zones are drawn in the world, so the creator needs a player in game. Who may open it is covered in Installation.

Client Events#

safezone:enteredZone

Fired once when the player walks, drives or falls into a safe zone.

lua

AddEventHandler('safezone:enteredZone', function(zone)
    print(('Entered safe zone %s (#%s)'):format(zone.label, zone.id))
end)

safezone:leftZone

Fired once when the player leaves it.

lua

AddEventHandler('safezone:leftZone', function(zone)
    print(('Left safe zone %s'):format(zone.label))
end)

Example: is the player in a safe zone?

Zones can overlap, so count entries rather than keeping a single true/false — otherwise leaving one zone while still standing in another reads as being outside.

lua

local zonesInside = 0

AddEventHandler('safezone:enteredZone', function()
    zonesInside = zonesInside + 1
end)

AddEventHandler('safezone:leftZone', function()
    zonesInside = math.max(zonesInside - 1, 0)
end)

function IsInSafeZone()
    return zonesInside > 0
end

-- in your own action
if IsInSafeZone() then
    return lib.notify({ type = 'error', description = 'You cannot do that in a safe zone.' })
end

The Zone Object#

What both events receive — the zone as it was saved in the creator:

Field	Type	Holds
`id`	number	The zone's number in the database.
`label`	string	Its name.
`zone.points`	table	The corners, each with `x`, `y` and `z`.
`zone.thickness`	number	The zone's height, in metres.
`blip`	table	`enable`, `label`, `sprite`, `color`, `scale` and `coords`.
`heal_on_enter`	boolean	Whether the zone heals.
`show_area`	boolean	Whether its outline is drawn in the world.
`enable_notification`	boolean	Whether players are told they entered and left.
`vehicle_speed_limit_kmh`	number	The speed limit; `0` when there is none.
`job` · `job_grades`	table · table	The exempt jobs, and their exempt grades keyed by job name. `nil` when none.
`gang` · `gang_grades`	string · table	The exempt gang and its exempt grades. `nil` when none.
`bypass_items`	table	The weapon names anybody may use inside. `nil` when none.

Network Events#

The server keeps every client's copy of the zones up to date with these events. They are listed so you recognise them in a log — not to be triggered by hand.

Event	Direction	Sent when
`safezone:playerConnected`	Client → server	The player's interface has loaded; it asks for the zones.
`safezone:setZones`	Server → client	The answer: every zone on the server.
`safezone:addZone`	Server → all clients	A zone was created.
`safezone:updateZone`	Server → all clients	A zone was edited.
`safezone:removeZone`	Server → all clients	A zone was deleted. Carries the zone's id.
`safezone:notification`	Server → client	The server shows a player a message.

A client script of yours can also listen to safezone:setZones, safezone:addZone, safezone:updateZone and safezone:removeZone with RegisterNetEvent to keep its own list of where the safe zones are — to draw them on a custom map, for example.

Commands#

Safezone Creator registers a single command. Everything else is done in the creator it opens.

Command	Where	Description
`/safezonecreator`	In game	Opens the creator. Framework admins and the jobs in `Config.CreatorJobs` only — anybody else is told they do not have permission. The check is made on the server every time, and again on every save and delete.

There is no console command and no default keybind: zones are drawn in the world, so the creator needs a player in game. Who may open it is covered in Installation.

Client Events#

safezone:enteredZone

Fired once when the player walks, drives or falls into a safe zone.

lua

AddEventHandler('safezone:enteredZone', function(zone)
    print(('Entered safe zone %s (#%s)'):format(zone.label, zone.id))
end)

safezone:leftZone

Fired once when the player leaves it.

lua

AddEventHandler('safezone:leftZone', function(zone)
    print(('Left safe zone %s'):format(zone.label))
end)

Example: is the player in a safe zone?

Zones can overlap, so count entries rather than keeping a single true/false — otherwise leaving one zone while still standing in another reads as being outside.

lua

local zonesInside = 0

AddEventHandler('safezone:enteredZone', function()
    zonesInside = zonesInside + 1
end)

AddEventHandler('safezone:leftZone', function()
    zonesInside = math.max(zonesInside - 1, 0)
end)

function IsInSafeZone()
    return zonesInside > 0
end

-- in your own action
if IsInSafeZone() then
    return lib.notify({ type = 'error', description = 'You cannot do that in a safe zone.' })
end

The Zone Object#

What both events receive — the zone as it was saved in the creator:

Field	Type	Holds
`id`	number	The zone's number in the database.
`label`	string	Its name.
`zone.points`	table	The corners, each with `x`, `y` and `z`.
`zone.thickness`	number	The zone's height, in metres.
`blip`	table	`enable`, `label`, `sprite`, `color`, `scale` and `coords`.
`heal_on_enter`	boolean	Whether the zone heals.
`show_area`	boolean	Whether its outline is drawn in the world.
`enable_notification`	boolean	Whether players are told they entered and left.
`vehicle_speed_limit_kmh`	number	The speed limit; `0` when there is none.
`job` · `job_grades`	table · table	The exempt jobs, and their exempt grades keyed by job name. `nil` when none.
`gang` · `gang_grades`	string · table	The exempt gang and its exempt grades. `nil` when none.
`bypass_items`	table	The weapon names anybody may use inside. `nil` when none.

Network Events#

The server keeps every client's copy of the zones up to date with these events. They are listed so you recognise them in a log — not to be triggered by hand.

Event	Direction	Sent when
`safezone:playerConnected`	Client → server	The player's interface has loaded; it asks for the zones.
`safezone:setZones`	Server → client	The answer: every zone on the server.
`safezone:addZone`	Server → all clients	A zone was created.
`safezone:updateZone`	Server → all clients	A zone was edited.
`safezone:removeZone`	Server → all clients	A zone was deleted. Carries the zone's id.
`safezone:notification`	Server → client	The server shows a player a message.

A client script of yours can also listen to safezone:setZones, safezone:addZone, safezone:updateZone and safezone:removeZone with RegisterNetEvent to keep its own list of where the safe zones are — to draw them on a custom map, for example.

Commands#

Safezone Creator registers a single command. Everything else is done in the creator it opens.

Command	Where	Description
`/safezonecreator`	In game	Opens the creator. Framework admins and the jobs in `Config.CreatorJobs` only — anybody else is told they do not have permission. The check is made on the server every time, and again on every save and delete.

There is no console command and no default keybind: zones are drawn in the world, so the creator needs a player in game. Who may open it is covered in Installation.

Client Events#

safezone:enteredZone

Fired once when the player walks, drives or falls into a safe zone.

lua

AddEventHandler('safezone:enteredZone', function(zone)
    print(('Entered safe zone %s (#%s)'):format(zone.label, zone.id))
end)

safezone:leftZone

Fired once when the player leaves it.

lua

AddEventHandler('safezone:leftZone', function(zone)
    print(('Left safe zone %s'):format(zone.label))
end)

Example: is the player in a safe zone?

Zones can overlap, so count entries rather than keeping a single true/false — otherwise leaving one zone while still standing in another reads as being outside.

lua

local zonesInside = 0

AddEventHandler('safezone:enteredZone', function()
    zonesInside = zonesInside + 1
end)

AddEventHandler('safezone:leftZone', function()
    zonesInside = math.max(zonesInside - 1, 0)
end)

function IsInSafeZone()
    return zonesInside > 0
end

-- in your own action
if IsInSafeZone() then
    return lib.notify({ type = 'error', description = 'You cannot do that in a safe zone.' })
end

The Zone Object#

What both events receive — the zone as it was saved in the creator:

Field	Type	Holds
`id`	number	The zone's number in the database.
`label`	string	Its name.
`zone.points`	table	The corners, each with `x`, `y` and `z`.
`zone.thickness`	number	The zone's height, in metres.
`blip`	table	`enable`, `label`, `sprite`, `color`, `scale` and `coords`.
`heal_on_enter`	boolean	Whether the zone heals.
`show_area`	boolean	Whether its outline is drawn in the world.
`enable_notification`	boolean	Whether players are told they entered and left.
`vehicle_speed_limit_kmh`	number	The speed limit; `0` when there is none.
`job` · `job_grades`	table · table	The exempt jobs, and their exempt grades keyed by job name. `nil` when none.
`gang` · `gang_grades`	string · table	The exempt gang and its exempt grades. `nil` when none.
`bypass_items`	table	The weapon names anybody may use inside. `nil` when none.

Network Events#

The server keeps every client's copy of the zones up to date with these events. They are listed so you recognise them in a log — not to be triggered by hand.

Event	Direction	Sent when
`safezone:playerConnected`	Client → server	The player's interface has loaded; it asks for the zones.
`safezone:setZones`	Server → client	The answer: every zone on the server.
`safezone:addZone`	Server → all clients	A zone was created.
`safezone:updateZone`	Server → all clients	A zone was edited.
`safezone:removeZone`	Server → all clients	A zone was deleted. Carries the zone's id.
`safezone:notification`	Server → client	The server shows a player a message.

A client script of yours can also listen to safezone:setZones, safezone:addZone, safezone:updateZone and safezone:removeZone with RegisterNetEvent to keep its own list of where the safe zones are — to draw them on a custom map, for example.

Commands andExports

Commands#

Client Events#

The Zone Object#

Network Events#

Commands andExports

Commands#

Client Events#

The Zone Object#

Network Events#

Commands andExports

Commands#

Client Events#

The Zone Object#

Network Events#

Commands andExports

Commands#

Client Events#

The Zone Object#

Network Events#