Skip to main content
Version: Current

System Types

  • CasualOSDevice​

    Contains information about the device that AUX is running on.

    Members​

    • ab1BootstrapUrl string​

      The URL that AB-1 should be bootstraped from.

    • allowCollaborationUpgrade boolean​

      Whether this device can enable collaboration features after the simulation has started.

    • isCollaborative boolean​

      Whether this device has enabled collaboration features.

      When creating a simulation, this property may be used to enable or disable features that facilitate users interacting with each other. For example, setting isCollaborative to false would make the shared partition act like a tempLocal partition.

    • supportsAR boolean​

      Whether the device supports augmented reality features.

    • supportsVR boolean​

      Whether the device supports virtual reality features.

  • CasualOSVersion​

    Contains information about the version of AUX that is running.

    Members​

    • alpha (number | boolean)​

      Whether this version is an alpha (i.e. test) version.

    • hash string​

      The commit of the hash that AUX was built from.

    • major number​

      The major portion of the version.

    • minor number​

      The minor portion of the version.

    • patch number​

      The patch portion of the version.

    • playerMode ("player" | "builder")​

      Gets the player mode of this CasualOS version.

      • "player" indicates that the instance has been configured for experiencing AUXes.
      • "builder" indicates that the instance has been configured for building AUXes.

    • version string​

      The full version number.

  • OpenConsoleAction​

    An event that is used to toggle whether the console is open.

    Members​

    • open boolean​

      Whether the console should be open.

    • type "open_console"​

    • uncopiable? boolean​

      Whether the action can be structure cloned. If true, then the action should not be passed across message ports without special handling.

  • RunScriptAction​

    Defines an event that executes a script.

    Members​

    • playerId? string​

      The ID of the player that created this task. Set by remote action handlers when a task is recieved from a remote player.

    • script string​

      The script that should be executed.

    • taskId (string | number)​

      The ID of the async task.

    • type "run_script"​

      The type of the event. This helps determine how the event should be applied to the state.

    • uncopiable? boolean​

      Whether the action can be structure cloned. If true, then the action should not be passed across message ports without special handling.