|
|
<!DOCTYPE HTML><html lang="de"><head><!-- Generated by javadoc (17) on Thu May 12 09:13:23 CEST 2022 --><title>GameLoop</title><meta name="viewport" content="width=device-width, initial-scale=1"><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="dc.created" content="2022-05-12"><meta name="description" content="declaration: package: base, class: GameLoop"><meta name="generator" content="javadoc/ClassWriterImpl"><link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"><link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style"><link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style"><script type="text/javascript" src="../script.js"></script><script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script><script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script></head><body class="class-declaration-page"><script type="text/javascript">var evenRowColor = "even-row-color";var oddRowColor = "odd-row-color";var tableTab = "table-tab";var activeTableTab = "active-table-tab";var pathtoroot = "../";loadScripts(document, 'script');</script><noscript><div>JavaScript is disabled on your browser.</div></noscript><div class="flex-box"><header role="banner" class="flex-header"><nav role="navigation"><!-- ========= START OF TOP NAVBAR ======= --><div class="top-nav" id="navbar-top"><div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div><ul id="navbar-top-firstrow" class="nav-list" title="Navigation"><li><a href="../index.html">Overview</a></li><li><a href="package-summary.html">Package</a></li><li class="nav-bar-cell1-rev">Class</li><li><a href="class-use/GameLoop.html">Use</a></li><li><a href="package-tree.html">Tree</a></li><li><a href="../index-files/index-1.html">Index</a></li><li><a href="../help-doc.html#class">Help</a></li></ul></div><div class="sub-nav"><div><ul class="sub-nav-list"><li>Summary: </li><li>Nested | </li><li><a href="#field-summary">Field</a> | </li><li><a href="#constructor-summary">Constr</a> | </li><li><a href="#method-summary">Method</a></li></ul><ul class="sub-nav-list"><li>Detail: </li><li><a href="#field-detail">Field</a> | </li><li><a href="#constructor-detail">Constr</a> | </li><li><a href="#method-detail">Method</a></li></ul></div><div class="nav-list-search"><label for="search-input">SEARCH:</label><input type="text" id="search-input" value="search" disabled="disabled"><input type="reset" id="reset-button" value="reset" disabled="disabled"></div></div><!-- ========= END OF TOP NAVBAR ========= --><span class="skip-nav" id="skip-navbar-top"></span></nav></header><div class="flex-content"><main role="main"><!-- ======== START OF CLASS DATA ======== --><div class="header"><div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">base</a></div><h1 title="Class GameLoop" class="title">Class GameLoop</h1></div><div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a><div class="inheritance">base.GameLoop</div></div><section class="class-description" id="class-description"><dl class="notes"><dt>Direct Known Subclasses:</dt><dd><code><a href="MultiLevelGame.html" title="class in base">MultiLevelGame</a></code></dd></dl><hr><div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">GameLoop</span><span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div><div class="block">Main class starting any game, contains main(). Apart from that, this class manages all non-logical functionalities which should be hidden from a game designer like: <ul> <li>Setting up windows, panels, buttons, action callbacks, ... <li>Reading keyboard inputs <li>Redrawing game window if necessary <li>managing the game time and calling the appropriate <a href="../gameobjects/GameObject.html" title="class in gameobjects"><code>GameObject</code></a> or <a href="../playground/Playground.html" title="class in playground"><code>Playground</code></a> methods periodically, at every time step of the game. </ul> There will normally never be a need to modify this file, a designer/game programmer should always redefine the <a href="../gameobjects/GameObject.html" title="class in gameobjects"><code>GameObject</code></a> and <a href="../playground/Playground.html" title="class in playground"><code>Playground</code></a> classes and implement new functionality there. To make a long story short<br></div></section><section class="summary"><ul class="summary-list"><!-- =========== FIELD SUMMARY =========== --><li><section class="field-summary" id="field-summary"><h2>Field Summary</h2><div class="caption"><span>Fields</span></div><div class="summary-table three-column-summary"><div class="table-header col-first">Modifier and Type</div><div class="table-header col-second">Field</div><div class="table-header col-last">Description</div><div class="col-first even-row-color"><code>static int</code></div><div class="col-second even-row-color"><code><a href="#SIZEX" class="member-name-link">SIZEX</a></code></div><div class="col-last even-row-color"><div class="block">Pixel width of Game GUI ( above 0)</div></div><div class="col-first odd-row-color"><code>static int</code></div><div class="col-second odd-row-color"><code><a href="#SIZEY" class="member-name-link">SIZEY</a></code></div><div class="col-last odd-row-color"><div class="block">Pixel height of Game GUI (above 0)</div></div></div></section></li><!-- ======== CONSTRUCTOR SUMMARY ======== --><li><section class="constructor-summary" id="constructor-summary"><h2>Constructor Summary</h2><div class="caption"><span>Constructors</span></div><div class="summary-table two-column-summary"><div class="table-header col-first">Constructor</div><div class="table-header col-last">Description</div><div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">GameLoop</a>()</code></div><div class="col-last even-row-color"><div class="block">constructor which calls <code>defineLevels()</code>, which adds all levels of this game.</div></div></div></section></li><!-- ========== METHOD SUMMARY =========== --><li><section class="method-summary" id="method-summary"><h2>Method Summary</h2><div id="method-summary-table"><div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div><div id="method-summary-table.tabpanel" role="tabpanel"><div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"><div class="table-header col-first">Modifier and Type</div><div class="table-header col-second">Method</div><div class="table-header col-last">Description</div><div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div><div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#main(java.lang.String%5B%5D)" class="member-name-link">main</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] args)</code></div><div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><div class="block">main to start the whole application.</div></div><div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div><div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#runGame(java.lang.String%5B%5D)" class="member-name-link">runGame</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] args)</code></div><div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><div class="block">loops over all <code>levels</code> and implements the game loop to update continuously the level during play time</div></div></div></div></div><div class="inherited-list"><h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3><code><a href="https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div></section></li></ul></section><section class="details"><ul class="details-list"><!-- ============ FIELD DETAIL =========== --><li><section class="field-details" id="field-detail"><h2>Field Details</h2><ul class="member-list"><li><section class="detail" id="SIZEX"><h3>SIZEX</h3><div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">SIZEX</span></div><div class="block">Pixel width of Game GUI ( above 0)</div></section></li><li><section class="detail" id="SIZEY"><h3>SIZEY</h3><div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">SIZEY</span></div><div class="block">Pixel height of Game GUI (above 0)</div></section></li></ul></section></li><!-- ========= CONSTRUCTOR DETAIL ======== --><li><section class="constructor-details" id="constructor-detail"><h2>Constructor Details</h2><ul class="member-list"><li><section class="detail" id="<init>()"><h3>GameLoop</h3><div class="member-signature"><span class="modifiers">public</span> <span class="element-name">GameLoop</span>()</div><div class="block">constructor which calls <code>defineLevels()</code>, which adds all levels of this game.</div></section></li></ul></section></li><!-- ============ METHOD DETAIL ========== --><li><section class="method-details" id="method-detail"><h2>Method Details</h2><ul class="member-list"><li><section class="detail" id="runGame(java.lang.String[])"><h3>runGame</h3><div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">runGame</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] args)</span> throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div><div class="block">loops over all <code>levels</code> and implements the game loop to update continuously the level during play time</div><dl class="notes"><dt>Parameters:</dt><dd><code>args</code> - command line arguments forwarded (currently ignored)</dd><dt>Throws:</dt><dd><code><a href="https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if hitghscore.txt cannot be written.</dd></dl></section></li><li><section class="detail" id="main(java.lang.String[])"><h3>main</h3><div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">main</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] args)</span> throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div><div class="block">main to start the whole application. initializes the <code>levels</code> ArrayList of Playground instances (levels) to be played with one level <code>SpaceInvadersLevel</code> in constructor of <a href="#%3Cinit%3E()"><code>GameLoop()</code></a>.</div><dl class="notes"><dt>Parameters:</dt><dd><code>args</code> - Java default command line args, forwarded to <a href="#runGame(java.lang.String%5B%5D)"><code>runGame(String[])</code></a></dd><dt>Throws:</dt><dd><code><a href="https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - in case highscore.txt cannot be written.</dd></dl></section></li></ul></section></li></ul></section><!-- ========= END OF CLASS DATA ========= --></main></div></div></body></html>
|
