Documentation
¶
Overview ¶
Package js builds the modlock library that TypeScript and JavaScript mods import: one ES module holding the calls into the game and its protobuf runtime, the entity classes as a second module that imports the first, and their declarations. It also bundles the renderer that draws mods' interfaces in the player's game.
Library builds from the Modlock source when it is on disk: a checkout, or the module cache of the build that links this package. A release build has no source on disk and downloads the library built for its release.
Index ¶
Constants ¶
const Archive = "modlock-library.tar.gz"
Archive is the release asset that holds the built library.
const Renderer = "ui.js"
Renderer is the built renderer's file name, which a client content package installs as scripts/modlock/ui.js beside the layout in panorama/layout.
Variables ¶
var Files = []string{"index.js", "index.d.ts", "globals.d.ts", "host.gen.d.ts", "entities.js", "entities.d.ts", "ui.d.ts", "bits.d.ts", "spot.d.ts", "dropper.d.ts"}
Files are the built library's files, which modlock build installs into each script project.
Functions ¶
func Library ¶
Library returns a directory holding the built library and renderer, building or downloading it into the user cache the first time.
Types ¶
This section is empty.
Source Files