423 lines
17 KiB
HTML
423 lines
17 KiB
HTML
|
<!DOCTYPE HTML>
|
|||
|
|
<html lang="en" class="light sidebar-visible" dir="ltr">
|
|||
|
|
<head>
|
|||
|
|
<!-- Book generated using mdBook -->
|
|||
|
|
<meta charset="UTF-8">
|
|||
|
|
<title>Schedules and Time - Storybook Language Guide</title>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<!-- Custom HTML head -->
|
|||
|
|
|
|||
|
|
<meta name="description" content="Comprehensive documentation for the Storybook narrative simulation language">
|
|||
|
|
<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">Storybook Language Guide</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>
|
|||
|
|
<a href="https://github.com/r3t-studios/storybook" title="Git repository" aria-label="Git repository">
|
|||
|
|
<i id="git-repository-button" class="fa fa-github"></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="schedules-and-time"><a class="header" href="#schedules-and-time">Schedules and Time</a></h1>
|
|||
|
|
<p>Characters live in time. A baker wakes before dawn to prepare dough; a guard patrols during the day shift; an innkeeper serves customers until late. Schedules define these time-based routines.</p>
|
|||
|
|
<h2 id="basic-schedules"><a class="header" href="#basic-schedules">Basic Schedules</a></h2>
|
|||
|
|
<p>A schedule contains time blocks, each with a time range and an action:</p>
|
|||
|
|
<pre><code class="language-storybook">schedule SimpleBaker {
|
|||
|
|
block morning_prep {
|
|||
|
|
05:00 - 08:00
|
|||
|
|
action: baking::prepare_dough
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
block sales {
|
|||
|
|
08:00 - 14:00
|
|||
|
|
action: baking::serve_customers
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
block cleanup {
|
|||
|
|
14:00 - 15:00
|
|||
|
|
action: baking::close_shop
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<p>Time ranges use 24-hour clock format (<code>HH:MM</code>). The <code>action</code> field links to a behavior tree that drives the character’s activity during that block.</p>
|
|||
|
|
<h2 id="named-blocks"><a class="header" href="#named-blocks">Named Blocks</a></h2>
|
|||
|
|
<p>Blocks can have names (like <code>morning_prep</code> above). Named blocks are important for schedule composition – they allow child schedules to override specific blocks by name.</p>
|
|||
|
|
<h2 id="linking-schedules-to-characters"><a class="header" href="#linking-schedules-to-characters">Linking Schedules to Characters</a></h2>
|
|||
|
|
<p>Characters use the <code>uses schedule</code> clause:</p>
|
|||
|
|
<pre><code class="language-storybook">character Baker: Human {
|
|||
|
|
uses schedule: SimpleBaker
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<p>For multiple schedules:</p>
|
|||
|
|
<pre><code class="language-storybook">character Innkeeper: Human {
|
|||
|
|
uses schedules: [WeekdaySchedule, WeekendSchedule]
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<h2 id="temporal-constraints"><a class="header" href="#temporal-constraints">Temporal Constraints</a></h2>
|
|||
|
|
<p>Blocks can be restricted to specific times using temporal constraints:</p>
|
|||
|
|
<h3 id="season-constraints"><a class="header" href="#season-constraints">Season Constraints</a></h3>
|
|||
|
|
<pre><code class="language-storybook">schedule SeasonalBaker {
|
|||
|
|
block summer_hours {
|
|||
|
|
06:00 - 20:00
|
|||
|
|
action: baking::long_shift
|
|||
|
|
on season summer
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
block winter_hours {
|
|||
|
|
07:00 - 18:00
|
|||
|
|
action: baking::short_shift
|
|||
|
|
on season winter
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<h3 id="day-of-week-constraints"><a class="header" href="#day-of-week-constraints">Day of Week Constraints</a></h3>
|
|||
|
|
<pre><code class="language-storybook">schedule WeeklyPattern {
|
|||
|
|
block weekday_work {
|
|||
|
|
09:00 - 17:00
|
|||
|
|
action: work::standard
|
|||
|
|
on day monday
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
block weekend_rest {
|
|||
|
|
10:00 - 16:00
|
|||
|
|
action: leisure::relax
|
|||
|
|
on day saturday
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<p>Temporal constraint values (like <code>summer</code> or <code>monday</code>) reference enums defined in your storybook:</p>
|
|||
|
|
<pre><code class="language-storybook">enum Season { spring, summer, fall, winter }
|
|||
|
|
enum DayOfWeek { monday, tuesday, wednesday, thursday, friday, saturday, sunday }
|
|||
|
|
</code></pre>
|
|||
|
|
<h2 id="recurring-events"><a class="header" href="#recurring-events">Recurring Events</a></h2>
|
|||
|
|
<p>Use <code>recurs</code> to define events that repeat on a schedule:</p>
|
|||
|
|
<pre><code class="language-storybook">schedule MarketSchedule {
|
|||
|
|
// Regular daily hours
|
|||
|
|
block work {
|
|||
|
|
08:00 - 17:00
|
|||
|
|
action: shop::regular_sales
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
// Market day every Saturday
|
|||
|
|
recurs MarketDay on day saturday {
|
|||
|
|
block setup {
|
|||
|
|
06:00 - 08:00
|
|||
|
|
action: market::setup_stall
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
block busy_market {
|
|||
|
|
08:00 - 18:00
|
|||
|
|
action: market::busy_sales
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
block teardown {
|
|||
|
|
18:00 - 20:00
|
|||
|
|
action: market::pack_up
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<p>Recurrences take priority over regular blocks. On Saturdays, the <code>MarketDay</code> blocks replace the regular <code>work</code> block.</p>
|
|||
|
|
<h2 id="schedule-composition-with-extends"><a class="header" href="#schedule-composition-with-extends">Schedule Composition with extends</a></h2>
|
|||
|
|
<p>Schedules can extend other schedules, inheriting and overriding blocks:</p>
|
|||
|
|
<pre><code class="language-storybook">schedule BaseShopkeeper {
|
|||
|
|
block open {
|
|||
|
|
09:00 - 17:00
|
|||
|
|
action: shop::standard_hours
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
schedule EarlyBaker extends BaseShopkeeper {
|
|||
|
|
block open {
|
|||
|
|
05:00 - 13:00
|
|||
|
|
action: baking::early_shift
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<p>The <code>EarlyBaker</code> schedule overrides the <code>open</code> block by name – same block name, different hours. Any blocks not overridden are inherited unchanged.</p>
|
|||
|
|
<p>You can chain extensions:</p>
|
|||
|
|
<pre><code class="language-storybook">schedule MasterBaker extends EarlyBaker {
|
|||
|
|
block open {
|
|||
|
|
03:00 - 11:00
|
|||
|
|
action: baking::master_work
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
block teaching {
|
|||
|
|
14:00 - 16:00
|
|||
|
|
action: baking::teach_apprentice
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<p><code>MasterBaker</code> overrides <code>open</code> again and adds a new <code>teaching</code> block.</p>
|
|||
|
|
<h2 id="overnight-blocks"><a class="header" href="#overnight-blocks">Overnight Blocks</a></h2>
|
|||
|
|
<p>Time ranges can span midnight:</p>
|
|||
|
|
<pre><code class="language-storybook">schedule NightGuard {
|
|||
|
|
block night_patrol {
|
|||
|
|
22:00 - 06:00
|
|||
|
|
action: security::patrol
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<p>The system interprets this as 22:00 to midnight on day one, then midnight to 06:00 on day two.</p>
|
|||
|
|
<h2 id="a-complete-schedule-example"><a class="header" href="#a-complete-schedule-example">A Complete Schedule Example</a></h2>
|
|||
|
|
<pre><code class="language-storybook">schedule MasterBaker_FullYear {
|
|||
|
|
// Daily base
|
|||
|
|
block prep {
|
|||
|
|
04:00 - 06:00
|
|||
|
|
action: baking::prepare
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
block baking {
|
|||
|
|
06:00 - 10:00
|
|||
|
|
action: baking::bake
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
block sales {
|
|||
|
|
10:00 - 16:00
|
|||
|
|
action: baking::serve
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
block cleanup {
|
|||
|
|
16:00 - 17:00
|
|||
|
|
action: baking::clean
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
// Summer extended hours
|
|||
|
|
block summer_sales {
|
|||
|
|
10:00 - 20:00
|
|||
|
|
action: baking::busy_summer
|
|||
|
|
on season summer
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
// Weekly market
|
|||
|
|
recurs MarketDay on day saturday {
|
|||
|
|
block market_prep {
|
|||
|
|
02:00 - 04:00
|
|||
|
|
action: baking::market_prep
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
block market_sales {
|
|||
|
|
08:00 - 18:00
|
|||
|
|
action: baking::market_rush
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
// Annual harvest festival
|
|||
|
|
recurs HarvestFestival on dates "Sep 20" .. "Sep 25" {
|
|||
|
|
block festival {
|
|||
|
|
06:00 - 23:00
|
|||
|
|
action: baking::festival_mode
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<h2 id="next-steps"><a class="header" href="#next-steps">Next Steps</a></h2>
|
|||
|
|
<p>Characters now have traits, behaviors, relationships, and schedules. In <a href="./08-life-arcs.html">Life Arcs</a>, you will learn how to model character development over time – how they grow, change, and evolve through different phases of life.</p>
|
|||
|
|
<hr />
|
|||
|
|
<p><strong>Reference</strong>: For complete schedule syntax, see the <a href="../reference/14-schedules.html">Schedules Reference</a>.</p>
|
|||
|
|
|
|||
|
|
</main>
|
|||
|
|
|
|||
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|||
|
|
<!-- Mobile navigation buttons -->
|
|||
|
|
<a rel="prev" href="../tutorial/06-relationships.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="../tutorial/08-life-arcs.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="../tutorial/06-relationships.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="../tutorial/08-life-arcs.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>
|
|||
|
|
|
|||
|
|
<!-- Livereload script (if served using the cli tool) -->
|
|||
|
|
<script>
|
|||
|
|
const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
|
|||
|
|
const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
|
|||
|
|
const socket = new WebSocket(wsAddress);
|
|||
|
|
socket.onmessage = function (event) {
|
|||
|
|
if (event.data === "reload") {
|
|||
|
|
socket.close();
|
|||
|
|
location.reload();
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
window.onbeforeunload = function() {
|
|||
|
|
socket.close();
|
|||
|
|
}
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<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 -->
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</body>
|
|||
|
|
</html>
|