Log inGet started
Package

api.module

Newest version

This package holds more than this page lists. See all of its files in its world.

README.md

api

The one public API of Hearthvale. Town.place({ style, layout, seed, at, yaw, parent, collide, lights, townsfolk }) builds a whole walkable town; Town.building(kind, { at, yaw, style, seed, ... }) places one building; Town.prop(kind, { at, yaw, style }) one prop; Town.anchor(name) answers { name, position, yaw, forward } for gameplay points (guildDesk, questBoard, innBar, shopCounter, castleGate, alley1, dungeonRoadSouth, playerSpawn, ...); Town.anchors(prefix), Town.spots() (townsfolkKit activity spots), Town.registerTownsfolkSpots(require("townsfolkKit.api")), Town.clear(), Town.stats(), Town.material(style, slot). Everything is local, temporary and deterministic, so every peer builds the same town. Require it as require("townKit.api").