@casual-simulation/aux-custom-portals - npm Package Versions

V1.5.0

Date: 3/17/2021

:boom: Breaking Changes

• Changed the #portalCameraRotationX and #portalCameraRotationY tags to use radians instead of degrees.

:rocket: Improvements

• Added the cameraZoom and cameraZoomOffset tags.
• Added the os.focusOn(botOrPosition, options?) function.
  • Works similarly to os.tweenTo() and os.moveTo() except that it takes an options object instead of a bunch of parameters.
  • Notable improvements includes that it can accept a position instead of a bot, it supports different easing types, and it will return a promise which completes when the camera movement is finished.
  • Additionally the rotation values are in radians instead of degrees.
• os.focusOn() and os.tweenTo() now use quadratic easing by default.
  • Additionally os.focusOn() supports specifying the easing type just like animateTag().
• os.tweenTo() and os.moveTo() are now deprecated and should no longer be used. They will be removed in a future release of CasualOS.
  • To encourage migration, they have been removed from the documentation and autocomplete.
• Added the experiment.beginAudioRecording() and experiment.endAudioRecording() functions to experiment with audio recording.
  • See the documentation for more information.

:bug: Bug Fixes

• Fixed an issue where camera offsets would not be taken into account when calculating the camera focus point.
  • This fixes issues with the focus point becoming more and more wrong as offsets are applied to the camera.
  • However, any calculations which try to calculate a camera position offset from the focus point must now subtract the current offset from the focus point to get the correct result. The example auxCode (cameraMovementExample) has been updated to reflect this change (version 2 and later).

V1.4.11

Date: 3/12/2021

:rocket: Improvements

• Added the math.scaleVector(vector, scale) function to make multiplying vectors by scalar values easy.

:bug: Bug Fixes

• Fixed an issue where the @onServerJoined event could be sent before all data was loaded.
  • This could happen if one player was changing data while another player was joining the server.
• Fixed an issue where custom portals would not open if the portal tags were not defined when the portal is opened.
• Fixed an issue where custom portals would always have default styling for their first load.

V1.4.10

Date: 3/9/2021

:rocket: Improvements

• Improved animateTag() to support animating multiple tags at once by accepting an object for the fromValue and toValue options properties.
  • Instead of calling animateTag(bot, tag, options), omit the tag argument and call animateTag(bot, options). This will indicate that you want to animate multiple tags at once over the same duration.
  • The animations that get triggered are grouped together, so cancelling one will cancel them all.
• Improved clearAnimations() to support accepting a list of tags to cancel.
• Added several 3D math functions:
  • getBotPosition(bot, dimension) - Gets the 3D position of a bot in the given dimension.
  • math.addVectors(...vectors) - Adds the given vectors together and returns the result.
  • math.subtractVectors(...vectors) - Subtracts the given vectors and returns the result.
  • math.negateVector(vector) - Mathematically negates the given vector and returns the result.
• Added the os.getFocusPoint(portal?) function to get the focus point that the camera is looking at.
  • This value is the same as the one highlighted by the #portalShowFocusPoint tag.
  • It is also backed up by cameraFocusX, cameraFocusY, cameraFocusZ tags on the portal bot.

V1.4.9

Date: 3/3/2021

:rocket: Improvements

• Changed the color of the progress spinner and progress bar on the loading dialog to gray.

:bug: Bug Fixes

• Fixed an issue where hover events could be sent for bots when the mouse was not directly over the game view.
• Fixed a couple issues where keyboard events were propagating outside the sheet and IDE portals.
• Fixed an issue where local variables in the top scope would not be included in the code editor autocomplete box.

V1.4.8

Date: 3/3/2021

:boom: Breaking Changes

• onRemoteData now uses that.remoteId instead of that.playerId.
• Renamed the portalPlayerZoom, portalPlayerRotationX and portalPlayerRotationY tags to portalCameraZoom and portalCameraRotationX and portalCameraRotationY.
• Renamed the player and otherPlayers spaces to tempShared and remoteTempShared.

:rocket: Improvements

• Added the @onError listen tag.
  • It is a shout and is triggered when an unhandled error occurs in a listen tag.
• Improved CasualOS to now include the Bot ID and tag name in internal console logs for unhandled errors.
• Added perferred alternatives for the following functions and listen tags:
  • server.serverPlayerCount() is now server.serverRemoteCount().
  • server.totalPlayerCount() is now server.totalRemoteCount().
  • server.stories() is now server.servers().
  • server.players() is now server.remotes().
  • sleep() is now os.sleep()
  • onServerSubscribed is now onServerJoined.
  • onServerUnsubscribed is now onServerLeave.
  • onPlayerPortalChanged is now onPortalChanged.
  • onRemotePlayerSubscribed is now onRemoteJoined
  • onRemotePlayerUnsubscribed is now onRemoteLeave.
  • Additionally, the that.playerId has been changed to that.remoteId in the new listen tags.
  • Note that the original tags and functions remain the same but will be removed at some point in the future.
• Added the web.get(), web.post(), and web.hook() functions as future replacements for the webhook() and webhook.post() functions.

:bug: Bug Fixes

• Fixed an issue where portal bots may not be defined before @onServerSubscribed is triggered.
• Fixed an issue where the white-space CSS property could not be used on menu bots.

V1.4.7

Date: 2/26/2021

:boom: Breaking Changes

• Renamed all the player functions to os.
  • Instead of player.toast() you should now do os.toast().
• Removed the configBot and configTag variables.
• Removed the portal config bot tags and replaced them with variables.
  • e.g. pagePortalConfigBot can now be accessed with the pagePortalBot variable.
  • You can now set the page portal color by doing pagePortalBot.tags.portalColor = "green".
  • By default a tempLocal bot will be created for each builtin portal.
  • You can also provide your own bot by calling portal.open(portalName, bot).
• Changed the portal.open() function to take a bot as a parameter.
  • It should now be called like portal.open(name, bot, tag?, options?).
  • After callilng this, the given bot will be available globally at {name}Bot.
  • For example portal.open("myPortal", bot, "main") will make bot available as myPortalBot.
• Removed player.getBot() and replaced it with configBot.
• Renamed the creator variable to creatorBot.
• Added the thisBot variable as a preferred alternative to this and bot.
• Moved the page and inventory camera tags to their portal config bots from the player bot.
  • e.g. pageCameraPositionX used to be on the player bot (now the config bot) but is now on the page portal bot.
• Changed the behavior of the transformer tag to use the page and inventory portal bots instead of the config bot (previously the player bot).
• Renamed the pageCameraPosition{X,Y,Z} and inventoryCameraPosition{X,Y,Z} tags to cameraPosition{X,Y,Z}.
• Renamed the pageCameraRotation{X,Y,Z} and inventoryCameraRotation{X,Y,Z} tags to cameraRotation{X,Y,Z}.
• Renamed the pagePixelHeight and pagePixelWidth tags to pixelHeight and pixelWidth.

:bug: Bug Fixes

• Fixed an issue where variables from other listen tags would appear as autocomplete options.

V1.4.5

Date: 2/23/2021

:rocket: Improvements

• Changed the ab-1 bootstrap URL to https://bootstrap.casualos.com/ab1.aux.
• Updated to three.js r125.
  • This fixes WebXR for Chrome 88 and later.
• Added the ability to disable hover states on menu item buttons using the menuItemHoverMode tag. It has three possible options:
  • auto - The bot will appear hoverable based on if it has a @onClick tag. (Default)
  • hover - The bot will appear hoverable.
  • none - The bot will not appear hoverable.
  • None of these options affect the existing functionality of any listen tags on menu bots.
• Added an initial version of the idePortal (IDE portal).
  • The IDE portal makes it easier to jump between tags to edit them in the multiline tag editor.
  • Setting the idePortal tag to a prefix (like 📖) will load every tag that starts with the prefix into the IDE portal and let you jump between them as if they are files in a text editor.
  • Currently it is pretty limited, but can be very useful for custom portals.

:bug: Bug Fixes

• Fixed an issue where it was not possible to enter numbers in menu bot input boxes.