Developer

Overview

Integrate through the open/ folder, where server, client and shared handlers hook into every step of a drop. Two server exports let other resources trigger drops and read the active ones.

Server Exports

• TriggerAirdrop(spec): starts a drop and returns its uid, or nil and 'denied' or 'invalid'. The calling resource must be listed in Config.AdminExportResources, and spec must be a table, empty for all defaults.
• GetActiveDrops(): returns the list of active drops with their state and coordinates.

1local uid, reason = exports.ml_airdrop:TriggerAirdrop({
2    crateId = 'military',
3    planeId = 'cargobob_titan',
4    zoneId  = 'sandy',
5    contested = false,
6    triggeredBy = source,
7})

• crateId, planeId, zoneId: leave any of them out for the default or a random pick. The shipped zones are sandy, grapeseed, chiliad, paleto and elysian
• contested: false together with triggeredBy locks the drop to that player. Without triggeredBy the drop has no owner and stays open to everyone

Server Handlers

Located in open/server.lua. Return false from a Before handler to block that step.

1function OpenServer.BeforeTrigger(src, triggerKind, opts) return true end
2function OpenServer.OnDropSpawned(drop) end
3function OpenServer.OnDropLanded(drop) end
4function OpenServer.ModifyLoot(drop, stock) return stock end
5function OpenServer.BeforeGiveLoot(src, drop, entry) return true end
6function OpenServer.OnLootGiven(src, drop, entry) end
7function OpenServer.BeforeVehicleClaim(src, drop, model) return true end
8function OpenServer.OnVehicleClaimed(src, payload) end
9function OpenServer.CanCallFlare(src) return true end
10function OpenServer.OnDropDespawned(drop, reason) end

• BeforeTrigger: fires before a drop starts. triggerKind is auto, admin or flare. A drop started by export uses the triggerKind of its spec, auto when not set.
• OnDropSpawned / OnDropLanded: fire as the drop goes inbound and when it lands.
• ModifyLoot: mutate and return the rolled loot before it is locked in.
• BeforeGiveLoot / OnLootGiven: gate and observe each captured slot.
• BeforeVehicleClaim / OnVehicleClaimed: gate and observe a vehicle claim. Register ownership here on QBCore or ESX.

• CanCallFlare: gate whether a player may call a drop with a flare item.
• OnDropDespawned: fires on cleanup. reason is emptied, expired or forced.

Client Handlers

Located in open/client.lua.

1function OpenClient.BeforeOpenLoot(drop) return true end
2function OpenClient.AfterLanded(drop) end
3function OpenClient.AfterOpened(drop) end
4function OpenClient.AfterCaptureItem(drop, item, count) end

• BeforeOpenLoot: return false to block the loot panel from opening.
• AfterLanded / AfterOpened / AfterCaptureItem: observe the lifecycle on this client.

Shared Handlers

Located in open/shared.lua.

1function OpenShared.ResolveId(kind, id) return id end

• ResolveId: remap a crate, loot, plane or zone id before it is used, for example a seasonal swap.

Minigames

Crate open minigames are adapters in open/minigames. Each returns whether the player passed, and registers itself into Config.AirdropMiniGames.

1Config.AirdropMiniGames['my_game'] = {
2    label = 'My Minigame',
3    Start = function()
4        -- run your minigame, return true on success
5        return true
6    end,
7}

Examples

1exports.ml_airdrop:TriggerAirdrop({ crateId = 'military', contested = true })

1function OpenServer.BeforeTrigger(src, triggerKind, opts)
2    if MyEvent and MyEvent.active then return false end
3    return true
4end

1function OpenServer.OnLootGiven(src, drop, entry)
2    -- runs once per captured slot
3end