@casual-simulation/aux-vm-client - npm Package Versions

V0.11.24

Date: 1/31/2020

Changes:

:boom: Breaking Changes

• Renamed the following tags:
  • _auxUserDimension -> auxPagePortal
  • _auxUserInventoryDimension -> auxInventoryPortal
  • _auxUserMenuDimension -> auxMenuPortal
  • _auxUserUniverse -> auxUniverse
  • auxDimensionColor -> auxPortalColor
  • auxDimensionLocked -> auxPortalLocked
  • auxDimensionRotatable -> auxPortalRotatable
  • auxDimensionPannable -> auxPortalPannable
  • auxDimensionPannableMaxX -> auxPortalPannableMaxX
  • auxDimensionPannableMaxY -> auxPortalPannableMaxY
  • auxDimensionPannableMinX -> auxPortalPannableMinX
  • auxDimensionPannableMinY -> auxPortalPannableMinY
  • auxDimensionZoomable -> auxPortalZoomable
  • auxDimensionZoomableMax -> auxPortalZoomableMax
  • auxDimensionZoomableMin -> auxPortalZoomableMin
  • auxDimensionPlayerZoom -> auxPortalPlayerZoom
  • auxDimensionPlayerRotationX -> auxPortalPlayerRotationX
  • auxDimensionPlayerRotationY -> auxPortalPlayerRotationY
  • auxDimensionGridScale -> auxPortalGridScale
  • auxDimensionSurfaceScale -> auxPortalSurfaceScale
  • auxDimensionInventoryHeight -> auxInventoryPortalHeight
  • auxDimensionInventoryResizable -> auxInventoryPortalResizable
  • Removed all the inventory-specific dimension config tags in favor of the normal ones.
    • e.g. auxDimensionInventoryColor is now just auxPortalColor
• Removed the following tags:
  • aux._lastActiveTime
  • _auxSelection
  • aux.connected
  • _auxUser
  • auxUserUniversesDimension
  • auxDimensionConfig
• Removed the following function:
  • player.isConnected()
• The player.isInDimension() function has been updated to check whether the page portal is showing the given dimension.
• Dimensions can no longer be configured using the auxDimensionConfig tag.
  • Instead of configuring dimensions, you must configure portals.
  • Use the new aux{type}PortalConfigBot (like auxPagePortalConfigBot) tags to specify the bot that should configure the portal.
  • The you can find a list of the possible tags under the "Portal Config Tags" header in the documentation.
• Channel Designer is no more.
  • In addition, the URL scheme has changed. Instead of auxplayer.com/*{dimension}/{universe} to get the sheet, you now have to specify the portals via URL query parameters. (e.g. auxplayer.com?auxUniverse={universe}&auxSheetPortal={dimension})
  • The possible portal values are:
    • auxSheetPortal - Loads the sheet with the given dimension.
    • auxPagePortal - Loads the normal 3D view with the given dimension.
    • auxMenuPortal - Loads the menu with the given dimension.
    • auxInventoryPortal - Loads the inventory with the given dimension.
  • As a shortcut, you can go to casualos.com/{dimension}/{universe} and it will redirect you to auxplayer.com?auxUniverse={universe}&auxPagePortal={dimension} or auxplayer.com?auxUniverse={universe}&auxSheetPortal={dimension} depending on if you include the * for the dimension.

:rocket: Features

• Added the player.getPortalDimension(portal) function.
  • portal is a string with the name of the portal. Can be one of the following options:
    • page - Gets the auxPagePortal tag.
    • inventory - Gets the auxInventoryPortal tag.
    • menu - Gets the auxMenuPortal tag.
    • sheet - Gets the auxSheetPortal tag.
    • universes - Gets the auxUniversesPortal tag.
    • You can also give it a tag that ends with "Portal" to get that tag directly. (e.g. auxPagePortal will return auxPagePortal)
• Added the player.getDimensionalDepth(dimension) function.
  • dimension is the dimension that should be searched for.
  • Returns the distance between the player bot and the given dimension.
    • A return value of 0 means that the player bot is in the given dimension.
    • A return value of 1 means that the player bot is viewing the given dimension through a portal.
    • A return value of -1 means that the player bot cannot access the given dimension at this moment.
• Added the ability to show the sheet in auxPlayer by setting the auxSheetPortal tag on the player bot.

:bug: Bug Fixes

• Fixed an issue where the inventory camera would be placed at an impossible location if the inventory was hidden during startup.
• Fixed an issue with the inventory where setting auxInventoryPortal to null or undefined would not hide it.
• Fixed an issue where setting a dimension tag to a number would place the bot in the dimension.
• Fixed an issue where tag autocomplete results would become duplicated after closing and reopening the sheet.

V0.11.23

Date: 1/23/2020

Changes:

:boom: Breaking Changes

• Renamed the player.inDesigner() function to player.inSheet().
• Changed the player.showChat(placeholder) function to set the placeholder of the chat bar instead of the prefill.
• Removed the ability to trigger a listener by clicking the play button in the code editor.
• Removed the side menu from auxPlayer.
• Removed sharp to allow us to make ARM builds on macOS.

:rocket: Features

• Added the ability to specify an options object when calling player.showChat(options).
  • options is an object with the following properties:
    • placeholder - The placeholder. Will override the existing placeholder. (optional)
    • prefill - The prefill. Will only be set if there is no text already in the chat bar. (optional)
• Added the ability to click the id tag in the sheet to load all the bots.
• Added the ability to use the browser back button in the sheet.
• Added the version number to the loading popup.
• Added the player.version() function which gets information about the current version number.
  • Returns an object with the following properties:
    • hash - The Git hash that the build was made from.
    • version - The Git tag that the build was made from.
    • major - The major number of the build.
    • minor - The minor number of the build.
    • patch - The patch number of the build.
• Improved the chat bar to remove focus from the input box when the "Send Message" button is clicked/tapped.
  • This should cause the on-screen keyboard to automatically close.
• Improved the menu positioning so that it will appear at the bottom of the screen when the inventory is hidden.
• Added the ability to resize the code editor window.
• Added the player.device() function which gets information about the current device.
  • Returns an object with the following properties:
    • supportsAR - Whether AR is supported.
    • supportsVR - Whether VR is supported.
• Added the player.enableAR() and player.disableAR() functions.
• Added the player.enableVR() and player.disableVR() functions.

:bug: Bug Fixes

• Fixed an issue where hidden tags would not get a button to toggle their visiblity in the sheet.
• Fixed an issue where the space tag in the sheet would sometimes show an incorrect value.
• Fixed an issue where sometimes AUX would crash when multiple tabs were open due to a race condition.
• Fixed an issue where bots from the history space would not be findable in scripts.

V0.11.22

Date: 1/16/2020

Changes:

• Breaking Changes
  • Changed player bots to use the tempLocal space.
    • This means that refreshing the page won't pollute the universe with a ton of extra bots.
  • player.loadUniverse() will now create bots in the tempLocal space.
    • Previously they were created in the shared space.
• Improvements
  • Added the ability to create, load, and restore version marks.
    • The player.markHistory(options) function creates a history mark for the current version.
      • options is an object with the following properties:
        • message - The message that the new mark should have.
    • The player.browseHistory() function loads the history space with all the marks that the universe has.
    • The player.restoreHistoryMark(mark) function restores the state in the given mark to the universe.
      • mark - The bot or bot ID of the mark that should be restored.
    • The player.restoreHistoryMarkToUniverse(mark, universe) function restores the state in the given mark to the given universe.
      • mark - The bot or bot ID of the mark that should be restored.
      • universe - The universe that the mark should be restored to.
  • Changed the CORS settings to allow access from any origin.

V0.11.21

Date: 1/14/2020

Changes:

• Breaking Changes
  • Renamed the player.showUploadUniverse() function to player.showUploadAuxFile().
• Improvements
  • Added the @onAnyCreate shout listener.
    • that is an object with the following properties:
      • bot - The bot that was created.

V0.11.20

Date: 1/13/2020

Changes:

• Breaking Changes
  • Renamed context to dimension.
    • All the auxContext* tags have been renamed to auxDimension*.
    • Listeners like @onDrop, @onModDrop, @onClick, etc. now have a dimension property in the data argument instead of context.
    • The @onPlayerEnterContext listener has been renamed to @onPlayerEnterDimension.
    • The _auxUserContext, _auxUserMenuContext, _auxUserInventoryContext, and _auxUserChannelsContext have been renamed to use dimension instead of context.
  • Renamed channel to universe.
    • All the auxChannel* tags have been renamed to auxUniverse*.
    • The _auxUserChannelsContext tag has been renamed to _auxUserUniversesDimension.
    • The _auxUserChannel tag has been renamed to _auxUserUniverse.
    • The player.setupChannel() function has been renamed to player.setupUniverse().
    • The player.loadChannel() and player.unloadChannel() functions have been renamed to player.loadUniverse() and player.unloadUniverse().
    • The player.getCurrentChannel() function has been renamed to player.getCurrentUniverse().
    • The setup_channel action type has been renamed to setup_universe.
    • The @onChannel* listen tags have been renamed to @onUniverse*.
      • Also the channel property in the data argument has been renamed to universe.
  • Renamed the auxDimensionRotation (auxContextRotation) tags to auxDimensionOrientation.
  • You no longer need to define a dimension bot (context bot) in order to view a dimension in auxPlayer.
    • You can still configure a dimension using the auxDimensionConfig tag (renamed from auxContext).
  • Channel Designer is no more!
    • It has been replaced with the "sheet dimension" (bot table).
    • You can show any dimension in the sheet by putting a * in front of the dimension name in the URL.
      • e.g. https://auxplayer.com/*home/example if you wanted to view the home dimension in the sheet from the example universe.
      • Going to just * will show all bots in the universe in the sheet. (which is very slow at the moment)
    • You can also jump directly into auxPlayer by using the "Open dimension in auxPlayer" button that is next to the tag filters.
  • Removed the player.isDesigner() function.
  • Renamed auxShape to auxForm.
  • Renamed auxImage to auxFormAddress.
• Improvements
  • Added the player.showChat() and player.hideChat() functions.
    • These show/hide the chat bar in auxPlayer.
    • Typing in the chat bar will trigger a @onChatUpdated shout with the text in the chat bar.
    • Pressing Enter or clicking the send button on the chat bar will trigger a @onChatEnter shout with the text in the chat bar.
  • Added the @onChat shout listener.
    • Triggered when the user sends a message using the chat bar.
    • that is an object with the following properties:
      • message - The message that was sent.
  • Added the @onChatTyping shout listener.
    • Triggered when the user edits the text in the chat bar.
    • that is an object with the following properties:
      • message - The message that is in the chat bar after the user edited it.
  • Added the player.run(script) function.
    • script is the script text that should be executed.
    • Works by sending a run_script action. This allows @onUniverseAction() listener to intercept and prevent scripts.
  • Added the ability to click a tag in the bot table to teleport to that dimension.
  • Added a play button to the right side of the code editor to run scripts for quick debugging.
  • Added the player.downloadBots(bots, filename) function.
    • The first parameter is an array of bots that should be downloaded.
    • The second parameter is the name of the file that is downloaded.
  • Added the player.showUploadUniverse() function.
    • Shows a dialog that lets the user upload .aux files.
• Other Changes
  • Changed the "AUX Player" and "Channel Designer" tab titles to "auxPlayer".
  • Removed the colored dots from tag labels in the bot table.
• Bug Fixes
  • auxIframe now supports URLs with * characters in them.
  • Fixed an issue with the menu dimension that would cause items to remain even though a different dimension should be visible.

V0.11.18

Date: 12/30/2019

Changes:

• Improvements
  • Showing hidden tags in the bot table will now also show the shared tag.
  • Removed the multi-select button from the bot table.
  • Removed the create context button from the bot table.
  • Removed the clear search button from the bot table.
  • Removed the "create mod from selection" button from the bot table.
  • Added the ability to click/tap on a bot preview in the bot table to select a mod of it.
  • Added the ability to drag a bot preview in the bot table to drag a mod of it.
  • Hid the ID tag when a mod is selected.
  • Hid all other buttons when a mod is selected in the bot table.

V0.11.17

Date: 12/20/2019

Changes:

• Breaking Changes
  • Changed @onDrop, @onDropEnter, and @onDropExit to use the same parameters.
    • that is an object with the following properties:
      • dragBot - The bot that is being dragged.
      • to - an object with the following properties:
        • context - The context the bot is being dragged into.
        • x - The X grid position the bot is being dragged to.
        • y - The Y grid position the bot is being dragged to.
        • bot - The bot that the dragBot is being dragged onto.
      • from - an object with the following properties:
        • context The context the bot is being dragged from.
        • x - The X grid position the bot is being dragged from.
        • y - The Y grid position the bot is being dragged from.
• Improvements
  • create() will now automatically set the auxCreator tag to null if it references a bot that is in a different space from the created bot.
  • Also create() will not set the auxCreator tag to null if it references a non-existent bot.
  • Added the changeState(bot, stateName, groupName) function to help with building state machines.
    • Sets the [groupName] tag to [stateName] on bot and sends "on enter" and "on exit" whispers to the bot that was updated.
    • groupName defaults to "state" if not specified.
    • If the state has changed, then a @[groupName][previousStateName]OnExit() and @[groupName][stateName]OnEnter() whispers are sent to the updated bot.
      • that is a object with the following properties:
        • from - The previous state name.
        • to - The next state name.
    • Example: Running changeState(bot, "Running") will set the state tag to "Running" and will send a @stateRunningOnEnter() whisper to the bot.

V0.11.16

Date: 12/19/2019

Changes:

• Breaking Changes
  • Renamed onBotDrag and onBotDrop to onDrag and onDrop respectively.
  • Renamed onMod to onModDrop.
  • Removed onCombine, onCombineEnter, and onCombineExit.
  • Dropping a mod in an empty space will no longer create a new bot.
  • Setting auxPositioningMode to absolute will no longer prevent mods.
  • Changed applyMod() and subtractMods() to not send onMod() events.
  • Renamed the diffs property on the onModDrop argument to mod.
• Improvements
  • Added onModDropEnter and onModDropExit listeners for when a mod is dragged onto or off of a bot.
    • The bot that the mod will be applied to recieves the onModDropEnter and onModDropExit events.
  • If a custom onModDrop listener is provided, then the mod will not be applied. It is up to the onModDrop listener to apply the mod via applyMod(this, that.mod).
  • Added onDropEnter and onDropExit listeners for when a bot is dragged onto or off of another bot.
    • Both the bot that is being dragged and the bot that they are on top of will recieve the onDropEnter and onDropExit events.
    • Note that onDropEnter and onDropExit events will fire even if one of the bots is not stackable.
    • They have the following parameters:
      • draggedBot - the bot that is being dragged.
      • otherBot - the bot that the dragged bot is on top of.
      • context - the context that this is happening in.
  • Improved onDrop to be sent to both the dragged bot and the bot that it is dropped on top of.
    • The event will fire on the other bot even if it has auxPositioningMode set to absolute.
  • Added the player.setClipboard() function that is able to set the user's clipboard to the given text.
    • ex. player.setClipboard("abc") will set the user's clipboard to "abc".
    • On Chrome and Firefox, the text will be copied directly to the user's clipboard.
    • On Safari and all iOS browsers, a popup will be triggered with a copy button allowing the user to copy the text to their clipboard.
  • Tags that contain listeners will now display with a @ symbol in front of the tag name.
  • Tags that contain formulas will now display with a = sign after the tag name.
  • Removed the @ symbol from the first line in the code editor when editing a script.
  • Added the ability to use an @ symbol while creating a new tag to prefill the editor with an @.
  • Added the ability to use @ symbols in tags in getTag(), setTag(), getBot(), getBots(), byTag(), shout(), and whisper().
  • Added tag filters for listener tags and formula tags to the bot table.
  • Added the ability to detect the tags variable in scripts as a reference to tags.
    • This is useful for knowing when to update a formula.
    • Also works with the raw variable.
    • Limitations:
      • Does not detect references via the bot or this variables. (e.g. bot.tags.abc)
      • Does not detect references via other bots. (e.g. otherBot.tags.abc)
      • Does not detect references if a function is called on the tag. (e.g. tags.name.toString())
    • If you need to work around the limitations, use the getTag() function.

V0.11.15

Date: 12/17/2019

Changes:

• Bug Fixes
  • Fixed an issue where player.replaceDragBot() actions were not getting processed because some data was improperly formatted.
  • Resolved issue with inventory not remaining in place on resizing.

V0.11.14

Date: 12/16/2019

Changes:

• Breaking Changes

  • Removed auxStackable and replaced it with auxPositioningMode.
    • auxPositioningMode has two possible values:
      • stack - Indicates that the bot will stack on top of other bots (default)
      • absolute - Indicates that the bot will ignore other bots when positioning.
  • Removed the createTemp() function.
    • It has been replaced with the { space: "value" } mod.
    • e.g. Instead of createTemp() you should use create({ space: "tempLocal" }).
  • Removed the cookie bot. It has been replaced with the local space.
  • Removed the following functions:
    • addToContextMod()
    • removeFromContextMod()
    • addToMenuMod()
    • removeFromMenuMod()
    • setPositionMod()
    • from()
      • You can use a mod declaration with the new getID() function to achieve the same functionality:
      • { auxCreator: getID(bot) }
  • Renamed the createdBy() filter function to byCreator().

• Improvements

  • Added the space tag which indicates where a bot will be stored.
    • The following spaces are currently available:
      • shared - This space is shared among multiple users and is persistent. This is the default space for bots if not specified.
      • tempLocal - This space is not shared and is cleared every time the browser refreshes.
      • local - This space is kept on your device and is persistent.
    • When creating a bot, you can set the space that it will be stored in using a { space: "value" } mod.
      • e.g. create({ space: "local" }) will create a new bot in the local space.
      • Creating a bot from another bot will inherit spaces. So cloning a tempLocal bot will produce another tempLocal bot. You can of course override this using a mod.
    • You can search for bots in a specific space using the bySpace() filter function.
      • e.g. getBots(bySpace("local")) will get all the bots in the local space.
      • It is simply an alternative way to do getBots(byTag("space", value)).
  • Added the following functions:
    • getID(bot) gets the ID of a bot. If given a string, then that will be returned instead.
    • getJSON(data) gets a JSON string for the given data.

• Bug Fixes

  • Resolved issue of orientation inverting then attepting to resize the inventory once the viewport has beeen panned.