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.

180 lines
12 KiB

  1. <!DOCTYPE HTML>
  2. <html lang="de">
  3. <head>
  4. <!-- Generated by javadoc (17) on Thu May 12 09:13:23 CEST 2022 -->
  5. <title>FallingStarController</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-05-12">
  9. <meta name="description" content="declaration: package: controller, class: FallingStarController">
  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/FallingStarController.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>Field&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">controller</a></div>
  73. <h1 title="Class FallingStarController" class="title">Class FallingStarController</h1>
  74. </div>
  75. <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>
  76. <div class="inheritance"><a href="ObjectController.html" title="class in controller">controller.ObjectController</a>
  77. <div class="inheritance">controller.FallingStarController</div>
  78. </div>
  79. </div>
  80. <section class="class-description" id="class-description">
  81. <hr>
  82. <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">FallingStarController</span>
  83. <span class="extends-implements">extends <a href="ObjectController.html" title="class in controller">ObjectController</a></span></div>
  84. <div class="block">Controls background stars. When they touch the bottom of the display they reappear on top.</div>
  85. </section>
  86. <section class="summary">
  87. <ul class="summary-list">
  88. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  89. <li>
  90. <section class="constructor-summary" id="constructor-summary">
  91. <h2>Constructor Summary</h2>
  92. <div class="caption"><span>Constructors</span></div>
  93. <div class="summary-table two-column-summary">
  94. <div class="table-header col-first">Constructor</div>
  95. <div class="table-header col-last">Description</div>
  96. <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">FallingStarController</a>()</code></div>
  97. <div class="col-last even-row-color">&nbsp;</div>
  98. </div>
  99. </section>
  100. </li>
  101. <!-- ========== METHOD SUMMARY =========== -->
  102. <li>
  103. <section class="method-summary" id="method-summary">
  104. <h2>Method Summary</h2>
  105. <div id="method-summary-table">
  106. <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>
  107. <div id="method-summary-table.tabpanel" role="tabpanel">
  108. <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
  109. <div class="table-header col-first">Modifier and Type</div>
  110. <div class="table-header col-second">Method</div>
  111. <div class="table-header col-last">Description</div>
  112. <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
  113. <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateObject()" class="member-name-link">updateObject</a>()</code></div>
  114. <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
  115. <div class="block">Is called once every game time step by the game itself.</div>
  116. </div>
  117. </div>
  118. </div>
  119. </div>
  120. <div class="inherited-list">
  121. <h3 id="methods-inherited-from-class-controller.ObjectController">Methods inherited from class&nbsp;controller.<a href="ObjectController.html" title="class in controller">ObjectController</a></h3>
  122. <code><a href="ObjectController.html#applySpeedVector()">applySpeedVector</a>, <a href="ObjectController.html#getPlayground()">getPlayground</a>, <a href="ObjectController.html#getTimestep()">getTimestep</a>, <a href="ObjectController.html#getVX()">getVX</a>, <a href="ObjectController.html#getVY()">getVY</a>, <a href="ObjectController.html#getX()">getX</a>, <a href="ObjectController.html#getY()">getY</a>, <a href="ObjectController.html#setDummy(java.lang.String)">setDummy</a>, <a href="ObjectController.html#setObject(gameobjects.GameObject)">setObject</a>, <a href="ObjectController.html#setPlayground(playground.Playground)">setPlayground</a>, <a href="ObjectController.html#setVX(double)">setVX</a>, <a href="ObjectController.html#setVY(double)">setVY</a>, <a href="ObjectController.html#setX(double)">setX</a>, <a href="ObjectController.html#setY(double)">setY</a></code></div>
  123. <div class="inherited-list">
  124. <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;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>
  125. <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>
  126. </section>
  127. </li>
  128. </ul>
  129. </section>
  130. <section class="details">
  131. <ul class="details-list">
  132. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  133. <li>
  134. <section class="constructor-details" id="constructor-detail">
  135. <h2>Constructor Details</h2>
  136. <ul class="member-list">
  137. <li>
  138. <section class="detail" id="&lt;init&gt;()">
  139. <h3>FallingStarController</h3>
  140. <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">FallingStarController</span>()</div>
  141. </section>
  142. </li>
  143. </ul>
  144. </section>
  145. </li>
  146. <!-- ============ METHOD DETAIL ========== -->
  147. <li>
  148. <section class="method-details" id="method-detail">
  149. <h2>Method Details</h2>
  150. <ul class="member-list">
  151. <li>
  152. <section class="detail" id="updateObject()">
  153. <h3>updateObject</h3>
  154. <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">updateObject</span>()</div>
  155. <div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="ObjectController.html#updateObject()">ObjectController</a></code></span></div>
  156. <div class="block">Is called once every game time step by the game itself. NEVER call this directly, not
  157. necessary!<br>
  158. The method can do whatever it likes, including nothing. The attribute <code>ObjectController.gameObject</code>
  159. contains a reference to the controlled object, which allows access to the Playground the object
  160. belongs to (useful for getting the pixel size in x and y of the playing field.<br>
  161. <strong>Recommended:</strong> when implementing this method, call at the end
  162. <a href="ObjectController.html#applySpeedVector()"><code>ObjectController.applySpeedVector()</code></a> method. This is a helper method that sets the new x,y coordinates
  163. for the <code>ObjectController.gameObject</code> correctly.</div>
  164. <dl class="notes">
  165. <dt>Specified by:</dt>
  166. <dd><code><a href="ObjectController.html#updateObject()">updateObject</a></code>&nbsp;in class&nbsp;<code><a href="ObjectController.html" title="class in controller">ObjectController</a></code></dd>
  167. </dl>
  168. </section>
  169. </li>
  170. </ul>
  171. </section>
  172. </li>
  173. </ul>
  174. </section>
  175. <!-- ========= END OF CLASS DATA ========= -->
  176. </main>
  177. </div>
  178. </div>
  179. </body>
  180. </html>