lkn-core v0.4.1 Lkn.Core.Instance View Source

A Process to arbitrate the Systems of a given Map.

There are two things to remember about Instances:

  1. There can be several Instances of a single Map
  2. They are dynamically created by the Lkn.Core.Pool of a Map when required

In other words, it is not the developer job to spawn an Instance. You can see an instance as the entry point of a game scene. It acts as a proxy between Lkn.Core.Puppeteers and Lkn.Core.Systems.

An Instance will stay alive as long as it hosts at least one Lkn.Core.Puppeteer. Once it has became empty, it warns its Lkn.Core.Pool so that the Pool can kill it.

Link to this section Summary

Types

k()

A key to identify and reach an Instance

Functions

Insert a new Puppet into an Instance

Remove a Puppet from an Instance

Notify an Instance that a given Puppeteer is leaving

Link to this section Types

A key to identify and reach an Instance.

Link to this section Functions

Link to this function notify_puppeteers(instance_key, notif) View Source
Link to this function register_puppet(instance_key, puppet_key, opts \\ %{}) View Source
register_puppet(k, Lkn.Core.Puppet.k, %{optional(Lkn.Core.System.m) => Keyworld.t}) :: boolean

Insert a new Puppet into an Instance.

This function can be used by a Lkn.Core.Puppeteer to insert a new Puppet into an Instance. There is no notion of Puppet owner, from an Instance point of view. Therefore, any Puppeteer can send a command “on behalf of a given Puppet. This Puppeteer will have the obligation to unregister it.

Under the hood, this function dispatches the register event to each system the Puppet has a Component for.

Link to this function unregister_puppet(instance_key, puppet_key) View Source
unregister_puppet(k, Lkn.Core.Puppet.k) :: boolean

Remove a Puppet from an Instance.

This function can be used by a Lkn.Core.Puppeteer to an Instance. An Instance will never do it by itself, so it needs to be done by the Puppeteer owner, e.g. before it registers istelf. Note that, if the Puppeteer forgets to unregister one of its Puppets, this Puppets will stay in this Instance as long as at least one Puppeteer stays registered (and it will probably do nothing at all).

Link to this function unregister_puppeteer(instance_key, puppeteer_key) View Source
unregister_puppeteer(k, Lkn.Core.Puppeteer.k) :: :ok

Notify an Instance that a given Puppeteer is leaving.

This function needs to be used by a Puppeteer, after it has removed all of its Puppets. Right now, a Puppeteer cannot choose its Instance to join, and the Lkn.Core.Pool.register_puppeteer is the function to use to join the Instance of a given Map.