release
Which build of the engine this is, what the channels are publishing, and replacing this install with another. The editor's Engine tab and About sheet…
On this page
Which build of the engine this is, what the channels are publishing, and replacing this install with another. The editor's Engine tab and About sheet; balaur update is the same code.
5 functions, 0 constants. Scripts reach it as release::.
Functions
Argument kinds are the script values a call passes: node is a node handle, any a table or value of any kind, fn a callback.
| function | acts on | what it does |
|---|---|---|
channels() -> [str] |
— | Every release line a build may follow, in the order a version moves through them. |
check() -> bool |
— | Read the release feed on a thread. listen hears { kind: "listed", rows }, newest first, each { tag, id, channel, when, current, order, download }: order is newer, older or same than this build, empty where they do not order, and download is the zipped app a macOS bundle fetches instead. { kind: "failed", job: "check", message } when the feed could not be read. False while a recording plays. |
install(string, string, any) -> bool |
— | Replace this install with what that channel or tag holds, on a thread; allow_downgrade = true lets an older build replace a newer one. listen hears downloading with done and total bytes, unpacking, then installed with a note, or failed with job: "install". Refuses where installed().held says why. False while a recording plays. |
installed() -> release::Build |
— | This build: { version, id, channel, tag, source, held }, where id is the build id a release was tagged with, tag is the release its assets live under, source is true for a build from a checkout, and held says why this install cannot replace itself, empty when it can. |
listen(Node, any) |
— | Call a method on node with every report a check or an install makes: on_release_event unless opts.on_event names another. |