scenemanagerplugin + addon

Many truths in one process, a seat moved between them, and the page's one client for its scene.

#Putting it in a scene

Every game is built on it, a game of one scene too, because it is what gives a connection a seat. The manager scene lists this plugin alone and holds the table of scenes. Each scene is a scene file of its own, with its own rows, world numbers, seed counter and step counter.

{
  "plugins": ["scenemanager"],
  "seats": 1,
  "prefabs": {
    "engine": { "dt": 0.016667 },
    "scenemanager": {
      "scenes": {
        "title": { "file": "title.scene.json", "suspend": true },
        "arena": { "file": "arena.scene.json", "suspend": false, "enter": { "kind": "arena", "act": "welcome" } }
      },
      "dt": 0.016667,
      "entry": "title",
      "port": 8123
    }
  },
  "actors": [{ "is": "scenemanager" }]
}

Each scene names scenemanager in its plugins, has the same prefab with an empty out and an actor for it, and an engine prefab whose width and height size the page's canvases:

{
  "plugins": ["scenemanager", "player", "ui"],
  "prefabs": {
    "engine": { "dt": 0.016667, "width": 640, "height": 360 },
    "scenemanager": { "out": {} }
  },
  "actors": [{ "is": "scenemanager" }]
}

A rule moves a seat to another scene with go, handing on any arguments:

w.call(w.find('scenemanager'), 'go', seat, 'arena', 3)

#A game's files

A scene's level is a Tiled map, the tilemap entry its world.tilemap names, and nothing in the map makes a row. Everything that has a row is an actor, from the scene file's actors and then from the list its actorsFile names.

#Properties

The manager's row

The scenemanager prefab of the manager scene.

A scene's entry

A scene's row

The scenemanager prefab of each scene.

A scene file

A scene's prefabs are the manager's with its own over them, name by name, so a prefab every scene uses is written once, in the manager's file. Its world is made the same way, key by key, so a plugin's fixed numbers, world.<plugin>, are written once in the manager's world and a scene that gives the key has its own.

Partials

Scenes played on one place, such as a skirmish and its missions, share a partial: a scene file that is never a scene of its own and is not in the manager's scenes. A scene that names it in extends holds only what is its own, and is loaded as follows.

A partial that names extends itself stops the load. Importing a scene file, or reading the scene its sim exports, gives the scene's own part without its partial; child (below) gives it whole.

{
  "extends": "highlands.partial_scene.json",
  "plugins": ["loader", "scenemanager", "player", "terrain3d", "render3d"],
  "world": { "exit": "harbour" },
  "actors": [{ "is": "start", "slot": 0, "pos": [4, 0, 12] }]
}

World values written for a scene

Read from world.scenemanager. They are never sent in a packet.

#Seats

A connection is one seat on one scene at a time. It enters the entry scene when it is made and moves when that scene writes the seat's next scene into out. A seat number changes every time the seat enters a scene, the same scene included.

The wire between a page and the manager is the one link is given: loopback when the page holds the manager in the same tab, or socket across a WebSocket. Only the rows added, changed and dropped since the last packet the page confirmed cross it, so a step where nothing moved crosses as next to nothing.

#Methods

Acts

Open acts of the scenemanager row. A rule calls them with w.call, and a seat may send them.

go( seat, name, ...args )

Sends a seat to the scene name once this scene's step is over, with args arriving at the new scene's player row. seat is the seat's number on this scene, the number out is keyed by, not the slot on its player row. An act passes the seat it was handed. A hook has no seat, so a player row keeps the number its arrive act was handed, for a hook to pass.

On the page

Through plugins.scenemanager. The page makes one link, which is one seat, and holds one client on it for the scene the seat is on. When the seat moves, the client is closed (every actor removed, every plugin closed, the renderers letting go of their canvases and WebGL contexts) and a new one is made for the scene the seat moved to.

go( name, ...args )

Names the next scene for this page's seat, as a seat sending go to this scene's row does. Call it after the first tick.

here : boolean

Whether the seat is still on this client's scene. It is false from the moment the link carries a packet of another scene, so a key pressed before the page has closed this client sends nothing to a scene the seat has left.

link : Link

The page's link, which outlives every client the page makes. Its store is the table the store plugin reads and writes.

Addon functions

From #addons/scenemanager/scenemanager.addon.ts.

#Mods

A plugin a supports a plugin p with a mod, a file named <a>.<p>.ts, which hands on what a knows. A scene gives p a function of the mod by naming it in world.<p>.mods as { "<function>": "<a>" }. The function is new to p, or one p already has, which the mod's then overwrites. Swapping one a for another that exports the same function changes that one value.

"world": { "skydome3d": { "mods": { "land": "terrain3d" } } }

An entry may name several plugins, { "<function>": ["<a>", "<b>"] }, each giving p the same function, for a p that takes the function from every one of them, such as box3d's props. A single name is a list of one. A p that takes its function from one plugin refuses an entry that names more.

Every mod a scene names is loaded before the first step, on the server and on the page, and a mod that does not export the function it is named for stops the load. A mod is a function of what p asks it with: the server's w, or on the page the plugins it is handed, so it hands on what a's page half holds. The server loads every mod a scene names, so a mod imports only types of anything that draws. A plugin a whose page half a mod hands on must be one of the scene's plugins.

#Used by

These use it: accounts, box2d, box3d, box3dvehicle, cover3d, cutscene, flight3d, hitscan3d, loader, ocean3d, party, predict, ragdoll3d, recorder, scatter3d, simulator, skydome3d, solids, store, terrain3d, volley3d and walker. It uses loopback, player and rewind.

#In the guide