@casual-simulation/aux-common
Advanced tools
Changelog
V0.7.5
player.goToContext()
fast by not triggering a page reload.diff.create(file, ...tags)
function.
applyDiff()
or in create()
.diff.create(this, /aux\..+/, 'fun')
aux.*
and fun
tags.player.currentContext()
function.
onPlayerContextEnter()
event.
that
variable is an object containing the following properties:
context
- the context that was loaded.array.first()
will get the first element.array.last()
will get the last element..first()
function to get the first file returned from a query.Changelog
V0.7.0
aux.context.grid
tag not use objects for hex heights.auxplayer.com/channel
load AUX Builder and auxplayer.com/channel/context
load AUX Player.onConnected()
and onDisconnected()
events to notify scripts when the user becomes connected for disconnected from the server.player.isConnected()
to help formulas easily determine if the player is currently connected.
aux.connected
tag on the user's file.Changelog
V0.6.5
aux.iframe
tag that allows you to embed HTML pages inside an AUX.
aux.iframe
: URL of the page to embedaux.iframe.x
: X local positionaux.iframe.y
: Y local positionaux.iframe.z
: Z local positionaux.iframe.size.x
: Width of the iframe plane geometryaux.iframe.size.y
: Height of the iframe plane geometryaux.iframe.rotation.x
: X local rotationaux.iframe.rotation.y
: Y local rotationaux.iframe.rotation.z
: Z local rotationaux.iframe.element.width
: The pixel width of the iframe DOM elementaux.iframe.scale
: The uniform scale of the iframe plane geometryChangelog
V0.6.2
that.face
variable on an onClick
tag.aux.pickupable
and replaced it with special values for aux.movable
.
aux.movable
to true
means it can be moved anywhere.aux.movable
to false
means it cannot be moved.aux.movable
to clone
means that dragging it will create a clone that can be placed anywhere.aux.movable
to pickup
means it can be moved into any other context but not moved within the context it is currently in (only applies to AUX Player).aux.movable
to drag
means it can be moved anywhere within the context it is currently in but not moved to another context. (only applies to AUX Player).showQRCode(data)
and hideQRCode()
from formula actions.aux.whitelist
and aux.blacklist
.
aux.whitelist
to Kal
will ensure that only users named Kal
can access the session.aux.blacklist
to Kal
will ensure that users named Kal
cannot access the session.Changelog
V0.6.0
Improvements
aux.progressBar
tag that generates a progressbar above the file, this tag can be set to any value form 0 to 1.
aux.progressBar.color
and aux.progressBar.backgroundColor
to color the progressbar's components.aux.progressBar.anchor
to set the facing direction of the progress bar relative to the file.aux.pickupable
to control whether files can be placed into the inventory in the player or not, will be true (able to be put in inventory) by default.
aux.pickupable
is true but aux.movable
is false, the file can still be dragged into the inventory without moving the file position. It can also be dragged out of the inventory by setting the file position only until is is placed, then not allowing position changes again as aux.movable
is still false.https://auxplayer.com/channel/context
)auxplayer.com/channel/context
)channel/context
)channel
)channels
set to the ID of the channel that you want to load.channels=abc/test
will load the abc/test
channel.https://auxplayer.com/channel/context?channels=abc/test&channels=other/channel
.superShout(event, arg)
performs a shout that goes to every loaded channel. This is the only way for channels to communicate with each other.player.loadChannel(id)
loads the channel with the given ID.player.unloadChannel(id)
unloads the channel with the given ID.onQRCodeScannerOpened()
onQRCodeScannerClosed()
onQRCodeScanned()
onTapCode()
player.getFile().aux._userSimulationsContext
.aux.channel
tag.
aux.channel
tag value is used as a channel ID and then AUX Player loads it for each file.player.unloadChannel(id)
is called, we only remove simulation files that are in the channel that the script is running in.player.loadChannel(id)
with the same ID the channel will remain loaded because at least one channel has requested that it be loaded.whisper(file, event, argument)
formula function that sends shouts to a single file.aux.version
tag to the globals file which will be used to help determine when breaking changes in the AUX file format occur.Ctrl+C
or Cmd+C
will cause the currently selected files to be copied to the user's clipboard.Ctrl+V
or Cmd+V
will cause the currently selected files to be pasted into the world where the user's cursor is."Copy"
option in the context menu.
Ctrl+V
keybinding after copying the worksurface will paste a duplicate worksurface with duplicates of all the files that were on the surface..aux
files into AUX Builder.
player.hasFileInInventory(file)
formula function that determines if the given file or list of files are in the current player's inventory.
handlePointerEnter
and handlePointerExit
function logic to only work in PlayerInteractionManager
.handlePointerDown
to PlayerInteractionManager
so down events in general can be collected on the player.Raise
and Lower
options on the workspace dropdown will now effect the entrire workspace if it has been expanded.Changelog
V0.5.4
aux.context.movable
to false
will prevent this behavior.Changelog
V0.5.2
onDragAny/onDropAny
actions to be onAnyDrag/onAnyDrop
.formula-lib.ts
has changed isPlayerInContext
export to player.isInContext
.formula-lib.ts
has changed makeDiff
export to diff
.openQRCodeScanner()
and closeQRCodeScanner()
functions.
onQRCodeScanned()
event is triggered with the that
variable bound to the scanned QR code.onQRCodeScannerOpened()
event is triggered whenever the QR Code Scanner is opened.onQRCodeScannerClosed()
event is triggered whenever the QR Code Scanner is closed.Changelog
V0.5.1
guest_###
upon logging into a new guest account for the first time.Changelog
V0.5.0
clone()
function.create()
function to be able to accept lists of diffs/files.
create(this, [ { hello: true }, { hello: false } ])
will create two files. One with #hello: true
and one with #hello: false
.create(this, [ { row: 1 }, { row: 2 } ], [ { column: 1 }, { column: 2 } ])
will create four files for every possible combination between row: 1|2
and column: 1|2
.create(this, { 'aux.color': 'red' }, [ makeDiff.addToContext('context_1'), makeDiff.addToContext('context_2') ])
will create two files that are both red but are on different contexts.create(this, @aux.color('red'), { 'aux.color': 'green' })
will find every file that is red, duplicate them, and set the new files' colors to green.tweenPlayerTo
function to set a consistent zoom on file focus..aux
file from the current selection/search.Changelog
V0.4.15
Improvements
PNG
JPG
GIF
WEBP
BMP
TIFF
ICO
onPointerEnter()
and onPointerExit()
events that are triggered on files that the user's cursor hovers.formula-lib.ts
has added a isPlayerInContext
function to determine if path is in the expected context in aux-player.formula-lib.ts
has changed tweenTo
function to tweenPlayerTo
for better clarity on the function's use.