Packages@robojs/sync
useZoneContext()
Function: useZoneContext()
function useZoneContext<ClientData>():
| ZoneContextValue<ClientData>
| nullHook to access the current zone context. Returns null if not within a SyncZone.
Type Parameters
| Type Parameter | Default type |
|---|---|
ClientData | unknown |
Returns
| ZoneContextValue<ClientData>
| null
Example
function GameComponent() {
const zone = useZoneContext()
if (!zone) return <div>Not in a zone</div>
return (
<div>
Host: {zone.isHost ? 'You' : zone.hostId}
Players: {zone.clients.length}
</div>
)
}