Document not found (404)
-This URL is invalid, sorry. Please use the navigation bar or search to continue.
- -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/book/creating-a-game.html b/book/creating-a-game.html
deleted file mode 100644
index c715dcdad..000000000
--- a/book/creating-a-game.html
+++ /dev/null
@@ -1,277 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Command Line Arguments
-When run, Yaeger accepts command line arguments. These arguments are primarily -meant for debugging your Game.
-The following arguments are currently supported:
-| Argument | Explanation |
|---|---|
| --noSplash | Skip the Splash screen during start up. |
| --showBB | Show the BoundingBox of all instances of YaegerEntity that implement either Collider or Collided. |
| --showDebug | Show a debug window with information about the Scene. More information on the debug window can be found here. |
| --showGrid | Show a coordinate grid as an overlay on each Scene. This can be useful when figuring out where exactly Entities are on the Scene. |
| --enableScroll | Enable the scrolling gesture for all instances of ScrollableDynamicScene. This can help during the development process of such a scene. |
| --limitGWU | Limit the Game World Update (GWU) to a max of 60/sec. |
| --help | Show this help screen with all commandline options. |
Using command line arguments from an IDE
-Since the command line arguments mainly focus on the development cycle, they -will likely only be used during development of a Yaeger Game. In such a case you -will be working in an IDE, which will also be responsible for creating a run -configuration. Part of such a run configuration will be the (extra) arguments -that can be passed to the application. So check the documentation of your IDE to -see where these arguments can be entered.
- -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/book/creating-entities.html b/book/creating-entities.html
deleted file mode 100644
index 4ff89feaa..000000000
--- a/book/creating-entities.html
+++ /dev/null
@@ -1,237 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Lifecycle methods of
-Setting up the game, through
-Adding Scenes, through
-
-
-
-
- Creating a game
-To create a new Yaeger Game, a Java class should be created that
--
-
- extends
YeagerGame
- - contains the following method: -
public static void main(String[]args){
- launch(args);
-}
-Such a game does not have any content yet, but it can be run and will only -show the Splash screen. This Splash screen will be shown before each Yaeger -Game. It can, however, be disabled by adding a commandline argument when running -your game. More information on this can be found -here.
-Lifecycle methods of YeagerGame
-By extending YeagerGame, several methods will need to be implemented.
-These methods are part of the lifecycle of a Yaeger Game and will be responsible
-for setting up the content of the Game.
Setting up the game, through setupGame()
-The first method to implement is setupGame(), which has the following s
-ignature:
@Override
-protected void setupGame(){
-}
-This method will be called first and must be used to set up the width/height -and title of the Game. A typical implementation can look like:
-@Override
-protected void setupGame(){
- setGameTitle("Waterworld");
- setSize(new Size(800,600));
-}
-For more information, check the
-API
-of setupGame()
Adding Scenes, through setupScenes()
-After setupGame() has been called, Yaeger will call setupScenes(). This is
-the second step in the life cycle of a Yaeger Game, in which it expects the
-developer to add Scenes to the Game. Scenes can be added by calling
-addScene(int, YaegerScene). The first parameter is the id of the
-YaegerScene, which can be used to select which YaegerScene will be shown.
-By default, the first scene that is added, will be the first scene that is
-shown.
A typical implementation can ook like:
-@Override
-protected void setupScenes(){
- addScene(0, new TitleScene(this));
- addScene(1, new GameLevel(this));
- addScene(2, new GameOverScene(this));
-}
-Loading a scene
-When adding scenes to the Yaeger Game, the first added scene will also be the
-one that gets loaded and becomes visible. To load a specific scene,
-YaegerGame provides the method setActiveScene(int). Read
-the API
-for the details on how to use this method.
What about the constructor?
-For Plain Old Java Objects (POJO's) the constructor is usually used for -configuring your Object. Although it is not always the best approach, since -the constructor should be only used for constructing an Object, not for -configuring it, it will usually still work.
-With Yaeger, however, it will usually not work. Configuring a YaegerGame
-should only be done from the setupGame() method. Furthermore, the
-constructor of the class that extends YaegerGame should be empty, since Yaeger
-will otherwise not know how to make an instance of it.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/book/css/chrome.css b/book/css/chrome.css
deleted file mode 100644
index 4cd73086d..000000000
--- a/book/css/chrome.css
+++ /dev/null
@@ -1,640 +0,0 @@
-/* CSS for UI elements (a.k.a. chrome) */
-
-html {
- scrollbar-color: var(--scrollbar) var(--bg);
-}
-#searchresults a,
-.content a:link,
-a:visited,
-a > .hljs {
- color: var(--links);
-}
-
-/*
- body-container is necessary because mobile browsers don't seem to like
- overflow-x on the body tag when there is a tag.
-*/
-#body-container {
- /*
- This is used when the sidebar pushes the body content off the side of
- the screen on small screens. Without it, dragging on mobile Safari
- will want to reposition the viewport in a weird way.
- */
- overflow-x: clip;
-}
-
-/* Menu Bar */
-
-#menu-bar,
-#menu-bar-hover-placeholder {
- z-index: 101;
- margin: auto calc(0px - var(--page-padding));
-}
-#menu-bar {
- position: relative;
- display: flex;
- flex-wrap: wrap;
- background-color: var(--bg);
- border-block-end-color: var(--bg);
- border-block-end-width: 1px;
- border-block-end-style: solid;
-}
-#menu-bar.sticky,
-#menu-bar-hover-placeholder:hover + #menu-bar,
-#menu-bar:hover,
-html.sidebar-visible #menu-bar {
- position: -webkit-sticky;
- position: sticky;
- top: 0 !important;
-}
-#menu-bar-hover-placeholder {
- position: sticky;
- position: -webkit-sticky;
- top: 0;
- height: var(--menu-bar-height);
-}
-#menu-bar.bordered {
- border-block-end-color: var(--table-border-color);
-}
-#menu-bar i, #menu-bar .icon-button {
- position: relative;
- padding: 0 8px;
- z-index: 10;
- line-height: var(--menu-bar-height);
- cursor: pointer;
- transition: color 0.5s;
-}
-@media only screen and (max-width: 420px) {
- #menu-bar i, #menu-bar .icon-button {
- padding: 0 5px;
- }
-}
-
-.icon-button {
- border: none;
- background: none;
- padding: 0;
- color: inherit;
-}
-.icon-button i {
- margin: 0;
-}
-
-.right-buttons {
- margin: 0 15px;
-}
-.right-buttons a {
- text-decoration: none;
-}
-
-.left-buttons {
- display: flex;
- margin: 0 5px;
-}
-html:not(.js) .left-buttons button {
- display: none;
-}
-
-.menu-title {
- display: inline-block;
- font-weight: 200;
- font-size: 2.4rem;
- line-height: var(--menu-bar-height);
- text-align: center;
- margin: 0;
- flex: 1;
- white-space: nowrap;
- overflow: hidden;
- text-overflow: ellipsis;
-}
-.menu-title {
- cursor: pointer;
-}
-
-.menu-bar,
-.menu-bar:visited,
-.nav-chapters,
-.nav-chapters:visited,
-.mobile-nav-chapters,
-.mobile-nav-chapters:visited,
-.menu-bar .icon-button,
-.menu-bar a i {
- color: var(--icons);
-}
-
-.menu-bar i:hover,
-.menu-bar .icon-button:hover,
-.nav-chapters:hover,
-.mobile-nav-chapters i:hover {
- color: var(--icons-hover);
-}
-
-/* Nav Icons */
-
-.nav-chapters {
- font-size: 2.5em;
- text-align: center;
- text-decoration: none;
-
- position: fixed;
- top: 0;
- bottom: 0;
- margin: 0;
- max-width: 150px;
- min-width: 90px;
-
- display: flex;
- justify-content: center;
- align-content: center;
- flex-direction: column;
-
- transition: color 0.5s, background-color 0.5s;
-}
-
-.nav-chapters:hover {
- text-decoration: none;
- background-color: var(--theme-hover);
- transition: background-color 0.15s, color 0.15s;
-}
-
-.nav-wrapper {
- margin-block-start: 50px;
- display: none;
-}
-
-.mobile-nav-chapters {
- font-size: 2.5em;
- text-align: center;
- text-decoration: none;
- width: 90px;
- border-radius: 5px;
- background-color: var(--sidebar-bg);
-}
-
-/* Only Firefox supports flow-relative values */
-.previous { float: left; }
-[dir=rtl] .previous { float: right; }
-
-/* Only Firefox supports flow-relative values */
-.next {
- float: right;
- right: var(--page-padding);
-}
-[dir=rtl] .next {
- float: left;
- right: unset;
- left: var(--page-padding);
-}
-
-/* Use the correct buttons for RTL layouts*/
-[dir=rtl] .previous i.fa-angle-left:before {content:"\f105";}
-[dir=rtl] .next i.fa-angle-right:before { content:"\f104"; }
-
-@media only screen and (max-width: 1080px) {
- .nav-wide-wrapper { display: none; }
- .nav-wrapper { display: block; }
-}
-
-/* sidebar-visible */
-@media only screen and (max-width: 1380px) {
- #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wide-wrapper { display: none; }
- #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wrapper { display: block; }
-}
-
-/* Inline code */
-
-:not(pre) > .hljs {
- display: inline;
- padding: 0.1em 0.3em;
- border-radius: 3px;
-}
-
-:not(pre):not(a) > .hljs {
- color: var(--inline-code-color);
- overflow-x: initial;
-}
-
-a:hover > .hljs {
- text-decoration: underline;
-}
-
-pre {
- position: relative;
-}
-pre > .buttons {
- position: absolute;
- z-index: 100;
- right: 0px;
- top: 2px;
- margin: 0px;
- padding: 2px 0px;
-
- color: var(--sidebar-fg);
- cursor: pointer;
- visibility: hidden;
- opacity: 0;
- transition: visibility 0.1s linear, opacity 0.1s linear;
-}
-pre:hover > .buttons {
- visibility: visible;
- opacity: 1
-}
-pre > .buttons :hover {
- color: var(--sidebar-active);
- border-color: var(--icons-hover);
- background-color: var(--theme-hover);
-}
-pre > .buttons i {
- margin-inline-start: 8px;
-}
-pre > .buttons button {
- cursor: inherit;
- margin: 0px 5px;
- padding: 4px 4px 3px 5px;
- font-size: 23px;
-
- border-style: solid;
- border-width: 1px;
- border-radius: 4px;
- border-color: var(--icons);
- background-color: var(--theme-popup-bg);
- transition: 100ms;
- transition-property: color,border-color,background-color;
- color: var(--icons);
-}
-
-pre > .buttons button.clip-button {
- padding: 2px 4px 0px 6px;
-}
-pre > .buttons button.clip-button::before {
- /* clipboard image from octicons (https://github.com/primer/octicons/tree/v2.0.0) MIT license
- */
- content: url('data:image/svg+xml,');
- filter: var(--copy-button-filter);
-}
-pre > .buttons button.clip-button:hover::before {
- filter: var(--copy-button-filter-hover);
-}
-
-@media (pointer: coarse) {
- pre > .buttons button {
- /* On mobile, make it easier to tap buttons. */
- padding: 0.3rem 1rem;
- }
-
- .sidebar-resize-indicator {
- /* Hide resize indicator on devices with limited accuracy */
- display: none;
- }
-}
-pre > code {
- display: block;
- padding: 1rem;
-}
-
-/* FIXME: ACE editors overlap their buttons because ACE does absolute
- positioning within the code block which breaks padding. The only solution I
- can think of is to move the padding to the outer pre tag (or insert a div
- wrapper), but that would require fixing a whole bunch of CSS rules.
-*/
-.hljs.ace_editor {
- padding: 0rem 0rem;
-}
-
-pre > .result {
- margin-block-start: 10px;
-}
-
-/* Search */
-
-#searchresults a {
- text-decoration: none;
-}
-
-mark {
- border-radius: 2px;
- padding-block-start: 0;
- padding-block-end: 1px;
- padding-inline-start: 3px;
- padding-inline-end: 3px;
- margin-block-start: 0;
- margin-block-end: -1px;
- margin-inline-start: -3px;
- margin-inline-end: -3px;
- background-color: var(--search-mark-bg);
- transition: background-color 300ms linear;
- cursor: pointer;
-}
-
-mark.fade-out {
- background-color: rgba(0,0,0,0) !important;
- cursor: auto;
-}
-
-.searchbar-outer {
- margin-inline-start: auto;
- margin-inline-end: auto;
- max-width: var(--content-max-width);
-}
-
-#searchbar {
- width: 100%;
- margin-block-start: 5px;
- margin-block-end: 0;
- margin-inline-start: auto;
- margin-inline-end: auto;
- padding: 10px 16px;
- transition: box-shadow 300ms ease-in-out;
- border: 1px solid var(--searchbar-border-color);
- border-radius: 3px;
- background-color: var(--searchbar-bg);
- color: var(--searchbar-fg);
-}
-#searchbar:focus,
-#searchbar.active {
- box-shadow: 0 0 3px var(--searchbar-shadow-color);
-}
-
-.searchresults-header {
- font-weight: bold;
- font-size: 1em;
- padding-block-start: 18px;
- padding-block-end: 0;
- padding-inline-start: 5px;
- padding-inline-end: 0;
- color: var(--searchresults-header-fg);
-}
-
-.searchresults-outer {
- margin-inline-start: auto;
- margin-inline-end: auto;
- max-width: var(--content-max-width);
- border-block-end: 1px dashed var(--searchresults-border-color);
-}
-
-ul#searchresults {
- list-style: none;
- padding-inline-start: 20px;
-}
-ul#searchresults li {
- margin: 10px 0px;
- padding: 2px;
- border-radius: 2px;
-}
-ul#searchresults li.focus {
- background-color: var(--searchresults-li-bg);
-}
-ul#searchresults span.teaser {
- display: block;
- clear: both;
- margin-block-start: 5px;
- margin-block-end: 0;
- margin-inline-start: 20px;
- margin-inline-end: 0;
- font-size: 0.8em;
-}
-ul#searchresults span.teaser em {
- font-weight: bold;
- font-style: normal;
-}
-
-/* Sidebar */
-
-.sidebar {
- position: fixed;
- left: 0;
- top: 0;
- bottom: 0;
- width: var(--sidebar-width);
- font-size: 0.875em;
- box-sizing: border-box;
- -webkit-overflow-scrolling: touch;
- overscroll-behavior-y: contain;
- background-color: var(--sidebar-bg);
- color: var(--sidebar-fg);
-}
-.sidebar-iframe-inner {
- background-color: var(--sidebar-bg);
- color: var(--sidebar-fg);
- padding: 10px 10px;
- margin: 0;
- font-size: 1.4rem;
-}
-.sidebar-iframe-outer {
- border: none;
- height: 100%;
- position: absolute;
- top: 0;
- bottom: 0;
- left: 0;
- right: 0;
-}
-[dir=rtl] .sidebar { left: unset; right: 0; }
-.sidebar-resizing {
- -moz-user-select: none;
- -webkit-user-select: none;
- -ms-user-select: none;
- user-select: none;
-}
-html:not(.sidebar-resizing) .sidebar {
- transition: transform 0.3s; /* Animation: slide away */
-}
-.sidebar code {
- line-height: 2em;
-}
-.sidebar .sidebar-scrollbox {
- overflow-y: auto;
- position: absolute;
- top: 0;
- bottom: 0;
- left: 0;
- right: 0;
- padding: 10px 10px;
-}
-.sidebar .sidebar-resize-handle {
- position: absolute;
- cursor: col-resize;
- width: 0;
- right: calc(var(--sidebar-resize-indicator-width) * -1);
- top: 0;
- bottom: 0;
- display: flex;
- align-items: center;
-}
-
-.sidebar-resize-handle .sidebar-resize-indicator {
- width: 100%;
- height: 12px;
- background-color: var(--icons);
- margin-inline-start: var(--sidebar-resize-indicator-space);
-}
-
-[dir=rtl] .sidebar .sidebar-resize-handle {
- left: calc(var(--sidebar-resize-indicator-width) * -1);
- right: unset;
-}
-.js .sidebar .sidebar-resize-handle {
- cursor: col-resize;
- width: calc(var(--sidebar-resize-indicator-width) - var(--sidebar-resize-indicator-space));
-}
-/* sidebar-hidden */
-#sidebar-toggle-anchor:not(:checked) ~ .sidebar {
- transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
- z-index: -1;
-}
-[dir=rtl] #sidebar-toggle-anchor:not(:checked) ~ .sidebar {
- transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
-}
-.sidebar::-webkit-scrollbar {
- background: var(--sidebar-bg);
-}
-.sidebar::-webkit-scrollbar-thumb {
- background: var(--scrollbar);
-}
-
-/* sidebar-visible */
-#sidebar-toggle-anchor:checked ~ .page-wrapper {
- transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
-}
-[dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
- transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
-}
-@media only screen and (min-width: 620px) {
- #sidebar-toggle-anchor:checked ~ .page-wrapper {
- transform: none;
- margin-inline-start: calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width));
- }
- [dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
- transform: none;
- }
-}
-
-.chapter {
- list-style: none outside none;
- padding-inline-start: 0;
- line-height: 2.2em;
-}
-
-.chapter ol {
- width: 100%;
-}
-
-.chapter li {
- display: flex;
- color: var(--sidebar-non-existant);
-}
-.chapter li a {
- display: block;
- padding: 0;
- text-decoration: none;
- color: var(--sidebar-fg);
-}
-
-.chapter li a:hover {
- color: var(--sidebar-active);
-}
-
-.chapter li a.active {
- color: var(--sidebar-active);
-}
-
-.chapter li > a.toggle {
- cursor: pointer;
- display: block;
- margin-inline-start: auto;
- padding: 0 10px;
- user-select: none;
- opacity: 0.68;
-}
-
-.chapter li > a.toggle div {
- transition: transform 0.5s;
-}
-
-/* collapse the section */
-.chapter li:not(.expanded) + li > ol {
- display: none;
-}
-
-.chapter li.chapter-item {
- line-height: 1.5em;
- margin-block-start: 0.6em;
-}
-
-.chapter li.expanded > a.toggle div {
- transform: rotate(90deg);
-}
-
-.spacer {
- width: 100%;
- height: 3px;
- margin: 5px 0px;
-}
-.chapter .spacer {
- background-color: var(--sidebar-spacer);
-}
-
-@media (-moz-touch-enabled: 1), (pointer: coarse) {
- .chapter li a { padding: 5px 0; }
- .spacer { margin: 10px 0; }
-}
-
-.section {
- list-style: none outside none;
- padding-inline-start: 20px;
- line-height: 1.9em;
-}
-
-/* Theme Menu Popup */
-
-.theme-popup {
- position: absolute;
- left: 10px;
- top: var(--menu-bar-height);
- z-index: 1000;
- border-radius: 4px;
- font-size: 0.7em;
- color: var(--fg);
- background: var(--theme-popup-bg);
- border: 1px solid var(--theme-popup-border);
- margin: 0;
- padding: 0;
- list-style: none;
- display: none;
- /* Don't let the children's background extend past the rounded corners. */
- overflow: hidden;
-}
-[dir=rtl] .theme-popup { left: unset; right: 10px; }
-.theme-popup .default {
- color: var(--icons);
-}
-.theme-popup .theme {
- width: 100%;
- border: 0;
- margin: 0;
- padding: 2px 20px;
- line-height: 25px;
- white-space: nowrap;
- text-align: start;
- cursor: pointer;
- color: inherit;
- background: inherit;
- font-size: inherit;
-}
-.theme-popup .theme:hover {
- background-color: var(--theme-hover);
-}
-
-.theme-selected::before {
- display: inline-block;
- content: "✓";
- margin-inline-start: -14px;
- width: 14px;
-}
diff --git a/book/css/general.css b/book/css/general.css
deleted file mode 100644
index 0862b5167..000000000
--- a/book/css/general.css
+++ /dev/null
@@ -1,242 +0,0 @@
-/* Base styles and content styles */
-
-:root {
- /* Browser default font-size is 16px, this way 1 rem = 10px */
- font-size: 62.5%;
- color-scheme: var(--color-scheme);
-}
-
-html {
- font-family: "Open Sans", sans-serif;
- color: var(--fg);
- background-color: var(--bg);
- text-size-adjust: none;
- -webkit-text-size-adjust: none;
-}
-
-body {
- margin: 0;
- font-size: 1.6rem;
- overflow-x: hidden;
-}
-
-code {
- font-family: var(--mono-font) !important;
- font-size: var(--code-font-size);
- direction: ltr !important;
-}
-
-/* make long words/inline code not x overflow */
-main {
- overflow-wrap: break-word;
-}
-
-/* make wide tables scroll if they overflow */
-.table-wrapper {
- overflow-x: auto;
-}
-
-/* Don't change font size in headers. */
-h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
- font-size: unset;
-}
-
-.left { float: left; }
-.right { float: right; }
-.boring { opacity: 0.6; }
-.hide-boring .boring { display: none; }
-.hidden { display: none !important; }
-
-h2, h3 { margin-block-start: 2.5em; }
-h4, h5 { margin-block-start: 2em; }
-
-.header + .header h3,
-.header + .header h4,
-.header + .header h5 {
- margin-block-start: 1em;
-}
-
-h1:target::before,
-h2:target::before,
-h3:target::before,
-h4:target::before,
-h5:target::before,
-h6:target::before {
- display: inline-block;
- content: "»";
- margin-inline-start: -30px;
- width: 30px;
-}
-
-/* This is broken on Safari as of version 14, but is fixed
- in Safari Technology Preview 117 which I think will be Safari 14.2.
- https://bugs.webkit.org/show_bug.cgi?id=218076
-*/
-:target {
- /* Safari does not support logical properties */
- scroll-margin-top: calc(var(--menu-bar-height) + 0.5em);
-}
-
-.page {
- outline: 0;
- padding: 0 var(--page-padding);
- margin-block-start: calc(0px - var(--menu-bar-height)); /* Compensate for the #menu-bar-hover-placeholder */
-}
-.page-wrapper {
- box-sizing: border-box;
- background-color: var(--bg);
-}
-.no-js .page-wrapper,
-.js:not(.sidebar-resizing) .page-wrapper {
- transition: margin-left 0.3s ease, transform 0.3s ease; /* Animation: slide away */
-}
-[dir=rtl] .js:not(.sidebar-resizing) .page-wrapper {
- transition: margin-right 0.3s ease, transform 0.3s ease; /* Animation: slide away */
-}
-
-.content {
- overflow-y: auto;
- padding: 0 5px 50px 5px;
-}
-.content main {
- margin-inline-start: auto;
- margin-inline-end: auto;
- max-width: var(--content-max-width);
-}
-.content p { line-height: 1.45em; }
-.content ol { line-height: 1.45em; }
-.content ul { line-height: 1.45em; }
-.content a { text-decoration: none; }
-.content a:hover { text-decoration: underline; }
-.content img, .content video { max-width: 100%; }
-.content .header:link,
-.content .header:visited {
- color: var(--fg);
-}
-.content .header:link,
-.content .header:visited:hover {
- text-decoration: none;
-}
-
-table {
- margin: 0 auto;
- border-collapse: collapse;
-}
-table td {
- padding: 3px 20px;
- border: 1px var(--table-border-color) solid;
-}
-table thead {
- background: var(--table-header-bg);
-}
-table thead td {
- font-weight: 700;
- border: none;
-}
-table thead th {
- padding: 3px 20px;
-}
-table thead tr {
- border: 1px var(--table-header-bg) solid;
-}
-/* Alternate background colors for rows */
-table tbody tr:nth-child(2n) {
- background: var(--table-alternate-bg);
-}
-
-
-blockquote {
- margin: 20px 0;
- padding: 0 20px;
- color: var(--fg);
- background-color: var(--quote-bg);
- border-block-start: .1em solid var(--quote-border);
- border-block-end: .1em solid var(--quote-border);
-}
-
-.warning {
- margin: 20px;
- padding: 0 20px;
- border-inline-start: 2px solid var(--warning-border);
-}
-
-.warning:before {
- position: absolute;
- width: 3rem;
- height: 3rem;
- margin-inline-start: calc(-1.5rem - 21px);
- content: "ⓘ";
- text-align: center;
- background-color: var(--bg);
- color: var(--warning-border);
- font-weight: bold;
- font-size: 2rem;
-}
-
-blockquote .warning:before {
- background-color: var(--quote-bg);
-}
-
-kbd {
- background-color: var(--table-border-color);
- border-radius: 4px;
- border: solid 1px var(--theme-popup-border);
- box-shadow: inset 0 -1px 0 var(--theme-hover);
- display: inline-block;
- font-size: var(--code-font-size);
- font-family: var(--mono-font);
- line-height: 10px;
- padding: 4px 5px;
- vertical-align: middle;
-}
-
-sup {
- /* Set the line-height for superscript and footnote references so that there
- isn't an awkward space appearing above lines that contain the footnote.
-
- See https://github.com/rust-lang/mdBook/pull/2443#discussion_r1813773583
- for an explanation.
- */
- line-height: 0;
-}
-
-:not(.footnote-definition) + .footnote-definition,
-.footnote-definition + :not(.footnote-definition) {
- margin-block-start: 2em;
-}
-.footnote-definition {
- font-size: 0.9em;
- margin: 0.5em 0;
-}
-.footnote-definition p {
- display: inline;
-}
-
-.tooltiptext {
- position: absolute;
- visibility: hidden;
- color: #fff;
- background-color: #333;
- transform: translateX(-50%); /* Center by moving tooltip 50% of its width left */
- left: -8px; /* Half of the width of the icon */
- top: -35px;
- font-size: 0.8em;
- text-align: center;
- border-radius: 6px;
- padding: 5px 8px;
- margin: 5px;
- z-index: 1000;
-}
-.tooltipped .tooltiptext {
- visibility: visible;
-}
-
-.chapter li.part-title {
- color: var(--sidebar-fg);
- margin: 5px 0px;
- font-weight: bold;
-}
-
-.result-no-output {
- font-style: italic;
-}
diff --git a/book/css/print.css b/book/css/print.css
deleted file mode 100644
index 80ec3a544..000000000
--- a/book/css/print.css
+++ /dev/null
@@ -1,50 +0,0 @@
-
-#sidebar,
-#menu-bar,
-.nav-chapters,
-.mobile-nav-chapters {
- display: none;
-}
-
-#page-wrapper.page-wrapper {
- transform: none !important;
- margin-inline-start: 0px;
- overflow-y: initial;
-}
-
-#content {
- max-width: none;
- margin: 0;
- padding: 0;
-}
-
-.page {
- overflow-y: initial;
-}
-
-code {
- direction: ltr !important;
-}
-
-pre > .buttons {
- z-index: 2;
-}
-
-a, a:visited, a:active, a:hover {
- color: #4183c4;
- text-decoration: none;
-}
-
-h1, h2, h3, h4, h5, h6 {
- page-break-inside: avoid;
- page-break-after: avoid;
-}
-
-pre, code {
- page-break-inside: avoid;
- white-space: pre-wrap;
-}
-
-.fa {
- display: none !important;
-}
diff --git a/book/css/variables.css b/book/css/variables.css
deleted file mode 100644
index 12d1db7a3..000000000
--- a/book/css/variables.css
+++ /dev/null
@@ -1,309 +0,0 @@
-
-/* Globals */
-
-:root {
- --sidebar-width: 300px;
- --sidebar-resize-indicator-width: 8px;
- --sidebar-resize-indicator-space: 2px;
- --page-padding: 15px;
- --content-max-width: 750px;
- --menu-bar-height: 50px;
- --mono-font: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace;
- --code-font-size: 0.875em /* please adjust the ace font size accordingly in editor.js */
-}
-
-/* Themes */
-
-.ayu {
- --bg: hsl(210, 25%, 8%);
- --fg: #c5c5c5;
-
- --sidebar-bg: #14191f;
- --sidebar-fg: #c8c9db;
- --sidebar-non-existant: #5c6773;
- --sidebar-active: #ffb454;
- --sidebar-spacer: #2d334f;
-
- --scrollbar: var(--sidebar-fg);
-
- --icons: #737480;
- --icons-hover: #b7b9cc;
-
- --links: #0096cf;
-
- --inline-code-color: #ffb454;
-
- --theme-popup-bg: #14191f;
- --theme-popup-border: #5c6773;
- --theme-hover: #191f26;
-
- --quote-bg: hsl(226, 15%, 17%);
- --quote-border: hsl(226, 15%, 22%);
-
- --warning-border: #ff8e00;
-
- --table-border-color: hsl(210, 25%, 13%);
- --table-header-bg: hsl(210, 25%, 28%);
- --table-alternate-bg: hsl(210, 25%, 11%);
-
- --searchbar-border-color: #848484;
- --searchbar-bg: #424242;
- --searchbar-fg: #fff;
- --searchbar-shadow-color: #d4c89f;
- --searchresults-header-fg: #666;
- --searchresults-border-color: #888;
- --searchresults-li-bg: #252932;
- --search-mark-bg: #e3b171;
-
- --color-scheme: dark;
-
- /* Same as `--icons` */
- --copy-button-filter: invert(45%) sepia(6%) saturate(621%) hue-rotate(198deg) brightness(99%) contrast(85%);
- /* Same as `--sidebar-active` */
- --copy-button-filter-hover: invert(68%) sepia(55%) saturate(531%) hue-rotate(341deg) brightness(104%) contrast(101%);
-}
-
-.coal {
- --bg: hsl(200, 7%, 8%);
- --fg: #98a3ad;
-
- --sidebar-bg: #292c2f;
- --sidebar-fg: #a1adb8;
- --sidebar-non-existant: #505254;
- --sidebar-active: #3473ad;
- --sidebar-spacer: #393939;
-
- --scrollbar: var(--sidebar-fg);
-
- --icons: #43484d;
- --icons-hover: #b3c0cc;
-
- --links: #2b79a2;
-
- --inline-code-color: #c5c8c6;
-
- --theme-popup-bg: #141617;
- --theme-popup-border: #43484d;
- --theme-hover: #1f2124;
-
- --quote-bg: hsl(234, 21%, 18%);
- --quote-border: hsl(234, 21%, 23%);
-
- --warning-border: #ff8e00;
-
- --table-border-color: hsl(200, 7%, 13%);
- --table-header-bg: hsl(200, 7%, 28%);
- --table-alternate-bg: hsl(200, 7%, 11%);
-
- --searchbar-border-color: #aaa;
- --searchbar-bg: #b7b7b7;
- --searchbar-fg: #000;
- --searchbar-shadow-color: #aaa;
- --searchresults-header-fg: #666;
- --searchresults-border-color: #98a3ad;
- --searchresults-li-bg: #2b2b2f;
- --search-mark-bg: #355c7d;
-
- --color-scheme: dark;
-
- /* Same as `--icons` */
- --copy-button-filter: invert(26%) sepia(8%) saturate(575%) hue-rotate(169deg) brightness(87%) contrast(82%);
- /* Same as `--sidebar-active` */
- --copy-button-filter-hover: invert(36%) sepia(70%) saturate(503%) hue-rotate(167deg) brightness(98%) contrast(89%);
-}
-
-.light, html:not(.js) {
- --bg: hsl(0, 0%, 100%);
- --fg: hsl(0, 0%, 0%);
-
- --sidebar-bg: #fafafa;
- --sidebar-fg: hsl(0, 0%, 0%);
- --sidebar-non-existant: #aaaaaa;
- --sidebar-active: #1f1fff;
- --sidebar-spacer: #f4f4f4;
-
- --scrollbar: #8F8F8F;
-
- --icons: #747474;
- --icons-hover: #000000;
-
- --links: #20609f;
-
- --inline-code-color: #301900;
-
- --theme-popup-bg: #fafafa;
- --theme-popup-border: #cccccc;
- --theme-hover: #e6e6e6;
-
- --quote-bg: hsl(197, 37%, 96%);
- --quote-border: hsl(197, 37%, 91%);
-
- --warning-border: #ff8e00;
-
- --table-border-color: hsl(0, 0%, 95%);
- --table-header-bg: hsl(0, 0%, 80%);
- --table-alternate-bg: hsl(0, 0%, 97%);
-
- --searchbar-border-color: #aaa;
- --searchbar-bg: #fafafa;
- --searchbar-fg: #000;
- --searchbar-shadow-color: #aaa;
- --searchresults-header-fg: #666;
- --searchresults-border-color: #888;
- --searchresults-li-bg: #e4f2fe;
- --search-mark-bg: #a2cff5;
-
- --color-scheme: light;
-
- /* Same as `--icons` */
- --copy-button-filter: invert(45.49%);
- /* Same as `--sidebar-active` */
- --copy-button-filter-hover: invert(14%) sepia(93%) saturate(4250%) hue-rotate(243deg) brightness(99%) contrast(130%);
-}
-
-.navy {
- --bg: hsl(226, 23%, 11%);
- --fg: #bcbdd0;
-
- --sidebar-bg: #282d3f;
- --sidebar-fg: #c8c9db;
- --sidebar-non-existant: #505274;
- --sidebar-active: #2b79a2;
- --sidebar-spacer: #2d334f;
-
- --scrollbar: var(--sidebar-fg);
-
- --icons: #737480;
- --icons-hover: #b7b9cc;
-
- --links: #2b79a2;
-
- --inline-code-color: #c5c8c6;
-
- --theme-popup-bg: #161923;
- --theme-popup-border: #737480;
- --theme-hover: #282e40;
-
- --quote-bg: hsl(226, 15%, 17%);
- --quote-border: hsl(226, 15%, 22%);
-
- --warning-border: #ff8e00;
-
- --table-border-color: hsl(226, 23%, 16%);
- --table-header-bg: hsl(226, 23%, 31%);
- --table-alternate-bg: hsl(226, 23%, 14%);
-
- --searchbar-border-color: #aaa;
- --searchbar-bg: #aeaec6;
- --searchbar-fg: #000;
- --searchbar-shadow-color: #aaa;
- --searchresults-header-fg: #5f5f71;
- --searchresults-border-color: #5c5c68;
- --searchresults-li-bg: #242430;
- --search-mark-bg: #a2cff5;
-
- --color-scheme: dark;
-
- /* Same as `--icons` */
- --copy-button-filter: invert(51%) sepia(10%) saturate(393%) hue-rotate(198deg) brightness(86%) contrast(87%);
- /* Same as `--sidebar-active` */
- --copy-button-filter-hover: invert(46%) sepia(20%) saturate(1537%) hue-rotate(156deg) brightness(85%) contrast(90%);
-}
-
-.rust {
- --bg: hsl(60, 9%, 87%);
- --fg: #262625;
-
- --sidebar-bg: #3b2e2a;
- --sidebar-fg: #c8c9db;
- --sidebar-non-existant: #505254;
- --sidebar-active: #e69f67;
- --sidebar-spacer: #45373a;
-
- --scrollbar: var(--sidebar-fg);
-
- --icons: #737480;
- --icons-hover: #262625;
-
- --links: #2b79a2;
-
- --inline-code-color: #6e6b5e;
-
- --theme-popup-bg: #e1e1db;
- --theme-popup-border: #b38f6b;
- --theme-hover: #99908a;
-
- --quote-bg: hsl(60, 5%, 75%);
- --quote-border: hsl(60, 5%, 70%);
-
- --warning-border: #ff8e00;
-
- --table-border-color: hsl(60, 9%, 82%);
- --table-header-bg: #b3a497;
- --table-alternate-bg: hsl(60, 9%, 84%);
-
- --searchbar-border-color: #aaa;
- --searchbar-bg: #fafafa;
- --searchbar-fg: #000;
- --searchbar-shadow-color: #aaa;
- --searchresults-header-fg: #666;
- --searchresults-border-color: #888;
- --searchresults-li-bg: #dec2a2;
- --search-mark-bg: #e69f67;
-
- /* Same as `--icons` */
- --copy-button-filter: invert(51%) sepia(10%) saturate(393%) hue-rotate(198deg) brightness(86%) contrast(87%);
- /* Same as `--sidebar-active` */
- --copy-button-filter-hover: invert(77%) sepia(16%) saturate(1798%) hue-rotate(328deg) brightness(98%) contrast(83%);
-}
-
-@media (prefers-color-scheme: dark) {
- html:not(.js) {
- --bg: hsl(200, 7%, 8%);
- --fg: #98a3ad;
-
- --sidebar-bg: #292c2f;
- --sidebar-fg: #a1adb8;
- --sidebar-non-existant: #505254;
- --sidebar-active: #3473ad;
- --sidebar-spacer: #393939;
-
- --scrollbar: var(--sidebar-fg);
-
- --icons: #43484d;
- --icons-hover: #b3c0cc;
-
- --links: #2b79a2;
-
- --inline-code-color: #c5c8c6;
-
- --theme-popup-bg: #141617;
- --theme-popup-border: #43484d;
- --theme-hover: #1f2124;
-
- --quote-bg: hsl(234, 21%, 18%);
- --quote-border: hsl(234, 21%, 23%);
-
- --warning-border: #ff8e00;
-
- --table-border-color: hsl(200, 7%, 13%);
- --table-header-bg: hsl(200, 7%, 28%);
- --table-alternate-bg: hsl(200, 7%, 11%);
-
- --searchbar-border-color: #aaa;
- --searchbar-bg: #b7b7b7;
- --searchbar-fg: #000;
- --searchbar-shadow-color: #aaa;
- --searchresults-header-fg: #666;
- --searchresults-border-color: #98a3ad;
- --searchresults-li-bg: #2b2b2f;
- --search-mark-bg: #355c7d;
-
- --color-scheme: dark;
-
- /* Same as `--icons` */
- --copy-button-filter: invert(26%) sepia(8%) saturate(575%) hue-rotate(169deg) brightness(87%) contrast(82%);
- /* Same as `--sidebar-active` */
- --copy-button-filter-hover: invert(36%) sepia(70%) saturate(503%) hue-rotate(167deg) brightness(98%) contrast(89%);
- }
-}
diff --git a/book/debugging.html b/book/debugging.html
deleted file mode 100644
index f9cb89f45..000000000
--- a/book/debugging.html
+++ /dev/null
@@ -1,246 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Creating many entities at once, using a
-
-
-
-
- Creating entities
-All available entities, except the TextEntity, are abstract classes, meaning
-they should be extended to create an instance. After creating a class, an
-instance should be created, which can then be added to a YaegerScene, or a
-CompositeEntity through the addEntity(YaegerEntity) method.
In general, the setupEntities() is the appropriate place to do such a
-thing, but it is possible to call addEntity(YaegerEntity) from methods such
-as setupTimers() (see Timing things) or setupSpawners()
-(see below).
Spawning entities at a regular time-interval
-Sometimes many entities should spawn within a scene. For instance, when enemies -spawn to life, or when it snows.
-For such cases, Yaeger provides an EntitySpawner, which was designed for
-specifically this case.
Creating many entities at once, using a TileMap
-When many entities populate the scene, a TileMap can be used to easily
-create them and to let Yaeger calculate the exact location where they should
-be placed.
Imagine the image below should be used multiple times on the scene:
-
,
and should be placed in such a way that we get the following scene:
-
.
A TileMap facilitates this, by defining a two-dimensional array that
-represents the scene and stating which entities should be used. The
-TileMap will then calculate the location and size of each entity,
-instantiate them and add them to the scene.
To be able to use a TileMap, the scene should implement the interface
-TileMapContainer.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/book/elasticlunr.min.js b/book/elasticlunr.min.js
deleted file mode 100644
index 94b20dd2e..000000000
--- a/book/elasticlunr.min.js
+++ /dev/null
@@ -1,10 +0,0 @@
-/**
- * elasticlunr - http://weixsong.github.io
- * Lightweight full-text search engine in Javascript for browser search and offline search. - 0.9.5
- *
- * Copyright (C) 2017 Oliver Nightingale
- * Copyright (C) 2017 Wei Song
- * MIT Licensed
- * @license
- */
-!function(){function e(e){if(null===e||"object"!=typeof e)return e;var t=e.constructor();for(var n in e)e.hasOwnProperty(n)&&(t[n]=e[n]);return t}var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="0.9.5",lunr=t,t.utils={},t.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),t.utils.toString=function(e){return void 0===e||null===e?"":e.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var e=Array.prototype.slice.call(arguments),t=e.pop(),n=e;if("function"!=typeof t)throw new TypeError("last argument must be a function");n.forEach(function(e){this.hasHandler(e)||(this.events[e]=[]),this.events[e].push(t)},this)},t.EventEmitter.prototype.removeListener=function(e,t){if(this.hasHandler(e)){var n=this.events[e].indexOf(t);-1!==n&&(this.events[e].splice(n,1),0==this.events[e].length&&delete this.events[e])}},t.EventEmitter.prototype.emit=function(e){if(this.hasHandler(e)){var t=Array.prototype.slice.call(arguments,1);this.events[e].forEach(function(e){e.apply(void 0,t)},this)}},t.EventEmitter.prototype.hasHandler=function(e){return e in this.events},t.tokenizer=function(e){if(!arguments.length||null===e||void 0===e)return[];if(Array.isArray(e)){var n=e.filter(function(e){return null===e||void 0===e?!1:!0});n=n.map(function(e){return t.utils.toString(e).toLowerCase()});var i=[];return n.forEach(function(e){var n=e.split(t.tokenizer.seperator);i=i.concat(n)},this),i}return e.toString().trim().toLowerCase().split(t.tokenizer.seperator)},t.tokenizer.defaultSeperator=/[\s\-]+/,t.tokenizer.seperator=t.tokenizer.defaultSeperator,t.tokenizer.setSeperator=function(e){null!==e&&void 0!==e&&"object"==typeof e&&(t.tokenizer.seperator=e)},t.tokenizer.resetSeperator=function(){t.tokenizer.seperator=t.tokenizer.defaultSeperator},t.tokenizer.getSeperator=function(){return t.tokenizer.seperator},t.Pipeline=function(){this._queue=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in t.Pipeline.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[n]=e},t.Pipeline.getRegisteredFunction=function(e){return e in t.Pipeline.registeredFunctions!=!0?null:t.Pipeline.registeredFunctions[e]},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.getRegisteredFunction(e);if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._queue.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i+1,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i,0,n)},t.Pipeline.prototype.remove=function(e){var t=this._queue.indexOf(e);-1!==t&&this._queue.splice(t,1)},t.Pipeline.prototype.run=function(e){for(var t=[],n=e.length,i=this._queue.length,o=0;n>o;o++){for(var r=e[o],s=0;i>s&&(r=this._queue[s](r,o,e),void 0!==r&&null!==r);s++);void 0!==r&&null!==r&&t.push(r)}return t},t.Pipeline.prototype.reset=function(){this._queue=[]},t.Pipeline.prototype.get=function(){return this._queue},t.Pipeline.prototype.toJSON=function(){return this._queue.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Index=function(){this._fields=[],this._ref="id",this.pipeline=new t.Pipeline,this.documentStore=new t.DocumentStore,this.index={},this.eventEmitter=new t.EventEmitter,this._idfCache={},this.on("add","remove","update",function(){this._idfCache={}}.bind(this))},t.Index.prototype.on=function(){var e=Array.prototype.slice.call(arguments);return this.eventEmitter.addListener.apply(this.eventEmitter,e)},t.Index.prototype.off=function(e,t){return this.eventEmitter.removeListener(e,t)},t.Index.load=function(e){e.version!==t.version&&t.utils.warn("version mismatch: current "+t.version+" importing "+e.version);var n=new this;n._fields=e.fields,n._ref=e.ref,n.documentStore=t.DocumentStore.load(e.documentStore),n.pipeline=t.Pipeline.load(e.pipeline),n.index={};for(var i in e.index)n.index[i]=t.InvertedIndex.load(e.index[i]);return n},t.Index.prototype.addField=function(e){return this._fields.push(e),this.index[e]=new t.InvertedIndex,this},t.Index.prototype.setRef=function(e){return this._ref=e,this},t.Index.prototype.saveDocument=function(e){return this.documentStore=new t.DocumentStore(e),this},t.Index.prototype.addDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.addDoc(i,e),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));this.documentStore.addFieldLength(i,n,o.length);var r={};o.forEach(function(e){e in r?r[e]+=1:r[e]=1},this);for(var s in r){var u=r[s];u=Math.sqrt(u),this.index[n].addToken(s,{ref:i,tf:u})}},this),n&&this.eventEmitter.emit("add",e,this)}},t.Index.prototype.removeDocByRef=function(e){if(e&&this.documentStore.isDocStored()!==!1&&this.documentStore.hasDoc(e)){var t=this.documentStore.getDoc(e);this.removeDoc(t,!1)}},t.Index.prototype.removeDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.hasDoc(i)&&(this.documentStore.removeDoc(i),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));o.forEach(function(e){this.index[n].removeToken(e,i)},this)},this),n&&this.eventEmitter.emit("remove",e,this))}},t.Index.prototype.updateDoc=function(e,t){var t=void 0===t?!0:t;this.removeDocByRef(e[this._ref],!1),this.addDoc(e,!1),t&&this.eventEmitter.emit("update",e,this)},t.Index.prototype.idf=function(e,t){var n="@"+t+"/"+e;if(Object.prototype.hasOwnProperty.call(this._idfCache,n))return this._idfCache[n];var i=this.index[t].getDocFreq(e),o=1+Math.log(this.documentStore.length/(i+1));return this._idfCache[n]=o,o},t.Index.prototype.getFields=function(){return this._fields.slice()},t.Index.prototype.search=function(e,n){if(!e)return[];e="string"==typeof e?{any:e}:JSON.parse(JSON.stringify(e));var i=null;null!=n&&(i=JSON.stringify(n));for(var o=new t.Configuration(i,this.getFields()).get(),r={},s=Object.keys(e),u=0;u
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Debugging a game
-Yaeger provides a debugging dialog that shows information about the current
-scene, and the machine it is running on. Since this dialog requires the
-Game World Update to refresh itself, it gives little information on a scene that
-extends StaticScene. But on a scene that extends DynamicScene it can give
-insight.
To enable the debugging dialog, start you Yaeger game with the command line -argument as shown in Command line arguments.
-Processors and memory
-When run, a Java-program allocates memory through the JVM, the Java Virtual -Machine, which is part of the Java Runtime Environment (JRE). Depending on the -number of Objects that make up the program, it then uses this memory. Since, -during the lifecycle of a program, more and more Objects are created, you can -see the total used memory increase. When some of these Objects are no longer -used by the program, the memory they use gets cleared by the JVM. Hence, the -total used memory periodically decreases.
-If the total used memory reaches the value of total allocated memory, the -program will come to a grinding halt.
-Entities, suppliers and garbage
-The debugger keeps track of the number of Entities that are present on the -scene.
-| Entity | Explanation |
|---|---|
| Dynamic Entities | Number of entities that extend DynamicEntity |
| Static Entities | Number of entities that extend StaticEntity |
| Suppliers | Number of objects that are able to supply entities to the scene. This means all instances of EntitySpawner, but also the Scene itself. |
| Garbage | Number of Entities that have been marked as garbage, by calling the remove() method. The will be removed from the Scene during the next Game World Update, which should result in a drop of total used memory |
| Key listening entities | Number of entities that implement KeyListener |
Loaded files
-Image and audio files will probably make up most of Yaeger's memory usage. To -minimize this memory footprint, Yaeger reuses images if possible. Meaning, -for entities that use the same image file, this image file gets loaded only -once. The same goes for audio files. Because Yaeger tries to reclaim the -memory if such a file is no longer used, the background audio does get added to -the value in the debugger. As soon as it starts playing, Yaeger loses its -reference to the loaded file, and it continues playing.
- -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/book/entity-interactions.html b/book/entity-interactions.html
deleted file mode 100644
index 4cee7e218..000000000
--- a/book/entity-interactions.html
+++ /dev/null
@@ -1,229 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Entities aka Game Objects
-Entities are what actually make a game. Anything that can be placed on a scene
-will be an Entity and will have to (indirectly) implement the abstract
-superclass YaegerEntity.
Static or dynamic entities
-Just as with scenes, entities are available in static and dynamic version. The -main difference is that a dynamic entity receives a GWU, where a -static entity does not.
-In general static entities will be typically used for menu-items or non-moving -things. Dynamic entities are typically used for anything that should move -around the scene, or should have time-based behaviour in general.
-Note that the GWU originates at the scene. To make a dynamic entity to receive -the GWU, it must be added to a dynamic scene. If added to a static scene, it -will be as static as a static entity.
-Properties for all entities
-Although there a different entities, they all share a basic set of properties. -These include the hue, saturation, brightness, rotation and many more. -One of the more interesting properties is the viewOrder, which can be used -to influence the order in which the entities are rendered on the scene. The -lower the value, the closer the entity is placed to the front of the scene.
-Movement of dynamic entities
-Dynamic entities can move around the scene, by setting their motion. This -movement is applied each GWU, which means the entity moves discretely across the -scene (as opposed to continuously).
-The motion consists of a direction and speed, which can be set
-individually or together. The direction is a double, where the value 0
-denotes downward and 180 logically means upward.
Different types of entities
-There are several Entities available, which can be divided into four different -types:
-| Static Entity | Dynamic Entity | Type |
|---|---|---|
SpriteEntity | DynamicSpriteEntity | Sprite entity |
CircleEntity | DynamicCircleEntity | Shape entity |
EllipseEntity | DynamicEllipseEntity | Shape entity |
RectangleEntity | DynamicRectangleEntity | Shape entity |
TextEntity | DynamicTextEntity | Text entity |
CompositeEntity | DynamicCompositeEntity | Composite entity |
The sprite, shape and text-entity are basic entities. The composite entity -is of a different type. It should be used whenever the entity should -actually consist of several smaller entities.
-Applying physics
-Yaeger supports a basic form of physics for entities, through the
-Newtonian interface. Since this form of physics is based on motion,
-the interface makes only sense when applied to a dynamic entity.
Animating entities
-Both the SpriteEntity and the DynamicSpriteEntity can be used to create
-animated entities. Fot this, the provides image should be a spritesheet, as
-can be seen in the image below:
For complex animation, an Animation can be created to encapsulate a part
-of the spritesheet. For more information, please read the API of the interface
-Animation and its implementations.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/book/faq.html b/book/faq.html
deleted file mode 100644
index 04f983244..000000000
--- a/book/faq.html
+++ /dev/null
@@ -1,255 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Entity collisions
-Entities can interact with each other by using collision detection.
-Collision detection is Yaeger is fairly simple. Each GWU checks if all
-entities that implement Collider intersect with each entity that implements
-Collided. If an intersection occurs, the method onCollision (List<Collider>) is called on the entity that implements Collided.
Because collision detection is performed on each GWU, which has a discreet -value of 60 times/second, if entities move at a high speed, it is possible that -collision detection misses their collision. This is currently a limitation -of Yaeger.
-Entities leaving the scene
-Do be notified whenever an entity leaves the scene border, two interfaces -are available:
--
-
SceneBorderCrossingWatcher
-SceneBorderTouchingWatcher
-
Their event handler will be called whenever an entity respectively leaves -the scene border or merely touches the scene border. As with collision -detection, also this checks is performed only on the GWU, meaning it will -not be extremely accurate with fast moving entities.
- -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/book/favicon.png b/book/favicon.png
deleted file mode 100644
index a5b1aa16c..000000000
Binary files a/book/favicon.png and /dev/null differ
diff --git a/book/favicon.svg b/book/favicon.svg
deleted file mode 100644
index 90e0ea58b..000000000
--- a/book/favicon.svg
+++ /dev/null
@@ -1,22 +0,0 @@
-
-
diff --git a/book/fonts/OPEN-SANS-LICENSE.txt b/book/fonts/OPEN-SANS-LICENSE.txt
deleted file mode 100644
index d64569567..000000000
--- a/book/fonts/OPEN-SANS-LICENSE.txt
+++ /dev/null
@@ -1,202 +0,0 @@
-
- Apache License
- Version 2.0, January 2004
- http://www.apache.org/licenses/
-
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
- 1. Definitions.
-
- "License" shall mean the terms and conditions for use, reproduction,
- and distribution as defined by Sections 1 through 9 of this document.
-
- "Licensor" shall mean the copyright owner or entity authorized by
- the copyright owner that is granting the License.
-
- "Legal Entity" shall mean the union of the acting entity and all
- other entities that control, are controlled by, or are under common
- control with that entity. For the purposes of this definition,
- "control" means (i) the power, direct or indirect, to cause the
- direction or management of such entity, whether by contract or
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
- outstanding shares, or (iii) beneficial ownership of such entity.
-
- "You" (or "Your") shall mean an individual or Legal Entity
- exercising permissions granted by this License.
-
- "Source" form shall mean the preferred form for making modifications,
- including but not limited to software source code, documentation
- source, and configuration files.
-
- "Object" form shall mean any form resulting from mechanical
- transformation or translation of a Source form, including but
- not limited to compiled object code, generated documentation,
- and conversions to other media types.
-
- "Work" shall mean the work of authorship, whether in Source or
- Object form, made available under the License, as indicated by a
- copyright notice that is included in or attached to the work
- (an example is provided in the Appendix below).
-
- "Derivative Works" shall mean any work, whether in Source or Object
- form, that is based on (or derived from) the Work and for which the
- editorial revisions, annotations, elaborations, or other modifications
- represent, as a whole, an original work of authorship. For the purposes
- of this License, Derivative Works shall not include works that remain
- separable from, or merely link (or bind by name) to the interfaces of,
- the Work and Derivative Works thereof.
-
- "Contribution" shall mean any work of authorship, including
- the original version of the Work and any modifications or additions
- to that Work or Derivative Works thereof, that is intentionally
- submitted to Licensor for inclusion in the Work by the copyright owner
- or by an individual or Legal Entity authorized to submit on behalf of
- the copyright owner. For the purposes of this definition, "submitted"
- means any form of electronic, verbal, or written communication sent
- to the Licensor or its representatives, including but not limited to
- communication on electronic mailing lists, source code control systems,
- and issue tracking systems that are managed by, or on behalf of, the
- Licensor for the purpose of discussing and improving the Work, but
- excluding communication that is conspicuously marked or otherwise
- designated in writing by the copyright owner as "Not a Contribution."
-
- "Contributor" shall mean Licensor and any individual or Legal Entity
- on behalf of whom a Contribution has been received by Licensor and
- subsequently incorporated within the Work.
-
- 2. Grant of Copyright License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- copyright license to reproduce, prepare Derivative Works of,
- publicly display, publicly perform, sublicense, and distribute the
- Work and such Derivative Works in Source or Object form.
-
- 3. Grant of Patent License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- (except as stated in this section) patent license to make, have made,
- use, offer to sell, sell, import, and otherwise transfer the Work,
- where such license applies only to those patent claims licensable
- by such Contributor that are necessarily infringed by their
- Contribution(s) alone or by combination of their Contribution(s)
- with the Work to which such Contribution(s) was submitted. If You
- institute patent litigation against any entity (including a
- cross-claim or counterclaim in a lawsuit) alleging that the Work
- or a Contribution incorporated within the Work constitutes direct
- or contributory patent infringement, then any patent licenses
- granted to You under this License for that Work shall terminate
- as of the date such litigation is filed.
-
- 4. Redistribution. You may reproduce and distribute copies of the
- Work or Derivative Works thereof in any medium, with or without
- modifications, and in Source or Object form, provided that You
- meet the following conditions:
-
- (a) You must give any other recipients of the Work or
- Derivative Works a copy of this License; and
-
- (b) You must cause any modified files to carry prominent notices
- stating that You changed the files; and
-
- (c) You must retain, in the Source form of any Derivative Works
- that You distribute, all copyright, patent, trademark, and
- attribution notices from the Source form of the Work,
- excluding those notices that do not pertain to any part of
- the Derivative Works; and
-
- (d) If the Work includes a "NOTICE" text file as part of its
- distribution, then any Derivative Works that You distribute must
- include a readable copy of the attribution notices contained
- within such NOTICE file, excluding those notices that do not
- pertain to any part of the Derivative Works, in at least one
- of the following places: within a NOTICE text file distributed
- as part of the Derivative Works; within the Source form or
- documentation, if provided along with the Derivative Works; or,
- within a display generated by the Derivative Works, if and
- wherever such third-party notices normally appear. The contents
- of the NOTICE file are for informational purposes only and
- do not modify the License. You may add Your own attribution
- notices within Derivative Works that You distribute, alongside
- or as an addendum to the NOTICE text from the Work, provided
- that such additional attribution notices cannot be construed
- as modifying the License.
-
- You may add Your own copyright statement to Your modifications and
- may provide additional or different license terms and conditions
- for use, reproduction, or distribution of Your modifications, or
- for any such Derivative Works as a whole, provided Your use,
- reproduction, and distribution of the Work otherwise complies with
- the conditions stated in this License.
-
- 5. Submission of Contributions. Unless You explicitly state otherwise,
- any Contribution intentionally submitted for inclusion in the Work
- by You to the Licensor shall be under the terms and conditions of
- this License, without any additional terms or conditions.
- Notwithstanding the above, nothing herein shall supersede or modify
- the terms of any separate license agreement you may have executed
- with Licensor regarding such Contributions.
-
- 6. Trademarks. This License does not grant permission to use the trade
- names, trademarks, service marks, or product names of the Licensor,
- except as required for reasonable and customary use in describing the
- origin of the Work and reproducing the content of the NOTICE file.
-
- 7. Disclaimer of Warranty. Unless required by applicable law or
- agreed to in writing, Licensor provides the Work (and each
- Contributor provides its Contributions) on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied, including, without limitation, any warranties or conditions
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
- PARTICULAR PURPOSE. You are solely responsible for determining the
- appropriateness of using or redistributing the Work and assume any
- risks associated with Your exercise of permissions under this License.
-
- 8. Limitation of Liability. In no event and under no legal theory,
- whether in tort (including negligence), contract, or otherwise,
- unless required by applicable law (such as deliberate and grossly
- negligent acts) or agreed to in writing, shall any Contributor be
- liable to You for damages, including any direct, indirect, special,
- incidental, or consequential damages of any character arising as a
- result of this License or out of the use or inability to use the
- Work (including but not limited to damages for loss of goodwill,
- work stoppage, computer failure or malfunction, or any and all
- other commercial damages or losses), even if such Contributor
- has been advised of the possibility of such damages.
-
- 9. Accepting Warranty or Additional Liability. While redistributing
- the Work or Derivative Works thereof, You may choose to offer,
- and charge a fee for, acceptance of support, warranty, indemnity,
- or other liability obligations and/or rights consistent with this
- License. However, in accepting such obligations, You may act only
- on Your own behalf and on Your sole responsibility, not on behalf
- of any other Contributor, and only if You agree to indemnify,
- defend, and hold each Contributor harmless for any liability
- incurred by, or claims asserted against, such Contributor by reason
- of your accepting any such warranty or additional liability.
-
- END OF TERMS AND CONDITIONS
-
- APPENDIX: How to apply the Apache License to your work.
-
- To apply the Apache License to your work, attach the following
- boilerplate notice, with the fields enclosed by brackets "[]"
- replaced with your own identifying information. (Don't include
- the brackets!) The text should be enclosed in the appropriate
- comment syntax for the file format. We also recommend that a
- file or class name and description of purpose be included on the
- same "printed page" as the copyright notice for easier
- identification within third-party archives.
-
- Copyright [yyyy] [name of copyright owner]
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
diff --git a/book/fonts/SOURCE-CODE-PRO-LICENSE.txt b/book/fonts/SOURCE-CODE-PRO-LICENSE.txt
deleted file mode 100644
index 366206f54..000000000
--- a/book/fonts/SOURCE-CODE-PRO-LICENSE.txt
+++ /dev/null
@@ -1,93 +0,0 @@
-Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries.
-
-This Font Software is licensed under the SIL Open Font License, Version 1.1.
-This license is copied below, and is also available with a FAQ at:
-http://scripts.sil.org/OFL
-
-
------------------------------------------------------------
-SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
------------------------------------------------------------
-
-PREAMBLE
-The goals of the Open Font License (OFL) are to stimulate worldwide
-development of collaborative font projects, to support the font creation
-efforts of academic and linguistic communities, and to provide a free and
-open framework in which fonts may be shared and improved in partnership
-with others.
-
-The OFL allows the licensed fonts to be used, studied, modified and
-redistributed freely as long as they are not sold by themselves. The
-fonts, including any derivative works, can be bundled, embedded,
-redistributed and/or sold with any software provided that any reserved
-names are not used by derivative works. The fonts and derivatives,
-however, cannot be released under any other type of license. The
-requirement for fonts to remain under this license does not apply
-to any document created using the fonts or their derivatives.
-
-DEFINITIONS
-"Font Software" refers to the set of files released by the Copyright
-Holder(s) under this license and clearly marked as such. This may
-include source files, build scripts and documentation.
-
-"Reserved Font Name" refers to any names specified as such after the
-copyright statement(s).
-
-"Original Version" refers to the collection of Font Software components as
-distributed by the Copyright Holder(s).
-
-"Modified Version" refers to any derivative made by adding to, deleting,
-or substituting -- in part or in whole -- any of the components of the
-Original Version, by changing formats or by porting the Font Software to a
-new environment.
-
-"Author" refers to any designer, engineer, programmer, technical
-writer or other person who contributed to the Font Software.
-
-PERMISSION & CONDITIONS
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of the Font Software, to use, study, copy, merge, embed, modify,
-redistribute, and sell modified and unmodified copies of the Font
-Software, subject to the following conditions:
-
-1) Neither the Font Software nor any of its individual components,
-in Original or Modified Versions, may be sold by itself.
-
-2) Original or Modified Versions of the Font Software may be bundled,
-redistributed and/or sold with any software, provided that each copy
-contains the above copyright notice and this license. These can be
-included either as stand-alone text files, human-readable headers or
-in the appropriate machine-readable metadata fields within text or
-binary files as long as those fields can be easily viewed by the user.
-
-3) No Modified Version of the Font Software may use the Reserved Font
-Name(s) unless explicit written permission is granted by the corresponding
-Copyright Holder. This restriction only applies to the primary font name as
-presented to the users.
-
-4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
-Software shall not be used to promote, endorse or advertise any
-Modified Version, except to acknowledge the contribution(s) of the
-Copyright Holder(s) and the Author(s) or with their explicit written
-permission.
-
-5) The Font Software, modified or unmodified, in part or in whole,
-must be distributed entirely under this license, and must not be
-distributed under any other license. The requirement for fonts to
-remain under this license does not apply to any document created
-using the Font Software.
-
-TERMINATION
-This license becomes null and void if any of the above conditions are
-not met.
-
-DISCLAIMER
-THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
-OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
-COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
-DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
-OTHER DEALINGS IN THE FONT SOFTWARE.
diff --git a/book/fonts/fonts.css b/book/fonts/fonts.css
deleted file mode 100644
index 858efa598..000000000
--- a/book/fonts/fonts.css
+++ /dev/null
@@ -1,100 +0,0 @@
-/* Open Sans is licensed under the Apache License, Version 2.0. See http://www.apache.org/licenses/LICENSE-2.0 */
-/* Source Code Pro is under the Open Font License. See https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL */
-
-/* open-sans-300 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Open Sans';
- font-style: normal;
- font-weight: 300;
- src: local('Open Sans Light'), local('OpenSans-Light'),
- url('open-sans-v17-all-charsets-300.woff2') format('woff2');
-}
-
-/* open-sans-300italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Open Sans';
- font-style: italic;
- font-weight: 300;
- src: local('Open Sans Light Italic'), local('OpenSans-LightItalic'),
- url('open-sans-v17-all-charsets-300italic.woff2') format('woff2');
-}
-
-/* open-sans-regular - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Open Sans';
- font-style: normal;
- font-weight: 400;
- src: local('Open Sans Regular'), local('OpenSans-Regular'),
- url('open-sans-v17-all-charsets-regular.woff2') format('woff2');
-}
-
-/* open-sans-italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Open Sans';
- font-style: italic;
- font-weight: 400;
- src: local('Open Sans Italic'), local('OpenSans-Italic'),
- url('open-sans-v17-all-charsets-italic.woff2') format('woff2');
-}
-
-/* open-sans-600 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Open Sans';
- font-style: normal;
- font-weight: 600;
- src: local('Open Sans SemiBold'), local('OpenSans-SemiBold'),
- url('open-sans-v17-all-charsets-600.woff2') format('woff2');
-}
-
-/* open-sans-600italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Open Sans';
- font-style: italic;
- font-weight: 600;
- src: local('Open Sans SemiBold Italic'), local('OpenSans-SemiBoldItalic'),
- url('open-sans-v17-all-charsets-600italic.woff2') format('woff2');
-}
-
-/* open-sans-700 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Open Sans';
- font-style: normal;
- font-weight: 700;
- src: local('Open Sans Bold'), local('OpenSans-Bold'),
- url('open-sans-v17-all-charsets-700.woff2') format('woff2');
-}
-
-/* open-sans-700italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Open Sans';
- font-style: italic;
- font-weight: 700;
- src: local('Open Sans Bold Italic'), local('OpenSans-BoldItalic'),
- url('open-sans-v17-all-charsets-700italic.woff2') format('woff2');
-}
-
-/* open-sans-800 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Open Sans';
- font-style: normal;
- font-weight: 800;
- src: local('Open Sans ExtraBold'), local('OpenSans-ExtraBold'),
- url('open-sans-v17-all-charsets-800.woff2') format('woff2');
-}
-
-/* open-sans-800italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Open Sans';
- font-style: italic;
- font-weight: 800;
- src: local('Open Sans ExtraBold Italic'), local('OpenSans-ExtraBoldItalic'),
- url('open-sans-v17-all-charsets-800italic.woff2') format('woff2');
-}
-
-/* source-code-pro-500 - latin_vietnamese_latin-ext_greek_cyrillic-ext_cyrillic */
-@font-face {
- font-family: 'Source Code Pro';
- font-style: normal;
- font-weight: 500;
- src: url('source-code-pro-v11-all-charsets-500.woff2') format('woff2');
-}
diff --git a/book/fonts/open-sans-v17-all-charsets-300.woff2 b/book/fonts/open-sans-v17-all-charsets-300.woff2
deleted file mode 100644
index 9f51be370..000000000
Binary files a/book/fonts/open-sans-v17-all-charsets-300.woff2 and /dev/null differ
diff --git a/book/fonts/open-sans-v17-all-charsets-300italic.woff2 b/book/fonts/open-sans-v17-all-charsets-300italic.woff2
deleted file mode 100644
index 2f5454484..000000000
Binary files a/book/fonts/open-sans-v17-all-charsets-300italic.woff2 and /dev/null differ
diff --git a/book/fonts/open-sans-v17-all-charsets-600.woff2 b/book/fonts/open-sans-v17-all-charsets-600.woff2
deleted file mode 100644
index f503d558d..000000000
Binary files a/book/fonts/open-sans-v17-all-charsets-600.woff2 and /dev/null differ
diff --git a/book/fonts/open-sans-v17-all-charsets-600italic.woff2 b/book/fonts/open-sans-v17-all-charsets-600italic.woff2
deleted file mode 100644
index c99aabe80..000000000
Binary files a/book/fonts/open-sans-v17-all-charsets-600italic.woff2 and /dev/null differ
diff --git a/book/fonts/open-sans-v17-all-charsets-700.woff2 b/book/fonts/open-sans-v17-all-charsets-700.woff2
deleted file mode 100644
index 421a1ab25..000000000
Binary files a/book/fonts/open-sans-v17-all-charsets-700.woff2 and /dev/null differ
diff --git a/book/fonts/open-sans-v17-all-charsets-700italic.woff2 b/book/fonts/open-sans-v17-all-charsets-700italic.woff2
deleted file mode 100644
index 12ce3d20d..000000000
Binary files a/book/fonts/open-sans-v17-all-charsets-700italic.woff2 and /dev/null differ
diff --git a/book/fonts/open-sans-v17-all-charsets-800.woff2 b/book/fonts/open-sans-v17-all-charsets-800.woff2
deleted file mode 100644
index c94a223b0..000000000
Binary files a/book/fonts/open-sans-v17-all-charsets-800.woff2 and /dev/null differ
diff --git a/book/fonts/open-sans-v17-all-charsets-800italic.woff2 b/book/fonts/open-sans-v17-all-charsets-800italic.woff2
deleted file mode 100644
index eed7d3c63..000000000
Binary files a/book/fonts/open-sans-v17-all-charsets-800italic.woff2 and /dev/null differ
diff --git a/book/fonts/open-sans-v17-all-charsets-italic.woff2 b/book/fonts/open-sans-v17-all-charsets-italic.woff2
deleted file mode 100644
index 398b68a08..000000000
Binary files a/book/fonts/open-sans-v17-all-charsets-italic.woff2 and /dev/null differ
diff --git a/book/fonts/open-sans-v17-all-charsets-regular.woff2 b/book/fonts/open-sans-v17-all-charsets-regular.woff2
deleted file mode 100644
index 8383e94c6..000000000
Binary files a/book/fonts/open-sans-v17-all-charsets-regular.woff2 and /dev/null differ
diff --git a/book/fonts/source-code-pro-v11-all-charsets-500.woff2 b/book/fonts/source-code-pro-v11-all-charsets-500.woff2
deleted file mode 100644
index 722245682..000000000
Binary files a/book/fonts/source-code-pro-v11-all-charsets-500.woff2 and /dev/null differ
diff --git a/book/highlight.css b/book/highlight.css
deleted file mode 100644
index 352c79b96..000000000
--- a/book/highlight.css
+++ /dev/null
@@ -1,83 +0,0 @@
-/*
- * An increased contrast highlighting scheme loosely based on the
- * "Base16 Atelier Dune Light" theme by Bram de Haan
- * (http://atelierbram.github.io/syntax-highlighting/atelier-schemes/dune)
- * Original Base16 color scheme by Chris Kempson
- * (https://github.com/chriskempson/base16)
- */
-
-/* Comment */
-.hljs-comment,
-.hljs-quote {
- color: #575757;
-}
-
-/* Red */
-.hljs-variable,
-.hljs-template-variable,
-.hljs-attribute,
-.hljs-attr,
-.hljs-tag,
-.hljs-name,
-.hljs-regexp,
-.hljs-link,
-.hljs-name,
-.hljs-selector-id,
-.hljs-selector-class {
- color: #d70025;
-}
-
-/* Orange */
-.hljs-number,
-.hljs-meta,
-.hljs-built_in,
-.hljs-builtin-name,
-.hljs-literal,
-.hljs-type,
-.hljs-params {
- color: #b21e00;
-}
-
-/* Green */
-.hljs-string,
-.hljs-symbol,
-.hljs-bullet {
- color: #008200;
-}
-
-/* Blue */
-.hljs-title,
-.hljs-section {
- color: #0030f2;
-}
-
-/* Purple */
-.hljs-keyword,
-.hljs-selector-tag {
- color: #9d00ec;
-}
-
-.hljs {
- display: block;
- overflow-x: auto;
- background: #f6f7f6;
- color: #000;
-}
-
-.hljs-emphasis {
- font-style: italic;
-}
-
-.hljs-strong {
- font-weight: bold;
-}
-
-.hljs-addition {
- color: #22863a;
- background-color: #f0fff4;
-}
-
-.hljs-deletion {
- color: #b31d28;
- background-color: #ffeef0;
-}
diff --git a/book/highlight.js b/book/highlight.js
deleted file mode 100644
index 18d24345b..000000000
--- a/book/highlight.js
+++ /dev/null
@@ -1,54 +0,0 @@
-/*
- Highlight.js 10.1.1 (93fd0d73)
- License: BSD-3-Clause
- Copyright (c) 2006-2020, Ivan Sagalaev
-*/
-var hljs=function(){"use strict";function e(n){Object.freeze(n);var t="function"==typeof n;return Object.getOwnPropertyNames(n).forEach((function(r){!Object.hasOwnProperty.call(n,r)||null===n[r]||"object"!=typeof n[r]&&"function"!=typeof n[r]||t&&("caller"===r||"callee"===r||"arguments"===r)||Object.isFrozen(n[r])||e(n[r])})),n}class n{constructor(e){void 0===e.data&&(e.data={}),this.data=e.data}ignoreMatch(){this.ignore=!0}}function t(e){return e.replace(/&/g,"&").replace(//g,">").replace(/"/g,""").replace(/'/g,"'")}function r(e,...n){var t={};for(const n in e)t[n]=e[n];return n.forEach((function(e){for(const n in e)t[n]=e[n]})),t}function a(e){return e.nodeName.toLowerCase()}var i=Object.freeze({__proto__:null,escapeHTML:t,inherit:r,nodeStream:function(e){var n=[];return function e(t,r){for(var i=t.firstChild;i;i=i.nextSibling)3===i.nodeType?r+=i.nodeValue.length:1===i.nodeType&&(n.push({event:"start",offset:r,node:i}),r=e(i,r),a(i).match(/br|hr|img|input/)||n.push({event:"stop",offset:r,node:i}));return r}(e,0),n},mergeStreams:function(e,n,r){var i=0,s="",o=[];function l(){return e.length&&n.length?e[0].offset!==n[0].offset?e[0].offset
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- I use tile maps, timers and entities on the same scene, why not add everything in the
-
-
-
-
- FAQ
-This chapter will sum up known issues and solutions on how to bypass them. The -list is likely not complete, so do feel free to share your findings.
-Some of the issues noted here can be seen as bugs, but that does not mean they -are easily resolved.
-My MP3 file is not being played
-For some reason, not all MP3 files are supported. If playing an MP3 file does -not give any exceptions, but you can not hear it in game, it might be because -the MP3 file is not supported. To correct this, use -a tool to create an MP3 file that is -supported.
-An entity behaves strangely when colliding
-Sometimes an entity behaves unexpected when colliding. For instance, it is set -to change its direction on collision, but when this happens it doesn't -immediately do so. First it seems to stutter a few times, after which it -finally behaves as expected.
-This behaviour likely follows from the fact that the bounding box is used for
-collision detection, and the bounding box is usually larger that the entity we
-can see. Especially if the entity is a SpriteEntity containing a round image,
-the bounding box is still rectangular. When this SpriteEntity is also
-rotating, it is not unlikely that the angles of the rectangular bounding box
-will again cause a collision on the Game World Update after the first collision.
-Because of the second collision the entity will again change its direction
-and this cycle can repeat itself until the entity no longer collides.
A workaround could be to use a CompositeEntity with a smaller hit box.
I use tile maps, timers and entities on the same scene, why not add everything in the setupEntities() method?
-Each YaegerScene exposes the method setupEntities(), which should be used
-to add instances of YaegerEntity to the scene. When tile maps are required,
-the scene should implement the interface TileMapContainer, after which
-the method setupTileMaps() gets exposed and the method addTileMap(TileMap)
-becomes available. The same goes for timers through the interface
-TimerContainer.
In a Scene where either tileMaps or timers are required, it is very well
-possible to ignore the setupTileMaps() or setupTimers() methods and add
-TileMaps or Timers from the setupEntities() method. It is however preferable
-to use the appropriate method, to maximize readability. Scenes can grow rather
-large and to find specific entities, tile maps or timers, it can help to
-group them within their specific methods.
I have a machine with Apple Silicon (M1, M2, M3, etc.)
-If you have a machine with Apple Silicon you might come across an error in the build process like this:
-
To solve this you have to change the architecture of your JDK to one that is not specific to an ARM CPU.
-Go to Project Structure, through File->Project Structure or enter the keycombo: ⌘+;.
You will see something similar to this:
-
Click on Edit next to the SDK overview and then choose Download JDK.
Then choose a JDK that does not have the descriptor: aarch64.
To finish click download.
-
You should be able to build and run your project now.
- -":e:f.tabReplace?e.replace(/\t/g,f.tabReplace):e):e}function E(e){let n=null;const t=function(e){var n=e.className+" ";n+=e.parentNode?e.parentNode.className:"";const t=f.languageDetectRe.exec(n);if(t){var r=T(t[1]);return r||(console.warn(g.replace("{}",t[1])),console.warn("Falling back to no-highlight mode for this block.",e)),r?t[1]:"no-highlight"}return n.split(/\s+/).find(e=>p(e)||T(e))}(e);if(p(t))return;S("before:highlightBlock",{block:e,language:t}),f.useBR?(n=document.createElement("div")).innerHTML=e.innerHTML.replace(/\n/g,"").replace(/
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/book/introduction.html b/book/introduction.html
deleted file mode 100644
index 2adeeb6fa..000000000
--- a/book/introduction.html
+++ /dev/null
@@ -1,220 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- YAEGER_
-Yaeger is Another Education Game Engine Runtime, and a fully functional 2D -game-engine that requires only a traditional Object-Oriented style of -programming. To create a game, classes should be extended and interfaces -should be implemented.
-Its API is based on inheritance and composition and can be seen as a layer of -abstraction on top of JavaFX. JavaFX is only exposed minimally, so it is not -trivially possible to use JavaFX within Yaeger. This is by design.
-Required Java version
-Although Yaeger only exposes a traditional Object-Oriented API, internally its -based on modern Java. To see which specific version is required, please read -the readme on the project GitHub.
-Howto read this manual
-This manual is only meant to give a high-level overview. It will paint a -picture of how a game can be created and what kind of objects are available. -The details and specifics will not be part of this manual. They can be found in -the JavaDoc API.
- -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/book/mark.min.js b/book/mark.min.js
deleted file mode 100644
index 163623188..000000000
--- a/book/mark.min.js
+++ /dev/null
@@ -1,7 +0,0 @@
-/*!***************************************************
-* mark.js v8.11.1
-* https://markjs.io/
-* Copyright (c) 2014–2018, Julian Kühnel
-* Released under the MIT license https://git.io/vwTVl
-*****************************************************/
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):e.Mark=t()}(this,function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(e,t){for(var n=0;n
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- YAEGER_
-Yaeger is Another Education Game Engine Runtime, and a fully functional 2D -game-engine that requires only a traditional Object-Oriented style of -programming. To create a game, classes should be extended and interfaces -should be implemented.
-Its API is based on inheritance and composition and can be seen as a layer of -abstraction on top of JavaFX. JavaFX is only exposed minimally, so it is not -trivially possible to use JavaFX within Yaeger. This is by design.
-Required Java version
-Although Yaeger only exposes a traditional Object-Oriented API, internally its -based on modern Java. To see which specific version is required, please read -the readme on the project GitHub.
-Howto read this manual
-This manual is only meant to give a high-level overview. It will paint a -picture of how a game can be created and what kind of objects are available. -The details and specifics will not be part of this manual. They can be found in -the JavaDoc API.
- -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/book/scenes.html b/book/scenes.html
deleted file mode 100644
index 47629a8f2..000000000
--- a/book/scenes.html
+++ /dev/null
@@ -1,298 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Lifecycle methods of
-Setting up the game, through
-Adding Scenes, through
-
-
-
-Setting up the scene, through
-Adding entities to the scene, through
-
-
-Creating many entities at once, using a
-
-Using a
-
-
-
-
-I use tile maps, timers and entities on the same scene, why not add everything in the
-
-
-
-
- YAEGER_
-Yaeger is Another Education Game Engine Runtime, and a fully functional 2D -game-engine that requires only a traditional Object-Oriented style of -programming. To create a game, classes should be extended and interfaces -should be implemented.
-Its API is based on inheritance and composition and can be seen as a layer of -abstraction on top of JavaFX. JavaFX is only exposed minimally, so it is not -trivially possible to use JavaFX within Yaeger. This is by design.
-Required Java version
-Although Yaeger only exposes a traditional Object-Oriented API, internally its -based on modern Java. To see which specific version is required, please read -the readme on the project GitHub.
-Howto read this manual
-This manual is only meant to give a high-level overview. It will paint a -picture of how a game can be created and what kind of objects are available. -The details and specifics will not be part of this manual. They can be found in -the JavaDoc API.
-Creating a game
-To create a new Yaeger Game, a Java class should be created that
--
-
- extends
YeagerGame
- - contains the following method: -
public static void main(String[]args){
- launch(args);
-}
-Such a game does not have any content yet, but it can be run and will only -show the Splash screen. This Splash screen will be shown before each Yaeger -Game. It can, however, be disabled by adding a commandline argument when running -your game. More information on this can be found -here.
-Lifecycle methods of YeagerGame
-By extending YeagerGame, several methods will need to be implemented.
-These methods are part of the lifecycle of a Yaeger Game and will be responsible
-for setting up the content of the Game.
Setting up the game, through setupGame()
-The first method to implement is setupGame(), which has the following s
-ignature:
@Override
-protected void setupGame(){
-}
-This method will be called first and must be used to set up the width/height -and title of the Game. A typical implementation can look like:
-@Override
-protected void setupGame(){
- setGameTitle("Waterworld");
- setSize(new Size(800,600));
-}
-For more information, check the
-API
-of setupGame()
Adding Scenes, through setupScenes()
-After setupGame() has been called, Yaeger will call setupScenes(). This is
-the second step in the life cycle of a Yaeger Game, in which it expects the
-developer to add Scenes to the Game. Scenes can be added by calling
-addScene(int, YaegerScene). The first parameter is the id of the
-YaegerScene, which can be used to select which YaegerScene will be shown.
-By default, the first scene that is added, will be the first scene that is
-shown.
A typical implementation can ook like:
-@Override
-protected void setupScenes(){
- addScene(0, new TitleScene(this));
- addScene(1, new GameLevel(this));
- addScene(2, new GameOverScene(this));
-}
-Loading a scene
-When adding scenes to the Yaeger Game, the first added scene will also be the
-one that gets loaded and becomes visible. To load a specific scene,
-YaegerGame provides the method setActiveScene(int). Read
-the API
-for the details on how to use this method.
What about the constructor?
-For Plain Old Java Objects (POJO's) the constructor is usually used for -configuring your Object. Although it is not always the best approach, since -the constructor should be only used for constructing an Object, not for -configuring it, it will usually still work.
-With Yaeger, however, it will usually not work. Configuring a YaegerGame
-should only be done from the setupGame() method. Furthermore, the
-constructor of the class that extends YaegerGame should be empty, since Yaeger
-will otherwise not know how to make an instance of it.
Scenes aka levels
-After scenes have been added, Yaeger will load the first one. In this chapter we -will dive deeper into them.
-What are scenes?
-A game is usually comprised of different 'parts', such as levels, menu's or a -game-over screen. Some of those are just simple images and other are complex -levels, with lots of behaviour.
-In Yaeger, all of them implement YaegerScene and will be referred to as a
-Yaeger scene. For a simple Yaeger scene, without any moving parts, Yaeger
-provides the abstract class StaticScene. In case of a complex scene, with
-moving parts and a so-called Game World Update, Yaeger provides a
-DynamicScene. Both can be added to Yaeger, since they both implement
-YaegerScene. Their behaviour is, however, quite different.
StaticScene
-A StaticScene is a scene that is not aware of time. It can contain anything
-you like, and those things will listen to user interaction, but their behaviour
-will not be based on the concept of time. Typical use cases are:
-
-
- A Menu -
- A Game Over scene -
- An inventory selection scene -
DynamicScene
-A DynamicScene is exactly the same as a StaticScene, but it is also aware of
-time. A DynamicScene contains a Game World Update, that calls a
-update(long) method on the scene itself and all dynamic parts of the scene.
-This way, it is possible to create movement and add time-based behaviour.
-Typical use cases are:
-
-
- A level for a game -
- A Splash screen -
- A scene with any form of finiteAnimation -
ScrollableDynamicScene
-A ScrollableDynamicScene is exactly the same as a DynamicScene, but allows a
-different width/height for its content. This way the scene can be much larger
-that the viewable area (the viewport). The width and height of the scene can be
-set from the setupScene() and the part of the scene that is visible can be set
-by setting the scroll-position.
Creating a scene
-To create either a StaticScene or DynamicScene, let your own scene extend
-one of those. As when extending YaegerGame, again two methods will need to be
-implemented:
-
-
setupScene(), which should be used for setting all the properties of the -scene
-setupEntities(), which should be used for adding various entities (Game -Objects) to the Scene
-
Setting up the scene, through setupScene()
-The first method to implement is setupScene(), which has the following
-signature:
@Override
-protected void setupScene(){
- }
-This method will be called first and must be used to set up the background -image, background color and background audio of the scene.
-A typical implementation can look like:
-@Override
-public void setupScene(){
- setBackgroundAudio("audio/ocean.mp3");
- setBackgroundImage("backgrounds/background1.jpg");
- }
-For more information, check the -API
-Adding entities to the scene, through setupEntities()
-After setupScene() has been called, Yaeger will call setupEntities(). This
-is the second step in the life cycle of a YaegerScene, in which it expects the
-developer to add entities to the scene.
Entities can be added by calling addEntity(YaegerEntity). Since entities can
-overlap, their placement will follow the order in which they are added to the
-scene. So newly added entities may overlap entities that had been placed
-earlier.
More on entities in the following chapter of this documentation.
-A typical implementation can look like:
-@Override
-public void setupEntities(){
- addEntity(new Hanny(new Coordinate2D(1,1),waterworld));
- addEntity(new Swordfish(new Coordinate2D(200,300)));
- addEntity(new Sharky(new Coordinate2D(0,100)));
- }
-What about the constructor?
-The same rules apply to a YaegerScene, as do to a YaegerGame. Configuring
-the scene should only be done from the setupScene() method.
It is however possible to use the constructor for basic wiring of objects or -other commons object-oriented practices.
-Entities aka Game Objects
-Entities are what actually make a game. Anything that can be placed on a scene
-will be an Entity and will have to (indirectly) implement the abstract
-superclass YaegerEntity.
Static or dynamic entities
-Just as with scenes, entities are available in static and dynamic version. The -main difference is that a dynamic entity receives a GWU, where a -static entity does not.
-In general static entities will be typically used for menu-items or non-moving -things. Dynamic entities are typically used for anything that should move -around the scene, or should have time-based behaviour in general.
-Note that the GWU originates at the scene. To make a dynamic entity to receive -the GWU, it must be added to a dynamic scene. If added to a static scene, it -will be as static as a static entity.
-Properties for all entities
-Although there a different entities, they all share a basic set of properties. -These include the hue, saturation, brightness, rotation and many more. -One of the more interesting properties is the viewOrder, which can be used -to influence the order in which the entities are rendered on the scene. The -lower the value, the closer the entity is placed to the front of the scene.
-Movement of dynamic entities
-Dynamic entities can move around the scene, by setting their motion. This -movement is applied each GWU, which means the entity moves discretely across the -scene (as opposed to continuously).
-The motion consists of a direction and speed, which can be set
-individually or together. The direction is a double, where the value 0
-denotes downward and 180 logically means upward.
Different types of entities
-There are several Entities available, which can be divided into four different -types:
-| Static Entity | Dynamic Entity | Type |
|---|---|---|
SpriteEntity | DynamicSpriteEntity | Sprite entity |
CircleEntity | DynamicCircleEntity | Shape entity |
EllipseEntity | DynamicEllipseEntity | Shape entity |
RectangleEntity | DynamicRectangleEntity | Shape entity |
TextEntity | DynamicTextEntity | Text entity |
CompositeEntity | DynamicCompositeEntity | Composite entity |
The sprite, shape and text-entity are basic entities. The composite entity -is of a different type. It should be used whenever the entity should -actually consist of several smaller entities.
-Applying physics
-Yaeger supports a basic form of physics for entities, through the
-Newtonian interface. Since this form of physics is based on motion,
-the interface makes only sense when applied to a dynamic entity.
Animating entities
-Both the SpriteEntity and the DynamicSpriteEntity can be used to create
-animated entities. Fot this, the provides image should be a spritesheet, as
-can be seen in the image below:
For complex animation, an Animation can be created to encapsulate a part
-of the spritesheet. For more information, please read the API of the interface
-Animation and its implementations.
Creating entities
-All available entities, except the TextEntity, are abstract classes, meaning
-they should be extended to create an instance. After creating a class, an
-instance should be created, which can then be added to a YaegerScene, or a
-CompositeEntity through the addEntity(YaegerEntity) method.
In general, the setupEntities() is the appropriate place to do such a
-thing, but it is possible to call addEntity(YaegerEntity) from methods such
-as setupTimers() (see Timing things) or setupSpawners()
-(see below).
Spawning entities at a regular time-interval
-Sometimes many entities should spawn within a scene. For instance, when enemies -spawn to life, or when it snows.
-For such cases, Yaeger provides an EntitySpawner, which was designed for
-specifically this case.
Creating many entities at once, using a TileMap
-When many entities populate the scene, a TileMap can be used to easily
-create them and to let Yaeger calculate the exact location where they should
-be placed.
Imagine the image below should be used multiple times on the scene:
-,
and should be placed in such a way that we get the following scene:
-.
A TileMap facilitates this, by defining a two-dimensional array that
-represents the scene and stating which entities should be used. The
-TileMap will then calculate the location and size of each entity,
-instantiate them and add them to the scene.
To be able to use a TileMap, the scene should implement the interface
-TileMapContainer.
Entity collisions
-Entities can interact with each other by using collision detection.
-Collision detection is Yaeger is fairly simple. Each GWU checks if all
-entities that implement Collider intersect with each entity that implements
-Collided. If an intersection occurs, the method onCollision (List<Collider>) is called on the entity that implements Collided.
Because collision detection is performed on each GWU, which has a discreet -value of 60 times/second, if entities move at a high speed, it is possible that -collision detection misses their collision. This is currently a limitation -of Yaeger.
-Entities leaving the scene
-Do be notified whenever an entity leaves the scene border, two interfaces -are available:
--
-
SceneBorderCrossingWatcher
-SceneBorderTouchingWatcher
-
Their event handler will be called whenever an entity respectively leaves -the scene border or merely touches the scene border. As with collision -detection, also this checks is performed only on the GWU, meaning it will -not be extremely accurate with fast moving entities.
-User Input
-A Player can interact with both Entities and Scenes by using the keyboard or -mouse. To enable this interaction the Scene or Entity should implement the -appropriate interface, after which an event handler should be implemented.
-Available interactions
-The table below gives the full list of interfaces that are available. They can
-be found in package
-com.github.hanyaeger.api.userinput and most can be applied to all children of
-both YaegerEntity
-and YaegerScene, only the MouseDraggedListener can only be applied to
-children of YaegerEntity.
In case of a ScrollableDynamicScene, the instances of Coordinate2D that are
-passed to the event handlers report the coordinates of the entire scene, not
-only the viewport.
| Interface | EventHandler(s) |
|---|---|
KeyListener | void onPressedKeysChange(Set<KeyCode>) |
MouseButtonPressedListener | void onMouseButtonPressed(MouseButton, Coordinate2D) |
MouseButtonReleasedListener | void onMouseButtonReleased(MouseButton, Coordinate2D) |
MouseEnterListener | void onMouseEntered() |
MouseExitListener | void onMouseExited() |
MouseMovedListener | void onMouseMoved(Coordinate2D) |
MouseMovedWhileDraggingListener | void onMouseMovedWhileDragging(Coordinate2D) |
MouseDraggedListener | void onMouseDragged(Coordinate2D), void onDropped(Coordinate2D) |
MouseDragEnterListener | void onDragEntered(Coordinate2D, MouseDraggedListener) |
MouseDragExitListener | void onDragExited(Coordinate2D, MouseDraggedListener) |
MouseDropListener | void onDrop(Coordinate2D, MouseDraggedListener) |
Sounds
-Sound are usually an important part of any game. A sound can be either an -effect that is part of the game, or an audio-fragment that is being played at -the background. Both cases are supported by Yaeger, but both require a different -way to make them happen.
-Background audio
-Background audio can be set on either the YaegerGame or YaegerScene. In
-both cases the audio will loop indefinitely until respectively the YaegerGame
-has ended or a different YaegerScene is loaded. This way it is possible to
-set background that will be used throughout the game, or is specific to a
-YaegerScene.
Sound effects
-When a sound effect should be played, a SoundClip can be used. It will only
-be played once and as soon as it has finished it becomes eligible for garbage
-collection. Although the volume of a SoundClip can be set, note that it is
-only applied to the next time it is played. Thus, the volume has to be set
-before play() is called.
Timing things
-As can be read in Scenes aka Levels, there are two different
-implementations of YaegerScene available: a StaticScene and a
-DynamicScene. Their main difference resides in the fact that a DynamicScene
-contains a Game World Update (GWU) to which all instances of DynamicEntity
-added to the scene will listen.
This chapter will discuss the different ways in which the GWU can be used within -Yaeger. It will start by discussing how the GWU gets delegated to all -objects, after which different ways are discussed to use it within your scene or -entity.
-How the GWU is delegated to all objects
-The GWU is initiated by the DynamicScene, and handed down to all dynamic
-entities, timers, spawners and composite entities that were added to the scene.
-This is done in the same order as in which they were added to the scene.
From a programming point-of-view, the GWU is a timed method call. The
-DynamicScene calls its update() method, which then calls all the update()
-methods of all the dynamic entities, timers, spawners and composite entities. If
-those objects themself also contain child-objects, their update() method is
-then also called. And so forth.
Pausing and resuming the GWU
-Since the GWU gets initiated at the level of the DynamicScene, and then
-passed down, it is possible to pause all objects that are called by this
-GWU. For this a DynamicScene provides a method to pause and resume the GWU.
Using a Timer to create time-based events
-On both dynamic scenes and dynamic entities one or more timers can be used
-to create time based events. To use such a Timer the scene or entity
-should implement the interface TimerContainer. After doing so, the method
-setupTimers() should be implemented and the method addTimer(Timer) can
-be called to add an instance of Timer.
Exposing the GWU to scenes and entities
-The GWU is kept internal on all entities and scenes and gets delegated
-downwards. It is, however, possible to expose the GWU to an entity or scene by
-implementing the interface UpdateExposer, which exposes an explicitUpdate (long) method. The value passed to this method represents a timestamp
-of the current time and can be used to keep track of time.
Command Line Arguments
-When run, Yaeger accepts command line arguments. These arguments are primarily -meant for debugging your Game.
-The following arguments are currently supported:
-| Argument | Explanation |
|---|---|
| --noSplash | Skip the Splash screen during start up. |
| --showBB | Show the BoundingBox of all instances of YaegerEntity that implement either Collider or Collided. |
| --showDebug | Show a debug window with information about the Scene. More information on the debug window can be found here. |
| --showGrid | Show a coordinate grid as an overlay on each Scene. This can be useful when figuring out where exactly Entities are on the Scene. |
| --enableScroll | Enable the scrolling gesture for all instances of ScrollableDynamicScene. This can help during the development process of such a scene. |
| --limitGWU | Limit the Game World Update (GWU) to a max of 60/sec. |
| --help | Show this help screen with all commandline options. |
Using command line arguments from an IDE
-Since the command line arguments mainly focus on the development cycle, they -will likely only be used during development of a Yaeger Game. In such a case you -will be working in an IDE, which will also be responsible for creating a run -configuration. Part of such a run configuration will be the (extra) arguments -that can be passed to the application. So check the documentation of your IDE to -see where these arguments can be entered.
-Debugging a game
-Yaeger provides a debugging dialog that shows information about the current
-scene, and the machine it is running on. Since this dialog requires the
-Game World Update to refresh itself, it gives little information on a scene that
-extends StaticScene. But on a scene that extends DynamicScene it can give
-insight.
To enable the debugging dialog, start you Yaeger game with the command line -argument as shown in Command line arguments.
-Processors and memory
-When run, a Java-program allocates memory through the JVM, the Java Virtual -Machine, which is part of the Java Runtime Environment (JRE). Depending on the -number of Objects that make up the program, it then uses this memory. Since, -during the lifecycle of a program, more and more Objects are created, you can -see the total used memory increase. When some of these Objects are no longer -used by the program, the memory they use gets cleared by the JVM. Hence, the -total used memory periodically decreases.
-If the total used memory reaches the value of total allocated memory, the -program will come to a grinding halt.
-Entities, suppliers and garbage
-The debugger keeps track of the number of Entities that are present on the -scene.
-| Entity | Explanation |
|---|---|
| Dynamic Entities | Number of entities that extend DynamicEntity |
| Static Entities | Number of entities that extend StaticEntity |
| Suppliers | Number of objects that are able to supply entities to the scene. This means all instances of EntitySpawner, but also the Scene itself. |
| Garbage | Number of Entities that have been marked as garbage, by calling the remove() method. The will be removed from the Scene during the next Game World Update, which should result in a drop of total used memory |
| Key listening entities | Number of entities that implement KeyListener |
Loaded files
-Image and audio files will probably make up most of Yaeger's memory usage. To -minimize this memory footprint, Yaeger reuses images if possible. Meaning, -for entities that use the same image file, this image file gets loaded only -once. The same goes for audio files. Because Yaeger tries to reclaim the -memory if such a file is no longer used, the background audio does get added to -the value in the debugger. As soon as it starts playing, Yaeger loses its -reference to the loaded file, and it continues playing.
-FAQ
-This chapter will sum up known issues and solutions on how to bypass them. The -list is likely not complete, so do feel free to share your findings.
-Some of the issues noted here can be seen as bugs, but that does not mean they -are easily resolved.
-My MP3 file is not being played
-For some reason, not all MP3 files are supported. If playing an MP3 file does -not give any exceptions, but you can not hear it in game, it might be because -the MP3 file is not supported. To correct this, use -a tool to create an MP3 file that is -supported.
-An entity behaves strangely when colliding
-Sometimes an entity behaves unexpected when colliding. For instance, it is set -to change its direction on collision, but when this happens it doesn't -immediately do so. First it seems to stutter a few times, after which it -finally behaves as expected.
-This behaviour likely follows from the fact that the bounding box is used for
-collision detection, and the bounding box is usually larger that the entity we
-can see. Especially if the entity is a SpriteEntity containing a round image,
-the bounding box is still rectangular. When this SpriteEntity is also
-rotating, it is not unlikely that the angles of the rectangular bounding box
-will again cause a collision on the Game World Update after the first collision.
-Because of the second collision the entity will again change its direction
-and this cycle can repeat itself until the entity no longer collides.
A workaround could be to use a CompositeEntity with a smaller hit box.
I use tile maps, timers and entities on the same scene, why not add everything in the setupEntities() method?
-Each YaegerScene exposes the method setupEntities(), which should be used
-to add instances of YaegerEntity to the scene. When tile maps are required,
-the scene should implement the interface TileMapContainer, after which
-the method setupTileMaps() gets exposed and the method addTileMap(TileMap)
-becomes available. The same goes for timers through the interface
-TimerContainer.
In a Scene where either tileMaps or timers are required, it is very well
-possible to ignore the setupTileMaps() or setupTimers() methods and add
-TileMaps or Timers from the setupEntities() method. It is however preferable
-to use the appropriate method, to maximize readability. Scenes can grow rather
-large and to find specific entities, tile maps or timers, it can help to
-group them within their specific methods.
I have a machine with Apple Silicon (M1, M2, M3, etc.)
-If you have a machine with Apple Silicon you might come across an error in the build process like this:
-
To solve this you have to change the architecture of your JDK to one that is not specific to an ARM CPU.
-Go to Project Structure, through File->Project Structure or enter the keycombo: ⌘+;.
You will see something similar to this:
-
Click on Edit next to the SDK overview and then choose Download JDK.
Then choose a JDK that does not have the descriptor: aarch64.
To finish click download.
-
You should be able to build and run your project now.
- -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/book/searcher.js b/book/searcher.js
deleted file mode 100644
index dc03e0a02..000000000
--- a/book/searcher.js
+++ /dev/null
@@ -1,483 +0,0 @@
-"use strict";
-window.search = window.search || {};
-(function search(search) {
- // Search functionality
- //
- // You can use !hasFocus() to prevent keyhandling in your key
- // event handlers while the user is typing their search.
-
- if (!Mark || !elasticlunr) {
- return;
- }
-
- //IE 11 Compatibility from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith
- if (!String.prototype.startsWith) {
- String.prototype.startsWith = function(search, pos) {
- return this.substr(!pos || pos < 0 ? 0 : +pos, search.length) === search;
- };
- }
-
- var search_wrap = document.getElementById('search-wrapper'),
- searchbar = document.getElementById('searchbar'),
- searchbar_outer = document.getElementById('searchbar-outer'),
- searchresults = document.getElementById('searchresults'),
- searchresults_outer = document.getElementById('searchresults-outer'),
- searchresults_header = document.getElementById('searchresults-header'),
- searchicon = document.getElementById('search-toggle'),
- content = document.getElementById('content'),
-
- searchindex = null,
- doc_urls = [],
- results_options = {
- teaser_word_count: 30,
- limit_results: 30,
- },
- search_options = {
- bool: "AND",
- expand: true,
- fields: {
- title: {boost: 1},
- body: {boost: 1},
- breadcrumbs: {boost: 0}
- }
- },
- mark_exclude = [],
- marker = new Mark(content),
- current_searchterm = "",
- URL_SEARCH_PARAM = 'search',
- URL_MARK_PARAM = 'highlight',
- teaser_count = 0,
-
- SEARCH_HOTKEY_KEYCODE = 83,
- ESCAPE_KEYCODE = 27,
- DOWN_KEYCODE = 40,
- UP_KEYCODE = 38,
- SELECT_KEYCODE = 13;
-
- function hasFocus() {
- return searchbar === document.activeElement;
- }
-
- function removeChildren(elem) {
- while (elem.firstChild) {
- elem.removeChild(elem.firstChild);
- }
- }
-
- // Helper to parse a url into its building blocks.
- function parseURL(url) {
- var a = document.createElement('a');
- a.href = url;
- return {
- source: url,
- protocol: a.protocol.replace(':',''),
- host: a.hostname,
- port: a.port,
- params: (function(){
- var ret = {};
- var seg = a.search.replace(/^\?/,'').split('&');
- var len = seg.length, i = 0, s;
- for (;i
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Setting up the scene, through
-Adding entities to the scene, through
-
-
-
-
- Scenes aka levels
-After scenes have been added, Yaeger will load the first one. In this chapter we -will dive deeper into them.
-What are scenes?
-A game is usually comprised of different 'parts', such as levels, menu's or a -game-over screen. Some of those are just simple images and other are complex -levels, with lots of behaviour.
-In Yaeger, all of them implement YaegerScene and will be referred to as a
-Yaeger scene. For a simple Yaeger scene, without any moving parts, Yaeger
-provides the abstract class StaticScene. In case of a complex scene, with
-moving parts and a so-called Game World Update, Yaeger provides a
-DynamicScene. Both can be added to Yaeger, since they both implement
-YaegerScene. Their behaviour is, however, quite different.
StaticScene
-A StaticScene is a scene that is not aware of time. It can contain anything
-you like, and those things will listen to user interaction, but their behaviour
-will not be based on the concept of time. Typical use cases are:
-
-
- A Menu -
- A Game Over scene -
- An inventory selection scene -
DynamicScene
-A DynamicScene is exactly the same as a StaticScene, but it is also aware of
-time. A DynamicScene contains a Game World Update, that calls a
-update(long) method on the scene itself and all dynamic parts of the scene.
-This way, it is possible to create movement and add time-based behaviour.
-Typical use cases are:
-
-
- A level for a game -
- A Splash screen -
- A scene with any form of finiteAnimation -
ScrollableDynamicScene
-A ScrollableDynamicScene is exactly the same as a DynamicScene, but allows a
-different width/height for its content. This way the scene can be much larger
-that the viewable area (the viewport). The width and height of the scene can be
-set from the setupScene() and the part of the scene that is visible can be set
-by setting the scroll-position.
Creating a scene
-To create either a StaticScene or DynamicScene, let your own scene extend
-one of those. As when extending YaegerGame, again two methods will need to be
-implemented:
-
-
setupScene(), which should be used for setting all the properties of the -scene
-setupEntities(), which should be used for adding various entities (Game -Objects) to the Scene
-
Setting up the scene, through setupScene()
-The first method to implement is setupScene(), which has the following
-signature:
@Override
-protected void setupScene(){
- }
-This method will be called first and must be used to set up the background -image, background color and background audio of the scene.
-A typical implementation can look like:
-@Override
-public void setupScene(){
- setBackgroundAudio("audio/ocean.mp3");
- setBackgroundImage("backgrounds/background1.jpg");
- }
-For more information, check the -API
-Adding entities to the scene, through setupEntities()
-After setupScene() has been called, Yaeger will call setupEntities(). This
-is the second step in the life cycle of a YaegerScene, in which it expects the
-developer to add entities to the scene.
Entities can be added by calling addEntity(YaegerEntity). Since entities can
-overlap, their placement will follow the order in which they are added to the
-scene. So newly added entities may overlap entities that had been placed
-earlier.
More on entities in the following chapter of this documentation.
-A typical implementation can look like:
-@Override
-public void setupEntities(){
- addEntity(new Hanny(new Coordinate2D(1,1),waterworld));
- addEntity(new Swordfish(new Coordinate2D(200,300)));
- addEntity(new Sharky(new Coordinate2D(0,100)));
- }
-What about the constructor?
-The same rules apply to a YaegerScene, as do to a YaegerGame. Configuring
-the scene should only be done from the setupScene() method.
It is however possible to use the constructor for basic wiring of objects or -other commons object-oriented practices.
- -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/book/timing-things.html b/book/timing-things.html
deleted file mode 100644
index 8df0ce8bb..000000000
--- a/book/timing-things.html
+++ /dev/null
@@ -1,244 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Sounds
-Sound are usually an important part of any game. A sound can be either an -effect that is part of the game, or an audio-fragment that is being played at -the background. Both cases are supported by Yaeger, but both require a different -way to make them happen.
-Background audio
-Background audio can be set on either the YaegerGame or YaegerScene. In
-both cases the audio will loop indefinitely until respectively the YaegerGame
-has ended or a different YaegerScene is loaded. This way it is possible to
-set background that will be used throughout the game, or is specific to a
-YaegerScene.
Sound effects
-When a sound effect should be played, a SoundClip can be used. It will only
-be played once and as soon as it has finished it becomes eligible for garbage
-collection. Although the volume of a SoundClip can be set, note that it is
-only applied to the next time it is played. Thus, the volume has to be set
-before play() is called.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/book/toc.html b/book/toc.html
deleted file mode 100644
index 018778c0c..000000000
--- a/book/toc.html
+++ /dev/null
@@ -1,32 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Using a
-
-
-
-
- Timing things
-As can be read in Scenes aka Levels, there are two different
-implementations of YaegerScene available: a StaticScene and a
-DynamicScene. Their main difference resides in the fact that a DynamicScene
-contains a Game World Update (GWU) to which all instances of DynamicEntity
-added to the scene will listen.
This chapter will discuss the different ways in which the GWU can be used within -Yaeger. It will start by discussing how the GWU gets delegated to all -objects, after which different ways are discussed to use it within your scene or -entity.
-How the GWU is delegated to all objects
-The GWU is initiated by the DynamicScene, and handed down to all dynamic
-entities, timers, spawners and composite entities that were added to the scene.
-This is done in the same order as in which they were added to the scene.
From a programming point-of-view, the GWU is a timed method call. The
-DynamicScene calls its update() method, which then calls all the update()
-methods of all the dynamic entities, timers, spawners and composite entities. If
-those objects themself also contain child-objects, their update() method is
-then also called. And so forth.
Pausing and resuming the GWU
-Since the GWU gets initiated at the level of the DynamicScene, and then
-passed down, it is possible to pause all objects that are called by this
-GWU. For this a DynamicScene provides a method to pause and resume the GWU.
Using a Timer to create time-based events
-On both dynamic scenes and dynamic entities one or more timers can be used
-to create time based events. To use such a Timer the scene or entity
-should implement the interface TimerContainer. After doing so, the method
-setupTimers() should be implemented and the method addTimer(Timer) can
-be called to add an instance of Timer.
Exposing the GWU to scenes and entities
-The GWU is kept internal on all entities and scenes and gets delegated
-downwards. It is, however, possible to expose the GWU to an entity or scene by
-implementing the interface UpdateExposer, which exposes an explicitUpdate (long) method. The value passed to this method represents a timestamp
-of the current time and can be used to keep track of time.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/constant-values.html b/constant-values.html
index d77270a6c..b30e2b063 100644
--- a/constant-values.html
+++ b/constant-values.html
@@ -1,7 +1,7 @@
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- User Input
-A Player can interact with both Entities and Scenes by using the keyboard or -mouse. To enable this interaction the Scene or Entity should implement the -appropriate interface, after which an event handler should be implemented.
-Available interactions
-The table below gives the full list of interfaces that are available. They can
-be found in package
-com.github.hanyaeger.api.userinput and most can be applied to all children of
-both YaegerEntity
-and YaegerScene, only the MouseDraggedListener can only be applied to
-children of YaegerEntity.
In case of a ScrollableDynamicScene, the instances of Coordinate2D that are
-passed to the event handlers report the coordinates of the entire scene, not
-only the viewport.
| Interface | EventHandler(s) |
|---|---|
KeyListener | void onPressedKeysChange(Set<KeyCode>) |
MouseButtonPressedListener | void onMouseButtonPressed(MouseButton, Coordinate2D) |
MouseButtonReleasedListener | void onMouseButtonReleased(MouseButton, Coordinate2D) |
MouseEnterListener | void onMouseEntered() |
MouseExitListener | void onMouseExited() |
MouseMovedListener | void onMouseMoved(Coordinate2D) |
MouseMovedWhileDraggingListener | void onMouseMovedWhileDragging(Coordinate2D) |
MouseDraggedListener | void onMouseDragged(Coordinate2D), void onDropped(Coordinate2D) |
MouseDragEnterListener | void onDragEntered(Coordinate2D, MouseDraggedListener) |
MouseDragExitListener | void onDragExited(Coordinate2D, MouseDraggedListener) |
MouseDropListener | void onDrop(Coordinate2D, MouseDraggedListener) |