js

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 carries the library it was built with.

Index

• Constants
• Variables
• func Build(ctx context.Context, source, out string) error
• func Library(ctx context.Context) (string, error)
• func Source() string

Constants

const Built = "built"

Built is the directory under js that the release build fills with the built library before it builds the command line, which embeds it.

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", "console.js", "console.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 Build

func Build(ctx context.Context, source, out string) error

Build builds the library and renderer from the Modlock source into out.

func Library

func Library(ctx context.Context) (string, error)

Library returns a directory holding the built library and renderer: one built from the Modlock source when it is on disk, or else the one this build embeds, placed in the user cache the first time.

func Source

func Source() string

Source returns the root of the Modlock source on disk, or empty when this build has none: the checkout or module cache directory this package was compiled from, or else the module cache entry of the linked version.