You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

214 lines
15 KiB

  1. <!DOCTYPE HTML>
  2. <html lang="de">
  3. <head>
  4. <!-- Generated by javadoc (17) on Fri Jun 17 12:42:43 CEST 2022 -->
  5. <title>BreakoutLevelBaseAdvanced</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1">
  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  8. <meta name="dc.created" content="2022-06-17">
  9. <meta name="description" content="declaration: package: playground, class: BreakoutLevelBaseAdvanced">
  10. <meta name="generator" content="javadoc/ClassWriterImpl">
  11. <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
  12. <link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
  13. <link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
  14. <script type="text/javascript" src="../script.js"></script>
  15. <script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
  16. <script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
  17. </head>
  18. <body class="class-declaration-page">
  19. <script type="text/javascript">var evenRowColor = "even-row-color";
  20. var oddRowColor = "odd-row-color";
  21. var tableTab = "table-tab";
  22. var activeTableTab = "active-table-tab";
  23. var pathtoroot = "../";
  24. loadScripts(document, 'script');</script>
  25. <noscript>
  26. <div>JavaScript is disabled on your browser.</div>
  27. </noscript>
  28. <div class="flex-box">
  29. <header role="banner" class="flex-header">
  30. <nav role="navigation">
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="top-nav" id="navbar-top">
  33. <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
  34. <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
  35. <li><a href="../index.html">Overview</a></li>
  36. <li><a href="package-summary.html">Package</a></li>
  37. <li class="nav-bar-cell1-rev">Class</li>
  38. <li><a href="class-use/BreakoutLevelBaseAdvanced.html">Use</a></li>
  39. <li><a href="package-tree.html">Tree</a></li>
  40. <li><a href="../index-files/index-1.html">Index</a></li>
  41. <li><a href="../help-doc.html#class">Help</a></li>
  42. </ul>
  43. </div>
  44. <div class="sub-nav">
  45. <div>
  46. <ul class="sub-nav-list">
  47. <li>Summary:&nbsp;</li>
  48. <li>Nested&nbsp;|&nbsp;</li>
  49. <li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
  50. <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
  51. <li><a href="#method-summary">Method</a></li>
  52. </ul>
  53. <ul class="sub-nav-list">
  54. <li>Detail:&nbsp;</li>
  55. <li>Field&nbsp;|&nbsp;</li>
  56. <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
  57. <li><a href="#method-detail">Method</a></li>
  58. </ul>
  59. </div>
  60. <div class="nav-list-search"><label for="search-input">SEARCH:</label>
  61. <input type="text" id="search-input" value="search" disabled="disabled">
  62. <input type="reset" id="reset-button" value="reset" disabled="disabled">
  63. </div>
  64. </div>
  65. <!-- ========= END OF TOP NAVBAR ========= -->
  66. <span class="skip-nav" id="skip-navbar-top"></span></nav>
  67. </header>
  68. <div class="flex-content">
  69. <main role="main">
  70. <!-- ======== START OF CLASS DATA ======== -->
  71. <div class="header">
  72. <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">playground</a></div>
  73. <h1 title="Class BreakoutLevelBaseAdvanced" class="title">Class BreakoutLevelBaseAdvanced</h1>
  74. </div>
  75. <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>
  76. <div class="inheritance"><a href="Playground.html" title="class in playground">playground.Playground</a>
  77. <div class="inheritance"><a href="BreakoutLevelBase.html" title="class in playground">playground.BreakoutLevelBase</a>
  78. <div class="inheritance">playground.BreakoutLevelBaseAdvanced</div>
  79. </div>
  80. </div>
  81. </div>
  82. <section class="class-description" id="class-description">
  83. <hr>
  84. <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">BreakoutLevelBaseAdvanced</span>
  85. <span class="extends-implements">extends <a href="BreakoutLevelBase.html" title="class in playground">BreakoutLevelBase</a></span></div>
  86. <div class="block">Advanced version of abstract <a href="BreakoutLevelBase.html" title="class in playground"><code>BreakoutLevelBase</code></a> providing a complete implementation of
  87. <a href="#prepareLevel(java.lang.String)"><code>prepareLevel(String)</code></a>. Additionally abstract methods for number of bricks in X and Y
  88. direction are provided as well as abstract methods for brick sizes and start coordinates.</div>
  89. <dl class="notes">
  90. <dt>See Also:</dt>
  91. <dd>
  92. <ul class="see-list">
  93. <li><code>calcNrBricksX()</code></li>
  94. <li><code>calcNrBricksY()</code></li>
  95. <li><code>getBrickSizeX()</code></li>
  96. <li><code>getBrickSizeY()</code></li>
  97. <li><code>getBrickStartX()</code></li>
  98. <li><code>getBrickStartY()</code></li>
  99. </ul>
  100. </dd>
  101. </dl>
  102. </section>
  103. <section class="summary">
  104. <ul class="summary-list">
  105. <!-- =========== FIELD SUMMARY =========== -->
  106. <li>
  107. <section class="field-summary" id="field-summary">
  108. <h2>Field Summary</h2>
  109. <div class="inherited-list">
  110. <h3 id="fields-inherited-from-class-playground.Playground">Fields inherited from class&nbsp;playground.<a href="Playground.html" title="class in playground">Playground</a></h3>
  111. <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>
  112. </section>
  113. </li>
  114. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  115. <li>
  116. <section class="constructor-summary" id="constructor-summary">
  117. <h2>Constructor Summary</h2>
  118. <div class="caption"><span>Constructors</span></div>
  119. <div class="summary-table two-column-summary">
  120. <div class="table-header col-first">Constructor</div>
  121. <div class="table-header col-last">Description</div>
  122. <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">BreakoutLevelBaseAdvanced</a>()</code></div>
  123. <div class="col-last even-row-color">&nbsp;</div>
  124. </div>
  125. </section>
  126. </li>
  127. <!-- ========== METHOD SUMMARY =========== -->
  128. <li>
  129. <section class="method-summary" id="method-summary">
  130. <h2>Method Summary</h2>
  131. <div id="method-summary-table">
  132. <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-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>
  133. <div id="method-summary-table.tabpanel" role="tabpanel">
  134. <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
  135. <div class="table-header col-first">Modifier and Type</div>
  136. <div class="table-header col-second">Method</div>
  137. <div class="table-header col-last">Description</div>
  138. <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
  139. <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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>&nbsp;level)</code></div>
  140. <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
  141. <div class="block">Prepares a complete Breakout type level and uses the values provided by implementations of
  142. <code>calcNrBricksX()</code> and <code>calcNrBricksY()</code> to generate the stone matrix.</div>
  143. </div>
  144. </div>
  145. </div>
  146. </div>
  147. <div class="inherited-list">
  148. <h3 id="methods-inherited-from-class-playground.BreakoutLevelBase">Methods inherited from class&nbsp;playground.<a href="BreakoutLevelBase.html" title="class in playground">BreakoutLevelBase</a></h3>
  149. <code><a href="BreakoutLevelBase.html#applyGameLogic()">applyGameLogic</a>, <a href="BreakoutLevelBase.html#gameOver()">gameOver</a>, <a href="BreakoutLevelBase.html#levelFinished()">levelFinished</a>, <a href="BreakoutLevelBase.html#preferredSizeX()">preferredSizeX</a>, <a href="BreakoutLevelBase.html#preferredSizeY()">preferredSizeY</a>, <a href="BreakoutLevelBase.html#redrawLevel(java.awt.Graphics2D)">redrawLevel</a>, <a href="BreakoutLevelBase.html#resetRequested()">resetRequested</a></code></div>
  150. <div class="inherited-list">
  151. <h3 id="methods-inherited-from-class-playground.Playground">Methods inherited from class&nbsp;playground.<a href="Playground.html" title="class in playground">Playground</a></h3>
  152. <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>
  153. <div class="inherited-list">
  154. <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;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>
  155. <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>
  156. </section>
  157. </li>
  158. </ul>
  159. </section>
  160. <section class="details">
  161. <ul class="details-list">
  162. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  163. <li>
  164. <section class="constructor-details" id="constructor-detail">
  165. <h2>Constructor Details</h2>
  166. <ul class="member-list">
  167. <li>
  168. <section class="detail" id="&lt;init&gt;()">
  169. <h3>BreakoutLevelBaseAdvanced</h3>
  170. <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">BreakoutLevelBaseAdvanced</span>()</div>
  171. </section>
  172. </li>
  173. </ul>
  174. </section>
  175. </li>
  176. <!-- ============ METHOD DETAIL ========== -->
  177. <li>
  178. <section class="method-details" id="method-detail">
  179. <h2>Method Details</h2>
  180. <ul class="member-list">
  181. <li>
  182. <section class="detail" id="prepareLevel(java.lang.String)">
  183. <h3>prepareLevel</h3>
  184. <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<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>&nbsp;level)</span></div>
  185. <div class="block">Prepares a complete Breakout type level and uses the values provided by implementations of
  186. <code>calcNrBricksX()</code> and <code>calcNrBricksY()</code> to generate the stone matrix.
  187. Furthermore, it relies on the methods <code>BreakoutLevelBase.createEgoObject()</code>, <code>BreakoutLevelBase.createBall()</code> and <code>BreakoutLevelBase.createBrick(int, int)</code>,
  188. which are meant to be overwritten in subclasses. <br>
  189. Attention: For collision detection bricks created by <code>BreakoutLevelBase.createBrick(int, int)</code> need to have the String 'brick' in ID.</div>
  190. <dl class="notes">
  191. <dt>Specified by:</dt>
  192. <dd><code><a href="BreakoutLevelBase.html#prepareLevel(java.lang.String)">prepareLevel</a></code>&nbsp;in class&nbsp;<code><a href="BreakoutLevelBase.html" title="class in playground">BreakoutLevelBase</a></code></dd>
  193. <dt>Parameters:</dt>
  194. <dd><code>level</code> - String passes by the game engine (not used currently and can be ignored).</dd>
  195. <dt>See Also:</dt>
  196. <dd>
  197. <ul class="see-list">
  198. <li><code>for further information.</code></li>
  199. </ul>
  200. </dd>
  201. </dl>
  202. </section>
  203. </li>
  204. </ul>
  205. </section>
  206. </li>
  207. </ul>
  208. </section>
  209. <!-- ========= END OF CLASS DATA ========= -->
  210. </main>
  211. </div>
  212. </div>
  213. </body>
  214. </html>