Skip to content

feat: document radio server events - #116

Open
Z3rio wants to merge 1 commit into
mainfrom
radio-event-api
Open

Z3rio wants to merge 1 commit into
mainfrom
radio-event-api

Conversation

@Z3rio

@Z3rio Z3rio commented Oct 10, 2026

Copy link
Copy Markdown
Member

Summary

Adds an "Event list" section to the Zerio Radio developer docs, covering the server events from the v3 event API. Each event gets its handler signature, an argument table with types, and when it fires.

 Developer Documentation
   Export list
     Client
     Server
+  Event list
+    Server
+      playerJoinedChannel        (source, frequency, channelLabel)
+      playerLeftChannel          (source, frequency)
+      playerStartedTransmitting  (source, frequency)
+      playerStoppedTransmitting  (source, frequency)
+      panicButtonPressed         (source, frequency, coords)
+      signalLost                 (source, frequency)
+      signalRestored             (source, frequency)
+      jammerPlaced               (source, position, jammer)  + jammer table fields
+      jammerRemoved              (id)

The section also warns against listening with RegisterNetEvent, since that lets clients fake these events. It also warns that signalLost / signalRestored are reported by the client and shouldn't be trusted for anything a cheater would gain from.

Evidence

  • Before: /radio/devdocs lists exports only. It doesn't mention any events.
    After: pnpm lint:check passes for the page (prettier and eslint). next dev compiles /radio/devdocs and serves it with a 200, and the new tables render correctly.

Merge Danger

Door: two-way

Docs-only change, and a revert removes it.

Blast Radius: timing

These events ship with zerio-radio v3 (the v3-update branch). Several are new, and jammerRemoved now sends the real jammer id. If this merges before v3 is released, the docs describe events that customers on v2 don't receive. Merge alongside the v3 release.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Oct 10, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
documentation Ready Ready Preview Oct 10, 2026 12:03pm UTC

Request Review

This branch was successfully deployed

1 active deployment
Preview — 421fed72 Deployed Oct 10, 2026 by vercel[bot]
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