diff options
| author | jakob.stendahl <jakob.stendahl@infomedia.dk> | 2022-12-12 14:13:40 +0100 |
|---|---|---|
| committer | Jakob Stendahl <jakob.stendahl@outlook.com> | 2022-12-12 14:13:40 +0100 |
| commit | 4189c0c988daa939be0e8ec979ce0ae0563c4b7d (patch) | |
| tree | f07143ac71bd80457f681ec64bde1bbcbefa7a08 /public/docs/Code Documentation/Modules | |
| parent | f1664d7c0dda8b4e557a02cd6fbfe56308daa4e4 (diff) | |
| download | Luxcena-Neo-4189c0c988daa939be0e8ec979ce0ae0563c4b7d.tar.gz Luxcena-Neo-4189c0c988daa939be0e8ec979ce0ae0563c4b7d.zip | |
Create docs from python code
Diffstat (limited to 'public/docs/Code Documentation/Modules')
| -rw-r--r-- | public/docs/Code Documentation/Modules/CompileAndRun/index.html | 888 |
1 files changed, 349 insertions, 539 deletions
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"> -  - </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">"/usrData/usrCode/example"</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">"/usrData/usrCode/example"</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">"/usrData/usrCode/example"</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">"stdout::data"</span><span class="p">,</span> <span class="p">(</span><span class="nx">_stdout</span><span class="p">)</span> <span class="p">=></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">"stdout::end"</span><span class="p">,</span> <span class="p">(</span><span class="nx">_stdout</span><span class="p">)</span> <span class="p">=></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">"stderr::out"</span><span class="p">,</span> <span class="p">(</span><span class="nx">_stderr</span><span class="p">)</span> <span class="p">=></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">"stderr::end"</span><span class="p">,</span> <span class="p">(</span><span class="nx">_stderr</span><span class="p">)</span> <span class="p">=></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">"close"</span><span class="p">,</span> <span class="p">(</span><span class="nx">_code</span><span class="p">)</span> <span class="p">=></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">"/usrData/usrCode/example"</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">"stdout::data"</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">=></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">"stdout::end"</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">=></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">"stderr::out"</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">=></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">"stderr::end"</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">=></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">"close"</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">=></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"><</span><span class="n">pathToAppRoot</span><span class="o">></span> -</pre></div> -</td></tr></table> - - - - - - +<div class="highlight"><pre><span></span><code>python entry.py <pathToAppRoot> +</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 |