Net, Multiplayer, and Runtime Sessions Exact Reference

Use this page when the task is about sockets, discovery, host or join flow, or multiplayer session orchestration.

Table of Contents

1. Covers
2. Open These Handbook Pages First
3. Canonical Contracts
4. Namespace Coverage Summary
5. Namespaces
6. Non-Namespace Contract Topics

Covers

• aura.net
• aura.multiplayer
• Session-facing play, join, and CLI runtime control are documented in the game-state CLI contract alongside the runtime namespaces listed here.

Open These Handbook Pages First

• external/game-dev-api/11-networking-and-multiplayer.md
• external/game-dev-api/13-cli-create-build-dev-test-and-project-files.md

Canonical Contracts

• api-contract.md
• game-state-cli-contract-v1.md

Namespace Coverage Summary

Namespaces

`aura.net`

Optional networking APIs (connect, websocket) and deterministic callback dispatch semantics when modules.network=true.

• Native support: supported
• Web support: unsupported
• Exact signatures in generated schema: 0
• Additional known method names: 5
• Contract source: api-contract.md, game-state-cli-contract-v1.md

Known Contract Methods

aura.net.connect(...)
aura.net.fetch(...)
aura.net.get(...)
aura.net.post(...)
aura.net.websocket(...)

Exact signature extraction is still incomplete for the methods above. Use the canonical contract source if argument or return-value detail matters.

`aura.multiplayer`

Additive multiplayer helper for host/client lifecycle, player/session state synchronization, and deterministic callback delivery.

• Native support: supported
• Web support: unsupported
• Exact signatures in generated schema: 0
• Additional known method names: 31
• Contract source: api-contract.md, game-state-cli-contract-v1.md

Known Contract Methods

aura.multiplayer.advertise(...)
aura.multiplayer.broadcast(...)
aura.multiplayer.configure(...)
aura.multiplayer.discover(...)
aura.multiplayer.getAllPlayerInputs(...)
aura.multiplayer.getAllState(...)
aura.multiplayer.getLocalId(...)
aura.multiplayer.getPing(...)
aura.multiplayer.getPlayerCount(...)
aura.multiplayer.getPlayerData(...)
aura.multiplayer.getPlayerInput(...)
aura.multiplayer.getPlayers(...)
aura.multiplayer.getServerTime(...)
aura.multiplayer.getState(...)
aura.multiplayer.host(...)
aura.multiplayer.isClient(...)
aura.multiplayer.isConnected(...)
aura.multiplayer.isHost(...)
aura.multiplayer.join(...)
aura.multiplayer.kick(...)
aura.multiplayer.leave(...)
aura.multiplayer.onDisconnect(...)
aura.multiplayer.onMessage(...)
aura.multiplayer.onPlayerJoin(...)
aura.multiplayer.onPlayerLeave(...)
aura.multiplayer.onStateUpdate(...)
aura.multiplayer.send(...)
aura.multiplayer.sendInput(...)
aura.multiplayer.setPlayerData(...)
aura.multiplayer.setState(...)
aura.multiplayer.stop(...)

Exact signature extraction is still incomplete for the methods above. Use the canonical contract source if argument or return-value detail matters.

Non-Namespace Contract Topics

• Session-facing play, join, and CLI runtime control are documented in the game-state CLI contract alongside the runtime namespaces listed here.