Skip to content

Document the wider creator surface - #10

Merged
dop42 merged 2 commits into
mainfrom
docs/api-power
Oct 4, 2026
Merged

dop42 merged 2 commits into
mainfrom
docs/api-power

Conversation

@dop42

@dop42 dop42 commented Oct 4, 2026

Copy link
Copy Markdown
Contributor

Docs for opx77-framework/opx_infinity feat/api-power (the creator API pass).

  • One page per new export, ox style (heading anchor, snippet, params, returns, errors, example):
    • server: GetPlayers, GetJobs, GetGangs, GetItem, GetItems, GetInventory, CanCarryItem, RegisterItem, RegisterUsableItem, UnregisterUsableItem, OpenStash, GetVehicle, GetOwnedVehicles, AddVehicle, HasKeys, GiveKeys, Notify, StartProgress, StopProgress, RegisterCraftingBench, UnregisterCraftingBench
    • client: OpenPanel, UpdatePanel, AppendPanel, ClosePanel, AddTarget, UpdateTarget, RemoveTarget, ClearTargets, ShowPrompt, UpdatePrompt, HidePrompt, HideAllPrompts, OpenCraftingBench, GetPlayerData, GetItemCount, HasItem, GetItem, IsDown, GetNeeds
    • the doorlock exports already on main (GetDoor … RemoveDoor) had no page: added
  • GetMetadata / SetMetadata take a citizen id (offline, under the ledger)
  • New public events on the creators page and the module pages: opx:on:inventory:items, opx:on:character:created / deleted, opx:on:vehicles:registered / state, opx:on:crafting:ordered / collected, opx:on:progress:finished, opx:on:doorlock:changed; net events opx:net:inventory:catalog, opx:net:progress:report
  • progress gets a server page; new contract members on character, inventory, crafting; OPX.Export.* reference
  • "What you still cannot do" rewritten to what is really still missing

Checks: npm ci && npm run build green; node scripts/check-content.mjs 0 problems; npm run check:api against the feature branch: every name this pass publishes is documented. 104 failures remain, all of them already failing against opx_infinity main (doorlock and loading module pages, the animations duo events, the doorlock commands and config, OPX.Spots.*, …) and outside this pass.

🤖 Generated with Claude Code

One page per new export in the ox style: the roster and group reads, the
catalogue and bag reads, runtime items and use handlers, OpenStash, vehicles
and keys, Notify, the server-judged StartProgress / StopProgress, crafting
benches, and on the client the panel, the eye, the key strip, the crafting
bench and the local-player reads. GetMetadata / SetMetadata take a citizen id.

The doorlock exports, already shipped, get their pages too, and OPX.Export.*
its reference. The new public events (opx:on:inventory:items, character
created / deleted, vehicles registered / state, crafting ordered / collected,
progress finished) and net events are documented on the creators page and
the module pages; the progress module gains its server page; "What you still
cannot do" is rewritten to what is really still missing.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Merge #11: its doorlock export pages and its doorlock event are kept, the
duplicate Doors section of the server index dropped, and the crafting and
progress events kept beside them.

The review fixes on opx_infinity#89: a runtime item's use.status holds at most
8 needs and items travel four per event; OpenStash makes a configured stash at
its configured size; the stop cleanup leaves a caller that is running or
starting again.

Creator notes: a use handler slower than USE_HANDLER_MS is refused after its
effect may have applied, so answer fast and stay idempotent; GetInventory is a
read export and carries item metadata; public events are advisory, since any
server resource can raise them.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@dop42
dop42 merged commit 303ecf2 into main Oct 4, 2026
2 checks passed
@dop42
dop42 deleted the docs/api-power branch October 4, 2026 23:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant