@casual-simulation/aux-vm

AUX VM

A set of abstractions and common utilities required to run an AUX on any platform.

Installation

npm install @casual-simulation/aux-vm

Usage

Create a custom simulation class

import { BaseSimulation, AuxVM } from '@casual-simulation/aux-vm';

// Simulations are wrappers for an
// AuxVM + AuxChannel combo.
// They make all the capabilities of an AUX easy to access
// and understand.
export class MySimulation extends BaseSimulation {
    constructor(
        id: string, // The ID of the
        config: { isBuilder: boolean; isPlayer: boolean }
    ) {
        super(id, config, config => new MyAuxVM(config));
    }
}

// An AUX VM is in charge of separating
// the consumer from the AUX Environment.
// Basically its a security barrier between an AUX and the consumer code.
// On Web Browsers, this is usually implemented via web workers and sandboxed iframes.
// On Node.js, this is implemented via a custom script sandbox.
// Below, you can implement your own VM.
export class MyAuxVM implements AuxVM {
    // TODO: Implement
}

Changelog

V0.10.3

Date: 10/04/2019

Changes:

• Improvements
  • Added tags to control panning, zooming, and rotating the main camera.
    • aux.context.pannable: Controls whether the main camera is able to be panned.
    • aux.context.zoomable: Controls whether the main camera is able to be zoomed.
    • aux.context.rotatable: Controls whether the main camera is able to be rotated.
  • Added player.moveTo() to instantly tween the camera to a bot.
    • In the future, custom tween durations will be supported.
  • Changed the low camera angle limit to 32 degrees from 10 degrees.
  • onCombineExit action will now fire alongside the onCombine action.
  • Newly created contexts will no longer be autoselected.
  • Toast messages will now only remain on screen for 2 seconds.
  • Added the ability to send webhooks from the server.
    • You can also tell the server to send a webhook via remote(webhook()).
    • This is useful for getting around CORS issues.
• Bug Fixes
  • Fixed player.tweenTo() to not change the zoom level when it is not specified.
  • Tweens will now work better with the onPlayerEnterContext action.