

<!DOCTYPE html>

<html lang="en-US">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=Edge">

  <link rel="stylesheet" href="/pixelscript-docs/assets/css/just-the-docs-default.css">

  <link rel="stylesheet" href="/pixelscript-docs/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet">

  <style id="jtd-nav-activation">
  
    .site-nav ul li a {
      background-image: none;
    }

  </style>

  

  
    <script src="/pixelscript-docs/assets/js/vendor/lunr.min.js"></script>
  

  <script src="/pixelscript-docs/assets/js/just-the-docs.js"></script>

  <meta name="viewport" content="width=device-width, initial-scale=1">

  



  <!-- Begin Jekyll SEO tag v2.9.0 -->
<title>PixelScript | Documentation for PixelScript, a hot-reloadable JavaScript and TypeScript runtime for Minecraft servers.</title>
<meta name="generator" content="Jekyll v4.4.1" />
<meta property="og:title" content="PixelScript" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="Documentation for PixelScript, a hot-reloadable JavaScript and TypeScript runtime for Minecraft servers." />
<meta name="twitter:description" property="og:description" content="Documentation for PixelScript, a hot-reloadable JavaScript and TypeScript runtime for Minecraft servers." />
<link rel="canonical" href="https://pixelib.github.io/pixelscript-docs/assets/css/just-the-docs-head-nav.css" />
<meta property="og:url" content="https://pixelib.github.io/pixelscript-docs/assets/css/just-the-docs-head-nav.css" />
<meta property="og:site_name" content="PixelScript" />
<meta property="og:type" content="website" />
<meta name="twitter:card" content="summary" />
<meta name="twitter:title" content="PixelScript" />
<script type="application/ld+json">
{"@context":"https://schema.org","@type":"WebPage","description":"Documentation for PixelScript, a hot-reloadable JavaScript and TypeScript runtime for Minecraft servers.","headline":"PixelScript","url":"https://pixelib.github.io/pixelscript-docs/assets/css/just-the-docs-head-nav.css"}</script>
<!-- End Jekyll SEO tag -->


  

</head>

<body>
  <a class="skip-to-main" href="#main-content">Skip to main content</a>
  <svg xmlns="http://www.w3.org/2000/svg" class="d-none">
  <symbol id="svg-link" viewBox="0 0 24 24">
  <title>Link</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link">
    <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path>
  </svg>
</symbol>

  <symbol id="svg-menu" viewBox="0 0 24 24">
  <title>Menu</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu">
    <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line>
  </svg>
</symbol>

  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
  <title>Expand</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right">
    <polyline points="9 18 15 12 9 6"></polyline>
  </svg>
</symbol>

  <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE -->
<symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link">
  <title id="svg-external-link-title">(external link)</title>
  <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line>
</symbol>

  
    <symbol id="svg-doc" viewBox="0 0 24 24">
  <title>Document</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file">
    <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline>
  </svg>
</symbol>

    <symbol id="svg-search" viewBox="0 0 24 24">
  <title>Search</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search">
    <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line>
  </svg>
</symbol>

  
  
    <!-- Bootstrap Icons. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md -->
<symbol id="svg-copy" viewBox="0 0 16 16">
  <title>Copy</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16">
    <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/>
    <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/>
  </svg>
</symbol>
<symbol id="svg-copied" viewBox="0 0 16 16">
  <title>Copied</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16">
    <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/>
    <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/>
  </svg>
</symbol>

  
</svg>

  
    <header class="side-bar">
  <div class="site-header">
    <a href="/pixelscript-docs/" class="site-title lh-tight">
  PixelScript

</a>
    <button id="menu-button" class="site-button btn-reset" aria-label="Menu" aria-expanded="false">
      <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg>
    </button>
  </div>

  <nav aria-label="Main" id="site-nav" class="site-nav">
  
  
    <ul class="nav-list"><li class="nav-list-item"><a href="/pixelscript-docs/" class="nav-list-link">Home</a></li><li class="nav-list-item"><a href="/pixelscript-docs/ai/" class="nav-list-link">Onboard your AI</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Getting started submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/pixelscript-docs/getting-started/" class="nav-list-link">Getting started</a><ul class="nav-list"><li class="nav-list-item"><a href="/pixelscript-docs/overview/" class="nav-list-link">PixelScript overview</a></li><li class="nav-list-item"><a href="/pixelscript-docs/download/" class="nav-list-link">Download PixelScript</a></li><li class="nav-list-item"><a href="/pixelscript-docs/script-logic/" class="nav-list-link">How to think about a script</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Tutorial submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/pixelscript-docs/tutorial/" class="nav-list-link">Tutorial</a><ul class="nav-list"><li class="nav-list-item"><a href="/pixelscript-docs/setting-up-your-work-env/" class="nav-list-link">Setting up your work environment</a></li><li class="nav-list-item"><a href="/pixelscript-docs/configuration/" class="nav-list-link">Configuration</a></li><li class="nav-list-item"><a href="/pixelscript-docs/scripts/" class="nav-list-link">Scripts and script management</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="API reference submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/pixelscript-docs/api/" class="nav-list-link">API reference</a><ul class="nav-list"><li class="nav-list-item"><a href="/pixelscript-docs/api-script/" class="nav-list-link">Script</a></li><li class="nav-list-item"><a href="/pixelscript-docs/magic-imports/" class="nav-list-link">Magic imports ($)</a></li><li class="nav-list-item"><a href="/pixelscript-docs/api-bukkit/" class="nav-list-link">Bukkit and platform globals</a></li><li class="nav-list-item"><a href="/pixelscript-docs/api-command/" class="nav-list-link">Commands</a></li><li class="nav-list-item"><a href="/pixelscript-docs/api-event-listener/" class="nav-list-link">Event listeners</a></li><li class="nav-list-item"><a href="/pixelscript-docs/api-scheduler/" class="nav-list-link">Scheduler</a></li><li class="nav-list-item"><a href="/pixelscript-docs/threading-model/" class="nav-list-link">Concurrency model</a></li><li class="nav-list-item"><a href="/pixelscript-docs/api-sql/" class="nav-list-link">Database</a></li><li class="nav-list-item"><a href="/pixelscript-docs/api-fetch/" class="nav-list-link">HTTP fetch</a></li><li class="nav-list-item"><a href="/pixelscript-docs/api-console/" class="nav-list-link">Console logging</a></li><li class="nav-list-item"><a href="/pixelscript-docs/api-json/" class="nav-list-link">JSON</a></li><li class="nav-list-item"><a href="/pixelscript-docs/api-shared-state/" class="nav-list-link">Shared state and messaging</a></li><li class="nav-list-item"><a href="/pixelscript-docs/java-implementations/" class="nav-list-link">Implementing Java interfaces</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Tips & tricks submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/pixelscript-docs/tips/" class="nav-list-link">Tips & tricks</a><ul class="nav-list"><li class="nav-list-item"><a href="/pixelscript-docs/interop-quirks/" class="nav-list-link">Java interop</a></li><li class="nav-list-item"><a href="/pixelscript-docs/interfaces-and-abs-classes/" class="nav-list-link">Interfaces and abstract classes</a></li><li class="nav-list-item"><a href="/pixelscript-docs/type-generation/" class="nav-list-link">TypeScript and type generation</a></li><li class="nav-list-item"><a href="/pixelscript-docs/performance-timings/" class="nav-list-link">Performance profiling</a></li><li class="nav-list-item"><a href="/pixelscript-docs/built-in-commands/" class="nav-list-link">Built-in commands</a></li></ul></li><li class="nav-list-item"><a href="/pixelscript-docs/changelog/" class="nav-list-link">Changelog</a></li></ul>
  
</nav>


<div class="d-md-block d-none site-footer">
  
  
    This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.
  
  </div>
</header>

  
  <div class="main" id="top">
    <div id="main-header" class="main-header">
  
    

<div class="search" role="search">
  <div class="search-input-wrap">
    <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search PixelScript" autocomplete="off">
    <label for="search-input" class="search-label">
      <span class="sr-only">Search PixelScript</span>
      <svg viewBox="0 0 24 24" class="search-icon" aria-hidden="true"><use xlink:href="#svg-search"></use></svg>
    </label>
  </div>
  <div id="search-results" class="search-results"></div>
</div>

  
  
  
    <nav aria-label="Auxiliary" class="aux-nav">
  <ul class="aux-nav-list">
    
      <li class="aux-nav-list-item">
        <a href="https://github.com/pixelib/pixelscript" class="site-button"
          
          target="_blank" rel="noopener noreferrer"
          
        >
          GitHub
        </a>
      </li>
    
      <li class="aux-nav-list-item">
        <a href="https://license-platform.pixelib.dev/artifacts" class="site-button"
          
          target="_blank" rel="noopener noreferrer"
          
        >
          Downloads
        </a>
      </li>
    
  </ul>
</nav>

  
</div>

    <div class="main-content-wrap">
      
      <div id="main-content" class="main-content">
        <main>
          
            <h.site-nav ul li a {
  background-image: linear-gradient(-90deg, rgb(12.4052287582%, 12.0871459695%, 13.6775599129%) 0%, rgba(12.4052287582%, 12.0871459695%, 13.6775599129%, 0.8) 80%, rgba(12.4052287582%, 12.0871459695%, 13.6775599129%, 0) 100%);
}

          

          
            
          
        </main>
        
<hr>
<footer>
  
    <p><a href="#top" id="back-to-top">Back to top</a></p>
  

  <p class="text-small mb-0">PixelScript is a Pixelib project. Found a mistake in these docs? <a href="https://github.com/pixelib/pixelscript-docs/issues">Open an issue</a>.</p>

  <div class="d-md-none mt-4 fs-2">
    
    
      This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.
    
  </div>
</footer>

      </div>
    </div>
    
      

<div class="search-overlay"></div>

    
  </div>

  
</body>
</html>

