37 lines
22 KiB
HTML
37 lines
22 KiB
HTML
<!doctype html>
|
|
<html lang="en" dir="ltr">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<meta name="generator" content="Docusaurus v2.0.0-beta.3">
|
|
<title data-react-helmet="true">Protocol | Stardust XR</title><meta data-react-helmet="true" property="og:url" content="https://stardustxr.github.io/docs/stardust-protocol/protocol"><meta data-react-helmet="true" name="docusaurus_locale" content="en"><meta data-react-helmet="true" name="docusaurus_version" content="current"><meta data-react-helmet="true" name="docusaurus_tag" content="docs-default-current"><meta data-react-helmet="true" property="og:title" content="Protocol | Stardust XR"><meta data-react-helmet="true" name="description" content="Data"><meta data-react-helmet="true" property="og:description" content="Data"><link data-react-helmet="true" rel="shortcut icon" href="/img/favicon.ico"><link data-react-helmet="true" rel="canonical" href="https://stardustxr.github.io/docs/stardust-protocol/protocol"><link data-react-helmet="true" rel="alternate" href="https://stardustxr.github.io/docs/stardust-protocol/protocol" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://stardustxr.github.io/docs/stardust-protocol/protocol" hreflang="x-default"><link rel="stylesheet" href="/assets/css/styles.3393768c.css">
|
|
<link rel="preload" href="/assets/js/runtime~main.a6061986.js" as="script">
|
|
<link rel="preload" href="/assets/js/main.e42582ed.js" as="script">
|
|
</head>
|
|
<body>
|
|
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"dark")}()</script><div id="__docusaurus">
|
|
<div><a href="#" class="skipToContent_1oUP">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle clean-btn" type="button" tabindex="0"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><img src="/img/icon.webp" alt="Stardust XR logo, a yellow astroid with smaller white astroids around it" class="themedImage_1VuW themedImage--light_3UqQ navbar__logo"><img src="/img/icon.webp" alt="Stardust XR logo, a yellow astroid with smaller white astroids around it" class="themedImage_1VuW themedImage--dark_hz6m navbar__logo"><b class="navbar__title">Stardust XR</b></a><a class="navbar__item navbar__link navbar__link--active" href="/docs/intro">Docs</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/technobaboo/stardust-xr" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link"><span>GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3J9K"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a><div class="react-toggle displayOnlyInLargeViewport_GrZ2 react-toggle--checked react-toggle--disabled"><div class="react-toggle-track" role="button" tabindex="-1"><div class="react-toggle-track-check"><span class="toggle_71bT">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_71bT">🌞</span></div><div class="react-toggle-thumb"></div></div><input type="checkbox" checked="" class="react-toggle-screenreader-only" aria-label="Switch between dark and light mode"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/"><img src="/img/icon.webp" alt="Stardust XR logo, a yellow astroid with smaller white astroids around it" class="themedImage_1VuW themedImage--light_3UqQ navbar__logo"><img src="/img/icon.webp" alt="Stardust XR logo, a yellow astroid with smaller white astroids around it" class="themedImage_1VuW themedImage--dark_hz6m navbar__logo"><b class="navbar__title">Stardust XR</b></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a class="menu__link navbar__link--active" href="/docs/intro">Docs</a></li><li class="menu__list-item"><a href="https://github.com/technobaboo/stardust-xr" target="_blank" rel="noopener noreferrer" class="menu__link"><span>GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3J9K"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li></ul></div></div></div></nav><div class="main-wrapper docs-wrapper doc-page"><div class="docPage_31aa"><aside class="docSidebarContainer_3Kbt"><div class="sidebar_15mo"><nav class="menu menu--responsive thin-scrollbar menu_Bmed menuWithAnnouncementBar_2WvA" aria-label="Sidebar navigation"><button aria-label="Open menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg class="sidebarMenuIcon_fgN0" width="24" height="24" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/intro">Intro</a></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#">Protocol</a><ul class="menu__list"><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" tabindex="0" href="/docs/stardust-protocol/protocol">Protocol</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">Client</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/client/initial-connection">Initial Client Connection</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">Server</a><ul class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="-1">Node Types</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/types/Node">Node</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/types/Spatial">Spatial</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/types/Model">Model</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="-1">Fields</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/types/field/BoxField">BoxField</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/types/field/Field">Field</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/types/field/SphereField">SphereField</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="-1">Input</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/types/input/InputHandler">InputHandler</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/types/input/InputMethod">InputMethod</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="-1">inputtypes</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/types/input/inputtypes/HandInput">HandInput</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/types/input/inputtypes/PointerInput">PointerInput</a></li></ul></li></ul></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="-1">Server Objects</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/objects/environment">/environment</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/objects/field">/field</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/objects/hmd">/hmd</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/objects/input">/input</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/objects/lifecycle">/lifecycle</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/objects/model">/model</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/objects/spatial">/spatial</a></li></ul></li></ul></li></ul></li></ul></nav></div></aside><main class="docMainContainer_3ufF"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_3FnS"><div class="docItemContainer_33ec"><article><div class="markdown"><header><h1 class="h1Heading_27L5">Protocol</h1></header><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="data"></a>Data<a class="hash-link" href="#data" title="Direct link to heading">#</a></h2><p>Every message uses flatbuffers and most use flexbuffers to add variant data such as method arguments and return values. The flatbuffers Message type is:</p><div class="codeBlockContainer_K1bP"><div class="codeBlockContent_hGly cpp"><pre tabindex="0" class="prism-code language-cpp codeBlock_23N8 thin-scrollbar" style="color:#9CDCFE;background-color:#1E1E1E"><code class="codeBlockLines_39YC"><span class="token-line" style="color:#9CDCFE"><span class="token keyword" style="color:rgb(86, 156, 214)">namespace</span><span class="token plain"> StardustXR</span><span class="token punctuation" style="color:rgb(212, 212, 212)">;</span><span class="token plain"></span></span><span class="token-line" style="color:#9CDCFE"><span class="token plain" style="display:inline-block">
|
|
</span></span><span class="token-line" style="color:#9CDCFE"><span class="token plain">table Message </span><span class="token punctuation" style="color:rgb(212, 212, 212)">{</span><span class="token plain"></span></span><span class="token-line" style="color:#9CDCFE"><span class="token plain"> type</span><span class="token operator" style="color:rgb(212, 212, 212)">:</span><span class="token plain"> ubyte</span><span class="token punctuation" style="color:rgb(212, 212, 212)">;</span><span class="token plain"></span></span><span class="token-line" style="color:#9CDCFE"><span class="token plain"> id</span><span class="token operator" style="color:rgb(212, 212, 212)">:</span><span class="token plain"> uint</span><span class="token punctuation" style="color:rgb(212, 212, 212)">;</span><span class="token plain"></span></span><span class="token-line" style="color:#9CDCFE"><span class="token plain"> object</span><span class="token operator" style="color:rgb(212, 212, 212)">:</span><span class="token plain"> string</span><span class="token punctuation" style="color:rgb(212, 212, 212)">;</span><span class="token plain"></span></span><span class="token-line" style="color:#9CDCFE"><span class="token plain"> method</span><span class="token operator" style="color:rgb(212, 212, 212)">:</span><span class="token plain"> string</span><span class="token punctuation" style="color:rgb(212, 212, 212)">;</span><span class="token plain"></span></span><span class="token-line" style="color:#9CDCFE"><span class="token plain"> error</span><span class="token operator" style="color:rgb(212, 212, 212)">:</span><span class="token plain"> string</span><span class="token punctuation" style="color:rgb(212, 212, 212)">;</span><span class="token plain"></span></span><span class="token-line" style="color:#9CDCFE"><span class="token plain"> data</span><span class="token operator" style="color:rgb(212, 212, 212)">:</span><span class="token punctuation" style="color:rgb(212, 212, 212)">[</span><span class="token plain">ubyte</span><span class="token punctuation" style="color:rgb(212, 212, 212)">]</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(212, 212, 212)">(</span><span class="token plain">flexbuffer</span><span class="token punctuation" style="color:rgb(212, 212, 212)">)</span><span class="token punctuation" style="color:rgb(212, 212, 212)">;</span><span class="token plain"></span></span><span class="token-line" style="color:#9CDCFE"><span class="token plain"></span><span class="token punctuation" style="color:rgb(212, 212, 212)">}</span><span class="token plain"></span></span><span class="token-line" style="color:#9CDCFE"><span class="token plain" style="display:inline-block">
|
|
</span></span><span class="token-line" style="color:#9CDCFE"><span class="token plain">root_type Message</span><span class="token punctuation" style="color:rgb(212, 212, 212)">;</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o clean-btn">Copy</button></div></div><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="message-types"></a>Message Types<a class="hash-link" href="#message-types" title="Direct link to heading">#</a></h2><p>All fields not accounted for are assumed to be not included or <code>0</code> or <code>""</code></p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="error"></a>Error<a class="hash-link" href="#error" title="Direct link to heading">#</a></h3><table><thead><tr><th align="right">Field Name</th><th align="left">Value</th></tr></thead><tbody><tr><td align="right"><code>type</code></td><td align="left"><code>0</code></td></tr><tr><td align="right"><code>id</code></td><td align="left"><code>0</code> or ID of method call</td></tr><tr><td align="right"><code>object</code></td><td align="left">Path to the object the error comes from</td></tr><tr><td align="right"><code>method</code></td><td align="left">What method caused the error (if applicable, otherwise this is an empty string)</td></tr><tr><td align="right"><code>error</code></td><td align="left">String containing the error message itself</td></tr><tr><td align="right"><code>data</code></td><td align="left">Empty vector</td></tr></tbody></table><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="signal"></a>Signal<a class="hash-link" href="#signal" title="Direct link to heading">#</a></h3><p>Signals are method calls that do not expect a response of any kind.
|
|
| Field Name | Value |
|
|
|-:|:-|
|
|
| <code>type</code> | <code>1</code> |
|
|
| <code>object</code> | Path to object to send signal to |
|
|
| <code>method</code> | Name of the method to execute |
|
|
| <code>data</code> | Flexbuffer containing arguments to pass to remote method |</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="method-call"></a>Method Call<a class="hash-link" href="#method-call" title="Direct link to heading">#</a></h3><p>Method calls allow for remote procedure calling and should block the thread they are sent from until a response is heard.
|
|
| Field Name | Value |
|
|
|-:|:-|
|
|
| <code>type</code> | <code>2</code> |
|
|
| <code>id</code> | Dynamically generated ID to identify method return for this method |
|
|
| <code>object</code> | Path to object to execute method on |
|
|
| <code>method</code> | Name of the method to execute |
|
|
| <code>data</code> | Flexbuffer containing arguments to pass to remote method |</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="method-return"></a>Method Return<a class="hash-link" href="#method-return" title="Direct link to heading">#</a></h3><p>Message to pass the return value back to the program.
|
|
| Field Name | Value |
|
|
|-:|:-|
|
|
| <code>type</code> | <code>3</code> |
|
|
| <code>id</code> | The same as the message call's ID |
|
|
| <code>data</code> | Flexbuffer containing return value |</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="data-types"></a>Data Types<a class="hash-link" href="#data-types" title="Direct link to heading">#</a></h2><p>Stardust does not support the <code>Map</code> or <code>FixedTypedVector</code> flexbuffers datatypes.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="color"></a>Color<a class="hash-link" href="#color" title="Direct link to heading">#</a></h3><p>A <code>Vector</code> of 4 <code>float</code> is treated as a <code>Color</code> in the form <code>RGBA</code>.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="vector2"></a>Vector2<a class="hash-link" href="#vector2" title="Direct link to heading">#</a></h3><p>A <code>Vector</code> of 2 <code>double</code> is treated as a <code>Vector2</code>.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="vector3"></a>Vector3<a class="hash-link" href="#vector3" title="Direct link to heading">#</a></h3><p>A <code>Vector</code> of 3 <code>double</code> is treated as a <code>Vector3</code>.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="quaternion"></a>Quaternion<a class="hash-link" href="#quaternion" title="Direct link to heading">#</a></h3><p>A <code>Vector</code> of 4 <code>double</code> is treated as a <code>Quaternion</code>.</p></div><footer class="row docusaurus-mt-lg"><div class="col"><a href="https://github.com/StardustXR/website/edit/main/docs/stardust-protocol/protocol.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_2_ui" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_3DPF"></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/intro"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« Intro</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/stardust-protocol/client/initial-connection"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Initial Client Connection »</div></a></div></nav></div></div><div class="col col--3"><div class="tableOfContents_35-E thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#data" class="table-of-contents__link">Data</a></li><li><a href="#message-types" class="table-of-contents__link">Message Types</a><ul><li><a href="#error" class="table-of-contents__link">Error</a></li><li><a href="#signal" class="table-of-contents__link">Signal</a></li><li><a href="#method-call" class="table-of-contents__link">Method Call</a></li><li><a href="#method-return" class="table-of-contents__link">Method Return</a></li></ul></li><li><a href="#data-types" class="table-of-contents__link">Data Types</a><ul><li><a href="#color" class="table-of-contents__link">Color</a></li><li><a href="#vector2" class="table-of-contents__link">Vector2</a></li><li><a href="#vector3" class="table-of-contents__link">Vector3</a></li><li><a href="#quaternion" class="table-of-contents__link">Quaternion</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/stardust-protocol/protocol">Protocol</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items"><li class="footer__item"><a href="https://discord.gg/qwxuwRrbP5" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3J9K"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li><li class="footer__item"><a href="https://twitter.com/stardustxr" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3J9K"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items"><li class="footer__item"><a href="https://github.com/facebook/docusaurus" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3J9K"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2021 Nova King</div></div></div></footer></div>
|
|
<script src="/assets/js/runtime~main.a6061986.js"></script>
|
|
<script src="/assets/js/main.e42582ed.js"></script>
|
|
</body>
|
|
</html> |