Skip to content

Commit

Permalink
deploy: 4347d50
Browse files Browse the repository at this point in the history
  • Loading branch information
makspll committed Jan 4, 2025
1 parent 2bc5bcc commit 4b37536
Show file tree
Hide file tree
Showing 8 changed files with 221 additions and 8 deletions.
4 changes: 2 additions & 2 deletions ScriptingReference/core-api.html
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ <h1 id="core-bindings"><a class="header" href="#core-bindings">Core Bindings</a>

<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<a rel="prev" href="../Summary/controlling-script-bindings.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<a rel="prev" href="../ScriptingReference/introduction.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>

Expand All @@ -174,7 +174,7 @@ <h1 id="core-bindings"><a class="header" href="#core-bindings">Core Bindings</a>
</div>

<nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="prev" href="../Summary/controlling-script-bindings.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<a rel="prev" href="../ScriptingReference/introduction.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>

Expand Down
210 changes: 210 additions & 0 deletions ScriptingReference/introduction.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,210 @@
<!DOCTYPE HTML>
<html lang="en" class="light sidebar-visible" dir="ltr">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>Introduction - Bevy Scripting</title>


<!-- Custom HTML head -->

<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff">

<link rel="icon" href="../favicon.svg">
<link rel="shortcut icon" href="../favicon.png">
<link rel="stylesheet" href="../css/variables.css">
<link rel="stylesheet" href="../css/general.css">
<link rel="stylesheet" href="../css/chrome.css">
<link rel="stylesheet" href="../css/print.css" media="print">

<!-- Fonts -->
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="../fonts/fonts.css">

<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" href="../highlight.css">
<link rel="stylesheet" href="../tomorrow-night.css">
<link rel="stylesheet" href="../ayu-highlight.css">

<!-- Custom theme stylesheets -->


<!-- Provide site root to javascript -->
<script>
var path_to_root = "../";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
</script>
<!-- Start loading toc.js asap -->
<script src="../toc.js"></script>
</head>
<body>
<div id="body-container">
<!-- Work around some values being stored in localStorage wrapped in quotes -->
<script>
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');

if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}

if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>

<!-- Set the theme before any content is loaded, prevents flash -->
<script>
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
const html = document.documentElement;
html.classList.remove('light')
html.classList.add(theme);
html.classList.add("js");
</script>

<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">

<!-- Hide / unhide sidebar before it is displayed -->
<script>
var sidebar = null;
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
} else {
sidebar = 'hidden';
}
sidebar_toggle.checked = sidebar === 'visible';
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
</script>

<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<!-- populated by js -->
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
<noscript>
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
</noscript>
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
<div class="sidebar-resize-indicator"></div>
</div>
</nav>

<div id="page-wrapper" class="page-wrapper">

<div class="page">
<div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky">
<div class="left-buttons">
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</label>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
</ul>
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
<i class="fa fa-search"></i>
</button>
</div>

<h1 class="menu-title">Bevy Scripting</h1>

<div class="right-buttons">
<a href="../print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>

</div>
</div>

<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>

<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
<script>
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>

<div id="content" class="content">
<main>
<h1 id="scripting-reference"><a class="header" href="#scripting-reference">Scripting Reference</a></h1>
<p>This part of the book covers the user-facing API of the scripting languages supported by BMS. This will be where you will want to forward your script users to get started with scripting in BMS.</p>
<p>If you are a modder, welcome! 👋, apologies for the rust-centricity of this guide, we are working on it!</p>

</main>

<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<a rel="prev" href="../Summary/controlling-script-bindings.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>

<a rel="next prefetch" href="../ScriptingReference/core-api.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>

<div style="clear: both"></div>
</nav>
</div>
</div>

<nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="prev" href="../Summary/controlling-script-bindings.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>

<a rel="next prefetch" href="../ScriptingReference/core-api.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</nav>

</div>




<script>
window.playground_copyable = true;
</script>


<script src="../elasticlunr.min.js"></script>
<script src="../mark.min.js"></script>
<script src="../searcher.js"></script>

<script src="../clipboard.min.js"></script>
<script src="../highlight.js"></script>
<script src="../book.js"></script>

<!-- Custom JS scripts -->
<script src="../multi-code-block.js"></script>


</div>
</body>
</html>
4 changes: 2 additions & 2 deletions Summary/controlling-script-bindings.html
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ <h2 id="fallible-functions"><a class="header" href="#fallible-functions">Fallibl
<i class="fa fa-angle-left"></i>
</a>

<a rel="next prefetch" href="../ScriptingReference/core-api.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<a rel="next prefetch" href="../ScriptingReference/introduction.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>

Expand All @@ -231,7 +231,7 @@ <h2 id="fallible-functions"><a class="header" href="#fallible-functions">Fallibl
<i class="fa fa-angle-left"></i>
</a>

<a rel="next prefetch" href="../ScriptingReference/core-api.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<a rel="next prefetch" href="../ScriptingReference/introduction.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</nav>
Expand Down
3 changes: 3 additions & 0 deletions print.html
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,9 @@ <h2 id="fallible-functions"><a class="header" href="#fallible-functions">Fallibl
<li>Returning <code>Result&lt;T: IntoScript, InteropError&gt;</code></li>
<li>Returning <code>ScriptValue</code> and manually creating the <code>ScriptValue::Error(into_interop_erorr.into())</code> variant.</li>
</ul>
<div style="break-before: page; page-break-before: always;"></div><h1 id="scripting-reference"><a class="header" href="#scripting-reference">Scripting Reference</a></h1>
<p>This part of the book covers the user-facing API of the scripting languages supported by BMS. This will be where you will want to forward your script users to get started with scripting in BMS.</p>
<p>If you are a modder, welcome! 👋, apologies for the rust-centricity of this guide, we are working on it!</p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="core-bindings"><a class="header" href="#core-bindings">Core Bindings</a></h1>
<p>The core bindings are manually written utilities for interacting with the <code>Bevy</code> world and everything contained within it. These bindings are used to create and manipulate entities, components, resources, and systems.</p>
<p>Every language BMS supports will support these.</p>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion searchindex.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@
<!-- Custom theme stylesheets -->
</head>
<body class="sidebar-iframe-inner">
<ol class="chapter"><li class="chapter-item expanded affix "><a href="Summary/installation.html" target="_parent">Installation</a></li><li class="chapter-item expanded affix "><li class="part-title">Quick Start</li><li class="chapter-item expanded "><a href="Summary/managing-scripts.html" target="_parent"><strong aria-hidden="true">1.</strong> Managing Scripts</a></li><li class="chapter-item expanded "><a href="Summary/running-scripts.html" target="_parent"><strong aria-hidden="true">2.</strong> Running Scripts</a></li><li class="chapter-item expanded "><a href="Summary/controlling-script-bindings.html" target="_parent"><strong aria-hidden="true">3.</strong> Controlling Script Bindings</a></li><li class="chapter-item expanded affix "><li class="part-title">Scripting Reference</li><li class="chapter-item expanded "><a href="ScriptingReference/core-api.html" target="_parent"><strong aria-hidden="true">4.</strong> Core Bindings</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="ScriptingReference/world.html" target="_parent"><strong aria-hidden="true">4.1.</strong> World</a></li><li class="chapter-item expanded "><a href="ScriptingReference/reflect-reference.html" target="_parent"><strong aria-hidden="true">4.2.</strong> ReflectReference</a></li><li class="chapter-item expanded "><a href="ScriptingReference/script-type-registration.html" target="_parent"><strong aria-hidden="true">4.3.</strong> ScriptTypeRegistration</a></li><li class="chapter-item expanded "><a href="ScriptingReference/script-query-builder.html" target="_parent"><strong aria-hidden="true">4.4.</strong> ScriptQueryBuilder</a></li><li class="chapter-item expanded "><a href="ScriptingReference/script-query-result.html" target="_parent"><strong aria-hidden="true">4.5.</strong> ScriptQueryResult</a></li></ol></li></ol>
<ol class="chapter"><li class="chapter-item expanded affix "><a href="Summary/installation.html" target="_parent">Installation</a></li><li class="chapter-item expanded affix "><li class="part-title">Quick Start</li><li class="chapter-item expanded "><a href="Summary/managing-scripts.html" target="_parent"><strong aria-hidden="true">1.</strong> Managing Scripts</a></li><li class="chapter-item expanded "><a href="Summary/running-scripts.html" target="_parent"><strong aria-hidden="true">2.</strong> Running Scripts</a></li><li class="chapter-item expanded "><a href="Summary/controlling-script-bindings.html" target="_parent"><strong aria-hidden="true">3.</strong> Controlling Script Bindings</a></li><li class="chapter-item expanded affix "><li class="part-title">Scripting Reference</li><li class="chapter-item expanded "><a href="ScriptingReference/introduction.html" target="_parent"><strong aria-hidden="true">4.</strong> Introduction</a></li><li class="chapter-item expanded "><a href="ScriptingReference/core-api.html" target="_parent"><strong aria-hidden="true">5.</strong> Core Bindings</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="ScriptingReference/world.html" target="_parent"><strong aria-hidden="true">5.1.</strong> World</a></li><li class="chapter-item expanded "><a href="ScriptingReference/reflect-reference.html" target="_parent"><strong aria-hidden="true">5.2.</strong> ReflectReference</a></li><li class="chapter-item expanded "><a href="ScriptingReference/script-type-registration.html" target="_parent"><strong aria-hidden="true">5.3.</strong> ScriptTypeRegistration</a></li><li class="chapter-item expanded "><a href="ScriptingReference/script-query-builder.html" target="_parent"><strong aria-hidden="true">5.4.</strong> ScriptQueryBuilder</a></li><li class="chapter-item expanded "><a href="ScriptingReference/script-query-result.html" target="_parent"><strong aria-hidden="true">5.5.</strong> ScriptQueryResult</a></li></ol></li></ol>
</body>
</html>
Loading

0 comments on commit 4b37536

Please sign in to comment.