gfx-pilotjob

Info

Dependencies

Installation

1. Copy Files

Place the gfx-pilotjob folder into your server's resources directory.

2. server.cfg

ensure gfx-pilotjob

3. Configure Framework

Open config.lua and set GFX.Framework to your framework:

GFX.Framework = "qb" -- "esx" or "qb"

Configuration

All configuration is done in config.lua via the GFX table.

General Settings

Reward Function

A custom function to handle reward distribution. By default it is empty and the script uses the built-in AddMoney function. You can override it for custom reward logic:

GFX.Reward = function(source, missionId, xPlayer)
    -- Example: xPlayer.Functions.AddMoney("cash", reward)
end

Missions

Missions are defined in GFX.Missions as a numbered table. Each mission has the following structure:

Default missions:

Locales

All user-facing text is defined in GFX.Locales:

Hook Files

The script provides two hook files for framework-specific customization:

• client/client_hook.lua -- Contains client-side framework integration: Notify(), DrawText3D(), AddVehicleKey(), and the police alert handler. Modify AddVehicleKey to match your vehicle keys resource.
• server/server_hook.lua -- Contains server-side framework integration: Notify(), GetPlayerFromId(), GetIdentifier(), GetPlayersAll(), GetJob(), GetSource(), AddMoney(). Modify these functions if using a non-standard framework setup.

Exports

No exports are created by this script.

Events

Public API events that other scripts can listen to or trigger.

Client Events

gfx-pilotjob:client:CallCops

Triggered on police players' clients when an illegal mission starts. Displays a blip and chat alert.

-- Parameters:
-- coords (vector3) - Location of the illegal flight activity
-- msg (string) - Alert message text

RegisterNetEvent('gfx-pilotjob:client:CallCops', function(coords, msg)
    -- Creates a fading radius blip at the coords
    -- Sends a chat message with the alert
end)

missionFailed

Triggered when a mission fails. Cleans up checkpoints and notifies the player.

-- Parameters:
-- vehicle (entity) - The mission vehicle entity

RegisterNetEvent('missionFailed', function(vehicle)
    -- Stops the mission and cleans up markers
end)

Server Events

gfx-pilotjob:server:CallCops

Triggered by the client when an illegal mission starts. Broadcasts the alert to all online police players.

-- Parameters:
-- coords (vector3) - Location of the illegal flight activity

TriggerServerEvent("gfx-pilotjob:server:CallCops", coords)

gfx-pilotjob:explodePlane

Triggered when a plane needs to be destroyed (crash, flying too low, or vehicle health reaches zero).

-- Parameters:
-- planeNetId (number) - Network ID of the plane entity

TriggerServerEvent('gfx-pilotjob:explodePlane', planeNetId)

gfx-pilotjob:deleteVehicle

Triggered when a mission vehicle needs to be cleaned up (e.g. player disconnect).

-- Parameters:
-- vehicleNetId (number) - Network ID of the vehicle entity

TriggerEvent('gfx-pilotjob:deleteVehicle', vehicleNetId)

gfx:server:UpdateCountAndGiveReward

Triggered when a player completes a mission. Increments flight count and pays the reward.

-- Parameters:
-- key (number) - Mission index from GFX.Missions table

TriggerServerEvent("gfx:server:UpdateCountAndGiveReward", key)

Commands

No commands are registered by this script.

Features

• Multi-level progression system -- 4 mission levels unlocked by cumulative flight count (0, 50, 100, 150 flights)
• Legal and illegal mission types -- Illegal missions alert online police players with a blip and notification
• Checkpoint-based flight paths -- Players follow a series of 3D checkpoints through the sky
• Round-trip missions -- After reaching the destination, checkpoints reverse and the player flies back to the starting point
• Cargo pickup timer -- NUI-based countdown timer at the destination point before the return trip
• Altitude enforcement -- Flying too low during descent triggers mission failure and plane destruction
• Plane health monitoring -- If the aircraft is destroyed, the mission automatically fails
• JSON-based player data -- Flight counts are stored in database.json (no SQL dependency)
• NUI menu -- Interactive UI to view current level, flight count, progress toward next level, and select missions
• Map blip -- "Flight Mission" blip placed at the NPC location (LSIA)
• NPC interaction -- Pilot ped at the job location with proximity-based [E] prompt
• Camera system -- Cinematic camera focused on the aircraft during the cargo pickup phase
• Dual framework support -- Works with both QBCore and ESX via configurable hook files
• Police integration -- Illegal flights trigger alerts via chat message and optionally via qb-phone
• Vehicle key integration -- Spawned aircraft automatically receive vehicle key ownership
• Player disconnect cleanup -- Mission vehicles are deleted when players disconnect

Troubleshooting

Source

• GitHub: https://github.com/gfx-fivem/gfx-pilotjob
• Organization: GFX-Fivem