omegga 1.17.0 → 1.17.2

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.
Files changed (161) hide show
  1. package/dist/main.js +15 -0
  2. package/dist/main.js.map +1 -1
  3. package/package.json +14 -3
  4. package/.nvmrc +0 -1
  5. package/CHANGELOG.md +0 -885
  6. package/book/.nojekyll +0 -1
  7. package/book/404.html +0 -246
  8. package/book/CNAME +0 -1
  9. package/book/api/events.html +0 -358
  10. package/book/api/index.html +0 -282
  11. package/book/api/log-parsing.html +0 -416
  12. package/book/api/omegga.html +0 -980
  13. package/book/api/player.html +0 -762
  14. package/book/api/plugin.html +0 -449
  15. package/book/api/types.html +0 -614
  16. package/book/assets/fonts/GlacialIndifferenceBold.ttf +0 -0
  17. package/book/assets/fonts/GlacialIndifferenceRegular.ttf +0 -0
  18. package/book/assets/logo.png +0 -0
  19. package/book/ayu-highlight-3fdfc3ac.css +0 -77
  20. package/book/book-609e4cb8.js +0 -870
  21. package/book/clipboard-1626706a.min.js +0 -7
  22. package/book/config.html +0 -326
  23. package/book/containers.html +0 -338
  24. package/book/css/chrome-d279d366.css +0 -770
  25. package/book/css/general-e96d0476.css +0 -464
  26. package/book/css/print-9e4910d8.css +0 -50
  27. package/book/css/variables-8adf115d.css +0 -383
  28. package/book/elasticlunr-ef4e11c1.min.js +0 -10
  29. package/book/env.html +0 -283
  30. package/book/favicon-8114d1fc.png +0 -0
  31. package/book/favicon-de23e50b.svg +0 -22
  32. package/book/fonts/OPEN-SANS-LICENSE.txt +0 -202
  33. package/book/fonts/SOURCE-CODE-PRO-LICENSE.txt +0 -93
  34. package/book/fonts/fonts-9644e21d.css +0 -100
  35. package/book/fonts/open-sans-v17-all-charsets-300-7736aa35.woff2 +0 -0
  36. package/book/fonts/open-sans-v17-all-charsets-300italic-2c7b95c0.woff2 +0 -0
  37. package/book/fonts/open-sans-v17-all-charsets-600-486c6759.woff2 +0 -0
  38. package/book/fonts/open-sans-v17-all-charsets-600italic-1a3e8659.woff2 +0 -0
  39. package/book/fonts/open-sans-v17-all-charsets-700-c22fe8c7.woff2 +0 -0
  40. package/book/fonts/open-sans-v17-all-charsets-700italic-238ae959.woff2 +0 -0
  41. package/book/fonts/open-sans-v17-all-charsets-800-3d2c812a.woff2 +0 -0
  42. package/book/fonts/open-sans-v17-all-charsets-800italic-ba1521ec.woff2 +0 -0
  43. package/book/fonts/open-sans-v17-all-charsets-italic-6c9463f7.woff2 +0 -0
  44. package/book/fonts/open-sans-v17-all-charsets-regular-2e3b1d34.woff2 +0 -0
  45. package/book/fonts/source-code-pro-v11-all-charsets-500-2bdd9410.woff2 +0 -0
  46. package/book/guides/https.html +0 -352
  47. package/book/guides/index.html +0 -276
  48. package/book/guides/pterodactyl.html +0 -397
  49. package/book/guides/remote.html +0 -328
  50. package/book/guides/wires.html +0 -518
  51. package/book/highlight-493f70e1.css +0 -83
  52. package/book/highlight-abc7f01d.js +0 -54
  53. package/book/index.html +0 -299
  54. package/book/install/index.html +0 -287
  55. package/book/install/linux.html +0 -407
  56. package/book/install/wsl.html +0 -286
  57. package/book/mark-09e88c2c.min.js +0 -7
  58. package/book/metrics.html +0 -662
  59. package/book/permissions.html +0 -532
  60. package/book/plugins/index.html +0 -521
  61. package/book/plugins/installing.html +0 -284
  62. package/book/plugins/jsonrpc.html +0 -519
  63. package/book/plugins/safe.html +0 -368
  64. package/book/plugins/unsafe.html +0 -317
  65. package/book/print.html +0 -4852
  66. package/book/running.html +0 -283
  67. package/book/searcher-09f2665d.js +0 -558
  68. package/book/searchindex-3480b9e2.js +0 -1
  69. package/book/theme/omegga-3aa7cb40.css +0 -196
  70. package/book/theme/wirescript-hljs-69fbef4b.js +0 -75
  71. package/book/toc-faa8fb01.js +0 -455
  72. package/book/toc.html +0 -32
  73. package/book/tomorrow-night-4c0ae647.css +0 -104
  74. package/book/troubleshooting.html +0 -330
  75. package/book/uninstall.html +0 -275
  76. package/docs/CNAME +0 -1
  77. package/docs/README.md +0 -44
  78. package/docs/SUMMARY.md +0 -33
  79. package/docs/api/README.md +0 -21
  80. package/docs/api/events.md +0 -109
  81. package/docs/api/log-parsing.md +0 -162
  82. package/docs/api/omegga.md +0 -785
  83. package/docs/api/player.md +0 -525
  84. package/docs/api/plugin.md +0 -284
  85. package/docs/api/types.md +0 -339
  86. package/docs/assets/fonts/GlacialIndifferenceBold.ttf +0 -0
  87. package/docs/assets/fonts/GlacialIndifferenceRegular.ttf +0 -0
  88. package/docs/assets/logo.png +0 -0
  89. package/docs/config.md +0 -76
  90. package/docs/containers.md +0 -110
  91. package/docs/env.md +0 -27
  92. package/docs/guides/README.md +0 -14
  93. package/docs/guides/https.md +0 -121
  94. package/docs/guides/pterodactyl.md +0 -155
  95. package/docs/guides/remote.md +0 -81
  96. package/docs/guides/wires.md +0 -292
  97. package/docs/install/README.md +0 -27
  98. package/docs/install/linux.md +0 -156
  99. package/docs/install/wsl.md +0 -40
  100. package/docs/metrics.md +0 -451
  101. package/docs/permissions.md +0 -264
  102. package/docs/plugins/README.md +0 -280
  103. package/docs/plugins/installing.md +0 -47
  104. package/docs/plugins/jsonrpc.md +0 -258
  105. package/docs/plugins/safe.md +0 -136
  106. package/docs/plugins/unsafe.md +0 -68
  107. package/docs/running.md +0 -43
  108. package/docs/troubleshooting.md +0 -38
  109. package/docs/uninstall.md +0 -22
  110. package/drizzle.config.ts +0 -7
  111. package/drizzle.plugin.config.ts +0 -7
  112. package/eslint.config.mjs +0 -135
  113. package/public/assets/IconCheck-DOe3u7iH.js.map +0 -1
  114. package/public/assets/IconLockOpen-Bs7Tsf6u.js.map +0 -1
  115. package/public/assets/IconShieldCheck-Bjlm8mX2.js.map +0 -1
  116. package/public/assets/IconWorld-DgiOjCuo.js.map +0 -1
  117. package/public/assets/IconWorldPlus-DJJNrT87.js.map +0 -1
  118. package/public/assets/IconX-CvmO0bbE.js.map +0 -1
  119. package/public/assets/_commonjsHelpers-CE1G-McA.js.map +0 -1
  120. package/public/assets/app-Mh--ChqF.js.map +0 -1
  121. package/public/assets/auth-DQtYicf-.js.map +0 -1
  122. package/public/assets/client-BT1QYH0O.js.map +0 -1
  123. package/public/assets/index-2cgXLhrt.js.map +0 -1
  124. package/public/assets/index-B0LowBt1.js.map +0 -1
  125. package/public/assets/index-BDkarAkX.js.map +0 -1
  126. package/public/assets/index-BTSbuqTr.js.map +0 -1
  127. package/public/assets/index-CJ4e7_2M.js.map +0 -1
  128. package/public/assets/index-CSV4ZXsq.js.map +0 -1
  129. package/public/assets/index-CrN8I5Az.js.map +0 -1
  130. package/public/assets/index-CtCtK5BX.js.map +0 -1
  131. package/public/assets/index-D0OPOe3j.js.map +0 -1
  132. package/public/assets/jsx-runtime-BX5r4UiA.js.map +0 -1
  133. package/public/assets/jsx-runtime-DldvXD6N.js.map +0 -1
  134. package/public/assets/shared/@components-DBMXoJMT.js.map +0 -1
  135. package/public/assets/shared/@hooks-DlZ8TOOZ.js.map +0 -1
  136. package/public/assets/shared/@nanostores_react-DJPF1Eqx.js.map +0 -1
  137. package/public/assets/shared/@tabler_icons-react-i-Q2c_A_.js.map +0 -1
  138. package/public/assets/shared/@utils-BA2UvC9c.js.map +0 -1
  139. package/public/assets/shared/nanostores-BFqqIY_c.js.map +0 -1
  140. package/public/assets/shared/react-dom-8Rcmh_FG.js.map +0 -1
  141. package/public/assets/shared/react-iXLZ_Bod.js.map +0 -1
  142. package/public/assets/shared/react_jsx-runtime-BwhiLcBy.js.map +0 -1
  143. package/public/assets/shared/wouter-CUC1caxu.js.map +0 -1
  144. package/public/assets/user-XF1UyJMA.js.map +0 -1
  145. package/public/assets/utils-Ds3ldd-U.js.map +0 -1
  146. package/server/data/nedb-imported.marker +0 -1
  147. package/server/data/omegga-plugins.db +0 -0
  148. package/server/data/omegga-plugins.db-shm +0 -0
  149. package/server/data/omegga-plugins.db-wal +0 -0
  150. package/server/data/omegga-sessions.db +0 -0
  151. package/server/data/omegga-sessions.db-shm +0 -0
  152. package/server/data/omegga-sessions.db-wal +0 -0
  153. package/server/data/omegga.db +0 -0
  154. package/server/data/omegga.db-shm +0 -0
  155. package/server/data/omegga.db-wal +0 -0
  156. package/server/data/web_session_token +0 -1
  157. package/server/fakegame/Binaries/Linux/BrickadiaServer-Linux-Shipping +0 -11
  158. package/server/omegga-config.yml +0 -7
  159. package/theme/omegga.css +0 -196
  160. package/theme/wirescript-hljs.js +0 -75
  161. package/tools/tag.sh +0 -48
package/book/api/omegga.html DELETED
@@ -1,980 +0,0 @@
1
- <!DOCTYPE HTML>
2
- <html lang="en" class="navy sidebar-visible" dir="ltr">
3
- <head>
4
- <!-- Book generated using mdBook -->
5
- <meta charset="UTF-8">
6
- <title>Omegga - Omegga</title>
7
-
8
-
9
- <!-- Custom HTML head -->
10
-
11
- <meta name="description" content="Brickadia server installer, updater, manager, wrapper, configurator, and automator">
12
- <meta name="viewport" content="width=device-width, initial-scale=1">
13
- <meta name="theme-color" content="#ffffff">
14
-
15
- <link rel="icon" href="../favicon-de23e50b.svg">
16
- <link rel="shortcut icon" href="../favicon-8114d1fc.png">
17
- <link rel="stylesheet" href="../css/variables-8adf115d.css">
18
- <link rel="stylesheet" href="../css/general-e96d0476.css">
19
- <link rel="stylesheet" href="../css/chrome-d279d366.css">
20
- <link rel="stylesheet" href="../css/print-9e4910d8.css" media="print">
21
-
22
- <!-- Fonts -->
23
- <link rel="stylesheet" href="../fonts/fonts-9644e21d.css">
24
-
25
- <!-- Highlight.js Stylesheets -->
26
- <link rel="stylesheet" id="mdbook-highlight-css" href="../highlight-493f70e1.css">
27
- <link rel="stylesheet" id="mdbook-tomorrow-night-css" href="../tomorrow-night-4c0ae647.css">
28
- <link rel="stylesheet" id="mdbook-ayu-highlight-css" href="../ayu-highlight-3fdfc3ac.css">
29
-
30
- <!-- Custom theme stylesheets -->
31
- <link rel="stylesheet" href="../theme/omegga-3aa7cb40.css">
32
-
33
-
34
- <!-- Provide site root and default themes to javascript -->
35
- <script>
36
- const path_to_root = "../";
37
- const default_light_theme = "navy";
38
- const default_dark_theme = "navy";
39
- window.path_to_searchindex_js = "../searchindex-3480b9e2.js";
40
- </script>
41
- <!-- Start loading toc.js asap -->
42
- <script src="../toc-faa8fb01.js"></script>
43
- </head>
44
- <body>
45
- <div id="mdbook-help-container">
46
- <div id="mdbook-help-popup">
47
- <h2 class="mdbook-help-title">Keyboard shortcuts</h2>
48
- <div>
49
- <p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
50
- <p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
51
- <p>Press <kbd>?</kbd> to show this help</p>
52
- <p>Press <kbd>Esc</kbd> to hide this help</p>
53
- </div>
54
- </div>
55
- </div>
56
- <div id="mdbook-body-container">
57
- <!-- Work around some values being stored in localStorage wrapped in quotes -->
58
- <script>
59
- try {
60
- let theme = localStorage.getItem('mdbook-theme');
61
- let sidebar = localStorage.getItem('mdbook-sidebar');
62
-
63
- if (theme.startsWith('"') && theme.endsWith('"')) {
64
- localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
65
- }
66
-
67
- if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
68
- localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
69
- }
70
- } catch (e) { }
71
- </script>
72
-
73
- <!-- Set the theme before any content is loaded, prevents flash -->
74
- <script>
75
- const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
76
- let theme;
77
- try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
78
- if (theme === null || theme === undefined) { theme = default_theme; }
79
- const html = document.documentElement;
80
- html.classList.remove('navy')
81
- html.classList.add(theme);
82
- html.classList.add("js");
83
- </script>
84
-
85
- <input type="checkbox" id="mdbook-sidebar-toggle-anchor" class="hidden">
86
-
87
- <!-- Hide / unhide sidebar before it is displayed -->
88
- <script>
89
- let sidebar = null;
90
- const sidebar_toggle = document.getElementById("mdbook-sidebar-toggle-anchor");
91
- if (document.body.clientWidth >= 1080) {
92
- try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
93
- sidebar = sidebar || 'visible';
94
- } else {
95
- sidebar = 'hidden';
96
- sidebar_toggle.checked = false;
97
- }
98
- if (sidebar === 'visible') {
99
- sidebar_toggle.checked = true;
100
- } else {
101
- html.classList.remove('sidebar-visible');
102
- }
103
- </script>
104
-
105
- <nav id="mdbook-sidebar" class="sidebar" aria-label="Table of contents">
106
- <!-- populated by js -->
107
- <mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
108
- <noscript>
109
- <iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
110
- </noscript>
111
- <div id="mdbook-sidebar-resize-handle" class="sidebar-resize-handle">
112
- <div class="sidebar-resize-indicator"></div>
113
- </div>
114
- </nav>
115
-
116
- <div id="mdbook-page-wrapper" class="page-wrapper">
117
-
118
- <div class="page">
119
- <div id="mdbook-menu-bar-hover-placeholder"></div>
120
- <div id="mdbook-menu-bar" class="menu-bar sticky">
121
- <div class="left-buttons">
122
- <label id="mdbook-sidebar-toggle" class="icon-button" for="mdbook-sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="mdbook-sidebar">
123
- <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M0 96C0 78.3 14.3 64 32 64H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32C14.3 128 0 113.7 0 96zM0 256c0-17.7 14.3-32 32-32H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32c-17.7 0-32-14.3-32-32zM448 416c0 17.7-14.3 32-32 32H32c-17.7 0-32-14.3-32-32s14.3-32 32-32H416c17.7 0 32 14.3 32 32z"/></svg></span>
124
- </label>
125
- <button id="mdbook-theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="mdbook-theme-list">
126
- <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M371.3 367.1c27.3-3.9 51.9-19.4 67.2-42.9L600.2 74.1c12.6-19.5 9.4-45.3-7.6-61.2S549.7-4.4 531.1 9.6L294.4 187.2c-24 18-38.2 46.1-38.4 76.1L371.3 367.1zm-19.6 25.4l-116-104.4C175.9 290.3 128 339.6 128 400c0 3.9 .2 7.8 .6 11.6c1.8 17.5-10.2 36.4-27.8 36.4H96c-17.7 0-32 14.3-32 32s14.3 32 32 32H240c61.9 0 112-50.1 112-112c0-2.5-.1-5-.2-7.5z"/></svg></span>
127
- </button>
128
- <ul id="mdbook-theme-list" class="theme-popup" aria-label="Themes" role="menu">
129
- <li role="none"><button role="menuitem" class="theme" id="mdbook-theme-default_theme">Auto</button></li>
130
- <li role="none"><button role="menuitem" class="theme" id="mdbook-theme-light">Light</button></li>
131
- <li role="none"><button role="menuitem" class="theme" id="mdbook-theme-rust">Rust</button></li>
132
- <li role="none"><button role="menuitem" class="theme" id="mdbook-theme-coal">Coal</button></li>
133
- <li role="none"><button role="menuitem" class="theme" id="mdbook-theme-navy">Navy</button></li>
134
- <li role="none"><button role="menuitem" class="theme" id="mdbook-theme-ayu">Ayu</button></li>
135
- </ul>
136
- <button id="mdbook-search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="mdbook-searchbar">
137
- <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M416 208c0 45.9-14.9 88.3-40 122.7L502.6 457.4c12.5 12.5 12.5 32.8 0 45.3s-32.8 12.5-45.3 0L330.7 376c-34.4 25.2-76.8 40-122.7 40C93.1 416 0 322.9 0 208S93.1 0 208 0S416 93.1 416 208zM208 352c79.5 0 144-64.5 144-144s-64.5-144-144-144S64 128.5 64 208s64.5 144 144 144z"/></svg></span>
138
- </button>
139
- </div>
140
-
141
- <h1 class="menu-title">Omegga</h1>
142
-
143
- <div class="right-buttons">
144
- <a href="../print.html" title="Print this book" aria-label="Print this book">
145
- <span class=fa-svg id="print-button"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M128 0C92.7 0 64 28.7 64 64v96h64V64H354.7L384 93.3V160h64V93.3c0-17-6.7-33.3-18.7-45.3L400 18.7C388 6.7 371.7 0 354.7 0H128zM384 352v32 64H128V384 368 352H384zm64 32h32c17.7 0 32-14.3 32-32V256c0-35.3-28.7-64-64-64H64c-35.3 0-64 28.7-64 64v96c0 17.7 14.3 32 32 32H64v64c0 35.3 28.7 64 64 64H384c35.3 0 64-28.7 64-64V384zm-16-88c-13.3 0-24-10.7-24-24s10.7-24 24-24s24 10.7 24 24s-10.7 24-24 24z"/></svg></span>
146
- </a>
147
- <a href="https://github.com/brickadia-community/omegga" title="Git repository" aria-label="Git repository">
148
- <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg></span>
149
- </a>
150
- <a href="https://github.com/brickadia-community/omegga/edit/master/docs/docs/api/omegga.md" title="Suggest an edit" aria-label="Suggest an edit" rel="edit">
151
- <span class=fa-svg id="git-edit-button"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M421.7 220.3l-11.3 11.3-22.6 22.6-205 205c-6.6 6.6-14.8 11.5-23.8 14.1L30.8 511c-8.4 2.5-17.5 .2-23.7-6.1S-1.5 489.7 1 481.2L38.7 353.1c2.6-9 7.5-17.2 14.1-23.8l205-205 22.6-22.6 11.3-11.3 33.9 33.9 62.1 62.1 33.9 33.9zM96 353.9l-9.3 9.3c-.9 .9-1.6 2.1-2 3.4l-25.3 86 86-25.3c1.3-.4 2.5-1.1 3.4-2l9.3-9.3H112c-8.8 0-16-7.2-16-16V353.9zM453.3 19.3l39.4 39.4c25 25 25 65.5 0 90.5l-14.5 14.5-22.6 22.6-11.3 11.3-33.9-33.9-62.1-62.1L314.3 67.7l11.3-11.3 22.6-22.6 14.5-14.5c25-25 65.5-25 90.5 0z"/></svg></span>
152
- </a>
153
-
154
- </div>
155
- </div>
156
-
157
- <div id="mdbook-search-wrapper" class="hidden">
158
- <form id="mdbook-searchbar-outer" class="searchbar-outer">
159
- <div class="search-wrapper">
160
- <input type="search" id="mdbook-searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="mdbook-searchresults-outer" aria-describedby="searchresults-header">
161
- <div class="spinner-wrapper">
162
- <span class=fa-svg id="fa-spin"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M304 48c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zm0 416c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zM48 304c26.5 0 48-21.5 48-48s-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48zm464-48c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zM142.9 437c18.7-18.7 18.7-49.1 0-67.9s-49.1-18.7-67.9 0s-18.7 49.1 0 67.9s49.1 18.7 67.9 0zm0-294.2c18.7-18.7 18.7-49.1 0-67.9S93.7 56.2 75 75s-18.7 49.1 0 67.9s49.1 18.7 67.9 0zM369.1 437c18.7 18.7 49.1 18.7 67.9 0s18.7-49.1 0-67.9s-49.1-18.7-67.9 0s-18.7 49.1 0 67.9z"/></svg></span>
163
- </div>
164
- </div>
165
- </form>
166
- <div id="mdbook-searchresults-outer" class="searchresults-outer hidden">
167
- <div id="mdbook-searchresults-header" class="searchresults-header"></div>
168
- <ul id="mdbook-searchresults">
169
- </ul>
170
- </div>
171
- </div>
172
-
173
- <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
174
- <script>
175
- document.getElementById('mdbook-sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
176
- document.getElementById('mdbook-sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
177
- Array.from(document.querySelectorAll('#mdbook-sidebar a')).forEach(function(link) {
178
- link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
179
- });
180
- </script>
181
-
182
- <div id="mdbook-content" class="content">
183
- <main>
184
- <!-- Generated by tools/gen-api-docs.mjs. Edit the JSDoc in src/ instead. -->
185
- <h1 id="omegga-api"><a class="header" href="#omegga-api">Omegga API</a></h1>
186
- <p>The <code>Omegga</code> global (and the <code>omegga</code> passed to a plugin constructor)
187
- implements <code>OmeggaLike</code>. It is an event emitter, so everything in
188
- <a href="events.html">Events</a> is available on it too.</p>
189
- <h2 id="omeggalike"><a class="header" href="#omeggalike"><code>OmeggaLike</code></a></h2>
190
- <p>Extends <a href="#omeggacore"><code>OmeggaCore</code></a>, <a href="#logwrangling"><code>LogWrangling</code></a>, <a href="#injectedcommands"><code>InjectedCommands</code></a>, <code>MockEventEmitter</code>.</p>
191
- <div class="table-wrapper">
192
- <table>
193
- <thead>
194
- <tr><th>Property</th><th>Type</th><th>Description</th></tr>
195
- </thead>
196
- <tbody>
197
- <tr><td><code>version</code></td><td><code>number</code></td><td>game CL version</td></tr>
198
- <tr><td><code>Console</code></td><td><code>ConsoleCommands</code></td><td>version-resolved Brickadia console command names, nested by namespace. e.g. <code>Omegga.Console.Bricks.Clear</code> resolves to the command string for the running game version (“Bricks.Clear” or “br.Bricks.Clear”)</td></tr>
199
- <tr><td><code>verbose</code></td><td><code>boolean</code></td><td>verbose logging is enabled</td></tr>
200
- <tr><td><code>players</code></td><td><code>OmeggaPlayer[]</code></td><td>list of players</td></tr>
201
- <tr><td><code>host?</code></td><td><code>{ id: string; name: string }</code></td><td>server host</td></tr>
202
- <tr><td><code>started</code></td><td><code>boolean</code></td><td>server is started</td></tr>
203
- <tr><td><code>starting</code></td><td><code>boolean</code></td><td>server is starting</td></tr>
204
- <tr><td><code>stopping</code></td><td><code>boolean</code></td><td>server is stopping</td></tr>
205
- <tr><td><code>currentMap</code></td><td><code>string</code></td><td>current map</td></tr>
206
- <tr><td><code>configPath</code></td><td><code>string</code></td><td>path to config files</td></tr>
207
- <tr><td><code>savePath</code></td><td><code>string</code></td><td>path to saves</td></tr>
208
- <tr><td><code>worldPath</code></td><td><code>string</code></td><td>path to worlds</td></tr>
209
- <tr><td><code>prefabPath</code></td><td><code>string</code></td><td>path to prefabs</td></tr>
210
- <tr><td><code>presetPath</code></td><td><code>string</code></td><td>path to presets</td></tr>
211
- <tr><td><code>path</code></td><td><code>string</code></td><td>path to containing dir</td></tr>
212
- <tr><td><code>binaryPath</code></td><td><code>string | null</code></td><td>path to the directory containing the game server binary - null when the install is launcher-managed and the binary location isn’t known</td></tr>
213
- </tbody>
214
- </table>
215
- </div>
216
- <h3 id="writeln"><a class="header" href="#writeln"><code>writeln</code></a></h3>
217
- <pre><code class="language-ts">writeln(line: string): void
218
- </code></pre>
219
- <h3 id="getplugin"><a class="header" href="#getplugin"><code>getPlugin</code></a></h3>
220
- <pre><code class="language-ts">getPlugin(name: string): Promise&lt;PluginInterop | null&gt;
221
- </code></pre>
222
- <p>get a plugin’s name, documentation, and loaded status
223
- If run in an unsafe plugin, the emitPlugin method sends events from
224
- an “unsafe” plugin</p>
225
- <p><sub>Declared in <a href="https://github.com/brickadia-community/omegga/blob/master/src/plugin.ts"><code>src/plugin.ts</code></a>.</sub></p>
226
- <h2 id="omeggacore"><a class="header" href="#omeggacore"><code>OmeggaCore</code></a></h2>
227
- <h3 id="getplayers"><a class="header" href="#getplayers"><code>getPlayers</code></a></h3>
228
- <pre><code class="language-ts">getPlayers(): { id: string; name: string; displayName: string; controller: string; state: string; }[]
229
- </code></pre>
230
- <p>get a list of players</p>
231
- <p><strong>Returns</strong> list of players {id: uuid, name: name} objects</p>
232
- <h3 id="getplayer"><a class="header" href="#getplayer"><code>getPlayer</code></a></h3>
233
- <pre><code class="language-ts">getPlayer(target: string): OmeggaPlayer | null
234
- </code></pre>
235
- <p>find a player by name, id, controller, or state</p>
236
- <div class="table-wrapper">
237
- <table>
238
- <thead>
239
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
240
- </thead>
241
- <tbody>
242
- <tr><td><code>target</code></td><td><code>string</code></td><td>name, id, controller, or state</td></tr>
243
- </tbody>
244
- </table>
245
- </div>
246
- <h3 id="findplayerbyname"><a class="header" href="#findplayerbyname"><code>findPlayerByName</code></a></h3>
247
- <pre><code class="language-ts">findPlayerByName(name: string): OmeggaPlayer | null
248
- </code></pre>
249
- <p>find a player by rough name, prioritize exact matches and get fuzzier</p>
250
- <div class="table-wrapper">
251
- <table>
252
- <thead>
253
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
254
- </thead>
255
- <tbody>
256
- <tr><td><code>name</code></td><td><code>string</code></td><td>player name, fuzzy</td></tr>
257
- </tbody>
258
- </table>
259
- </div>
260
- <h3 id="gethostid"><a class="header" href="#gethostid"><code>getHostId</code></a></h3>
261
- <pre><code class="language-ts">getHostId(): string
262
- </code></pre>
263
- <p>get the host’s ID</p>
264
- <p><strong>Returns</strong> Host Id</p>
265
- <h3 id="broadcast"><a class="header" href="#broadcast"><code>broadcast</code></a></h3>
266
- <pre><code class="language-ts">broadcast(...messages: string[]): void
267
- </code></pre>
268
- <p>broadcast messages to chat
269
- messages are broken by new line
270
- multiple arguments are additional lines
271
- all messages longer than 512 characters are deleted automatically, though omegga wouldn’t have sent them anyway</p>
272
- <div class="table-wrapper">
273
- <table>
274
- <thead>
275
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
276
- </thead>
277
- <tbody>
278
- <tr><td><code>...messages</code></td><td><code>string[]</code></td><td>unescaped chat messages to send. may need to wrap messages with quotes</td></tr>
279
- </tbody>
280
- </table>
281
- </div>
282
- <h3 id="whisper"><a class="header" href="#whisper"><code>whisper</code></a></h3>
283
- <pre><code class="language-ts">whisper(target: string | OmeggaPlayer, ...messages: string[]): void
284
- </code></pre>
285
- <p>whisper messages to a player’s chat
286
- messages are broken by new line
287
- multiple arguments are additional lines
288
- all messages longer than 512 characters are deleted automatically, though omegga wouldn’t have sent them anyway</p>
289
- <div class="table-wrapper">
290
- <table>
291
- <thead>
292
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
293
- </thead>
294
- <tbody>
295
- <tr><td><code>target</code></td><td><code>string | OmeggaPlayer</code></td><td>player identifier or player object</td></tr>
296
- <tr><td><code>...messages</code></td><td><code>string[]</code></td><td>unescaped chat messages to send. may need to wrap messages with quotes</td></tr>
297
- </tbody>
298
- </table>
299
- </div>
300
- <h3 id="middleprint"><a class="header" href="#middleprint"><code>middlePrint</code></a></h3>
301
- <pre><code class="language-ts">middlePrint(target: string | OmeggaPlayer, message: string): void
302
- </code></pre>
303
- <p>prints text to the middle of a player’s screen
304
- all messages longer than 512 characters are deleted automatically</p>
305
- <div class="table-wrapper">
306
- <table>
307
- <thead>
308
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
309
- </thead>
310
- <tbody>
311
- <tr><td><code>target</code></td><td><code>string | OmeggaPlayer</code></td><td>player identifier or player object</td></tr>
312
- <tr><td><code>message</code></td><td><code>string</code></td><td>unescaped chat messages to send. may need to wrap messages with quotes</td></tr>
313
- </tbody>
314
- </table>
315
- </div>
316
- <h3 id="saveminigame"><a class="header" href="#saveminigame"><code>saveMinigame</code></a></h3>
317
- <pre><code class="language-ts">saveMinigame(index: number, name: string): void
318
- </code></pre>
319
- <p>Save a minigame preset based on a minigame index</p>
320
- <div class="table-wrapper">
321
- <table>
322
- <thead>
323
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
324
- </thead>
325
- <tbody>
326
- <tr><td><code>index</code></td><td><code>number</code></td><td>minigame index</td></tr>
327
- <tr><td><code>name</code></td><td><code>string</code></td><td>preset name</td></tr>
328
- </tbody>
329
- </table>
330
- </div>
331
- <h3 id="deleteminigame"><a class="header" href="#deleteminigame"><code>deleteMinigame</code></a></h3>
332
- <pre><code class="language-ts">deleteMinigame(index: number): void
333
- </code></pre>
334
- <p>Delete a minigame</p>
335
- <div class="table-wrapper">
336
- <table>
337
- <thead>
338
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
339
- </thead>
340
- <tbody>
341
- <tr><td><code>index</code></td><td><code>number</code></td><td>minigame index</td></tr>
342
- </tbody>
343
- </table>
344
- </div>
345
- <h3 id="resetminigame"><a class="header" href="#resetminigame"><code>resetMinigame</code></a></h3>
346
- <pre><code class="language-ts">resetMinigame(index: number): void
347
- </code></pre>
348
- <p>Reset a minigame</p>
349
- <div class="table-wrapper">
350
- <table>
351
- <thead>
352
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
353
- </thead>
354
- <tbody>
355
- <tr><td><code>index</code></td><td><code>number</code></td><td>minigame index</td></tr>
356
- </tbody>
357
- </table>
358
- </div>
359
- <h3 id="nextroundminigame"><a class="header" href="#nextroundminigame"><code>nextRoundMinigame</code></a></h3>
360
- <pre><code class="language-ts">nextRoundMinigame(index: number): void
361
- </code></pre>
362
- <p>Force the next round in a minigame</p>
363
- <div class="table-wrapper">
364
- <table>
365
- <thead>
366
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
367
- </thead>
368
- <tbody>
369
- <tr><td><code>index</code></td><td><code>number</code></td><td>minigame index</td></tr>
370
- </tbody>
371
- </table>
372
- </div>
373
- <h3 id="loadminigame"><a class="header" href="#loadminigame"><code>loadMinigame</code></a></h3>
374
- <pre><code class="language-ts">loadMinigame(presetName: string, owner?: string): void
375
- </code></pre>
376
- <p>Load an Minigame preset</p>
377
- <div class="table-wrapper">
378
- <table>
379
- <thead>
380
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
381
- </thead>
382
- <tbody>
383
- <tr><td><code>presetName</code></td><td><code>string</code></td><td>preset name</td></tr>
384
- <tr><td><code>owner</code></td><td><code>string</code></td><td>owner id/name</td></tr>
385
- </tbody>
386
- </table>
387
- </div>
388
- <h3 id="getminigamepresets"><a class="header" href="#getminigamepresets"><code>getMinigamePresets</code></a></h3>
389
- <pre><code class="language-ts">getMinigamePresets(): string[]
390
- </code></pre>
391
- <p>Get all presets in the minigame folder and child folders</p>
392
- <h3 id="resetenvironment"><a class="header" href="#resetenvironment"><code>resetEnvironment</code></a></h3>
393
- <pre><code class="language-ts">resetEnvironment(): void
394
- </code></pre>
395
- <p>Reset the environment settings</p>
396
- <h3 id="saveenvironment"><a class="header" href="#saveenvironment"><code>saveEnvironment</code></a></h3>
397
- <pre><code class="language-ts">saveEnvironment(presetName: string): Promise&lt;void&gt;
398
- </code></pre>
399
- <p>Save an environment preset</p>
400
- <div class="table-wrapper">
401
- <table>
402
- <thead>
403
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
404
- </thead>
405
- <tbody>
406
- <tr><td><code>presetName</code></td><td><code>string</code></td><td>preset name</td></tr>
407
- </tbody>
408
- </table>
409
- </div>
410
- <h3 id="getenvironmentdata"><a class="header" href="#getenvironmentdata"><code>getEnvironmentData</code></a></h3>
411
- <pre><code class="language-ts">getEnvironmentData(): Promise&lt;EnvironmentPreset | null&gt;
412
- </code></pre>
413
- <p>Save a temporary environment preset and return its contents</p>
414
- <h3 id="readenvironmentdata"><a class="header" href="#readenvironmentdata"><code>readEnvironmentData</code></a></h3>
415
- <pre><code class="language-ts">readEnvironmentData(presetName: string): EnvironmentPreset | null
416
- </code></pre>
417
- <p>Read environment data as json; null when the preset is missing or invalid</p>
418
- <div class="table-wrapper">
419
- <table>
420
- <thead>
421
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
422
- </thead>
423
- <tbody>
424
- <tr><td><code>presetName</code></td><td><code>string</code></td><td>preset name</td></tr>
425
- </tbody>
426
- </table>
427
- </div>
428
- <h3 id="loadenvironment"><a class="header" href="#loadenvironment"><code>loadEnvironment</code></a></h3>
429
- <pre><code class="language-ts">loadEnvironment(presetName: string): void
430
- </code></pre>
431
- <p>Load an environment preset</p>
432
- <div class="table-wrapper">
433
- <table>
434
- <thead>
435
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
436
- </thead>
437
- <tbody>
438
- <tr><td><code>presetName</code></td><td><code>string</code></td><td>preset name</td></tr>
439
- </tbody>
440
- </table>
441
- </div>
442
- <h3 id="loadenvironmentdata"><a class="header" href="#loadenvironmentdata"><code>loadEnvironmentData</code></a></h3>
443
- <pre><code class="language-ts">loadEnvironmentData(preset: | EnvironmentPreset | NonNullable&lt;EnvironmentPreset['data']&gt;['groups']): void
444
- </code></pre>
445
- <p>Load some environment preset data</p>
446
- <div class="table-wrapper">
447
- <table>
448
- <thead>
449
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
450
- </thead>
451
- <tbody>
452
- <tr><td><code>preset</code></td><td><code>| EnvironmentPreset | NonNullable&lt;EnvironmentPreset['data']&gt;['groups']</code></td><td>preset data</td></tr>
453
- </tbody>
454
- </table>
455
- </div>
456
- <h3 id="getenvironmentpresets"><a class="header" href="#getenvironmentpresets"><code>getEnvironmentPresets</code></a></h3>
457
- <pre><code class="language-ts">getEnvironmentPresets(): string[]
458
- </code></pre>
459
- <p>Get all presets in the environment folder and child folders</p>
460
- <h3 id="clearbricks"><a class="header" href="#clearbricks"><code>clearBricks</code></a></h3>
461
- <pre><code class="language-ts">clearBricks(target: string | { id: string }, quiet?: boolean): void
462
- </code></pre>
463
- <p>Clear a user’s bricks (by uuid, name, controller, or player object)</p>
464
- <div class="table-wrapper">
465
- <table>
466
- <thead>
467
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
468
- </thead>
469
- <tbody>
470
- <tr><td><code>target</code></td><td><code>string | { id: string }</code></td><td>player or player identifier</td></tr>
471
- <tr><td><code>quiet</code></td><td><code>boolean</code></td><td>quietly clear bricks</td></tr>
472
- </tbody>
473
- </table>
474
- </div>
475
- <h3 id="clearregion"><a class="header" href="#clearregion"><code>clearRegion</code></a></h3>
476
- <pre><code class="language-ts">clearRegion(region: { center: [number, number, number]; extent: [number, number, number]; }, options?: { target?: string | OmeggaPlayer; bricks?: boolean; entities?: boolean; }): void
477
- </code></pre>
478
- <p>Clear a region of bricks. On EA3 this routes to <code>br.World.ClearRegion</code>
479
- and can optionally clear entities too.</p>
480
- <div class="table-wrapper">
481
- <table>
482
- <thead>
483
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
484
- </thead>
485
- <tbody>
486
- <tr><td><code>region</code></td><td><code>{ center: [number, number, number]; extent: [number, number, number]; }</code></td><td>region to clear</td></tr>
487
- <tr><td><code>options</code></td><td><code>{ target?: string | OmeggaPlayer; bricks?: boolean; entities?: boolean; }</code></td><td>optional settings</td></tr>
488
- </tbody>
489
- </table>
490
- </div>
491
- <h3 id="clearallbricks"><a class="header" href="#clearallbricks"><code>clearAllBricks</code></a></h3>
492
- <pre><code class="language-ts">clearAllBricks(options?: | boolean | { quiet?: boolean; bricks?: boolean; entities?: boolean }): void
493
- </code></pre>
494
- <p>Clear all bricks on the server. On EA3 this routes to
495
- <code>br.World.ClearAll</code> and can optionally clear entities too. A bare boolean
496
- is accepted as the legacy <code>quiet</code> argument.</p>
497
- <div class="table-wrapper">
498
- <table>
499
- <thead>
500
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
501
- </thead>
502
- <tbody>
503
- <tr><td><code>options</code></td><td><code>| boolean | { quiet?: boolean; bricks?: boolean; entities?: boolean }</code></td><td>quiet (or <code>{ quiet, bricks, entities }</code>)</td></tr>
504
- </tbody>
505
- </table>
506
- </div>
507
- <h3 id="savebricks"><a class="header" href="#savebricks"><code>saveBricks</code></a></h3>
508
- <pre><code class="language-ts">saveBricks(saveName: string, region?: { center: [number, number, number]; extent: [number, number, number]; }): void
509
- </code></pre>
510
- <p><strong>Deprecated.</strong> removed in Brickadia EA3 (no-op on newer servers) - save a
511
- prefab with <code>savePrefabRegion</code> instead</p>
512
- <p>Save bricks under a filename</p>
513
- <div class="table-wrapper">
514
- <table>
515
- <thead>
516
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
517
- </thead>
518
- <tbody>
519
- <tr><td><code>saveName</code></td><td><code>string</code></td><td>save file name</td></tr>
520
- <tr><td><code>region</code></td><td><code>{ center: [number, number, number]; extent: [number, number, number]; }</code></td><td>region of bricks to save</td></tr>
521
- </tbody>
522
- </table>
523
- </div>
524
- <h3 id="savebricksasync"><a class="header" href="#savebricksasync"><code>saveBricksAsync</code></a></h3>
525
- <pre><code class="language-ts">saveBricksAsync(saveName: string, region?: { center: [number, number, number]; extent: [number, number, number]; }): Promise&lt;void&gt;
526
- </code></pre>
527
- <p><strong>Deprecated.</strong> removed in Brickadia EA3 (no-op on newer servers) - save a
528
- prefab with <code>savePrefabRegion</code> instead</p>
529
- <p>Save bricks under a filename, with a promise</p>
530
- <div class="table-wrapper">
531
- <table>
532
- <thead>
533
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
534
- </thead>
535
- <tbody>
536
- <tr><td><code>saveName</code></td><td><code>string</code></td><td>save file name</td></tr>
537
- <tr><td><code>region</code></td><td><code>{ center: [number, number, number]; extent: [number, number, number]; }</code></td><td>region of bricks to save</td></tr>
538
- </tbody>
539
- </table>
540
- </div>
541
- <h3 id="loadbricks"><a class="header" href="#loadbricks"><code>loadBricks</code></a></h3>
542
- <pre><code class="language-ts">loadBricks(saveName: string, options?: { offX?: number; offY?: number; offZ?: number; quiet?: boolean; correctPalette?: boolean; correctCustom?: boolean; }): void
543
- </code></pre>
544
- <p><strong>Deprecated.</strong> removed in Brickadia EA3 (no-op on newer servers) - load a
545
- prefab with <code>loadPrefab</code> instead</p>
546
- <p>Load bricks on the server</p>
547
- <h3 id="loadbricksonplayer"><a class="header" href="#loadbricksonplayer"><code>loadBricksOnPlayer</code></a></h3>
548
- <pre><code class="language-ts">loadBricksOnPlayer(saveName: string, player: string | OmeggaPlayer, options?: { offX?: number; offY?: number; offZ?: number; correctPalette?: boolean; correctCustom?: boolean; }): void
549
- </code></pre>
550
- <p><strong>Deprecated.</strong> removed in Brickadia ~EA2 (no-op on newer servers) - use
551
- <code>loadPrefabOnPlayer</code> instead</p>
552
- <p>Load bricks on the server into a player’s clipbaord</p>
553
- <h3 id="getsaves"><a class="header" href="#getsaves"><code>getSaves</code></a></h3>
554
- <pre><code class="language-ts">getSaves(): string[]
555
- </code></pre>
556
- <p>Get all saves in the save folder and child folders</p>
557
- <h3 id="getsavepath"><a class="header" href="#getsavepath"><code>getSavePath</code></a></h3>
558
- <pre><code class="language-ts">getSavePath(saveName: string): string | undefined
559
- </code></pre>
560
- <p>Checks if a save exists and returns an absolute path</p>
561
- <div class="table-wrapper">
562
- <table>
563
- <thead>
564
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
565
- </thead>
566
- <tbody>
567
- <tr><td><code>saveName</code></td><td><code>string</code></td><td>Save filename</td></tr>
568
- </tbody>
569
- </table>
570
- </div>
571
- <p><strong>Returns</strong> Path to string, undefined if the save does not exist</p>
572
- <h3 id="getworlds"><a class="header" href="#getworlds"><code>getWorlds</code></a></h3>
573
- <pre><code class="language-ts">getWorlds(): string[]
574
- </code></pre>
575
- <p>Get all worlds in the worlds folder and child folders</p>
576
- <h3 id="getworldpath"><a class="header" href="#getworldpath"><code>getWorldPath</code></a></h3>
577
- <pre><code class="language-ts">getWorldPath(worldName: string): string | undefined
578
- </code></pre>
579
- <p>Checks if a world exists and returns an absolute path</p>
580
- <div class="table-wrapper">
581
- <table>
582
- <thead>
583
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
584
- </thead>
585
- <tbody>
586
- <tr><td><code>worldName</code></td><td><code>string</code></td><td>World name</td></tr>
587
- </tbody>
588
- </table>
589
- </div>
590
- <p><strong>Returns</strong> Path to string, undefined if the world does not exist</p>
591
- <h3 id="getworldrevisions"><a class="header" href="#getworldrevisions"><code>getWorldRevisions</code></a></h3>
592
- <pre><code class="language-ts">getWorldRevisions(worldName: string): Promise&lt;{ index: number; date: Date; note: string }[]&gt;
593
- </code></pre>
594
- <p>Get a list of revisions for a world</p>
595
- <div class="table-wrapper">
596
- <table>
597
- <thead>
598
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
599
- </thead>
600
- <tbody>
601
- <tr><td><code>worldName</code></td><td><code>string</code></td><td>World name</td></tr>
602
- </tbody>
603
- </table>
604
- </div>
605
- <h3 id="loadworld"><a class="header" href="#loadworld"><code>loadWorld</code></a></h3>
606
- <pre><code class="language-ts">loadWorld(worldName: string): Promise&lt;boolean&gt;
607
- </code></pre>
608
- <p>Load a world by its name</p>
609
- <div class="table-wrapper">
610
- <table>
611
- <thead>
612
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
613
- </thead>
614
- <tbody>
615
- <tr><td><code>worldName</code></td><td><code>string</code></td><td>World name</td></tr>
616
- </tbody>
617
- </table>
618
- </div>
619
- <h3 id="loadworldrevision"><a class="header" href="#loadworldrevision"><code>loadWorldRevision</code></a></h3>
620
- <pre><code class="language-ts">loadWorldRevision(worldName: string, revision: number): Promise&lt;boolean&gt;
621
- </code></pre>
622
- <p>Load a world at a specific revision</p>
623
- <div class="table-wrapper">
624
- <table>
625
- <thead>
626
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
627
- </thead>
628
- <tbody>
629
- <tr><td><code>worldName</code></td><td><code>string</code></td><td>World name</td></tr>
630
- <tr><td><code>revision</code></td><td><code>number</code></td><td></td></tr>
631
- </tbody>
632
- </table>
633
- </div>
634
- <h3 id="saveworldas"><a class="header" href="#saveworldas"><code>saveWorldAs</code></a></h3>
635
- <pre><code class="language-ts">saveWorldAs(worldName: string): Promise&lt;boolean&gt;
636
- </code></pre>
637
- <p>Save a world as a new name</p>
638
- <div class="table-wrapper">
639
- <table>
640
- <thead>
641
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
642
- </thead>
643
- <tbody>
644
- <tr><td><code>worldName</code></td><td><code>string</code></td><td>World name</td></tr>
645
- </tbody>
646
- </table>
647
- </div>
648
- <h3 id="saveworld"><a class="header" href="#saveworld"><code>saveWorld</code></a></h3>
649
- <pre><code class="language-ts">saveWorld(): Promise&lt;boolean&gt;
650
- </code></pre>
651
- <p>Save the current world</p>
652
- <h3 id="createemptyworld"><a class="header" href="#createemptyworld"><code>createEmptyWorld</code></a></h3>
653
- <pre><code class="language-ts">createEmptyWorld(worldName: string): Promise&lt;boolean&gt;
654
- </code></pre>
655
- <p>Create an empty world with the given name</p>
656
- <h3 id="writesavedata"><a class="header" href="#writesavedata"><code>writeSaveData</code></a></h3>
657
- <pre><code class="language-ts">writeSaveData(saveName: string, saveData: WriteSaveObject): void
658
- </code></pre>
659
- <p>unsafely load save data (wrap in try/catch)</p>
660
- <div class="table-wrapper">
661
- <table>
662
- <thead>
663
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
664
- </thead>
665
- <tbody>
666
- <tr><td><code>saveName</code></td><td><code>string</code></td><td>save file name</td></tr>
667
- <tr><td><code>saveData</code></td><td><code>WriteSaveObject</code></td><td>BRS JS Save data</td></tr>
668
- </tbody>
669
- </table>
670
- </div>
671
- <h3 id="readsavedata"><a class="header" href="#readsavedata"><code>readSaveData</code></a></h3>
672
- <pre><code class="language-ts">readSaveData(saveName: string, nobricks?: boolean): ReadSaveObject
673
- </code></pre>
674
- <p>unsafely read save data (wrap in try/catch)</p>
675
- <div class="table-wrapper">
676
- <table>
677
- <thead>
678
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
679
- </thead>
680
- <tbody>
681
- <tr><td><code>saveName</code></td><td><code>string</code></td><td>save file name</td></tr>
682
- <tr><td><code>nobricks</code></td><td><code>boolean</code></td><td>only read save header data</td></tr>
683
- </tbody>
684
- </table>
685
- </div>
686
- <p><strong>Returns</strong> BRS JS Save Data</p>
687
- <h3 id="loadsavedata"><a class="header" href="#loadsavedata"><code>loadSaveData</code></a></h3>
688
- <pre><code class="language-ts">loadSaveData(saveData: WriteSaveObject, options?: { offX?: number; offY?: number; offZ?: number; quiet?: boolean; correctPalette?: boolean; correctCustom?: boolean; }): Promise&lt;void&gt;
689
- </code></pre>
690
- <p><strong>Deprecated.</strong> removed in Brickadia EA3 (no-op on newer servers) - use the
691
- prefab API (<code>loadPrefab</code>) instead</p>
692
- <p>load bricks from save data and resolve when game finishes loading</p>
693
- <div class="table-wrapper">
694
- <table>
695
- <thead>
696
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
697
- </thead>
698
- <tbody>
699
- <tr><td><code>saveData</code></td><td><code>WriteSaveObject</code></td><td>BRS JS Save data</td></tr>
700
- <tr><td><code>options</code></td><td><code>{ offX?: number; offY?: number; offZ?: number; quiet?: boolean; correctPalette?: boolean; correctCustom?: boolean; }</code></td><td></td></tr>
701
- </tbody>
702
- </table>
703
- </div>
704
- <h3 id="loadsavedataonplayer"><a class="header" href="#loadsavedataonplayer"><code>loadSaveDataOnPlayer</code></a></h3>
705
- <pre><code class="language-ts">loadSaveDataOnPlayer(saveData: WriteSaveObject, player: string | OmeggaPlayer, options?: { offX?: number; offY?: number; offZ?: number; correctPalette?: boolean; correctCustom?: boolean; }): Promise&lt;void&gt;
706
- </code></pre>
707
- <p><strong>Deprecated.</strong> removed in Brickadia ~EA2 (no-op on newer servers) - use the
708
- prefab API (<code>loadPrefabOnPlayer</code>) instead</p>
709
- <p>load bricks from save data and resolve when game finishes loading</p>
710
- <div class="table-wrapper">
711
- <table>
712
- <thead>
713
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
714
- </thead>
715
- <tbody>
716
- <tr><td><code>saveData</code></td><td><code>WriteSaveObject</code></td><td>BRS JS Save data</td></tr>
717
- <tr><td><code>player</code></td><td><code>string | OmeggaPlayer</code></td><td>Player name/id or player object</td></tr>
718
- <tr><td><code>options</code></td><td><code>{ offX?: number; offY?: number; offZ?: number; correctPalette?: boolean; correctCustom?: boolean; }</code></td><td></td></tr>
719
- </tbody>
720
- </table>
721
- </div>
722
- <h3 id="getsavedata"><a class="header" href="#getsavedata"><code>getSaveData</code></a></h3>
723
- <pre><code class="language-ts">getSaveData(region?: { center: [number, number, number]; extent: [number, number, number]; }): Promise&lt;ReadSaveObject | undefined&gt;
724
- </code></pre>
725
- <p><strong>Deprecated.</strong> removed in Brickadia EA3 (returns undefined on newer
726
- servers) - use the prefab API instead</p>
727
- <p>get current bricks as save data</p>
728
- <h3 id="getprefabs"><a class="header" href="#getprefabs"><code>getPrefabs</code></a></h3>
729
- <pre><code class="language-ts">getPrefabs(): string[]
730
- </code></pre>
731
- <p>Get all prefabs in the prefabs folder and child folders (EA3)</p>
732
- <h3 id="getprefabpath"><a class="header" href="#getprefabpath"><code>getPrefabPath</code></a></h3>
733
- <pre><code class="language-ts">getPrefabPath(prefabName: string): string | undefined
734
- </code></pre>
735
- <p>Checks if a prefab exists and returns an absolute path (EA3)</p>
736
- <div class="table-wrapper">
737
- <table>
738
- <thead>
739
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
740
- </thead>
741
- <tbody>
742
- <tr><td><code>prefabName</code></td><td><code>string</code></td><td>Prefab filename</td></tr>
743
- </tbody>
744
- </table>
745
- </div>
746
- <p><strong>Returns</strong> Path to string</p>
747
- <h3 id="loadprefab"><a class="header" href="#loadprefab"><code>loadPrefab</code></a></h3>
748
- <pre><code class="language-ts">loadPrefab(path: string, options?: { offX?: number; offY?: number; offZ?: number; atOriginalPosition?: boolean; orientation?: number; rootEntityPersistentIndex?: number; mirrorAxes?: number; overrideUserId?: string; }): void
749
- </code></pre>
750
- <p>Load a prefab into the world (EA3). <code>path</code> is a bundle path ref such
751
- as <code>Prefabs/Uploads/&lt;hash&gt;.brz</code>.</p>
752
- <div class="table-wrapper">
753
- <table>
754
- <thead>
755
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
756
- </thead>
757
- <tbody>
758
- <tr><td><code>path</code></td><td><code>string</code></td><td>prefab bundle path ref</td></tr>
759
- <tr><td><code>options</code></td><td><code>{ offX?: number; offY?: number; offZ?: number; atOriginalPosition?: boolean; orientation?: number; rootEntityPersistentIndex?: number; mirrorAxes?: number; overrideUserId?: string; }</code></td><td>placement options (offset, orientation, mirror axes, etc)</td></tr>
760
- </tbody>
761
- </table>
762
- </div>
763
- <h3 id="saveprefab"><a class="header" href="#saveprefab"><code>savePrefab</code></a></h3>
764
- <pre><code class="language-ts">savePrefab(path: string, options?: { region?: { center: [number, number, number]; extent: [number, number, number]; }; entities?: boolean; rootEntityPersistentIndex?: number; userId?: string; }): void
765
- </code></pre>
766
- <p>Save the world (or a region of it) as a prefab (EA3).</p>
767
- <div class="table-wrapper">
768
- <table>
769
- <thead>
770
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
771
- </thead>
772
- <tbody>
773
- <tr><td><code>path</code></td><td><code>string</code></td><td>destination prefab bundle path ref (e.g. <code>Prefabs/MyPrefab.brz</code>)</td></tr>
774
- <tr><td><code>options</code></td><td><code>{ region?: { center: [number, number, number]; extent: [number, number, number]; }; entities?: boolean; rootEntityPersistentIndex?: number; userId?: string; }</code></td><td>save options; omit <code>region</code> to capture the whole world</td></tr>
775
- </tbody>
776
- </table>
777
- </div>
778
- <h3 id="saveprefabasync"><a class="header" href="#saveprefabasync"><code>savePrefabAsync</code></a></h3>
779
- <pre><code class="language-ts">savePrefabAsync(path: string, options?: { region?: { center: [number, number, number]; extent: [number, number, number]; }; entities?: boolean; rootEntityPersistentIndex?: number; userId?: string; }): Promise&lt;string | null&gt;
780
- </code></pre>
781
- <p>Save a prefab and resolve once the prefab file has been written to disk
782
- (EA3).</p>
783
- <div class="table-wrapper">
784
- <table>
785
- <thead>
786
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
787
- </thead>
788
- <tbody>
789
- <tr><td><code>path</code></td><td><code>string</code></td><td>destination prefab bundle path ref</td></tr>
790
- <tr><td><code>options</code></td><td><code>{ region?: { center: [number, number, number]; extent: [number, number, number]; }; entities?: boolean; rootEntityPersistentIndex?: number; userId?: string; }</code></td><td>same options as <code>savePrefab</code></td></tr>
791
- </tbody>
792
- </table>
793
- </div>
794
- <p><strong>Returns</strong> absolute path to the written prefab, or null on timeout</p>
795
- <h3 id="giveprefabtoplayer"><a class="header" href="#giveprefabtoplayer"><code>givePrefabToPlayer</code></a></h3>
796
- <pre><code class="language-ts">givePrefabToPlayer(path: string, player: string | OmeggaPlayer, options?: { preserveOwnership?: boolean }): void
797
- </code></pre>
798
- <p>Give a prefab to a player’s inventory (EA3).</p>
799
- <div class="table-wrapper">
800
- <table>
801
- <thead>
802
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
803
- </thead>
804
- <tbody>
805
- <tr><td><code>path</code></td><td><code>string</code></td><td>prefab bundle path ref</td></tr>
806
- <tr><td><code>player</code></td><td><code>string | OmeggaPlayer</code></td><td>player name/id or player object</td></tr>
807
- <tr><td><code>options</code></td><td><code>{ preserveOwnership?: boolean }</code></td><td>give options (preserve ownership)</td></tr>
808
- </tbody>
809
- </table>
810
- </div>
811
- <h3 id="loadprefabonplayer"><a class="header" href="#loadprefabonplayer"><code>loadPrefabOnPlayer</code></a></h3>
812
- <pre><code class="language-ts">loadPrefabOnPlayer(path: string, player: string | OmeggaPlayer, options?: { preserveOwnership?: boolean }): void
813
- </code></pre>
814
- <p>Load a prefab onto a player (EA3, replaces <code>loadBricksOnPlayer</code>).</p>
815
- <div class="table-wrapper">
816
- <table>
817
- <thead>
818
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
819
- </thead>
820
- <tbody>
821
- <tr><td><code>path</code></td><td><code>string</code></td><td>prefab bundle path ref</td></tr>
822
- <tr><td><code>player</code></td><td><code>string | OmeggaPlayer</code></td><td>player name/id or player object</td></tr>
823
- <tr><td><code>options</code></td><td><code>{ preserveOwnership?: boolean }</code></td><td>give options (preserve ownership)</td></tr>
824
- </tbody>
825
- </table>
826
- </div>
827
- <h3 id="changemap"><a class="header" href="#changemap"><code>changeMap</code></a></h3>
828
- <pre><code class="language-ts">changeMap(map: string): Promise&lt;boolean&gt;
829
- </code></pre>
830
- <p>Change server map</p>
831
- <div class="table-wrapper">
832
- <table>
833
- <thead>
834
- <tr><th>Param</th><th>Type</th><th>Description</th></tr>
835
- </thead>
836
- <tbody>
837
- <tr><td><code>map</code></td><td><code>string</code></td><td>Map name</td></tr>
838
- </tbody>
839
- </table>
840
- </div>
841
- <h3 id="getrolesetup"><a class="header" href="#getrolesetup"><code>getRoleSetup</code></a></h3>
842
- <pre><code class="language-ts">getRoleSetup(): BRRoleSetup
843
- </code></pre>
844
- <p>Get up-to-date role setup from RoleSetup.json</p>
845
- <h3 id="getroleassignments"><a class="header" href="#getroleassignments"><code>getRoleAssignments</code></a></h3>
846
- <pre><code class="language-ts">getRoleAssignments(): BRRoleAssignments
847
- </code></pre>
848
- <p>Get up-to-date role assignments from RoleAssignment.json</p>
849
- <h3 id="getbanlist"><a class="header" href="#getbanlist"><code>getBanList</code></a></h3>
850
- <pre><code class="language-ts">getBanList(): BRBanList
851
- </code></pre>
852
- <p>Get up-to-date ban list from BanList.json</p>
853
- <h3 id="getnamecache"><a class="header" href="#getnamecache"><code>getNameCache</code></a></h3>
854
- <pre><code class="language-ts">getNameCache(): BRPlayerNameCache
855
- </code></pre>
856
- <p>Get up-to-date name cache from PlayerNameCache.json</p>
857
- <p><sub>Declared in <a href="https://github.com/brickadia-community/omegga/blob/master/src/plugin.ts"><code>src/plugin.ts</code></a>.</sub></p>
858
- <h2 id="injectedcommands"><a class="header" href="#injectedcommands"><code>InjectedCommands</code></a></h2>
859
- <h3 id="getserverstatus"><a class="header" href="#getserverstatus"><code>getServerStatus</code></a></h3>
860
- <pre><code class="language-ts">getServerStatus(): Promise&lt;IServerStatus | null&gt;
861
- </code></pre>
862
- <p>Get server status</p>
863
- <h3 id="listminigames"><a class="header" href="#listminigames"><code>listMinigames</code></a></h3>
864
- <pre><code class="language-ts">listMinigames(): Promise&lt;IMinigameList&gt;
865
- </code></pre>
866
- <p><strong>Deprecated.</strong> minigames were replaced by a single gamemode (~CL14000); on
867
- modern servers this returns at most one entry with an empty <code>owner</code>.
868
- Prefer <code>getGamemode</code>.</p>
869
- <p>Get a list of minigames and their indices</p>
870
- <h3 id="getallplayerpositions"><a class="header" href="#getallplayerpositions"><code>getAllPlayerPositions</code></a></h3>
871
- <pre><code class="language-ts">getAllPlayerPositions(): Promise&lt;IPlayerPositions&gt;
872
- </code></pre>
873
- <p>Get all player positions and pawns</p>
874
- <h3 id="getminigames"><a class="header" href="#getminigames"><code>getMinigames</code></a></h3>
875
- <pre><code class="language-ts">getMinigames(): Promise&lt;ILogMinigame[]&gt;
876
- </code></pre>
877
- <p>Get minigames and members (one entry per gamemode on modern servers)</p>
878
- <h3 id="getgamemode"><a class="header" href="#getgamemode"><code>getGamemode</code></a></h3>
879
- <pre><code class="language-ts">getGamemode(): Promise&lt;IGamemode | null&gt;
880
- </code></pre>
881
- <p>Get the single gamemode and its teams/players (modern servers, &gt;=CL14000).
882
- Returns null on older servers (use <code>getMinigames</code>).</p>
883
- <p><sub>Declared in <a href="https://github.com/brickadia-community/omegga/blob/master/src/plugin.ts"><code>src/plugin.ts</code></a>.</sub></p>
884
- <h2 id="logwrangling"><a class="header" href="#logwrangling"><code>LogWrangling</code></a></h2>
885
- <h3 id="addmatcher"><a class="header" href="#addmatcher"><code>addMatcher</code></a></h3>
886
- <pre><code class="language-ts">addMatcher&lt;T&gt;(pattern: IMatcher&lt;T&gt;['pattern'], callback: IMatcher&lt;T&gt;['callback']): void
887
- </code></pre>
888
- <p>Add a passive pattern on console output that invokes callback on match</p>
889
- <h3 id="addwatcher"><a class="header" href="#addwatcher"><code>addWatcher</code></a></h3>
890
- <pre><code class="language-ts">addWatcher&lt;T = RegExpMatchArray&gt;(pattern: IWatcher&lt;T&gt;['pattern'], options?: { timeoutDelay?: number; bundle?: boolean; debounce?: boolean; afterMatchDelay?: number; last?: IWatcher&lt;T&gt;['last']; exec?: () =&gt; void; }): Promise&lt;T[]&gt;
891
- </code></pre>
892
- <p>Run an active pattern on console output that resolves a match.
893
- T is the element type of the resolved matches - RegExpMatchArray for
894
- RegExp patterns, the pattern’s return type for function patterns.</p>
895
- <h3 id="watchlogchunk"><a class="header" href="#watchlogchunk"><code>watchLogChunk</code></a></h3>
896
- <pre><code class="language-ts">watchLogChunk&lt;T = RegExpMatchArray&gt;(cmd: string, pattern: IWatcher&lt;T&gt;['pattern'], options?: { first?: 'index' | ((match: T) =&gt; boolean); last?: IWatcher&lt;T&gt;['last']; afterMatchDelay?: number; timeoutDelay?: number; }): Promise&lt;T[]&gt;
897
- </code></pre>
898
- <p>Run a command and capture bundled output.
899
- T is the element type of the resolved matches - RegExpMatchArray for
900
- RegExp patterns, the pattern’s return type for function patterns.</p>
901
- <h3 id="watchlogarray"><a class="header" href="#watchlogarray"><code>watchLogArray</code></a></h3>
902
- <pre><code class="language-ts">watchLogArray&lt;Item extends Record&lt;string, string&gt; = Record&lt;string, string&gt;, Member extends Record&lt;string, string&gt; = Record&lt;string, string&gt;&gt;(cmd: string, itemPattern: RegExp, memberPattern: RegExp): Promise&lt;{ item: Item; members: Member[] }[]&gt;
903
- </code></pre>
904
- <p>Run a command and capture bundled output for array functions</p>
905
- <p><sub>Declared in <a href="https://github.com/brickadia-community/omegga/blob/master/src/plugin.ts"><code>src/plugin.ts</code></a>.</sub></p>
906
-
907
- </main>
908
-
909
- <nav class="nav-wrapper" aria-label="Page navigation">
910
- <!-- Mobile navigation buttons -->
911
- <a rel="prev" href="../api/index.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
912
- <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M41.4 233.4c-12.5 12.5-12.5 32.8 0 45.3l160 160c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L109.3 256 246.6 118.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-160 160z"/></svg></span>
913
- </a>
914
-
915
- <a rel="next prefetch" href="../api/player.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
916
- <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M278.6 233.4c12.5 12.5 12.5 32.8 0 45.3l-160 160c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L210.7 256 73.4 118.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l160 160z"/></svg></span>
917
- </a>
918
-
919
- <div style="clear: both"></div>
920
- </nav>
921
- </div>
922
- </div>
923
-
924
- <nav class="nav-wide-wrapper" aria-label="Page navigation">
925
- <a rel="prev" href="../api/index.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
926
- <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M41.4 233.4c-12.5 12.5-12.5 32.8 0 45.3l160 160c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L109.3 256 246.6 118.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-160 160z"/></svg></span>
927
- </a>
928
-
929
- <a rel="next prefetch" href="../api/player.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
930
- <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M278.6 233.4c12.5 12.5 12.5 32.8 0 45.3l-160 160c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L210.7 256 73.4 118.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l160 160z"/></svg></span>
931
- </a>
932
- </nav>
933
-
934
- </div>
935
-
936
- <template id=fa-eye><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M288 32c-80.8 0-145.5 36.8-192.6 80.6C48.6 156 17.3 208 2.5 243.7c-3.3 7.9-3.3 16.7 0 24.6C17.3 304 48.6 356 95.4 399.4C142.5 443.2 207.2 480 288 480s145.5-36.8 192.6-80.6c46.8-43.5 78.1-95.4 93-131.1c3.3-7.9 3.3-16.7 0-24.6c-14.9-35.7-46.2-87.7-93-131.1C433.5 68.8 368.8 32 288 32zM432 256c0 79.5-64.5 144-144 144s-144-64.5-144-144s64.5-144 144-144s144 64.5 144 144zM288 192c0 35.3-28.7 64-64 64c-11.5 0-22.3-3-31.6-8.4c-.2 2.8-.4 5.5-.4 8.4c0 53 43 96 96 96s96-43 96-96s-43-96-96-96c-2.8 0-5.6 .1-8.4 .4c5.3 9.3 8.4 20.1 8.4 31.6z"/></svg></span></template>
937
- <template id=fa-eye-slash><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M38.8 5.1C28.4-3.1 13.3-1.2 5.1 9.2S-1.2 34.7 9.2 42.9l592 464c10.4 8.2 25.5 6.3 33.7-4.1s6.3-25.5-4.1-33.7L525.6 386.7c39.6-40.6 66.4-86.1 79.9-118.4c3.3-7.9 3.3-16.7 0-24.6c-14.9-35.7-46.2-87.7-93-131.1C465.5 68.8 400.8 32 320 32c-68.2 0-125 26.3-169.3 60.8L38.8 5.1zM223.1 149.5C248.6 126.2 282.7 112 320 112c79.5 0 144 64.5 144 144c0 24.9-6.3 48.3-17.4 68.7L408 294.5c5.2-11.8 8-24.8 8-38.5c0-53-43-96-96-96c-2.8 0-5.6 .1-8.4 .4c5.3 9.3 8.4 20.1 8.4 31.6c0 10.2-2.4 19.8-6.6 28.3l-90.3-70.8zm223.1 298L373 389.9c-16.4 6.5-34.3 10.1-53 10.1c-79.5 0-144-64.5-144-144c0-6.9 .5-13.6 1.4-20.2L83.1 161.5C60.3 191.2 44 220.8 34.5 243.7c-3.3 7.9-3.3 16.7 0 24.6c14.9 35.7 46.2 87.7 93 131.1C174.5 443.2 239.2 480 320 480c47.8 0 89.9-12.9 126.2-32.5z"/></svg></span></template>
938
- <template id=fa-copy><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M502.6 70.63l-61.25-61.25C435.4 3.371 427.2 0 418.7 0H255.1c-35.35 0-64 28.66-64 64l.0195 256C192 355.4 220.7 384 256 384h192c35.2 0 64-28.8 64-64V93.25C512 84.77 508.6 76.63 502.6 70.63zM464 320c0 8.836-7.164 16-16 16H255.1c-8.838 0-16-7.164-16-16L239.1 64.13c0-8.836 7.164-16 16-16h128L384 96c0 17.67 14.33 32 32 32h47.1V320zM272 448c0 8.836-7.164 16-16 16H63.1c-8.838 0-16-7.164-16-16L47.98 192.1c0-8.836 7.164-16 16-16H160V128H63.99c-35.35 0-64 28.65-64 64l.0098 256C.002 483.3 28.66 512 64 512h192c35.2 0 64-28.8 64-64v-32h-47.1L272 448z"/></svg></span></template>
939
- <template id=fa-play><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M73 39c-14.8-9.1-33.4-9.4-48.5-.9S0 62.6 0 80V432c0 17.4 9.4 33.4 24.5 41.9s33.7 8.1 48.5-.9L361 297c14.3-8.7 23-24.2 23-41s-8.7-32.2-23-41L73 39z"/></svg></span></template>
940
- <template id=fa-clock-rotate-left><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M75 75L41 41C25.9 25.9 0 36.6 0 57.9V168c0 13.3 10.7 24 24 24H134.1c21.4 0 32.1-25.9 17-41l-30.8-30.8C155 85.5 203 64 256 64c106 0 192 86 192 192s-86 192-192 192c-40.8 0-78.6-12.7-109.7-34.4c-14.5-10.1-34.4-6.6-44.6 7.9s-6.6 34.4 7.9 44.6C151.2 495 201.7 512 256 512c141.4 0 256-114.6 256-256S397.4 0 256 0C185.3 0 121.3 28.7 75 75zm181 53c-13.3 0-24 10.7-24 24V256c0 6.4 2.5 12.5 7 17l72 72c9.4 9.4 24.6 9.4 33.9 0s9.4-24.6 0-33.9l-65-65V152c0-13.3-10.7-24-24-24z"/></svg></span></template>
941
-
942
- <!-- Livereload script (if served using the cli tool) -->
943
- <script>
944
- const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
945
- const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
946
- const socket = new WebSocket(wsAddress);
947
- socket.onmessage = function (event) {
948
- if (event.data === "reload") {
949
- socket.close();
950
- location.reload();
951
- }
952
- };
953
-
954
- window.onbeforeunload = function() {
955
- socket.close();
956
- }
957
- </script>
958
-
959
-
960
- <script>
961
- window.playground_copyable = true;
962
- </script>
963
-
964
-
965
- <script src="../elasticlunr-ef4e11c1.min.js"></script>
966
- <script src="../mark-09e88c2c.min.js"></script>
967
- <script src="../searcher-09f2665d.js"></script>
968
-
969
- <script src="../clipboard-1626706a.min.js"></script>
970
- <script src="../highlight-abc7f01d.js"></script>
971
- <script src="../book-609e4cb8.js"></script>
972
-
973
- <!-- Custom JS scripts -->
974
- <script src="../theme/wirescript-hljs-69fbef4b.js"></script>
975
-
976
-
977
-
978
- </div>
979
- </body>
980
- </html>