Skip to content
Work in progress. These docs describe Spawnite at launch, and some parts are still being built.

WikiEntry

One part of the running game: what it is, what it belongs to, what it refers to and which entities carry it. It is made of the entries whose parent it is, and links holds every other entry it refers to: never its parent, and never an entry made part of it.

Property Type Description
description? string -
engine? boolean True where the engine registered it rather than the game: the platform’s wiki documents it, and the game keeps no page for it.
kind string A registered kind’s name.
links WikiLink[] What it refers to that is neither its parent nor part of it, such as a stat’s other traits, an action’s key that another action binds first, or the trait an item’s use changes.
name string -
omitted? string[] The systems of a plugin the game’s list omits, by their names.
page? string A wiki route, as Behaviour.wiki holds one.
pagePath? string Its page’s path from the game’s folder, as wikiPagePath gives it, where that file is; spawnite play wiki adds it, not the store.
parent? WikiRef What it belongs to.
phase? string The phase of the fixed step a system runs in, as the composer placed it: input, motion, rules or physics. None for any other kind, or for a plugin’s own entry.
properties? object Its own data as its registration holds it, in plain JSON with a function as the string "function", such as an item’s definition or a trait’s fields and their defaults; none where its kind has nothing to say. Never a timing or a position in the step.
replaces? string The system whose place a system took, by its name, where the game replaced one: behaviours.chase.
runsOn? "both" | "server" | "client" Where a system runs in a game with a room, as its entry declared it: server for the room alone, client for each page alone, or both. None for any other kind, or for a plugin’s own entry.
source? string The file that declares it, as Behaviour.source holds one.
usedBy string[] The entities that carry it, by the key the dump, the entity tree and describe file each under; empty where its registry cannot tell.