Write a separate resource

Last updated on

For a resource that is not part of opx_infinity (your own my_jobs, for example). It uses the curated surface opx_infinity publishes for creators. If you need a module's full contract (every function of character, inventory…), write a module instead.

What a separate resource can use

Start with For creators: the answer every export gives, the allowlist the operator controls (writes are refused until your resource is in SERVER.EXPORTS.WRITERS), and when you must await.

A minimal example

resource "my_jobs"
version "1.0.0"
dependency "opx_infinity"
server_script "server.lua"
client_script "client.lua"
permissions { "network.events" }

exports('OnOpxEvent', function(event, payload) TriggerEvent(event, payload) end)

RegisterCommand('jobmenu', function()
	exports.opx_infinity:OpenMenu({
		title = 'ODD JOBS',
		closeOnSelect = true,
		items = { { id = 'deliver', label = 'Deliver a parcel' } },
	})
end)

AddEventHandler('opx:on:menu:action', function(p)
	if p.action == 'select' and p.itemId == 'deliver' then
		TriggerServerEvent('my_jobs:start')
	end
end)

-- the operator adds my_jobs = true to SERVER.EXPORTS.WRITERS
RegisterNetEvent('my_jobs:start', function()
	local playerId = source
	CreateThread(function()
		local job = exports.opx_infinity:GetJob(playerId)        -- a read: sync is fine
		if not job.ok then return end
		-- ... run the job, check it on the server, then pay:
		local pending = Open77.exports.call('opx_infinity', 'AddMoney',
			playerId, 'EDDIES', 200, 'odd job')
		local answer = pending and pending:await()
		if answer and answer.ok then
			exports.opx_infinity:SendChat(playerId, { text = 'Paid 200 €$', kind = 'info' })
		end
	end)
end)

AddEventHandler('opx:on:character:unloaded', function(playerId, payload)
	-- forget anything you kept for payload.citizenId
end)

The player state bag

The character module writes no key on the player's replicated state bag any more (PR #93). The old keys (citizenId, name, charInfo, job, gang, username, life) reached every client in the bucket, the whole city, and are cleared. Ask the server instead, and keep the rule the framework keeps: never a name to a stranger — do not relay a character's name, citizen id, job or balance to a client whose player has not met that character.

local res = exports.opx_infinity:HasJob(playerId, 'police')
if res.ok and res.value then
	-- ...
end

• The local player's own character: the client export GetPlayerData.
• Another player: the server exports (GetPlayerData, HasJob, IsDown…), gated by SERVER.EXPORTS.READ.
• Platform names outside OPX: Open77.players.nearby and the platform chat/scoreboard still show account names; that is a platform setting.

opx_lib

A client library any resource may use.

dependency "opx_lib"

local Lib = require('@opx_lib')
print(Lib.Manifest())   -- the permissions line your manifest needs

Commands

A server resource whose manifest declares runtime.commands can queue an unrestricted command line with ExecuteCommand(line). Restricted (staff) commands are refused, and the answer goes to the server log.

Things to avoid

What you still cannot do

What used to be on this list and is not any more: the panel, the key strip and the eye (client exports), a bar the server starts and judges (StartProgress), an offline character's metadata (SetMetadata with a citizen id), runtime items and use handlers (RegisterItem, RegisterUsableItem).

A request/answer between your client and your server is Lib.Callback in opx_lib, over Open77.net: it is between your own two halves and needs no export.

Code written for the old opx77_* exports does not work as is; see From opx77_* to opx_infinity.