|
|
<!DOCTYPE HTML> <html lang="de"> <head> <!-- Generated by javadoc (17) on Fri Jun 03 15:36:13 CEST 2022 --> <title>BreakoutLevelBase</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-06-03"> <meta name="description" content="declaration: package: playground, class: BreakoutLevelBase"> <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/BreakoutLevelBase.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>Field | </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">playground</a></div> <h1 title="Class BreakoutLevelBase" class="title">Class BreakoutLevelBase</h1> </div> <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> <div class="inheritance"><a href="Playground.html" title="class in playground">playground.Playground</a> <div class="inheritance">playground.BreakoutLevelBase</div> </div> </div> <section class="class-description" id="class-description"> <dl class="notes"> <dt>Direct Known Subclasses:</dt> <dd><code><a href="BreakoutLevel1.html" title="class in playground">BreakoutLevel1</a></code></dd> </dl> <hr> <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">BreakoutLevelBase</span> <span class="extends-implements">extends <a href="Playground.html" title="class in playground">Playground</a></span></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="inherited-list"> <h3 id="fields-inherited-from-class-playground.Playground">Fields inherited from class playground.<a href="Playground.html" title="class in playground">Playground</a></h3> <code><a href="Playground.html#FLAGS_ALL">FLAGS_ALL</a>, <a href="Playground.html#FLAGS_GLOBAL">FLAGS_GLOBAL</a>, <a href="Playground.html#FLAGS_LEVEL">FLAGS_LEVEL</a></code></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">BreakoutLevelBase</a>()</code></div> <div class="col-last even-row-color"> </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-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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#applyGameLogic()" class="member-name-link">applyGameLogic</a>()</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">checks for interactions between GameObjects; notably ball with ego and ball with brick.</div> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#gameOver()" class="member-name-link">gameOver</a>()</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">signals to game engine that the game has finished by game over. called every game loop. default implementation is always false.</div> </div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#levelFinished()" class="member-name-link">levelFinished</a>()</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">signals to game engine that the game has finished by success. called every game loop. default implementation is always false.</div> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#preferredSizeX()" class="member-name-link">preferredSizeX</a>()</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Signal that the level has a size of 700x700 pixels.</div> </div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#preferredSizeY()" class="member-name-link">preferredSizeY</a>()</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Signal that the level has a size of 700x700 pixels.</div> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#prepareLevel(java.lang.String)" class="member-name-link">prepareLevel</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> level)</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> <div class="block">Prepares a generic Breakout-Type level.</div> </div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#redrawLevel(java.awt.Graphics2D)" class="member-name-link">redrawLevel</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/awt/Graphics2D.html" title="class or interface in java.awt" class="external-link">Graphics2D</a> g)</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">unimplemented empty method called by game engine every loop.</div> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#resetRequested()" class="member-name-link">resetRequested</a>()</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">signals to game engine that the game has been requested to be reseted (restart). called every game loop. default implementation is always false.</div> </div> </div> </div> </div> <div class="inherited-list"> <h3 id="methods-inherited-from-class-playground.Playground">Methods inherited from class playground.<a href="Playground.html" title="class in playground">Playground</a></h3> <code><a href="Playground.html#addObject(gameobjects.GameObject)">addObject</a>, <a href="Playground.html#addObjectNow(gameobjects.GameObject)">addObjectNow</a>, <a href="Playground.html#collectObjects(java.lang.String,boolean)">collectObjects</a>, <a href="Playground.html#deleteObject(java.lang.String)">deleteObject</a>, <a href="Playground.html#deleteObjectNow(java.lang.String)">deleteObjectNow</a>, <a href="Playground.html#getGameTime()">getGameTime</a>, <a href="Playground.html#getGlobalFlag(java.lang.String)">getGlobalFlag</a>, <a href="Playground.html#getKeyEvents()">getKeyEvents</a>, <a href="Playground.html#getLevelFlag(java.lang.String)">getLevelFlag</a>, <a href="Playground.html#getMouseEvents()">getMouseEvents</a>, <a href="Playground.html#getObject(java.lang.String)">getObject</a>, <a href="Playground.html#getOrCreateGlobalFlag(java.lang.String,java.lang.Object)">getOrCreateGlobalFlag</a>, <a href="Playground.html#getOrCreateLevelFlag(java.lang.String,java.lang.Object)">getOrCreateLevelFlag</a>, <a href="Playground.html#getSizeX()">getSizeX</a>, <a href="Playground.html#getSizeY()">getSizeY</a>, <a href="Playground.html#getTimestep()">getTimestep</a>, <a href="Playground.html#isPaused()">isPaused</a>, <a href="Playground.html#processKeyEvents(java.util.Stack)">processKeyEvents</a>, <a href="Playground.html#processMouseEvents(java.util.Stack)">processMouseEvents</a>, <a href="Playground.html#redraw(java.awt.Graphics2D)">redraw</a>, <a href="Playground.html#reset()">reset</a>, <a href="Playground.html#resetFlags(int)">resetFlags</a>, <a href="Playground.html#setGameTime(double)">setGameTime</a>, <a href="Playground.html#setGlobalFlag(java.lang.String,java.lang.Object)">setGlobalFlag</a>, <a href="Playground.html#setLevelFlag(java.lang.String,java.lang.Object)">setLevelFlag</a>, <a href="Playground.html#setPaused(boolean)">setPaused</a>, <a href="Playground.html#setTimestep(double)">setTimestep</a>, <a href="Playground.html#togglePause()">togglePause</a>, <a href="Playground.html#updateObjects()">updateObjects</a></code></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/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> <code><a href="https://docs.oracle.com/javase/8/docs/api/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/javase/8/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/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"> <!-- ========= 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>BreakoutLevelBase</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">BreakoutLevelBase</span>()</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="gameOver()"> <h3>gameOver</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">gameOver</span>()</div> <div class="block">signals to game engine that the game has finished by game over. called every game loop. default implementation is always false.</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code><a href="Playground.html#gameOver()">gameOver</a></code> in class <code><a href="Playground.html" title="class in playground">Playground</a></code></dd> <dt>Returns:</dt> <dd>false</dd> </dl> </section> </li> <li> <section class="detail" id="levelFinished()"> <h3>levelFinished</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">levelFinished</span>()</div> <div class="block">signals to game engine that the game has finished by success. called every game loop. default implementation is always false.</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code><a href="Playground.html#levelFinished()">levelFinished</a></code> in class <code><a href="Playground.html" title="class in playground">Playground</a></code></dd> <dt>Returns:</dt> <dd>false</dd> </dl> </section> </li> <li> <section class="detail" id="resetRequested()"> <h3>resetRequested</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">resetRequested</span>()</div> <div class="block">signals to game engine that the game has been requested to be reseted (restart). called every game loop. default implementation is always false.</div> <dl class="notes"> <dt>Returns:</dt> <dd>false</dd> </dl> </section> </li> <li> <section class="detail" id="redrawLevel(java.awt.Graphics2D)"> <h3>redrawLevel</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">redrawLevel</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/awt/Graphics2D.html" title="class or interface in java.awt" class="external-link">Graphics2D</a> g)</span></div> <div class="block">unimplemented empty method called by game engine every loop.</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code><a href="Playground.html#redrawLevel(java.awt.Graphics2D)">redrawLevel</a></code> in class <code><a href="Playground.html" title="class in playground">Playground</a></code></dd> <dt>Parameters:</dt> <dd><code>g</code> - Graphics2D abstract drawing object of java Swing, used to carry out all drawing operations.</dd> </dl> </section> </li> <li> <section class="detail" id="preferredSizeX()"> <h3>preferredSizeX</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">preferredSizeX</span>()</div> <div class="block">Signal that the level has a size of 700x700 pixels.</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code><a href="Playground.html#preferredSizeX()">preferredSizeX</a></code> in class <code><a href="Playground.html" title="class in playground">Playground</a></code></dd> <dt>Returns:</dt> <dd>x size of level 700</dd> </dl> </section> </li> <li> <section class="detail" id="preferredSizeY()"> <h3>preferredSizeY</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">preferredSizeY</span>()</div> <div class="block">Signal that the level has a size of 700x700 pixels.</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code><a href="Playground.html#preferredSizeY()">preferredSizeY</a></code> in class <code><a href="Playground.html" title="class in playground">Playground</a></code></dd> <dt>Returns:</dt> <dd>y size of level 700</dd> </dl> </section> </li> <li> <section class="detail" id="applyGameLogic()"> <h3>applyGameLogic</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">applyGameLogic</span>()</div> <div class="block">checks for interactions between GameObjects; notably ball with ego and ball with brick. In case of detected collisions, it calls either <code>actionIfBallHitsBrick(GameObject, GameObject)</code> or <code>actionIfBallHitsEgo(GameObject, GameObject)</code>. Called every game loop.</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code><a href="Playground.html#applyGameLogic()">applyGameLogic</a></code> in class <code><a href="Playground.html" title="class in playground">Playground</a></code></dd> </dl> </section> </li> <li> <section class="detail" id="prepareLevel(java.lang.String)"> <h3>prepareLevel</h3> <div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">prepareLevel</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> level)</span></div> <div class="block">Prepares a generic Breakout-Type level. This method relies on the methods <code>createEgoObject()</code>, <code>createBall()</code> and <code>createBrick(int, int)</code>, among others, which are meant to be overwritten in subclasses. <br> Attention: the attributes <code>ball</code> and <code>ego</code> need to be set properly to GameObject instances when implementing this method <a href="#prepareLevel(java.lang.String)"><code>prepareLevel(String)</code></a>.</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code><a href="Playground.html#prepareLevel(java.lang.String)">prepareLevel</a></code> in class <code><a href="Playground.html" title="class in playground">Playground</a></code></dd> <dt>Parameters:</dt> <dd><code>level</code> - String passes by the game engine (not used currently and can be ignored).</dd> </dl> </section> </li> </ul> </section> </li> </ul> </section> <!-- ========= END OF CLASS DATA ========= --> </main> </div> </div> </body> </html>
|