@casual-simulation/aux-vm-client

AUX VM Client

A set of utilities required to run an AUX as a client.

Installation

npm install @casual-simulation/aux-vm-client

Usage

Create a custom channel implementation

import { RemoteAuxChannel } from '@casual-simulation/aux-vm-client';
import { AuxUser, AuxConfig } from '@casual-simulation/aux-vm';

export class MyCustomChannel extends RemoteAuxChannel {

    constructor(defaultHost: string, user: AuxUser, config: AuxConfig) {
        super(defaultHost, user, config, {});
    }

    // Override the _handleServerEvents function
    // to handle events sent from a remote device.
    protected async _handleServerEvents(events: DeviceAction[]) {
        await super._handleServerEvents(events);
        let filtered = events.filter(
            e => e.device.roles.indexOf(SERVER_ROLE) >= 0
        );
        let mapped = <BotAction[]>filtered.map(e => e.event);
        if (filtered.length > 0) {
            await this.sendEvents(mapped);
        }
    }
}

Changelog

V0.10.4

Date: 10/08/2019

Changes:

• Improvements
  • Added onAnyAction() action tag to intercept and change actions before they are executed.
    • onAnyAction() runs for every action, including when a bot is created, changed, or deleted.
    • Every action is an object with a type property.
      • The type property is a string that indicates what the action does.
      • Here is a partial list of types:
        • add_bot: A bot should be added (i.e. created).
        • remove_bot: A bot should be removed (i.e. deleted).
        • update_bot: A bot should be updated.
        • apply_state: The given bot state should be applied. (i.e. a set of bots should be created/updated)
        • shout: A shout should be executed.
        • show_toast: A toast message should be shown on the device.
        • show_barcode: A barcode should be shown.
        • tween_to: The camera should be tweened to show a bot.
    • that is an object with the following properties:
      • action: The action that is going to be executed.
    • Forking a channel clears the onAnyAction() on the config bot.
      • This is so that you can recover from broken states and also gives the person who forked the AUX full control over the fork.
  • Added two new script functions:
    • action.reject(action): Prevents the given action from being performed. Returns the rejection action.
    • action.perform(action): Adds the given action to the performance queue so it will be performed. This can be used to re-enable an action after it has been rejected (you can also reject the rejection action). Returns the action that will be performed.
  • Added a local bot which is stored in the browser's local storage.
    • The local bot is a bot that is unique to the device and channel.
    • You can access the bot by querying for it: getBot("#id", "local").
  • Renamed onShout() to onAnyListen().
  • Added onListen() which is an alternative to onAnyListen() that is only called on the targeted bots.
  • Added ability to set duration of toast, plater.toast("message", durationNum).
  • Made the background for the menu label gray.