aboutsummaryrefslogtreecommitdiff
path: root/public/docs/Code Documentation
diff options
context:
space:
mode:
Diffstat (limited to 'public/docs/Code Documentation')
-rw-r--r--public/docs/Code Documentation/Design/index.html735
-rw-r--r--public/docs/Code Documentation/Modules/CompileAndRun/index.html888
-rw-r--r--public/docs/Code Documentation/Run/index.html896
-rw-r--r--public/docs/Code Documentation/SocketIO/index.html905
4 files changed, 1557 insertions, 1867 deletions
diff --git a/public/docs/Code Documentation/Design/index.html b/public/docs/Code Documentation/Design/index.html
index 2c0bc9d..06e0d27 100644
--- a/public/docs/Code Documentation/Design/index.html
+++ b/public/docs/Code Documentation/Design/index.html
@@ -1,38 +1,15 @@
-
-
-
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
- <meta http-equiv="x-ua-compatible" content="ie=edge">
-
-
-
-
- <meta name="lang:clipboard.copy" content="Copy to clipboard">
-
- <meta name="lang:clipboard.copied" content="Copied to clipboard">
-
- <meta name="lang:search.language" content="en">
-
- <meta name="lang:search.pipeline.stopwords" content="True">
-
- <meta name="lang:search.pipeline.trimmer" content="True">
-
- <meta name="lang:search.result.none" content="No matching documents">
- <meta name="lang:search.result.one" content="1 matching document">
- <meta name="lang:search.result.other" content="# matching documents">
- <meta name="lang:search.tokenizer" content="[\s\-]+">
-
- <link rel="shortcut icon" href="../../assets/images/favicon.png">
- <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.2">
+ <link rel="icon" href="../../assets/images/favicon.png">
+ <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-8.5.10">
@@ -40,126 +17,127 @@
- <link rel="stylesheet" href="../../assets/stylesheets/application.30686662.css">
+ <link rel="stylesheet" href="../../assets/stylesheets/main.975780f9.min.css">
+
+
+ <link rel="stylesheet" href="../../assets/stylesheets/palette.2505c338.min.css">
+
+
- <script src="../../assets/javascripts/modernizr.74668098.js"></script>
-
- <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
- <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono&display=fallback">
- <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
+
+
+ <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+ <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
+ <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
- <link rel="stylesheet" href="../../assets/fonts/material-icons.css">
+ <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
<link rel="stylesheet" href="../../assets/luxcena-colors.css">
+ <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+
+
</head>
- <body dir="ltr">
- <svg class="md-svg">
- <defs>
-
-
- </defs>
- </svg>
- <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
- <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
- <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
- <a href="#design" tabindex="1" class="md-skip">
- Skip to content
- </a>
- <header class="md-header" data-md-component="header">
- <nav class="md-header-nav md-grid">
- <div class="md-flex">
- <div class="md-flex__cell md-flex__cell--shrink">
- <a href="../.." title="Luxcena Neo Documentation" class="md-header-nav__button md-logo">
-
- <i class="md-icon"></i>
-
+
+
+ <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="None" data-md-color-accent="None">
+
+
+
+ <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
+ <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
+ <label class="md-overlay" for="__drawer"></label>
+ <div data-md-component="skip">
+
+
+ <a href="#design" class="md-skip">
+ Skip to content
</a>
- </div>
- <div class="md-flex__cell md-flex__cell--shrink">
- <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
- </div>
- <div class="md-flex__cell md-flex__cell--stretch">
- <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
-
- <span class="md-header-nav__topic">
- Luxcena Neo Documentation
- </span>
- <span class="md-header-nav__topic">
-
- Design
-
- </span>
-
+
+ </div>
+ <div data-md-component="announce">
+
+ </div>
+
+
+
+
+<header class="md-header" data-md-component="header">
+ <nav class="md-header__inner md-grid" aria-label="Header">
+ <a href="../.." title="Luxcena Neo Documentation" class="md-header__button md-logo" aria-label="Luxcena Neo Documentation" data-md-component="logo">
+
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
+
+ </a>
+ <label class="md-header__button md-icon" for="__drawer">
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
+ </label>
+ <div class="md-header__title" data-md-component="header-title">
+ <div class="md-header__ellipsis">
+ <div class="md-header__topic">
+ <span class="md-ellipsis">
+ Luxcena Neo Documentation
+ </span>
</div>
- </div>
- <div class="md-flex__cell md-flex__cell--shrink">
-
- <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
-
-<div class="md-search" data-md-component="search" role="dialog">
- <label class="md-search__overlay" for="__search"></label>
- <div class="md-search__inner" role="search">
- <form class="md-search__form" name="search">
- <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
- <label class="md-icon md-search__icon" for="__search"></label>
- <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
- &#xE5CD;
- </button>
- </form>
- <div class="md-search__output">
- <div class="md-search__scrollwrap" data-md-scrollfix>
- <div class="md-search-result" data-md-component="result">
- <div class="md-search-result__meta">
- Type to start searching
- </div>
- <ol class="md-search-result__list"></ol>
+ <div class="md-header__topic" data-md-component="header-topic">
+ <span class="md-ellipsis">
+
+ Design
+
+ </span>
</div>
</div>
</div>
- </div>
-</div>
-
- </div>
-
- </div>
+
+
+
+
</nav>
+
</header>
- <div class="md-container">
+ <div class="md-container" data-md-component="container">
-
+
+
+
- <main class="md-main" role="main">
- <div class="md-main__inner md-grid" data-md-component="container">
+ <main class="md-main" data-md-component="main">
+ <div class="md-main__inner md-grid">
- <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
+
+ <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
- <nav class="md-nav md-nav--primary" data-md-level="0">
- <label class="md-nav__title md-nav__title--site" for="__drawer">
- <a href="../.." title="Luxcena Neo Documentation" class="md-nav__button md-logo">
-
- <i class="md-icon"></i>
+
+
+
+<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
+ <label class="md-nav__title" for="__drawer">
+ <a href="../.." title="Luxcena Neo Documentation" class="md-nav__button md-logo" aria-label="Luxcena Neo Documentation" data-md-component="logo">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
+
</a>
Luxcena Neo Documentation
</label>
@@ -170,156 +148,168 @@
-
- <li class="md-nav__item">
- <a href="../.." title="Introduction" class="md-nav__link">
- Introduction
- </a>
- </li>
+
+
+
+ <li class="md-nav__item">
+ <a href="../.." class="md-nav__link">
+ Introduction
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../../FuturePlan/" title="Plan for the future" class="md-nav__link">
- Plan for the future
- </a>
- </li>
+
+
+
+ <li class="md-nav__item">
+ <a href="../../FuturePlan/" class="md-nav__link">
+ Plan for the future
+ </a>
+ </li>
+
-
- <li class="md-nav__item md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
+
+
+
- <label class="md-nav__link" for="nav-3">
- Usage
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
- <label class="md-nav__title" for="nav-3">
- Usage
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
+ <li class="md-nav__item md-nav__item--nested">
+
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
+
+
+
+
+ <label class="md-nav__link" for="__nav_3">
+ Usage
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" aria-label="Usage" data-md-level="1">
+ <label class="md-nav__title" for="__nav_3">
+ <span class="md-nav__icon md-icon"></span>
+ Usage
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../Usage/Install/" class="md-nav__link">
+ Install
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../../Usage/Install/" title="Install" class="md-nav__link">
- Install
- </a>
- </li>
-
-
-
-
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../Usage/Configuration/" class="md-nav__link">
+ Configuration
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../../Usage/Configuration/" title="Configuration" class="md-nav__link">
- Configuration
- </a>
- </li>
-
-
-
-
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../Usage/CLI/" class="md-nav__link">
+ CLI
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../../Usage/CLI/" title="CLI" class="md-nav__link">
- CLI
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
+
+
+ </ul>
+ </nav>
+ </li>
+
-
- <li class="md-nav__item md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
+
+
+
- <label class="md-nav__link" for="nav-4">
- Scripting
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
- <label class="md-nav__title" for="nav-4">
- Scripting
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
+ <li class="md-nav__item md-nav__item--nested">
+
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
+
+
+
+
+ <label class="md-nav__link" for="__nav_4">
+ Scripting
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" aria-label="Scripting" data-md-level="1">
+ <label class="md-nav__title" for="__nav_4">
+ <span class="md-nav__icon md-icon"></span>
+ Scripting
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../Scripting/Strip/" class="md-nav__link">
+ Strip
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../../Scripting/SupportLib/" title="Support Library" class="md-nav__link">
- Support Library
- </a>
- </li>
-
-
-
-
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../Scripting/NeoBehaviour/" class="md-nav__link">
+ Main interface
+ </a>
+ </li>
+
-
- <li class="md-nav__item md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4-2" type="checkbox" id="nav-4-2">
-
- <label class="md-nav__link" for="nav-4-2">
- Examples
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
- <label class="md-nav__title" for="nav-4-2">
- Examples
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
+
-
-
- <li class="md-nav__item">
- <a href="../../Scripting/Examples/strandtest/" title="Strandtest" class="md-nav__link">
- Strandtest
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
- </ul>
- </nav>
- </li>
+ </ul>
+ </nav>
+ </li>
+
@@ -327,130 +317,94 @@
-
-
- <li class="md-nav__item md-nav__item--active md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5" checked>
-
- <label class="md-nav__link" for="nav-5">
- Code Documentation
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
- <label class="md-nav__title" for="nav-5">
- Code Documentation
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-1" type="checkbox" id="nav-5-1">
+
+
- <label class="md-nav__link" for="nav-5-1">
- Modules
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
- <label class="md-nav__title" for="nav-5-1">
- Modules
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../Modules/CompileAndRun/" title="CompileAndRun" class="md-nav__link">
- CompileAndRun
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
+ <li class="md-nav__item md-nav__item--nested">
+
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
+
+
+
+
+ <label class="md-nav__link" for="__nav_5">
+ Code Documentation
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" aria-label="Code Documentation" data-md-level="1">
+ <label class="md-nav__title" for="__nav_5">
+ <span class="md-nav__icon md-icon"></span>
+ Code Documentation
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../Run/" class="md-nav__link">
+ Run
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../Run/" title="Run" class="md-nav__link">
- Run
- </a>
- </li>
-
-
-
-
+
-
+
+
+
+
-
-
- <li class="md-nav__item md-nav__item--active">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
+ <li class="md-nav__item md-nav__item--nested">
-
-
- <a href="./" title="Design" class="md-nav__link md-nav__link--active">
- Design
- </a>
-
- </li>
-
-
-
-
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
+
+
+
+
+ <label class="md-nav__link" for="__nav_5_2">
+ API
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" aria-label="API" data-md-level="2">
+ <label class="md-nav__title" for="__nav_5_2">
+ <span class="md-nav__icon md-icon"></span>
+ API
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../SocketIO/" class="md-nav__link">
+ Socket-IO
+ </a>
+ </li>
+
-
- <li class="md-nav__item md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-4" type="checkbox" id="nav-5-4">
-
- <label class="md-nav__link" for="nav-5-4">
- API
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
- <label class="md-nav__title" for="nav-5-4">
- API
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
+
+ </ul>
+ </nav>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../SocketIO/" title="Socket-IO" class="md-nav__link">
- Socket-IO
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
- </ul>
- </nav>
- </li>
+
+
+ </ul>
+ </nav>
+ </li>
+
</ul>
@@ -460,11 +414,14 @@
</div>
- <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
+
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
-<nav class="md-nav md-nav--secondary">
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
@@ -476,86 +433,57 @@
</div>
- <div class="md-content">
- <article class="md-content__inner md-typeset">
-
-
+
+ <div class="md-content" data-md-component="content">
+ <article class="md-content__inner md-typeset">
- <h1 id="design">Design</h1>
+
+
+
+<h1 id="design">Design</h1>
<p>We are using googles material design.</p>
<p><a href="https://material.io/components/">Link to the components</a></p>
-
-
-
-
-
-
-
- </article>
- </div>
+
+
+
+
+ </article>
+ </div>
+
+
</div>
+
</main>
-
-<footer class="md-footer">
-
- <div class="md-footer-nav">
- <nav class="md-footer-nav__inner md-grid">
-
- <a href="../Run/" title="Run" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
- <div class="md-flex__cell md-flex__cell--shrink">
- <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
- </div>
- <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
- <span class="md-flex__ellipsis">
- <span class="md-footer-nav__direction">
- Previous
- </span>
- Run
- </span>
- </div>
- </a>
-
-
- <a href="../SocketIO/" title="Socket-IO" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
- <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
- <span class="md-flex__ellipsis">
- <span class="md-footer-nav__direction">
- Next
- </span>
- Socket-IO
- </span>
- </div>
- <div class="md-flex__cell md-flex__cell--shrink">
- <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
- </div>
- </a>
-
- </nav>
- </div>
+ <footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
- <div class="md-footer-copyright">
-
- powered by
- <a href="https://www.mkdocs.org">MkDocs</a>
- and
- <a href="https://squidfunk.github.io/mkdocs-material/">
- Material for MkDocs</a>
- </div>
+ <div class="md-copyright">
+
+
+ Made with
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
+ Material for MkDocs
+ </a>
+
+</div>
</div>
</div>
</footer>
</div>
+ <div class="md-dialog" data-md-component="dialog">
+ <div class="md-dialog__inner md-typeset"></div>
+ </div>
- <script src="../../assets/javascripts/application.c648116f.js"></script>
-
- <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>
+ <script id="__config" type="application/json">{"base": "../..", "features": [], "search": "../../assets/javascripts/workers/search.16e2a7d4.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script>
+
+
+ <script src="../../assets/javascripts/bundle.5a2dcb6a.min.js"></script>
<script src="../../assets/luxcena-colors.js"></script>
@@ -570,5 +498,6 @@
<script src="../../assets/js-sequence.js"></script>
+
</body>
</html> \ No newline at end of file
diff --git a/public/docs/Code Documentation/Modules/CompileAndRun/index.html b/public/docs/Code Documentation/Modules/CompileAndRun/index.html
index e842528..caf1494 100644
--- a/public/docs/Code Documentation/Modules/CompileAndRun/index.html
+++ b/public/docs/Code Documentation/Modules/CompileAndRun/index.html
@@ -1,38 +1,15 @@
-
-
-
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
- <meta http-equiv="x-ua-compatible" content="ie=edge">
-
-
-
-
- <meta name="lang:clipboard.copy" content="Copy to clipboard">
-
- <meta name="lang:clipboard.copied" content="Copied to clipboard">
- <meta name="lang:search.language" content="en">
- <meta name="lang:search.pipeline.stopwords" content="True">
- <meta name="lang:search.pipeline.trimmer" content="True">
-
- <meta name="lang:search.result.none" content="No matching documents">
-
- <meta name="lang:search.result.one" content="1 matching document">
-
- <meta name="lang:search.result.other" content="# matching documents">
-
- <meta name="lang:search.tokenizer" content="[\s\-]+">
-
- <link rel="shortcut icon" href="../../../assets/images/favicon.png">
- <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.2">
+ <link rel="icon" href="../../../assets/images/favicon.png">
+ <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-8.5.10">
@@ -40,126 +17,127 @@
- <link rel="stylesheet" href="../../../assets/stylesheets/application.30686662.css">
+ <link rel="stylesheet" href="../../../assets/stylesheets/main.975780f9.min.css">
+
+ <link rel="stylesheet" href="../../../assets/stylesheets/palette.2505c338.min.css">
+
+
+
- <script src="../../../assets/javascripts/modernizr.74668098.js"></script>
-
- <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
- <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono&display=fallback">
- <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
+
+
+ <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+ <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
+ <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
- <link rel="stylesheet" href="../../../assets/fonts/material-icons.css">
+ <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
<link rel="stylesheet" href="../../../assets/luxcena-colors.css">
+ <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+
+
</head>
- <body dir="ltr">
- <svg class="md-svg">
- <defs>
-
-
- </defs>
- </svg>
- <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
- <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
- <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
- <a href="#index" tabindex="1" class="md-skip">
- Skip to content
- </a>
- <header class="md-header" data-md-component="header">
- <nav class="md-header-nav md-grid">
- <div class="md-flex">
- <div class="md-flex__cell md-flex__cell--shrink">
- <a href="../../.." title="Luxcena Neo Documentation" class="md-header-nav__button md-logo">
-
- <i class="md-icon"></i>
-
+
+
+ <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="None" data-md-color-accent="None">
+
+
+
+ <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
+ <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
+ <label class="md-overlay" for="__drawer"></label>
+ <div data-md-component="skip">
+
+
+ <a href="#index" class="md-skip">
+ Skip to content
</a>
- </div>
- <div class="md-flex__cell md-flex__cell--shrink">
- <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
- </div>
- <div class="md-flex__cell md-flex__cell--stretch">
- <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
-
- <span class="md-header-nav__topic">
- Luxcena Neo Documentation
- </span>
- <span class="md-header-nav__topic">
-
- CompileAndRun
-
- </span>
-
+
+ </div>
+ <div data-md-component="announce">
+
+ </div>
+
+
+
+
+<header class="md-header" data-md-component="header">
+ <nav class="md-header__inner md-grid" aria-label="Header">
+ <a href="../../.." title="Luxcena Neo Documentation" class="md-header__button md-logo" aria-label="Luxcena Neo Documentation" data-md-component="logo">
+
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
+
+ </a>
+ <label class="md-header__button md-icon" for="__drawer">
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
+ </label>
+ <div class="md-header__title" data-md-component="header-title">
+ <div class="md-header__ellipsis">
+ <div class="md-header__topic">
+ <span class="md-ellipsis">
+ Luxcena Neo Documentation
+ </span>
</div>
- </div>
- <div class="md-flex__cell md-flex__cell--shrink">
-
- <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
-
-<div class="md-search" data-md-component="search" role="dialog">
- <label class="md-search__overlay" for="__search"></label>
- <div class="md-search__inner" role="search">
- <form class="md-search__form" name="search">
- <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
- <label class="md-icon md-search__icon" for="__search"></label>
- <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
- &#xE5CD;
- </button>
- </form>
- <div class="md-search__output">
- <div class="md-search__scrollwrap" data-md-scrollfix>
- <div class="md-search-result" data-md-component="result">
- <div class="md-search-result__meta">
- Type to start searching
- </div>
- <ol class="md-search-result__list"></ol>
+ <div class="md-header__topic" data-md-component="header-topic">
+ <span class="md-ellipsis">
+
+ CompileAndRun
+
+ </span>
</div>
</div>
</div>
- </div>
-</div>
-
- </div>
-
- </div>
+
+
+
+
</nav>
+
</header>
- <div class="md-container">
+ <div class="md-container" data-md-component="container">
-
+
+
+
- <main class="md-main" role="main">
- <div class="md-main__inner md-grid" data-md-component="container">
+ <main class="md-main" data-md-component="main">
+ <div class="md-main__inner md-grid">
- <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
+
+ <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
- <nav class="md-nav md-nav--primary" data-md-level="0">
- <label class="md-nav__title md-nav__title--site" for="__drawer">
- <a href="../../.." title="Luxcena Neo Documentation" class="md-nav__button md-logo">
-
- <i class="md-icon"></i>
+
+
+
+<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
+ <label class="md-nav__title" for="__drawer">
+ <a href="../../.." title="Luxcena Neo Documentation" class="md-nav__button md-logo" aria-label="Luxcena Neo Documentation" data-md-component="logo">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
+
</a>
Luxcena Neo Documentation
</label>
@@ -170,156 +148,106 @@
-
- <li class="md-nav__item">
- <a href="../../.." title="Introduction" class="md-nav__link">
- Introduction
- </a>
- </li>
+
+
+
+ <li class="md-nav__item">
+ <a href="../../.." class="md-nav__link">
+ Introduction
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../../../FuturePlan/" title="Plan for the future" class="md-nav__link">
- Plan for the future
- </a>
- </li>
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../FuturePlan/" class="md-nav__link">
+ Plan for the future
+ </a>
+ </li>
+
-
- <li class="md-nav__item md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
-
- <label class="md-nav__link" for="nav-3">
- Usage
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
- <label class="md-nav__title" for="nav-3">
- Usage
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../../Usage/Install/" title="Install" class="md-nav__link">
- Install
- </a>
- </li>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../../Usage/Configuration/" title="Configuration" class="md-nav__link">
- Configuration
- </a>
- </li>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../../Usage/CLI/" title="CLI" class="md-nav__link">
- CLI
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
-
-
- <li class="md-nav__item md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
-
- <label class="md-nav__link" for="nav-4">
- Scripting
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
- <label class="md-nav__title" for="nav-4">
- Scripting
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
+
+
+
+ <label class="md-nav__link" for="__nav_3">
+ Usage
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" aria-label="Usage" data-md-level="1">
+ <label class="md-nav__title" for="__nav_3">
+ <span class="md-nav__icon md-icon"></span>
+ Usage
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../Usage/Install/" class="md-nav__link">
+ Install
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../../../Scripting/SupportLib/" title="Support Library" class="md-nav__link">
- Support Library
- </a>
- </li>
-
-
-
-
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../Usage/Configuration/" class="md-nav__link">
+ Configuration
+ </a>
+ </li>
+
-
- <li class="md-nav__item md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4-2" type="checkbox" id="nav-4-2">
-
- <label class="md-nav__link" for="nav-4-2">
- Examples
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
- <label class="md-nav__title" for="nav-4-2">
- Examples
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../Usage/CLI/" class="md-nav__link">
+ CLI
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../../../Scripting/Examples/strandtest/" title="Strandtest" class="md-nav__link">
- Strandtest
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
- </ul>
- </nav>
- </li>
+
+
+ </ul>
+ </nav>
+ </li>
+
@@ -327,232 +255,156 @@
-
-
- <li class="md-nav__item md-nav__item--active md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5" checked>
+
+
- <label class="md-nav__link" for="nav-5">
- Code Documentation
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
- <label class="md-nav__title" for="nav-5">
- Code Documentation
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
+ <li class="md-nav__item md-nav__item--nested">
+
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
+
+
+
+
+ <label class="md-nav__link" for="__nav_4">
+ Scripting
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" aria-label="Scripting" data-md-level="1">
+ <label class="md-nav__title" for="__nav_4">
+ <span class="md-nav__icon md-icon"></span>
+ Scripting
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
-
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../Scripting/Strip/" class="md-nav__link">
+ Strip
+ </a>
+ </li>
-
- <li class="md-nav__item md-nav__item--active md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-1" type="checkbox" id="nav-5-1" checked>
-
- <label class="md-nav__link" for="nav-5-1">
- Modules
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
- <label class="md-nav__title" for="nav-5-1">
- Modules
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
+
-
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../Scripting/NeoBehaviour/" class="md-nav__link">
+ Main interface
+ </a>
+ </li>
+
+
+ </ul>
+ </nav>
+ </li>
+
- <li class="md-nav__item md-nav__item--active">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
-
-
- <label class="md-nav__link md-nav__link--active" for="__toc">
- CompileAndRun
- </label>
-
- <a href="./" title="CompileAndRun" class="md-nav__link md-nav__link--active">
- CompileAndRun
- </a>
-<nav class="md-nav md-nav--secondary">
-
-
-
- <label class="md-nav__title" for="__toc">Table of contents</label>
- <ul class="md-nav__list" data-md-scrollfix>
- <li class="md-nav__item">
- <a href="#index" class="md-nav__link">
- Index
- </a>
-
-</li>
- <li class="md-nav__item">
- <a href="#locals" class="md-nav__link">
- Locals
- </a>
+
- <nav class="md-nav">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#var-pythonsupportfiles" class="md-nav__link">
- var pythonSupportFiles
- </a>
-</li>
-
- </ul>
- </nav>
-</li>
+
+ <li class="md-nav__item md-nav__item--nested">
- <li class="md-nav__item">
- <a href="#exported" class="md-nav__link">
- Exported
- </a>
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
+
+
+
+
+ <label class="md-nav__link" for="__nav_5">
+ Code Documentation
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" aria-label="Code Documentation" data-md-level="1">
+ <label class="md-nav__title" for="__nav_5">
+ <span class="md-nav__icon md-icon"></span>
+ Code Documentation
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
- <nav class="md-nav">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#class-python" class="md-nav__link">
- class Python
- </a>
-</li>
-
- <li class="md-nav__item">
- <a href="#method-pythonconstructor" class="md-nav__link">
- method Python.constructor
- </a>
-</li>
-
- <li class="md-nav__item">
- <a href="#method-pythoncompile" class="md-nav__link">
- method Python.compile
- </a>
+ <li class="md-nav__item">
+ <a href="../../Run/" class="md-nav__link">
+ Run
+ </a>
+ </li>
-</li>
-
- <li class="md-nav__item">
- <a href="#method-pythonrun" class="md-nav__link">
- method Python.run
- </a>
+
+
+
+
+
-</li>
-
- </ul>
- </nav>
-</li>
-
- <li class="md-nav__item">
- <a href="#python" class="md-nav__link">
- Python
- </a>
-</li>
+
+ <li class="md-nav__item md-nav__item--nested">
- <li class="md-nav__item">
- <a href="#entrypy" class="md-nav__link">
- Entry.py
- </a>
-
-</li>
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
- </ul>
-
-</nav>
-
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../Run/" title="Run" class="md-nav__link">
- Run
- </a>
- </li>
-
-
-
-
+ <label class="md-nav__link" for="__nav_5_2">
+ API
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" aria-label="API" data-md-level="2">
+ <label class="md-nav__title" for="__nav_5_2">
+ <span class="md-nav__icon md-icon"></span>
+ API
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../SocketIO/" class="md-nav__link">
+ Socket-IO
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../../Design/" title="Design" class="md-nav__link">
- Design
- </a>
- </li>
-
-
-
-
+
+ </ul>
+ </nav>
+ </li>
+
-
- <li class="md-nav__item md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-4" type="checkbox" id="nav-5-4">
-
- <label class="md-nav__link" for="nav-5-4">
- API
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
- <label class="md-nav__title" for="nav-5-4">
- API
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
+
-
-
- <li class="md-nav__item">
- <a href="../../SocketIO/" title="Socket-IO" class="md-nav__link">
- Socket-IO
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
- </ul>
- </nav>
- </li>
+ </ul>
+ </nav>
+ </li>
+
</ul>
@@ -562,16 +414,22 @@
</div>
- <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
+
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
-<nav class="md-nav md-nav--secondary">
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
- <label class="md-nav__title" for="__toc">Table of contents</label>
- <ul class="md-nav__list" data-md-scrollfix>
+ <label class="md-nav__title" for="__toc">
+ <span class="md-nav__icon md-icon"></span>
+ Table of contents
+ </label>
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#index" class="md-nav__link">
@@ -585,7 +443,7 @@
Locals
</a>
- <nav class="md-nav">
+ <nav class="md-nav" aria-label="Locals">
<ul class="md-nav__list">
<li class="md-nav__item">
@@ -605,7 +463,7 @@
Exported
</a>
- <nav class="md-nav">
+ <nav class="md-nav" aria-label="Exported">
<ul class="md-nav__list">
<li class="md-nav__item">
@@ -655,10 +513,6 @@
</li>
-
-
-
-
</ul>
</nav>
@@ -667,137 +521,92 @@
</div>
- <div class="md-content">
- <article class="md-content__inner md-typeset">
-
-
-
- <h1>CompileAndRun</h1>
+
+ <div class="md-content" data-md-component="content">
+ <article class="md-content__inner md-typeset">
- <h2 id="index">Index</h2>
+
+
+
+ <h1>CompileAndRun</h1>
+
+<h2 id="index">Index</h2>
<hr />
<h2 id="locals">Locals</h2>
-<h3 id="var-pythonsupportfiles">var <code class="codehilite"><span class="n">pythonSupportFiles</span></code></h3>
+<h3 id="var-pythonsupportfiles">var <code>pythonSupportFiles</code></h3>
<p>Points to the files for our python support code. They should be in a subdir of the module itself.</p>
<h2 id="exported">Exported</h2>
-<h3 id="class-python">class <code class="codehilite"><span class="n">Python</span></code></h3>
+<h3 id="class-python">class <code>Python</code></h3>
<p>This is exported as Python, just so that we could add other languages later. Used to build and run python-scripts with our support-code.</p>
-<h3 id="method-pythonconstructor">method <code class="codehilite"><span class="n">Python</span><span class="p">.</span><span class="k">constructor</span></code></h3>
+<h3 id="method-pythonconstructor">method <code>Python.constructor</code></h3>
<p>Takes one parameter, which is the full path to the folder where the script is located.</p>
<p>When initializing the class, this will be called. Can be done like this:</p>
-<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1</pre></div></td><td class="code"><div class="codehilite"><pre><span></span><span class="k">new</span> <span class="nx">compileRun</span><span class="p">.</span><span class="nx">Python</span><span class="p">(</span><span class="nx">global</span><span class="p">.</span><span class="nx">DirSwap</span> <span class="o">+</span> <span class="s2">&quot;/usrData/usrCode/example&quot;</span><span class="p">);</span>
-</pre></div>
-</td></tr></table>
-
-<h3 id="method-pythoncompile">method <code class="codehilite"><span class="n">Python</span><span class="p">.</span><span class="n">compile</span></code></h3>
+<div class="highlight"><pre><span></span><code><span class="ow">new</span><span class="w"> </span><span class="nx">compileRun</span><span class="p">.</span><span class="nx">Python</span><span class="p">(</span><span class="nb">global</span><span class="p">.</span><span class="nx">DirSwap</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="s2">&quot;/usrData/usrCode/example&quot;</span><span class="p">);</span><span class="w"></span>
+</code></pre></div>
+<h3 id="method-pythoncompile">method <code>Python.compile</code></h3>
<p>This deletes old build-folder, and makes a new one. It then moves all required files into the build-folder, making us ready for running the script.</p>
-<h3 id="method-pythonrun">method <code class="codehilite"><span class="n">Python</span><span class="p">.</span><span class="n">run</span></code></h3>
+<h3 id="method-pythonrun">method <code>Python.run</code></h3>
<p>Spawns a new process, starting entry.py in our build-folder. It also attaches event-listners on our class-object. All of them is in the example below:</p>
-<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span> 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12</pre></div></td><td class="code"><div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nx">sc</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">compileRun</span><span class="p">.</span><span class="nx">Python</span><span class="p">(</span><span class="nx">global</span><span class="p">.</span><span class="nx">DirSwap</span> <span class="o">+</span> <span class="s2">&quot;/usrData/usrCode/example&quot;</span><span class="p">);</span>
-<span class="err">​</span>
-<span class="c1">// When data is printed from the python-script</span>
-<span class="nx">sc</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s2">&quot;stdout::data&quot;</span><span class="p">,</span> <span class="p">(</span><span class="nx">_stdout</span><span class="p">)</span> <span class="p">=&gt;</span> <span class="p">{</span> <span class="p">});</span>
-<span class="c1">// Last write when script closes, any exiting messages</span>
-<span class="nx">sc</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s2">&quot;stdout::end&quot;</span><span class="p">,</span> <span class="p">(</span><span class="nx">_stdout</span><span class="p">)</span> <span class="p">=&gt;</span> <span class="p">{</span> <span class="p">});</span>
-<span class="c1">// When something is printed from the python-script to the error-out. Usually when a `throw` is called</span>
-<span class="nx">sc</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s2">&quot;stderr::out&quot;</span><span class="p">,</span> <span class="p">(</span><span class="nx">_stderr</span><span class="p">)</span> <span class="p">=&gt;</span> <span class="p">{</span> <span class="p">});</span>
-<span class="c1">// Last words when process is dying from an error :`(</span>
-<span class="nx">sc</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s2">&quot;stderr::end&quot;</span><span class="p">,</span> <span class="p">(</span><span class="nx">_stderr</span><span class="p">)</span> <span class="p">=&gt;</span> <span class="p">{</span> <span class="p">});</span>
-<span class="c1">// When script exits, _code is the exit-code</span>
-<span class="nx">sc</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s2">&quot;close&quot;</span><span class="p">,</span> <span class="p">(</span><span class="nx">_code</span><span class="p">)</span> <span class="p">=&gt;</span> <span class="p">{</span> <span class="p">});</span>
-</pre></div>
-</td></tr></table>
-
+<div class="highlight"><pre><span></span><code><span class="kd">let</span><span class="w"> </span><span class="nx">sc</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="nx">compileRun</span><span class="p">.</span><span class="nx">Python</span><span class="p">(</span><span class="nb">global</span><span class="p">.</span><span class="nx">DirSwap</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="s2">&quot;/usrData/usrCode/example&quot;</span><span class="p">);</span><span class="w"></span>
+<span class="err">​</span><span class="w"></span>
+<span class="c1">// When data is printed from the python-script</span><span class="w"></span>
+<span class="nx">sc</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s2">&quot;stdout::data&quot;</span><span class="p">,</span><span class="w"> </span><span class="p">(</span><span class="nx">_stdout</span><span class="p">)</span><span class="w"> </span><span class="p">=&gt;</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="p">});</span><span class="w"></span>
+<span class="c1">// Last write when script closes, any exiting messages</span><span class="w"></span>
+<span class="nx">sc</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s2">&quot;stdout::end&quot;</span><span class="p">,</span><span class="w"> </span><span class="p">(</span><span class="nx">_stdout</span><span class="p">)</span><span class="w"> </span><span class="p">=&gt;</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="p">});</span><span class="w"></span>
+<span class="c1">// When something is printed from the python-script to the error-out. Usually when a `throw` is called</span><span class="w"></span>
+<span class="nx">sc</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s2">&quot;stderr::out&quot;</span><span class="p">,</span><span class="w"> </span><span class="p">(</span><span class="nx">_stderr</span><span class="p">)</span><span class="w"> </span><span class="p">=&gt;</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="p">});</span><span class="w"></span>
+<span class="c1">// Last words when process is dying from an error :`(</span><span class="w"></span>
+<span class="nx">sc</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s2">&quot;stderr::end&quot;</span><span class="p">,</span><span class="w"> </span><span class="p">(</span><span class="nx">_stderr</span><span class="p">)</span><span class="w"> </span><span class="p">=&gt;</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="p">});</span><span class="w"></span>
+<span class="c1">// When script exits, _code is the exit-code</span><span class="w"></span>
+<span class="nx">sc</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s2">&quot;close&quot;</span><span class="p">,</span><span class="w"> </span><span class="p">(</span><span class="nx">_code</span><span class="p">)</span><span class="w"> </span><span class="p">=&gt;</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="p">});</span><span class="w"></span>
+</code></pre></div>
<h2 id="python">Python</h2>
<p>This is the support-files for user-made scripts.</p>
<h2 id="entrypy">Entry.py</h2>
<p>The entry-point when running a script. A file called script.py, containing the user-script, should be placed next to this file. Starting it should be done like this (Where app-root is where our app.js is located):</p>
-<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1</pre></div></td><td class="code"><div class="codehilite"><pre><span></span><span class="n">python</span> <span class="n">entry</span><span class="p">.</span><span class="n">py</span> <span class="o">&lt;</span><span class="n">pathToAppRoot</span><span class="o">&gt;</span>
-</pre></div>
-</td></tr></table>
-
-
-
-
-
-
+<div class="highlight"><pre><span></span><code>python entry.py &lt;pathToAppRoot&gt;
+</code></pre></div>
-
- </article>
- </div>
+
+
+
+
+ </article>
+ </div>
+
+
</div>
+
</main>
-
-<footer class="md-footer">
-
- <div class="md-footer-nav">
- <nav class="md-footer-nav__inner md-grid">
-
- <a href="../../../Scripting/Examples/strandtest/" title="Strandtest" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
- <div class="md-flex__cell md-flex__cell--shrink">
- <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
- </div>
- <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
- <span class="md-flex__ellipsis">
- <span class="md-footer-nav__direction">
- Previous
- </span>
- Strandtest
- </span>
- </div>
- </a>
-
-
- <a href="../../Run/" title="Run" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
- <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
- <span class="md-flex__ellipsis">
- <span class="md-footer-nav__direction">
- Next
- </span>
- Run
- </span>
- </div>
- <div class="md-flex__cell md-flex__cell--shrink">
- <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
- </div>
- </a>
-
- </nav>
- </div>
+ <footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
- <div class="md-footer-copyright">
-
- powered by
- <a href="https://www.mkdocs.org">MkDocs</a>
- and
- <a href="https://squidfunk.github.io/mkdocs-material/">
- Material for MkDocs</a>
- </div>
+ <div class="md-copyright">
+
+
+ Made with
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
+ Material for MkDocs
+ </a>
+
+</div>
</div>
</div>
</footer>
</div>
+ <div class="md-dialog" data-md-component="dialog">
+ <div class="md-dialog__inner md-typeset"></div>
+ </div>
- <script src="../../../assets/javascripts/application.c648116f.js"></script>
-
- <script>app.initialize({version:"1.0.4",url:{base:"../../.."}})</script>
+ <script id="__config" type="application/json">{"base": "../../..", "features": [], "search": "../../../assets/javascripts/workers/search.16e2a7d4.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script>
+
+
+ <script src="../../../assets/javascripts/bundle.5a2dcb6a.min.js"></script>
<script src="../../../assets/luxcena-colors.js"></script>
@@ -812,5 +621,6 @@
<script src="../../../assets/js-sequence.js"></script>
+
</body>
</html> \ No newline at end of file
diff --git a/public/docs/Code Documentation/Run/index.html b/public/docs/Code Documentation/Run/index.html
index bb572c2..d90d8c4 100644
--- a/public/docs/Code Documentation/Run/index.html
+++ b/public/docs/Code Documentation/Run/index.html
@@ -1,38 +1,15 @@
-
-
-
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
- <meta http-equiv="x-ua-compatible" content="ie=edge">
-
-
-
-
- <meta name="lang:clipboard.copy" content="Copy to clipboard">
- <meta name="lang:clipboard.copied" content="Copied to clipboard">
- <meta name="lang:search.language" content="en">
- <meta name="lang:search.pipeline.stopwords" content="True">
-
- <meta name="lang:search.pipeline.trimmer" content="True">
-
- <meta name="lang:search.result.none" content="No matching documents">
-
- <meta name="lang:search.result.one" content="1 matching document">
-
- <meta name="lang:search.result.other" content="# matching documents">
-
- <meta name="lang:search.tokenizer" content="[\s\-]+">
-
- <link rel="shortcut icon" href="../../assets/images/favicon.png">
- <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.2">
+ <link rel="icon" href="../../assets/images/favicon.png">
+ <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-8.5.10">
@@ -40,126 +17,127 @@
- <link rel="stylesheet" href="../../assets/stylesheets/application.30686662.css">
+ <link rel="stylesheet" href="../../assets/stylesheets/main.975780f9.min.css">
+
+ <link rel="stylesheet" href="../../assets/stylesheets/palette.2505c338.min.css">
+
+
+
- <script src="../../assets/javascripts/modernizr.74668098.js"></script>
-
- <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
- <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono&display=fallback">
- <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
+
+
+ <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+ <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
+ <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
- <link rel="stylesheet" href="../../assets/fonts/material-icons.css">
+ <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
<link rel="stylesheet" href="../../assets/luxcena-colors.css">
+ <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+
+
</head>
- <body dir="ltr">
- <svg class="md-svg">
- <defs>
-
-
- </defs>
- </svg>
- <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
- <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
- <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
- <a href="#run-when-developing" tabindex="1" class="md-skip">
- Skip to content
- </a>
- <header class="md-header" data-md-component="header">
- <nav class="md-header-nav md-grid">
- <div class="md-flex">
- <div class="md-flex__cell md-flex__cell--shrink">
- <a href="../.." title="Luxcena Neo Documentation" class="md-header-nav__button md-logo">
-
- <i class="md-icon"></i>
-
+
+
+ <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="None" data-md-color-accent="None">
+
+
+
+ <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
+ <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
+ <label class="md-overlay" for="__drawer"></label>
+ <div data-md-component="skip">
+
+
+ <a href="#run-when-developing" class="md-skip">
+ Skip to content
</a>
- </div>
- <div class="md-flex__cell md-flex__cell--shrink">
- <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
- </div>
- <div class="md-flex__cell md-flex__cell--stretch">
- <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
-
- <span class="md-header-nav__topic">
- Luxcena Neo Documentation
- </span>
- <span class="md-header-nav__topic">
-
- Run
-
- </span>
-
+
+ </div>
+ <div data-md-component="announce">
+
+ </div>
+
+
+
+
+<header class="md-header" data-md-component="header">
+ <nav class="md-header__inner md-grid" aria-label="Header">
+ <a href="../.." title="Luxcena Neo Documentation" class="md-header__button md-logo" aria-label="Luxcena Neo Documentation" data-md-component="logo">
+
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
+
+ </a>
+ <label class="md-header__button md-icon" for="__drawer">
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
+ </label>
+ <div class="md-header__title" data-md-component="header-title">
+ <div class="md-header__ellipsis">
+ <div class="md-header__topic">
+ <span class="md-ellipsis">
+ Luxcena Neo Documentation
+ </span>
</div>
- </div>
- <div class="md-flex__cell md-flex__cell--shrink">
-
- <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
-
-<div class="md-search" data-md-component="search" role="dialog">
- <label class="md-search__overlay" for="__search"></label>
- <div class="md-search__inner" role="search">
- <form class="md-search__form" name="search">
- <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
- <label class="md-icon md-search__icon" for="__search"></label>
- <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
- &#xE5CD;
- </button>
- </form>
- <div class="md-search__output">
- <div class="md-search__scrollwrap" data-md-scrollfix>
- <div class="md-search-result" data-md-component="result">
- <div class="md-search-result__meta">
- Type to start searching
- </div>
- <ol class="md-search-result__list"></ol>
+ <div class="md-header__topic" data-md-component="header-topic">
+ <span class="md-ellipsis">
+
+ Run
+
+ </span>
</div>
</div>
</div>
- </div>
-</div>
-
- </div>
-
- </div>
+
+
+
+
</nav>
+
</header>
- <div class="md-container">
+ <div class="md-container" data-md-component="container">
-
+
+
+
- <main class="md-main" role="main">
- <div class="md-main__inner md-grid" data-md-component="container">
+ <main class="md-main" data-md-component="main">
+ <div class="md-main__inner md-grid">
- <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
+
+ <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
- <nav class="md-nav md-nav--primary" data-md-level="0">
- <label class="md-nav__title md-nav__title--site" for="__drawer">
- <a href="../.." title="Luxcena Neo Documentation" class="md-nav__button md-logo">
-
- <i class="md-icon"></i>
+
+
+
+<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
+ <label class="md-nav__title" for="__drawer">
+ <a href="../.." title="Luxcena Neo Documentation" class="md-nav__button md-logo" aria-label="Luxcena Neo Documentation" data-md-component="logo">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
+
</a>
Luxcena Neo Documentation
</label>
@@ -170,156 +148,168 @@
-
- <li class="md-nav__item">
- <a href="../.." title="Introduction" class="md-nav__link">
- Introduction
- </a>
- </li>
+
+
+
+ <li class="md-nav__item">
+ <a href="../.." class="md-nav__link">
+ Introduction
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../../FuturePlan/" title="Plan for the future" class="md-nav__link">
- Plan for the future
- </a>
- </li>
+
+
+
+ <li class="md-nav__item">
+ <a href="../../FuturePlan/" class="md-nav__link">
+ Plan for the future
+ </a>
+ </li>
+
-
- <li class="md-nav__item md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
+
+
+
- <label class="md-nav__link" for="nav-3">
- Usage
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
- <label class="md-nav__title" for="nav-3">
- Usage
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
+ <li class="md-nav__item md-nav__item--nested">
+
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
+
+
+
+
+ <label class="md-nav__link" for="__nav_3">
+ Usage
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" aria-label="Usage" data-md-level="1">
+ <label class="md-nav__title" for="__nav_3">
+ <span class="md-nav__icon md-icon"></span>
+ Usage
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../Usage/Install/" class="md-nav__link">
+ Install
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../../Usage/Install/" title="Install" class="md-nav__link">
- Install
- </a>
- </li>
-
-
-
-
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../Usage/Configuration/" class="md-nav__link">
+ Configuration
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../../Usage/Configuration/" title="Configuration" class="md-nav__link">
- Configuration
- </a>
- </li>
-
-
-
-
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../Usage/CLI/" class="md-nav__link">
+ CLI
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../../Usage/CLI/" title="CLI" class="md-nav__link">
- CLI
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
+
+
+ </ul>
+ </nav>
+ </li>
+
-
- <li class="md-nav__item md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
+
+
+
- <label class="md-nav__link" for="nav-4">
- Scripting
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
- <label class="md-nav__title" for="nav-4">
- Scripting
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
+ <li class="md-nav__item md-nav__item--nested">
+
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
+
+
+
+
+ <label class="md-nav__link" for="__nav_4">
+ Scripting
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" aria-label="Scripting" data-md-level="1">
+ <label class="md-nav__title" for="__nav_4">
+ <span class="md-nav__icon md-icon"></span>
+ Scripting
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../Scripting/Strip/" class="md-nav__link">
+ Strip
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../../Scripting/SupportLib/" title="Support Library" class="md-nav__link">
- Support Library
- </a>
- </li>
-
-
-
-
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../Scripting/NeoBehaviour/" class="md-nav__link">
+ Main interface
+ </a>
+ </li>
+
-
- <li class="md-nav__item md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4-2" type="checkbox" id="nav-4-2">
-
- <label class="md-nav__link" for="nav-4-2">
- Examples
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
- <label class="md-nav__title" for="nav-4-2">
- Examples
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
+
-
-
- <li class="md-nav__item">
- <a href="../../Scripting/Examples/strandtest/" title="Strandtest" class="md-nav__link">
- Strandtest
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
- </ul>
- </nav>
- </li>
+ </ul>
+ </nav>
+ </li>
+
@@ -327,89 +317,69 @@
-
-
- <li class="md-nav__item md-nav__item--active md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5" checked>
-
- <label class="md-nav__link" for="nav-5">
- Code Documentation
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
- <label class="md-nav__title" for="nav-5">
- Code Documentation
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
+
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-1" type="checkbox" id="nav-5-1">
+
+
- <label class="md-nav__link" for="nav-5-1">
- Modules
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
- <label class="md-nav__title" for="nav-5-1">
- Modules
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../Modules/CompileAndRun/" title="CompileAndRun" class="md-nav__link">
- CompileAndRun
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
+
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
+
+
+
+
+ <label class="md-nav__link" for="__nav_5">
+ Code Documentation
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" aria-label="Code Documentation" data-md-level="1">
+ <label class="md-nav__title" for="__nav_5">
+ <span class="md-nav__icon md-icon"></span>
+ Code Documentation
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
-
+
+
+
-
-
- <li class="md-nav__item md-nav__item--active">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
+
+
+ <li class="md-nav__item md-nav__item--active">
-
-
- <label class="md-nav__link md-nav__link--active" for="__toc">
+ <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
+
+
+
+
+
+ <label class="md-nav__link md-nav__link--active" for="__toc">
+ Run
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <a href="./" class="md-nav__link md-nav__link--active">
Run
- </label>
-
- <a href="./" title="Run" class="md-nav__link md-nav__link--active">
- Run
- </a>
-
+ </a>
-<nav class="md-nav md-nav--secondary">
+
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
- <label class="md-nav__title" for="__toc">Table of contents</label>
- <ul class="md-nav__list" data-md-scrollfix>
+ <label class="md-nav__title" for="__toc">
+ <span class="md-nav__icon md-icon"></span>
+ Table of contents
+ </label>
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#build-watcher" class="md-nav__link">
@@ -430,7 +400,14 @@
webpack
</a>
- <nav class="md-nav">
+</li>
+
+ <li class="md-nav__item">
+ <a href="#inteface" class="md-nav__link">
+ Inteface
+ </a>
+
+ <nav class="md-nav" aria-label="Inteface">
<ul class="md-nav__list">
<li class="md-nav__item">
@@ -452,68 +429,66 @@
</li>
-
-
-
-
</ul>
</nav>
-
- </li>
+
+ </li>
+
-
-
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
+
+
+
+
+ <label class="md-nav__link" for="__nav_5_2">
+ API
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" aria-label="API" data-md-level="2">
+ <label class="md-nav__title" for="__nav_5_2">
+ <span class="md-nav__icon md-icon"></span>
+ API
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../SocketIO/" class="md-nav__link">
+ Socket-IO
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../Design/" title="Design" class="md-nav__link">
- Design
- </a>
- </li>
-
-
-
-
+
+ </ul>
+ </nav>
+ </li>
+
-
- <li class="md-nav__item md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-4" type="checkbox" id="nav-5-4">
-
- <label class="md-nav__link" for="nav-5-4">
- API
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
- <label class="md-nav__title" for="nav-5-4">
- API
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
+
-
-
- <li class="md-nav__item">
- <a href="../SocketIO/" title="Socket-IO" class="md-nav__link">
- Socket-IO
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
- </ul>
- </nav>
- </li>
+ </ul>
+ </nav>
+ </li>
+
</ul>
@@ -523,18 +498,24 @@
</div>
- <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
+
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
-<nav class="md-nav md-nav--secondary">
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
- <label class="md-nav__title" for="__toc">Table of contents</label>
- <ul class="md-nav__list" data-md-scrollfix>
+ <label class="md-nav__title" for="__toc">
+ <span class="md-nav__icon md-icon"></span>
+ Table of contents
+ </label>
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#build-watcher" class="md-nav__link">
@@ -555,7 +536,14 @@
webpack
</a>
- <nav class="md-nav">
+</li>
+
+ <li class="md-nav__item">
+ <a href="#inteface" class="md-nav__link">
+ Inteface
+ </a>
+
+ <nav class="md-nav" aria-label="Inteface">
<ul class="md-nav__list">
<li class="md-nav__item">
@@ -577,10 +565,6 @@
</li>
-
-
-
-
</ul>
</nav>
@@ -589,153 +573,154 @@
</div>
- <div class="md-content">
- <article class="md-content__inner md-typeset">
-
-
+
+ <div class="md-content" data-md-component="content">
+ <article class="md-content__inner md-typeset">
- <h1 id="run-when-developing">Run when developing</h1>
+
+
+
+<h1 id="run-when-developing">Run when developing</h1>
<p>I have made a simple script, that can be run both on a rPI and a normal computer.
(You will obviously not get any script to do anything on you pc)</p>
<p>I have only tested this on my mac...</p>
<p>To start it run:
-<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>npm run dev
-</pre></div>
-</td></tr></table>
+<div class="highlight"><pre><span></span><code>npm run dev
+</code></pre></div>
You have to run these commands beforehand:
-<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1
-2</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>npm i
+<div class="highlight"><pre><span></span><code>npm i
pip3 install mkdocs mkdocs-gitbook pygments pymdown-extensions
-</pre></div>
-</td></tr></table></p>
+</code></pre></div></p>
<div class="admonition warning">
<p class="admonition-title">Starting</p>
<p>It will when starting freak out a little. All the filewatchers fires an event for every file,
they find for some reason. But node should be killed each time, and when you end up with
only two processes, it should work as you'd expect.</p>
</div>
-<p>This will create a folder named <code class="codehilite"><span class="n">tmp</span></code> in you working directory. where all the user-files will be stored.</p>
+<p>This will create a folder named <code>tmp</code> in you working directory. where all the user-files will be stored.</p>
<h2 id="build-watcher">Build watcher.</h2>
<p>It starts to watch these directories:
-<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1</pre></div></td><td class="code"><div class="codehilite"><pre><span></span><span class="o">-</span> <span class="o">/</span><span class="n">build</span><span class="o">/</span>
-</pre></div>
-</td></tr></table>
+<div class="highlight"><pre><span></span><code>- /build/
+</code></pre></div>
If a change is detected, it runs:
-<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>mkdocs build
-</pre></div>
-</td></tr></table></p>
+<div class="highlight"><pre><span></span><code>mkdocs build
+</code></pre></div></p>
<h2 id="node-watcher">Node watcher</h2>
<p>It starts to watch these directories:
-<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1
-2</pre></div></td><td class="code"><div class="codehilite"><pre><span></span><span class="o">-</span> <span class="n">src</span><span class="o">/</span> <span class="p">(</span><span class="k">Except</span> <span class="o">/</span><span class="n">src</span><span class="o">/</span><span class="k">public</span><span class="o">/</span> <span class="k">and</span> <span class="o">/</span><span class="n">src</span><span class="o">/</span><span class="n">js</span><span class="o">/</span><span class="p">)</span>
-<span class="o">-</span> <span class="n">app</span><span class="p">.</span><span class="n">js</span>
-</pre></div>
-</td></tr></table></p>
+<div class="highlight"><pre><span></span><code>- src/ (Except /src/public/ and /src/js/)
+- app.js
+</code></pre></div></p>
<p>It then shuts down node and starts it again:
-<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>node app.js &lt;WORKING_DIR&gt;/tmp/
-</pre></div>
-</td></tr></table></p>
+<div class="highlight"><pre><span></span><code>node app.js &lt;WORKING_DIR&gt;/tmp/
+</code></pre></div></p>
<h2 id="webpack">webpack</h2>
<p>It just starts this command, witch rebundles when anything is changed:
-<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>npx webpack -p -w --mode<span class="o">=</span>development
-</pre></div>
-</td></tr></table></p>
+<div class="highlight"><pre><span></span><code>npx webpack -p -w --mode<span class="o">=</span>development
+</code></pre></div></p>
+<h2 id="inteface">Inteface</h2>
+<ul>
+<li><code>fsWatch</code>-window: logs when one of the watchers (not webpack obv.) detects a filesystem-change. <code>NODE</code> means node-watcher, and <code>DOCS</code> means docs-watcher.</li>
+<li><code>Actions</code>-window: Logs all events with processes, like starting one, when one exits, when we try to kill one etc.</li>
+<li><code>Node</code>-window: Shows the output of node.</li>
+<li><code>mkDocs</code>-window: Show the output from running mkDocs.</li>
+<li><code>Active Processes</code>-table: Shows a table of currently active processes started by the app. Use arrow keys to navigate it.</li>
+<li><code>Webpack</code>-window: Shows the output from our webpack-process.</li>
+</ul>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>All the log-windows respond to holding your cursor over and scrolling.</p>
</div>
-<h3 id="exit"><code class="codehilite"><span class="k">Exit</span></code></h3>
-<p>The script will exit when pressing <code class="codehilite"><span class="n">q</span></code>, <code class="codehilite"><span class="n">s</span></code>, <code class="codehilite"><span class="k">escape</span></code>, <code class="codehilite"><span class="n">Control</span><span class="o">+</span><span class="k">c</span></code>.
+<h3 id="exit"><code>Exit</code></h3>
+<p>The script will exit when pressing <code>q</code>, <code>s</code>, <code>escape</code>, <code>Control+c</code>.
It will then send a kill signal to all processes, wait 10 seconds and then exit.</p>
<h2 id="edit-file-watchers">Edit file-watchers.</h2>
-<p>Each of the file-watchers have explanatory names: <code class="codehilite"><span class="n">watcher_node</span></code> and <code class="codehilite"><span class="n">watcher_docs</span></code>.</p>
+<p>Each of the file-watchers have explanatory names: <code>watcher_node</code> and <code>watcher_docs</code>.</p>
<p>To add files or paths they should watch, find the init of the variable, and modify that code:
-<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1
-2
-3
-4
-5
-6</pre></div></td><td class="code"><div class="codehilite"><pre><span></span><span class="nx">e</span><span class="p">.</span><span class="nx">g</span><span class="p">.</span>
-<span class="kd">let</span><span class="p">;</span> <span class="nx">watcher_node</span> <span class="o">=</span> <span class="nx">chokidar</span><span class="p">.</span><span class="nx">watch</span><span class="p">([</span>
- <span class="s2">&quot;app.js&quot;</span><span class="p">,</span>
- <span class="s1">&#39;src/&#39;</span> <span class="c1">// Add new entrys here</span>
-
-<span class="p">]).</span><span class="nx">on</span><span class="p">(</span><span class="s1">&#39;all&#39;</span><span class="p">,</span> <span class="p">(</span><span class="nx">event</span><span class="p">,</span> <span class="nx">path</span><span class="p">)</span> <span class="p">=&gt;</span> <span class="p">{</span> <span class="c1">// ...</span>
-</pre></div>
-</td></tr></table></p>
-<p>For the node-watcher, specify paths it should ignore in the <code class="codehilite"><span class="n">path</span><span class="p">.</span><span class="n">includes</span></code> block.</p>
-
-
-
-
-
-
+<div class="highlight"><pre><span></span><code><span class="nx">e</span><span class="p">.</span><span class="nx">g</span><span class="p">.</span><span class="w"></span>
+<span class="kd">let</span><span class="p">;</span><span class="w"> </span><span class="nx">watcher_node</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">chokidar</span><span class="p">.</span><span class="nx">watch</span><span class="p">([</span><span class="w"></span>
+<span class="w"> </span><span class="s2">&quot;app.js&quot;</span><span class="p">,</span><span class="w"></span>
+<span class="w"> </span><span class="s1">&#39;src/&#39;</span><span class="w"> </span><span class="c1">// Add new entrys here</span><span class="w"></span>
+<span class="p">]).</span><span class="nx">on</span><span class="p">(</span><span class="s1">&#39;all&#39;</span><span class="p">,</span><span class="w"> </span><span class="p">(</span><span class="nx">event</span><span class="p">,</span><span class="w"> </span><span class="nx">path</span><span class="p">)</span><span class="w"> </span><span class="p">=&gt;</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="c1">// ...</span><span class="w"></span>
+</code></pre></div></p>
+<p>For the node-watcher, specify paths it should ignore in the <code>path.includes</code> block.</p>
-
- </article>
- </div>
+
+
+
+
+
+ </article>
+ </div>
+
+
</div>
+
</main>
-
-<footer class="md-footer">
+ <footer class="md-footer">
- <div class="md-footer-nav">
- <nav class="md-footer-nav__inner md-grid">
+
+ <nav class="md-footer__inner md-grid" aria-label="Footer" >
+
- <a href="../Modules/CompileAndRun/" title="CompileAndRun" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
- <div class="md-flex__cell md-flex__cell--shrink">
- <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
- </div>
- <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
- <span class="md-flex__ellipsis">
- <span class="md-footer-nav__direction">
- Previous
- </span>
- CompileAndRun
+ <a href="../../Scripting/NeoBehaviour/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Main interface" rel="prev">
+ <div class="md-footer__button md-icon">
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
+ </div>
+ <div class="md-footer__title">
+ <div class="md-ellipsis">
+ <span class="md-footer__direction">
+ Previous
</span>
+ Main interface
</div>
- </a>
-
+ </div>
+ </a>
+
+
- <a href="../Design/" title="Design" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
- <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
- <span class="md-flex__ellipsis">
- <span class="md-footer-nav__direction">
- Next
- </span>
- Design
+ <a href="../SocketIO/" class="md-footer__link md-footer__link--next" aria-label="Next: Socket-IO" rel="next">
+ <div class="md-footer__title">
+ <div class="md-ellipsis">
+ <span class="md-footer__direction">
+ Next
</span>
+ Socket-IO
</div>
- <div class="md-flex__cell md-flex__cell--shrink">
- <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
- </div>
- </a>
-
- </nav>
- </div>
+ </div>
+ <div class="md-footer__button md-icon">
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg>
+ </div>
+ </a>
+
+ </nav>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
- <div class="md-footer-copyright">
-
- powered by
- <a href="https://www.mkdocs.org">MkDocs</a>
- and
- <a href="https://squidfunk.github.io/mkdocs-material/">
- Material for MkDocs</a>
- </div>
+ <div class="md-copyright">
+
+
+ Made with
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
+ Material for MkDocs
+ </a>
+
+</div>
</div>
</div>
</footer>
</div>
+ <div class="md-dialog" data-md-component="dialog">
+ <div class="md-dialog__inner md-typeset"></div>
+ </div>
- <script src="../../assets/javascripts/application.c648116f.js"></script>
-
- <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>
+ <script id="__config" type="application/json">{"base": "../..", "features": [], "search": "../../assets/javascripts/workers/search.16e2a7d4.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script>
+
+
+ <script src="../../assets/javascripts/bundle.5a2dcb6a.min.js"></script>
<script src="../../assets/luxcena-colors.js"></script>
@@ -750,5 +735,6 @@ It will then send a kill signal to all processes, wait 10 seconds and then exit.
<script src="../../assets/js-sequence.js"></script>
+
</body>
</html> \ No newline at end of file
diff --git a/public/docs/Code Documentation/SocketIO/index.html b/public/docs/Code Documentation/SocketIO/index.html
index edcf9b1..20cdedf 100644
--- a/public/docs/Code Documentation/SocketIO/index.html
+++ b/public/docs/Code Documentation/SocketIO/index.html
@@ -1,38 +1,15 @@
-
-
-
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
- <meta http-equiv="x-ua-compatible" content="ie=edge">
-
-
-
-
- <meta name="lang:clipboard.copy" content="Copy to clipboard">
-
- <meta name="lang:clipboard.copied" content="Copied to clipboard">
-
- <meta name="lang:search.language" content="en">
-
- <meta name="lang:search.pipeline.stopwords" content="True">
-
- <meta name="lang:search.pipeline.trimmer" content="True">
-
- <meta name="lang:search.result.none" content="No matching documents">
-
- <meta name="lang:search.result.one" content="1 matching document">
- <meta name="lang:search.result.other" content="# matching documents">
- <meta name="lang:search.tokenizer" content="[\s\-]+">
- <link rel="shortcut icon" href="../../assets/images/favicon.png">
- <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.2">
+ <link rel="icon" href="../../assets/images/favicon.png">
+ <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-8.5.10">
@@ -40,126 +17,127 @@
- <link rel="stylesheet" href="../../assets/stylesheets/application.30686662.css">
+ <link rel="stylesheet" href="../../assets/stylesheets/main.975780f9.min.css">
+
+ <link rel="stylesheet" href="../../assets/stylesheets/palette.2505c338.min.css">
+
+
+
- <script src="../../assets/javascripts/modernizr.74668098.js"></script>
-
- <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
- <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono&display=fallback">
- <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
+
+
+ <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+ <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
+ <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
- <link rel="stylesheet" href="../../assets/fonts/material-icons.css">
+ <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
<link rel="stylesheet" href="../../assets/luxcena-colors.css">
+ <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+
+
</head>
- <body dir="ltr">
- <svg class="md-svg">
- <defs>
-
-
- </defs>
- </svg>
- <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
- <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
- <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
- <a href="#socketio" tabindex="1" class="md-skip">
- Skip to content
- </a>
- <header class="md-header" data-md-component="header">
- <nav class="md-header-nav md-grid">
- <div class="md-flex">
- <div class="md-flex__cell md-flex__cell--shrink">
- <a href="../.." title="Luxcena Neo Documentation" class="md-header-nav__button md-logo">
-
- <i class="md-icon"></i>
-
+
+
+ <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="None" data-md-color-accent="None">
+
+
+
+ <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
+ <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
+ <label class="md-overlay" for="__drawer"></label>
+ <div data-md-component="skip">
+
+
+ <a href="#socketio" class="md-skip">
+ Skip to content
</a>
- </div>
- <div class="md-flex__cell md-flex__cell--shrink">
- <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
- </div>
- <div class="md-flex__cell md-flex__cell--stretch">
- <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
-
- <span class="md-header-nav__topic">
- Luxcena Neo Documentation
- </span>
- <span class="md-header-nav__topic">
-
- Socket-IO
-
- </span>
-
+
+ </div>
+ <div data-md-component="announce">
+
+ </div>
+
+
+
+
+<header class="md-header" data-md-component="header">
+ <nav class="md-header__inner md-grid" aria-label="Header">
+ <a href="../.." title="Luxcena Neo Documentation" class="md-header__button md-logo" aria-label="Luxcena Neo Documentation" data-md-component="logo">
+
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
+
+ </a>
+ <label class="md-header__button md-icon" for="__drawer">
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
+ </label>
+ <div class="md-header__title" data-md-component="header-title">
+ <div class="md-header__ellipsis">
+ <div class="md-header__topic">
+ <span class="md-ellipsis">
+ Luxcena Neo Documentation
+ </span>
</div>
- </div>
- <div class="md-flex__cell md-flex__cell--shrink">
-
- <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
-
-<div class="md-search" data-md-component="search" role="dialog">
- <label class="md-search__overlay" for="__search"></label>
- <div class="md-search__inner" role="search">
- <form class="md-search__form" name="search">
- <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
- <label class="md-icon md-search__icon" for="__search"></label>
- <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
- &#xE5CD;
- </button>
- </form>
- <div class="md-search__output">
- <div class="md-search__scrollwrap" data-md-scrollfix>
- <div class="md-search-result" data-md-component="result">
- <div class="md-search-result__meta">
- Type to start searching
- </div>
- <ol class="md-search-result__list"></ol>
+ <div class="md-header__topic" data-md-component="header-topic">
+ <span class="md-ellipsis">
+
+ Socket-IO
+
+ </span>
</div>
</div>
</div>
- </div>
-</div>
-
- </div>
-
- </div>
+
+
+
+
</nav>
+
</header>
- <div class="md-container">
+ <div class="md-container" data-md-component="container">
-
+
+
+
- <main class="md-main" role="main">
- <div class="md-main__inner md-grid" data-md-component="container">
+ <main class="md-main" data-md-component="main">
+ <div class="md-main__inner md-grid">
- <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
+
+ <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
- <nav class="md-nav md-nav--primary" data-md-level="0">
- <label class="md-nav__title md-nav__title--site" for="__drawer">
- <a href="../.." title="Luxcena Neo Documentation" class="md-nav__button md-logo">
-
- <i class="md-icon"></i>
+
+
+
+<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
+ <label class="md-nav__title" for="__drawer">
+ <a href="../.." title="Luxcena Neo Documentation" class="md-nav__button md-logo" aria-label="Luxcena Neo Documentation" data-md-component="logo">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
+
</a>
Luxcena Neo Documentation
</label>
@@ -170,156 +148,168 @@
-
- <li class="md-nav__item">
- <a href="../.." title="Introduction" class="md-nav__link">
- Introduction
- </a>
- </li>
+
+
+
+ <li class="md-nav__item">
+ <a href="../.." class="md-nav__link">
+ Introduction
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../../FuturePlan/" title="Plan for the future" class="md-nav__link">
- Plan for the future
- </a>
- </li>
+
+
+
+ <li class="md-nav__item">
+ <a href="../../FuturePlan/" class="md-nav__link">
+ Plan for the future
+ </a>
+ </li>
+
-
- <li class="md-nav__item md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
+
+
+
- <label class="md-nav__link" for="nav-3">
- Usage
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
- <label class="md-nav__title" for="nav-3">
- Usage
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
+ <li class="md-nav__item md-nav__item--nested">
+
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
+
+
+
+
+ <label class="md-nav__link" for="__nav_3">
+ Usage
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" aria-label="Usage" data-md-level="1">
+ <label class="md-nav__title" for="__nav_3">
+ <span class="md-nav__icon md-icon"></span>
+ Usage
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../Usage/Install/" class="md-nav__link">
+ Install
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../../Usage/Install/" title="Install" class="md-nav__link">
- Install
- </a>
- </li>
-
-
-
-
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../Usage/Configuration/" class="md-nav__link">
+ Configuration
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../../Usage/Configuration/" title="Configuration" class="md-nav__link">
- Configuration
- </a>
- </li>
-
-
-
-
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../Usage/CLI/" class="md-nav__link">
+ CLI
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../../Usage/CLI/" title="CLI" class="md-nav__link">
- CLI
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
+
+
+ </ul>
+ </nav>
+ </li>
+
-
- <li class="md-nav__item md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
+
+
+
- <label class="md-nav__link" for="nav-4">
- Scripting
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
- <label class="md-nav__title" for="nav-4">
- Scripting
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
+ <li class="md-nav__item md-nav__item--nested">
+
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
+
+
+
+
+ <label class="md-nav__link" for="__nav_4">
+ Scripting
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" aria-label="Scripting" data-md-level="1">
+ <label class="md-nav__title" for="__nav_4">
+ <span class="md-nav__icon md-icon"></span>
+ Scripting
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../Scripting/Strip/" class="md-nav__link">
+ Strip
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../../Scripting/SupportLib/" title="Support Library" class="md-nav__link">
- Support Library
- </a>
- </li>
-
-
-
-
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../Scripting/NeoBehaviour/" class="md-nav__link">
+ Main interface
+ </a>
+ </li>
+
-
- <li class="md-nav__item md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4-2" type="checkbox" id="nav-4-2">
-
- <label class="md-nav__link" for="nav-4-2">
- Examples
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
- <label class="md-nav__title" for="nav-4-2">
- Examples
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
+
-
-
- <li class="md-nav__item">
- <a href="../../Scripting/Examples/strandtest/" title="Strandtest" class="md-nav__link">
- Strandtest
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
- </ul>
- </nav>
- </li>
+ </ul>
+ </nav>
+ </li>
+
@@ -327,141 +317,118 @@
-
-
- <li class="md-nav__item md-nav__item--active md-nav__item--nested">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5" checked>
-
- <label class="md-nav__link" for="nav-5">
- Code Documentation
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
- <label class="md-nav__title" for="nav-5">
- Code Documentation
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
+
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-1" type="checkbox" id="nav-5-1">
+
+
- <label class="md-nav__link" for="nav-5-1">
- Modules
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
- <label class="md-nav__title" for="nav-5-1">
- Modules
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../Modules/CompileAndRun/" title="CompileAndRun" class="md-nav__link">
- CompileAndRun
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../Run/" title="Run" class="md-nav__link">
- Run
- </a>
- </li>
-
-
-
-
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
+
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
+
+
+
+
+ <label class="md-nav__link" for="__nav_5">
+ Code Documentation
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" aria-label="Code Documentation" data-md-level="1">
+ <label class="md-nav__title" for="__nav_5">
+ <span class="md-nav__icon md-icon"></span>
+ Code Documentation
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../Run/" class="md-nav__link">
+ Run
+ </a>
+ </li>
+
-
- <li class="md-nav__item">
- <a href="../Design/" title="Design" class="md-nav__link">
- Design
- </a>
- </li>
-
-
-
-
+
-
+
+
+
-
-
- <li class="md-nav__item md-nav__item--active md-nav__item--nested">
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-4" type="checkbox" id="nav-5-4" checked>
+
+
- <label class="md-nav__link" for="nav-5-4">
- API
- </label>
- <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
- <label class="md-nav__title" for="nav-5-4">
- API
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
+
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
+
+
+
+
+ <label class="md-nav__link" for="__nav_5_2">
+ API
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" aria-label="API" data-md-level="2">
+ <label class="md-nav__title" for="__nav_5_2">
+ <span class="md-nav__icon md-icon"></span>
+ API
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
-
+
+
+
-
-
- <li class="md-nav__item md-nav__item--active">
-
- <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
+
+
+ <li class="md-nav__item md-nav__item--active">
-
-
- <label class="md-nav__link md-nav__link--active" for="__toc">
+ <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
+
+
+
+
+
+ <label class="md-nav__link md-nav__link--active" for="__toc">
+ Socket-IO
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <a href="./" class="md-nav__link md-nav__link--active">
Socket-IO
- </label>
-
- <a href="./" title="Socket-IO" class="md-nav__link md-nav__link--active">
- Socket-IO
- </a>
-
+ </a>
-<nav class="md-nav md-nav--secondary">
+
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
- <label class="md-nav__title" for="__toc">Table of contents</label>
- <ul class="md-nav__list" data-md-scrollfix>
+ <label class="md-nav__title" for="__toc">
+ <span class="md-nav__icon md-icon"></span>
+ Table of contents
+ </label>
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#client" class="md-nav__link">
Client
</a>
- <nav class="md-nav">
+ <nav class="md-nav" aria-label="Client">
<ul class="md-nav__list">
<li class="md-nav__item">
@@ -476,7 +443,7 @@
"Actions"
</a>
- <nav class="md-nav">
+ <nav class="md-nav" aria-label=""Actions"">
<ul class="md-nav__list">
<li class="md-nav__item">
@@ -538,25 +505,26 @@
</li>
-
-
-
-
</ul>
</nav>
-
- </li>
+
+ </li>
+
-
- </ul>
- </nav>
- </li>
+
+
+ </ul>
+ </nav>
+ </li>
+
-
- </ul>
- </nav>
- </li>
+
+
+ </ul>
+ </nav>
+ </li>
+
</ul>
@@ -566,25 +534,31 @@
</div>
- <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
+
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
-<nav class="md-nav md-nav--secondary">
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
- <label class="md-nav__title" for="__toc">Table of contents</label>
- <ul class="md-nav__list" data-md-scrollfix>
+ <label class="md-nav__title" for="__toc">
+ <span class="md-nav__icon md-icon"></span>
+ Table of contents
+ </label>
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#client" class="md-nav__link">
Client
</a>
- <nav class="md-nav">
+ <nav class="md-nav" aria-label="Client">
<ul class="md-nav__list">
<li class="md-nav__item">
@@ -599,7 +573,7 @@
"Actions"
</a>
- <nav class="md-nav">
+ <nav class="md-nav" aria-label=""Actions"">
<ul class="md-nav__list">
<li class="md-nav__item">
@@ -661,10 +635,6 @@
</li>
-
-
-
-
</ul>
</nav>
@@ -673,63 +643,46 @@
</div>
- <div class="md-content">
- <article class="md-content__inner md-typeset">
-
-
+
+ <div class="md-content" data-md-component="content">
+ <article class="md-content__inner md-typeset">
- <h1 id="socketio">SocketIO</h1>
+
+
+
+<h1 id="socketio">SocketIO</h1>
<h2 id="client">Client</h2>
-<p>Socketio is setup in the file <code class="codehilite"><span class="n">globals</span></code>.
-This means, import <code class="codehilite"><span class="n">globals</span></code>, and then you can use <code class="codehilite"><span class="n">Socket</span></code> from there.</p>
+<p>Socketio is setup in the file <code>globals</code>.
+This means, import <code>globals</code>, and then you can use <code>Socket</code> from there.</p>
<h3 id="connect">Connect</h3>
<ol>
<li>Client first needs to get an Authentication token,
this can be obtained by doing this:
- <table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1
-2
-3
-4
-5
-6
-7
-8
-9</pre></div></td><td class="code"><div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span><span class="nx">setCookie</span><span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;../../../cookies&quot;</span><span class="p">;</span>
-<span class="kd">let</span> <span class="nx">CryptoJS</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s2">&quot;crypto-js&quot;</span><span class="p">);</span>
-<span class="kd">let</span> <span class="nx">passwordHash</span> <span class="o">=</span> <span class="nx">CryptoJS</span><span class="p">.</span><span class="nx">SHA256</span><span class="p">(</span><span class="o">&lt;</span><span class="nx">PASSWORD</span><span class="o">&gt;</span><span class="p">;).</span><span class="nx">toString</span><span class="p">();</span>
-
-<span class="nx">Socket</span><span class="p">.</span><span class="nx">emit</span><span class="p">(</span><span class="s2">&quot;authenticate&quot;</span><span class="p">,</span> <span class="o">&lt;</span><span class="nx">USERNAME</span><span class="o">&gt;</span><span class="p">,</span> <span class="nx">passwordHash</span><span class="p">,</span> <span class="p">(</span><span class="nx">token</span><span class="p">)</span> <span class="p">=&gt;</span> <span class="p">{</span>
- <span class="c1">// Token will be a string if username/password combo is right,</span>
- <span class="c1">// if not, it is false.</span>
- <span class="nx">setCookie</span><span class="p">(</span><span class="s2">&quot;session_token&quot;</span><span class="p">,</span> <span class="nx">token</span><span class="p">,</span> <span class="mi">500</span><span class="p">);</span>
-<span class="p">};)</span>
-</pre></div>
-</td></tr></table></li>
+ <div class="highlight"><pre><span></span><code><span class="k">import</span><span class="w"> </span><span class="p">{</span><span class="nx">setCookie</span><span class="p">}</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s2">&quot;../../../cookies&quot;</span><span class="p">;</span><span class="w"></span>
+<span class="kd">let</span><span class="w"> </span><span class="nx">CryptoJS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">require</span><span class="p">(</span><span class="s2">&quot;crypto-js&quot;</span><span class="p">);</span><span class="w"></span>
+<span class="kd">let</span><span class="w"> </span><span class="nx">passwordHash</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">CryptoJS</span><span class="p">.</span><span class="nx">SHA256</span><span class="p">(</span><span class="o">&lt;</span><span class="nx">PASSWORD</span><span class="o">&gt;</span><span class="p">;).</span><span class="nx">toString</span><span class="p">();</span><span class="w"></span>
+
+<span class="nx">Socket</span><span class="p">.</span><span class="nx">emit</span><span class="p">(</span><span class="s2">&quot;authenticate&quot;</span><span class="p">,</span><span class="w"> </span><span class="o">&lt;</span><span class="nx">USERNAME</span><span class="o">&gt;</span><span class="p">,</span><span class="w"> </span><span class="nx">passwordHash</span><span class="p">,</span><span class="w"> </span><span class="p">(</span><span class="nx">token</span><span class="p">)</span><span class="w"> </span><span class="p">=&gt;</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
+<span class="w"> </span><span class="c1">// Token will be a string if username/password combo is right,</span><span class="w"></span>
+<span class="w"> </span><span class="c1">// if not, it is false.</span><span class="w"></span>
+<span class="w"> </span><span class="nx">setCookie</span><span class="p">(</span><span class="s2">&quot;session_token&quot;</span><span class="p">,</span><span class="w"> </span><span class="nx">token</span><span class="p">,</span><span class="w"> </span><span class="mf">500</span><span class="p">);</span><span class="w"></span>
+<span class="p">};)</span><span class="w"></span>
+</code></pre></div></li>
<li>Then the user can authenticate like this:
- <table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1
-2
-3
-4
-5
-6
-7</pre></div></td><td class="code"><div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span><span class="nx">getCookie</span><span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;../../../cookies&quot;</span><span class="p">;</span>
-<span class="kd">let</span> <span class="nx">cookieToken</span> <span class="o">=</span> <span class="nx">getCookie</span><span class="p">(</span><span class="s2">&quot;session_token&quot;</span><span class="p">);</span>
-
-<span class="nx">Socket</span><span class="p">.</span><span class="nx">emit</span><span class="p">(</span><span class="s2">&quot;authenticateToken&quot;</span><span class="p">,</span> <span class="nx">cookieToken</span><span class="p">,</span> <span class="p">(</span><span class="nx">res</span><span class="p">)</span> <span class="p">=&gt;</span> <span class="p">{</span>
- <span class="c1">// Res is true if we got authenticated,</span>
- <span class="c1">// If not, it is false.</span>
-<span class="p">});</span>
-</pre></div>
-</td></tr></table></li>
+ <div class="highlight"><pre><span></span><code><span class="k">import</span><span class="w"> </span><span class="p">{</span><span class="nx">getCookie</span><span class="p">}</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s2">&quot;../../../cookies&quot;</span><span class="p">;</span><span class="w"></span>
+<span class="kd">let</span><span class="w"> </span><span class="nx">cookieToken</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">getCookie</span><span class="p">(</span><span class="s2">&quot;session_token&quot;</span><span class="p">);</span><span class="w"></span>
+
+<span class="nx">Socket</span><span class="p">.</span><span class="nx">emit</span><span class="p">(</span><span class="s2">&quot;authenticateToken&quot;</span><span class="p">,</span><span class="w"> </span><span class="nx">cookieToken</span><span class="p">,</span><span class="w"> </span><span class="p">(</span><span class="nx">res</span><span class="p">)</span><span class="w"> </span><span class="p">=&gt;</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
+<span class="w"> </span><span class="c1">// Res is true if we got authenticated,</span><span class="w"></span>
+<span class="w"> </span><span class="c1">// If not, it is false.</span><span class="w"></span>
+<span class="p">});</span><span class="w"></span>
+</code></pre></div></li>
<li>We are now authenticated, and all actions and events are available to the client.</li>
</ol>
<h3 id="actions">"Actions"</h3>
-<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1
-2</pre></div></td><td class="code"><div class="codehilite"><pre><span></span><span class="nx">Socket</span><span class="p">.</span><span class="nx">emit</span><span class="p">(</span><span class="nx">Action</span><span class="p">,</span> <span class="o">*</span><span class="nx">Arguments</span><span class="p">,</span> <span class="p">(</span><span class="nx">Return</span><span class="p">)</span> <span class="p">=&gt;</span> <span class="p">{</span>
-<span class="p">};)</span>
-</pre></div>
-</td></tr></table>
-
+<div class="highlight"><pre><span></span><code><span class="nx">Socket</span><span class="p">.</span><span class="nx">emit</span><span class="p">(</span><span class="nx">Action</span><span class="p">,</span><span class="w"> </span><span class="o">*</span><span class="nx">Arguments</span><span class="p">,</span><span class="w"> </span><span class="p">(</span><span class="nx">Return</span><span class="p">)</span><span class="w"> </span><span class="p">=&gt;</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
+<span class="p">};)</span><span class="w"></span>
+</code></pre></div>
<h5 id="neoruntimestatus">NeoRuntime/status</h5>
<table>
<thead>
@@ -747,7 +700,9 @@ This means, import <code class="codehilite"><span class="n">globals</span></code
</tr>
</tbody>
</table>
-<details class="info"><summary>Return/status</summary><table>
+<details class="info">
+<summary>Return/status</summary>
+<table>
<thead>
<tr>
<th>Name</th>
@@ -775,7 +730,9 @@ This means, import <code class="codehilite"><span class="n">globals</span></code
</table>
</details>
<h5 id="neoruntimescriptcreate">NeoRuntime/Script/Create</h5>
-<details class="info"><summary>Arguments</summary><table>
+<details class="info">
+<summary>Arguments</summary>
+<table>
<thead>
<tr>
<th>Name</th>
@@ -792,7 +749,9 @@ This means, import <code class="codehilite"><span class="n">globals</span></code
</tbody>
</table>
</details>
-<details class="info"><summary>Return</summary><table>
+<details class="info">
+<summary>Return</summary>
+<table>
<thead>
<tr>
<th>Name</th>
@@ -815,7 +774,9 @@ This means, import <code class="codehilite"><span class="n">globals</span></code
</table>
</details>
<h5 id="neoruntimescriptdelete">NeoRuntime/Script/Delete</h5>
-<details class="info"><summary>Arguments</summary><table>
+<details class="info">
+<summary>Arguments</summary>
+<table>
<thead>
<tr>
<th>Name</th>
@@ -832,7 +793,9 @@ This means, import <code class="codehilite"><span class="n">globals</span></code
</tbody>
</table>
</details>
-<details class="info"><summary>Return</summary><table>
+<details class="info">
+<summary>Return</summary>
+<table>
<thead>
<tr>
<th>Name</th>
@@ -855,7 +818,9 @@ This means, import <code class="codehilite"><span class="n">globals</span></code
</table>
</details>
<h5 id="neoruntimescriptselect">NeoRuntime/Script/Select</h5>
-<details class="info"><summary>Arguments</summary><table>
+<details class="info">
+<summary>Arguments</summary>
+<table>
<thead>
<tr>
<th>Name</th>
@@ -873,7 +838,9 @@ This means, import <code class="codehilite"><span class="n">globals</span></code
</table>
</details>
<h5 id="neoruntimescriptsget">NeoRuntime/Scripts/get</h5>
-<details class="info"><summary>Return</summary><table>
+<details class="info">
+<summary>Return</summary>
+<table>
<thead>
<tr>
<th>Name</th>
@@ -896,81 +863,78 @@ This means, import <code class="codehilite"><span class="n">globals</span></code
</table>
</details>
<h3 id="events">"Events"</h3>
-<p><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1
-2
-3
-4
-5</pre></div></td><td class="code"><div class="codehilite"><pre><span></span><span class="c1">// Listen for a event</span>
-<span class="nx">Socket</span><span class="p">.</span><span class="nx">emit</span><span class="p">(</span><span class="nx">event</span> <span class="o">+</span> <span class="s2">&quot;::join&quot;</span><span class="p">);</span>
-<span class="nx">Socket</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="nx">event</span><span class="p">,</span> <span class="p">(</span><span class="o">*</span><span class="nx">Return</span><span class="p">);</span> <span class="p">=&gt;</span> <span class="p">{</span>
-
-<span class="p">})</span>
-</pre></div>
-</td></tr></table>
-<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1
-2</pre></div></td><td class="code"><div class="codehilite"><pre><span></span><span class="c1">// Stop listening for an event</span>
-<span class="nx">Socket</span><span class="p">.</span><span class="nx">emit</span><span class="p">(</span><span class="nx">event</span> <span class="o">+</span> <span class="s2">&quot;::leave&quot;</span><span class="p">)</span>
-</pre></div>
-</td></tr></table></p>
+<p><div class="highlight"><pre><span></span><code><span class="c1">// Listen for a event</span><span class="w"></span>
+<span class="nx">Socket</span><span class="p">.</span><span class="nx">emit</span><span class="p">(</span><span class="nx">event</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="s2">&quot;::join&quot;</span><span class="p">);</span><span class="w"></span>
+<span class="nx">Socket</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="nx">event</span><span class="p">,</span><span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="nx">Return</span><span class="p">);</span><span class="w"> </span><span class="p">=&gt;</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
+
+<span class="p">})</span><span class="w"></span>
+</code></pre></div>
+<div class="highlight"><pre><span></span><code><span class="c1">// Stop listening for an event</span><span class="w"></span>
+<span class="nx">Socket</span><span class="p">.</span><span class="nx">emit</span><span class="p">(</span><span class="nx">event</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="s2">&quot;::leave&quot;</span><span class="p">)</span><span class="w"></span>
+</code></pre></div></p>
<h2 id="server">Server</h2>
-
-
-
-
-
-
-
- </article>
- </div>
+
+
+
+
+ </article>
+ </div>
+
+
</div>
+
</main>
-
-<footer class="md-footer">
+ <footer class="md-footer">
- <div class="md-footer-nav">
- <nav class="md-footer-nav__inner md-grid">
+
+ <nav class="md-footer__inner md-grid" aria-label="Footer" >
+
- <a href="../Design/" title="Design" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
- <div class="md-flex__cell md-flex__cell--shrink">
- <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
- </div>
- <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
- <span class="md-flex__ellipsis">
- <span class="md-footer-nav__direction">
- Previous
- </span>
- Design
+ <a href="../Run/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Run" rel="prev">
+ <div class="md-footer__button md-icon">
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
+ </div>
+ <div class="md-footer__title">
+ <div class="md-ellipsis">
+ <span class="md-footer__direction">
+ Previous
</span>
+ Run
</div>
- </a>
-
-
- </nav>
- </div>
+ </div>
+ </a>
+
+
+ </nav>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
- <div class="md-footer-copyright">
-
- powered by
- <a href="https://www.mkdocs.org">MkDocs</a>
- and
- <a href="https://squidfunk.github.io/mkdocs-material/">
- Material for MkDocs</a>
- </div>
+ <div class="md-copyright">
+
+
+ Made with
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
+ Material for MkDocs
+ </a>
+
+</div>
</div>
</div>
</footer>
</div>
+ <div class="md-dialog" data-md-component="dialog">
+ <div class="md-dialog__inner md-typeset"></div>
+ </div>
- <script src="../../assets/javascripts/application.c648116f.js"></script>
-
- <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>
+ <script id="__config" type="application/json">{"base": "../..", "features": [], "search": "../../assets/javascripts/workers/search.16e2a7d4.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script>
+
+
+ <script src="../../assets/javascripts/bundle.5a2dcb6a.min.js"></script>
<script src="../../assets/luxcena-colors.js"></script>
@@ -985,5 +949,6 @@ This means, import <code class="codehilite"><span class="n">globals</span></code
<script src="../../assets/js-sequence.js"></script>
+
</body>
</html> \ No newline at end of file