@casual-simulation/aux-runtime 3.2.7 → 3.2.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@casual-simulation/aux-runtime",
3
- "version": "3.2.7",
3
+ "version": "3.2.9",
4
4
  "description": "Runtime for AUX projects",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
@@ -32,8 +32,8 @@
32
32
  "access": "public"
33
33
  },
34
34
  "dependencies": {
35
- "@casual-simulation/aux-common": "^3.2.7",
36
- "@casual-simulation/aux-records": "^3.2.7",
35
+ "@casual-simulation/aux-common": "^3.2.9",
36
+ "@casual-simulation/aux-records": "^3.2.9",
37
37
  "@casual-simulation/crypto": "^3.2.7",
38
38
  "@casual-simulation/engine262": "0.0.1-4de2170374e22761996e46eb1362f4496ee57f8f",
39
39
  "@casual-simulation/error-stack-parser": "^2.0.7",
@@ -79,5 +79,5 @@
79
79
  "**/*.d.ts",
80
80
  "**/*.def"
81
81
  ],
82
- "gitHead": "90cad6020f3b60f67771679be4c01fa439faaa12"
82
+ "gitHead": "372e367bd779842ff2d101a7d6caf616a3a0b6fa"
83
83
  }
@@ -1,7 +1,10 @@
1
1
  /**
2
2
  * Contains information about the device that AUX is running on.
3
3
  *
4
- * @dochash types/os
4
+ * @dochash types/os/system
5
+ * @doctitle System Types
6
+ * @docsidebar System
7
+ * @docdescription Types that are used in system-related actions.
5
8
  * @docname CasualOSDevice
6
9
  */
7
10
  export interface AuxDevice {
@@ -84,7 +84,7 @@ export type Mod = BotTags | Bot;
84
84
  /**
85
85
  * An interface that is used to say which user/device/session an event should be sent to.
86
86
  *
87
- * @dochash types/os
87
+ * @dochash types/os/event
88
88
  * @docname SessionSelector
89
89
  */
90
90
  export interface SessionSelector {
@@ -1457,7 +1457,7 @@ export interface RecordFileApiFailure {
1457
1457
  /**
1458
1458
  * Defines an interface that contains options for a snap grid for {@link os.addDropGrid}.
1459
1459
  *
1460
- * @dochash types/os
1460
+ * @dochash types/os/portals
1461
1461
  * @docname SnapGridTarget
1462
1462
  */
1463
1463
  export interface SnapGridTarget {
@@ -1517,14 +1517,14 @@ export interface SnapGridTarget {
1517
1517
  /**
1518
1518
  * The possible results for a "join room" request.
1519
1519
  *
1520
- * @dochash types/os
1520
+ * @dochash types/os/portals
1521
1521
  * @docname JoinRoomResult
1522
1522
  */
1523
1523
  export type JoinRoomResult = JoinRoomSuccess | JoinRoomFailure;
1524
1524
  /**
1525
1525
  * Defines an interface that represents a successful "join room" request.
1526
1526
  *
1527
- * @dochash types/os
1527
+ * @dochash types/os/portals
1528
1528
  * @docname JoinRoomSuccess
1529
1529
  */
1530
1530
  export interface JoinRoomSuccess {
@@ -1537,7 +1537,7 @@ export interface JoinRoomSuccess {
1537
1537
  /**
1538
1538
  * Defines an interface that represents a failed "join room" request.
1539
1539
  *
1540
- * @dochash types/os
1540
+ * @dochash types/os/portals
1541
1541
  * @docname JoinRoomFailure
1542
1542
  */
1543
1543
  export interface JoinRoomFailure {
@@ -1558,14 +1558,14 @@ export interface JoinRoomFailure {
1558
1558
  /**
1559
1559
  * The possible results for a "leave room" request.
1560
1560
  *
1561
- * @dochash types/os
1561
+ * @dochash types/os/portals
1562
1562
  * @docname LeaveRoomResult
1563
1563
  */
1564
1564
  export type LeaveRoomResult = LeaveRoomSuccess | LeaveRoomFailure;
1565
1565
  /**
1566
1566
  * Defines an interface that represents a successful "leave room" request.
1567
1567
  *
1568
- * @dochash types/os
1568
+ * @dochash types/os/portals
1569
1569
  * @docname LeaveRoomSuccess
1570
1570
  */
1571
1571
  export interface LeaveRoomSuccess {
@@ -1578,7 +1578,7 @@ export interface LeaveRoomSuccess {
1578
1578
  /**
1579
1579
  * Defines an interface that represents a failed "leave room" request.
1580
1580
  *
1581
- * @dochash types/os
1581
+ * @dochash types/os/portals
1582
1582
  * @docname LeaveRoomFailure
1583
1583
  */
1584
1584
  export interface LeaveRoomFailure {
@@ -1599,14 +1599,14 @@ export interface LeaveRoomFailure {
1599
1599
  /**
1600
1600
  * The possible results for a "set room options" request.
1601
1601
  *
1602
- * @dochash types/os
1602
+ * @dochash types/os/portals
1603
1603
  * @docname SetRoomOptionsResult
1604
1604
  */
1605
1605
  export type SetRoomOptionsResult = SetRoomOptionsSuccess | SetRoomOptionsFailure;
1606
1606
  /**
1607
1607
  * Defines an interface that represents a successful "set room options" request.
1608
1608
  *
1609
- * @dochash types/os
1609
+ * @dochash types/os/portals
1610
1610
  * @docname SetRoomOptionsSuccess
1611
1611
  */
1612
1612
  export interface SetRoomOptionsSuccess {
@@ -1637,14 +1637,14 @@ export interface SetRoomOptionsFailure {
1637
1637
  /**
1638
1638
  * The possible results for a "get room options" request.
1639
1639
  *
1640
- * @dochash types/os
1640
+ * @dochash types/os/portals
1641
1641
  * @docname GetRoomOptionsResult
1642
1642
  */
1643
1643
  export type GetRoomOptionsResult = GetRoomOptionsSuccess | GetRoomOptionsFailure;
1644
1644
  /**
1645
1645
  * Defines an interface that represents a successful "get room options" request.
1646
1646
  *
1647
- * @dochash types/os
1647
+ * @dochash types/os/portals
1648
1648
  * @docname GetRoomOptionsSuccess
1649
1649
  */
1650
1650
  export interface GetRoomOptionsSuccess {
@@ -1661,7 +1661,7 @@ export interface GetRoomOptionsSuccess {
1661
1661
  /**
1662
1662
  * Defines an interface that represents a failed "get room options" request.
1663
1663
  *
1664
- * @dochash types/os
1664
+ * @dochash types/os/portals
1665
1665
  * @docname GetRoomOptionsFailure
1666
1666
  */
1667
1667
  export interface GetRoomOptionsFailure {
@@ -1678,14 +1678,14 @@ export interface GetRoomOptionsFailure {
1678
1678
  /**
1679
1679
  * The possible results for a "get room track options" request.
1680
1680
  *
1681
- * @dochash types/os
1681
+ * @dochash types/os/portals
1682
1682
  * @docname GetRoomTrackOptionsResult
1683
1683
  */
1684
1684
  export type GetRoomTrackOptionsResult = GetRoomTrackOptionsSuccess | GetRoomTrackOptionsFailure;
1685
1685
  /**
1686
1686
  * Defines an interface that represents a successful "get room track options" request.
1687
1687
  *
1688
- * @dochash types/os
1688
+ * @dochash types/os/portals
1689
1689
  * @docname GetRoomTrackOptionsSuccess
1690
1690
  */
1691
1691
  export interface GetRoomTrackOptionsSuccess {
@@ -1706,7 +1706,7 @@ export interface GetRoomTrackOptionsSuccess {
1706
1706
  /**
1707
1707
  * Defines an interface that represents a failed "get room track options" request.
1708
1708
  *
1709
- * @dochash types/os
1709
+ * @dochash types/os/portals
1710
1710
  * @docname GetRoomTrackOptionsFailure
1711
1711
  */
1712
1712
  export interface GetRoomTrackOptionsFailure {
@@ -1731,14 +1731,14 @@ export interface GetRoomTrackOptionsFailure {
1731
1731
  /**
1732
1732
  * The possible results for a "set room track options" request.
1733
1733
  *
1734
- * @dochash types/os
1734
+ * @dochash types/os/portals
1735
1735
  * @docname SetRoomTrackOptionsResult
1736
1736
  */
1737
1737
  export type SetRoomTrackOptionsResult = SetRoomTrackOptionsSuccess | SetRoomTrackOptionsFailure;
1738
1738
  /**
1739
1739
  * Defines an interface that represents a successful "set room track options" request.
1740
1740
  *
1741
- * @dochash types/os
1741
+ * @dochash types/os/portals
1742
1742
  * @docname SetRoomTrackOptionsSuccess
1743
1743
  */
1744
1744
  export interface SetRoomTrackOptionsSuccess {
@@ -1759,7 +1759,7 @@ export interface SetRoomTrackOptionsSuccess {
1759
1759
  /**
1760
1760
  * Defines an interface that represents a failed "set room track options" request.
1761
1761
  *
1762
- * @dochash types/os
1762
+ * @dochash types/os/portals
1763
1763
  * @docname SetRoomTrackOptionsFailure
1764
1764
  */
1765
1765
  export interface SetRoomTrackOptionsFailure {
@@ -1784,14 +1784,14 @@ export interface SetRoomTrackOptionsFailure {
1784
1784
  /**
1785
1785
  * The possible results for a "get room remote options" request.
1786
1786
  *
1787
- * @dochash types/os
1787
+ * @dochash types/os/portals
1788
1788
  * @docname GetRoomRemoteOptionsResult
1789
1789
  */
1790
1790
  export type GetRoomRemoteOptionsResult = GetRoomRemoteOptionsSuccess | GetRoomRemoteOptionsFailure;
1791
1791
  /**
1792
1792
  * Defines an interface that represents a successful "get room remote options" request.
1793
1793
  *
1794
- * @dochash types/os
1794
+ * @dochash types/os/portals
1795
1795
  * @docname GetRoomRemoteOptionsSuccess
1796
1796
  */
1797
1797
  export interface GetRoomRemoteOptionsSuccess {
@@ -1812,7 +1812,7 @@ export interface GetRoomRemoteOptionsSuccess {
1812
1812
  /**
1813
1813
  * Defines an interface that represents a failed "get room remote options" request.
1814
1814
  *
1815
- * @dochash types/os
1815
+ * @dochash types/os/portals
1816
1816
  * @docname GetRoomRemoteOptionsFailure
1817
1817
  */
1818
1818
  export interface GetRoomRemoteOptionsFailure {
@@ -1859,7 +1859,7 @@ export interface RecordFileOptions {
1859
1859
  /**
1860
1860
  * Defines an interface that represents the result of a raycast operation.
1861
1861
  *
1862
- * @dochash types/os
1862
+ * @dochash types/os/portals
1863
1863
  * @docname RaycastResult
1864
1864
  */
1865
1865
  export interface RaycastResult {
@@ -1912,7 +1912,7 @@ export interface BotIntersection {
1912
1912
  /**
1913
1913
  * Defines an interface that represents a ray. That is, a line that has a start position and a direction, but no end.
1914
1914
  *
1915
- * @dochash types/os
1915
+ * @dochash types/os/portals
1916
1916
  * @docname RaycastRay
1917
1917
  */
1918
1918
  export interface RaycastRay {
@@ -1928,7 +1928,7 @@ export interface RaycastRay {
1928
1928
  /**
1929
1929
  * Defines an interface that represents a file that was uploaded.
1930
1930
  *
1931
- * @dochash types/os
1931
+ * @dochash types/os/files
1932
1932
  * @docname UploadedFile
1933
1933
  */
1934
1934
  export interface UploadedFile {
@@ -2087,10 +2087,10 @@ export declare function createDefaultLibrary(context: AuxGlobalContext): {
2087
2087
  * @example Open the sheetPortal to "testDimension".
2088
2088
  * configBot.tags.sheetPortal = "testDimension";
2089
2089
  *
2090
- * @dochash actions/os
2091
- * @doctitle OS Actions
2092
- * @docsidebar OS
2093
- * @docdescription OS actions are used to interact with the player's current session.
2090
+ * @dochash actions/os/system
2091
+ * @doctitle System Actions
2092
+ * @docsidebar System
2093
+ * @docdescription System actions are used to get information about the current session.
2094
2094
  * @docname configBot
2095
2095
  * @docgroup 01-os
2096
2096
  */
@@ -2186,7 +2186,7 @@ export declare function createDefaultLibrary(context: AuxGlobalContext): {
2186
2186
  * @example Toast the number of miliseconds since the Unix Epoch
2187
2187
  * os.toast(os.localTime);
2188
2188
  *
2189
- * @dochash actions/time
2189
+ * @dochash actions/os/time
2190
2190
  * @doctitle Time Actions
2191
2191
  * @docsidebar Time
2192
2192
  * @docdescription Time actions make working with time across devices easy.
@@ -2203,7 +2203,7 @@ export declare function createDefaultLibrary(context: AuxGlobalContext): {
2203
2203
  * @example Toast the current shared time
2204
2204
  * os.toast(os.agreedUponTime);
2205
2205
  *
2206
- * @dochash actions/time
2206
+ * @dochash actions/os/time
2207
2207
  * @docgroup 01-time
2208
2208
  * @docname os.agreedUponTime
2209
2209
  */
@@ -2213,7 +2213,7 @@ export declare function createDefaultLibrary(context: AuxGlobalContext): {
2213
2213
  *
2214
2214
  * If an agreed upon time cannot be determined (for example, because collaboration is disabled in the inst), then this value will always be `NaN`.
2215
2215
  *
2216
- * @dochash actions/time
2216
+ * @dochash actions/os/time
2217
2217
  * @docgroup 01-time
2218
2218
  * @docname os.instLatency
2219
2219
  */
@@ -2223,7 +2223,7 @@ export declare function createDefaultLibrary(context: AuxGlobalContext): {
2223
2223
  *
2224
2224
  * If an agreed upon time cannot be determined (for example, because collaboration is disabled in the inst), then this value will always be `NaN`.
2225
2225
  *
2226
- * @dochash actions/time
2226
+ * @dochash actions/os/time
2227
2227
  * @docgroup 01-time
2228
2228
  * @docname os.instTimeOffset
2229
2229
  */
@@ -2233,7 +2233,7 @@ export declare function createDefaultLibrary(context: AuxGlobalContext): {
2233
2233
  *
2234
2234
  * If an agreed upon time cannot be determined (for example, because collaboration is disabled in the inst), then this value will always be `NaN`.
2235
2235
  *
2236
- * @dochash actions/time
2236
+ * @dochash actions/os/time
2237
2237
  * @docgroup 01-time
2238
2238
  * @docname os.instTimeOffsetSpread
2239
2239
  */
@@ -2244,7 +2244,7 @@ export declare function createDefaultLibrary(context: AuxGlobalContext): {
2244
2244
  *
2245
2245
  * If an agreed upon time cannot be determined (for example, because collaboration is disabled in the inst), then this value will always be `NaN`.
2246
2246
  *
2247
- * @dochash actions/time
2247
+ * @dochash actions/os/time
2248
2248
  * @docgroup 01-time
2249
2249
  * @docname os.deadReckoningTime
2250
2250
  */