Interface reference

Generated from host.wit, the contract a mod compiles against — so a page here says what the running host actually offers, not what it offered when someone last wrote about it.

Keep your copy fresh

A mod vendors its own copy of the contract. When a page here and your copy disagree, your copy is stale — download the current one.

Exported — you implement these, the host calls them

server-apiThe server half of a mod: init, update, joins, signals, contacts, interaction.

client-apiThe client half: init, input, and messages from your server half.

Imported — the host offers these, you call them

entitySpawn, despawn, read and write components, possess and release.

spatialRaycasts and overlap queries.

signalEmit and subscribe on the mod-to-mod bus.

broadcastSend to every client, or to one.

rpc-outCall from a client half into your server half.

map-apiRead what the loaded map declares.

gamemodeWhat the designated gamemode may switch off.

uiThe overlay surface a client half can write to.

logWrite to the host log.