PageRenderTime 48ms CodeModel.GetById 19ms RepoModel.GetById 0ms app.codeStats 0ms

/doc/core api/Game/prototype/gameSpeed/index.html

http://github.com/TooTallNate/Simple-Game-Framework
HTML | 152 lines | 108 code | 44 blank | 0 comment | 0 complexity | 2750cb89eb3b0fcf0f2ec365b71d9af3 MD5 | raw file
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    2. 

  2.     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
    3. 

  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    4. 

  4. <head>
    5. 

  5.   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    6. 

  6.   <title>SGF  API Specification v0.1 | Game#gameSpeed</title>
    7. 

  7.   <meta name="generator" content="PDoc" />
    8. 

  8.   
    9. 

  9.   <script charset="utf-8" src="../../../../javascripts/pdoc/prototype.js" type="text/javascript"></script>
    10. 

  10.   <script charset="utf-8" src="../../../../javascripts/pdoc/application.js" type="text/javascript"></script>
    11. 

  11. <script charset="utf-8" src="../../../../javascripts/pdoc/tabs.js" type="text/javascript"></script>
    12. 

  12.   <script charset="utf-8" src="../../../../javascripts/pdoc/item_index.js" type="text/javascript"></script>
    13. 

  13.   
    14. 

  14.   <link charset="utf-8" href="../../../../stylesheets/pdoc/api.css" media="screen, projection" rel="stylesheet" type="text/css" />
    15. 

  15. <link charset="utf-8" href="../../../../stylesheets/pdoc/pygments.css" media="screen, projection" rel="stylesheet" type="text/css" />
    16. 

  16.   
    17. 

  17.   <script type="text/javascript">
    18. 

  18.     PDoc.pathPrefix = '../../../../';
    19. 

  19.   </script>
    20. 

  20. </head>
    21. 

  21.   <body>
    22. 

  22. 

  23.     <div id="sidebar">
    24. 

  24.       <ul id="sidebar_tabs" class="sidebar-tabs">
    25. 

  25.         <li>
    26. 

  26.           <a href="#menu_pane">Menu</a>
    27. 

  27.         </li>
    28. 

  28.         <li>
    29. 

  29.           <a href="#search_pane">Search</a>
    30. 

  30.         </li>
    31. 

  31.       </ul> <!-- .sidebar-tabs -->
    32. 

  32. 

  33.       <form class="search-ribbon">
    34. 

  34.         <label>
    35. 

  35.           <span class="hidden">Search</span>
    36. 

  36.           <input type="text" id="search" size="20" title="Search" />
    37. 

  37.         </label>
    38. 

  38.       </form>
    39. 

  39.       
    40. 

  40.       <div class="sidebar-pane scrollable" id="menu_pane">
    41. 

  41.         <ul class="menu-items" id="api_menu"><li><div class="menu-item"><a class="section" href="../../../../components api/index.html" title="Components API section">Components API section</a></div><ul class="menu-section"><li><div class="menu-item"><a class="class" href="../../../../components api/Component/index.html" title="Component (class)">Component</a></div></li>
    42. 

  42. <li><div class="menu-item"><a class="class" href="../../../../components api/Container/index.html" title="Container (class)">Container</a></div></li>
    43. 

  43. <li><div class="menu-item"><a class="class" href="../../../../components api/DumbContainer/index.html" title="DumbContainer (class)">DumbContainer</a></div></li>
    44. 

  44. <li><div class="menu-item"><a class="class" href="../../../../components api/Rectangle/index.html" title="Rectangle (class)">Rectangle</a></div></li>
    45. 

  45. <li><div class="menu-item"><a class="class" href="../../../../components api/Shape/index.html" title="Shape (class)">Shape</a></div></li>
    46. 

  46. <li><div class="menu-item"><a class="class" href="../../../../components api/Sprite/index.html" title="Sprite (class)">Sprite</a></div></li></ul></li>
    47. 

  47. <li><div class="menu-item"><a class="section current-parent" href="../../../../core api/index.html" title="Core API section">Core API section</a></div><ul class="menu-section"><li><div class="menu-item"><a class="class" href="../../../../core api/EventEmitter/index.html" title="EventEmitter (class)">EventEmitter</a></div></li>
    48. 

  48. <li><div class="menu-item"><a class="class current-parent" href="../../../../core api/Game/index.html" title="Game (class)">Game</a></div><ul><li><div class="menu-item"><a class="class-method" href="../../../../core api/Game/getInstance/index.html" title="Game.getInstance (class method)">getInstance</a></div></li>
    49. 

  49. <li><div class="menu-item"><a class="instance-method" href="../../../../core api/Game/prototype/addComponent/index.html" title="Game#addComponent (instance method)">addComponent</a></div></li>
    50. 

  50. <li><div class="menu-item"><a class="instance-method" href="../../../../core api/Game/prototype/getFont/index.html" title="Game#getFont (instance method)">getFont</a></div></li>
    51. 

  51. <li><div class="menu-item"><a class="instance-method" href="../../../../core api/Game/prototype/getScript/index.html" title="Game#getScript (instance method)">getScript</a></div></li>
    52. 

  52. <li><div class="menu-item"><a class="instance-method" href="../../../../core api/Game/prototype/getSound/index.html" title="Game#getSound (instance method)">getSound</a></div></li>
    53. 

  53. <li><div class="menu-item"><a class="instance-method" href="../../../../core api/Game/prototype/getSpriteset/index.html" title="Game#getSpriteset (instance method)">getSpriteset</a></div></li>
    54. 

  54. <li><div class="menu-item"><a class="instance-method" href="../../../../core api/Game/prototype/removeComponent/index.html" title="Game#removeComponent (instance method)">removeComponent</a></div></li>
    55. 

  55. <li><div class="menu-item"><a class="instance-method" href="../../../../core api/Game/prototype/render/index.html" title="Game#render (instance method)">render</a></div></li>
    56. 

  56. <li><div class="menu-item"><a class="instance-method" href="../../../../core api/Game/prototype/setGameSpeed/index.html" title="Game#setGameSpeed (instance method)">setGameSpeed</a></div></li>
    57. 

  57. <li><div class="menu-item"><a class="instance-method" href="../../../../core api/Game/prototype/update/index.html" title="Game#update (instance method)">update</a></div></li>
    58. 

  58. <li><div class="menu-item"><a class="instance-property current" href="../../../../core api/Game/prototype/gameSpeed/index.html" title="Game#gameSpeed (instance property)">gameSpeed</a></div></li>
    59. 

  59. <li><div class="menu-item"><a class="instance-property" href="../../../../core api/Game/prototype/loaded/index.html" title="Game#loaded (instance property)">loaded</a></div></li>
    60. 

  60. <li><div class="menu-item"><a class="instance-property" href="../../../../core api/Game/prototype/maxFrameSkips/index.html" title="Game#maxFrameSkips (instance property)">maxFrameSkips</a></div></li>
    61. 

  61. <li><div class="menu-item"><a class="instance-property" href="../../../../core api/Game/prototype/renderCount/index.html" title="Game#renderCount (instance property)">renderCount</a></div></li>
    62. 

  62. <li><div class="menu-item"><a class="instance-property" href="../../../../core api/Game/prototype/root/index.html" title="Game#root (instance property)">root</a></div></li>
    63. 

  63. <li><div class="menu-item"><a class="instance-property" href="../../../../core api/Game/prototype/updateCount/index.html" title="Game#updateCount (instance property)">updateCount</a></div></li></ul></li>
    64. 

  64. <li><div class="menu-item"><a class="class" href="../../../../core api/Input/index.html" title="Input (class)">Input</a></div></li>
    65. 

  65. <li><div class="menu-item"><a class="class" href="../../../../core api/Screen/index.html" title="Screen (class)">Screen</a></div></li>
    66. 

  66. <li><div class="menu-item"><a class="namespace" href="../../../../core api/SGF/index.html" title="SGF (namespace)">SGF</a></div></li></ul></li>
    67. 

  67. <li><div class="menu-item"><a class="section" href="../../../../resources api/index.html" title="Resources API section">Resources API section</a></div><ul class="menu-section"><li><div class="menu-item"><a class="class" href="../../../../resources api/Font/index.html" title="Font (class)">Font</a></div></li>
    68. 

  68. <li><div class="menu-item"><a class="class" href="../../../../resources api/Script/index.html" title="Script (class)">Script</a></div></li>
    69. 

  69. <li><div class="menu-item"><a class="class" href="../../../../resources api/Spriteset/index.html" title="Spriteset (class)">Spriteset</a></div></li></ul></li>
    70. 

  70. <li><div class="menu-item"><a class="section" href="../../../../networking api/index.html" title="Networking API section">Networking API section</a></div><ul class="menu-section"><li><div class="menu-item"><a class="class" href="../../../../networking api/Client/index.html" title="Client (class)">Client</a></div></li>
    71. 

  71. <li><div class="menu-item"><a class="class" href="../../../../networking api/Server/index.html" title="Server (class)">Server</a></div></li></ul></li></ul><!--- #api_menu =-->
    72. 

  72.       </div> <!-- .sidebar-pane -->
    73. 

  73.       <div class="sidebar-pane" id="search_pane">
    74. 

  74.         <ul id="search_results" class="search-results menu-items scrollable"></ul>
    75. 

  75.       </div> <!-- .sidebar-pane -->
    76. 

  76.     </div> <!-- #sidebar -->
    77. 

  77. 

  78.     <div id="page">
    79. 

  79.       
    80. 

  80. 

  81.       <div id="main" class="page-content">
    82. 

  82.         
    83. 

  83. 

  84. 

  85. 

  86. 

  87. 

  88. <ul class="breadcrumbs clearfix">
    89. 

  89.   <li><a href="../../../../">Home</a></li>
    90. 

  90.   
    91. 

  91.     <li>&rarr; <a href="../../../../core api/index.html" title="Core API section">Core API</a></li>
    92. 

  92.   
    93. 

  93.     <li>&rarr; <a href="../../../../core api/Game/index.html" title="Game (class)">Game</a></li>
    94. 

  94.   
    95. 

  95.     <li>&rarr; <a href="../../../../core api/Game/prototype/gameSpeed/index.html" title="Game#gameSpeed (instance property)">gameSpeed</a></li>
    96. 

  96.   
    97. 

  97. </ul>
    98. 

  98. 

  99. 

  100.   <p id="src_code_href"><a href="http://github.com/TooTallNate/Simple-Game-Framework/blob/1146020/src/html/dist/SGF.debug.js#LID1637">src code</a></p>
    101. 

  101. 

  102. 

  103. <h2 class="page-title">
    104. 

  104.   <span class="type">instance property</span> Game#gameSpeed
    105. 

  105. </h2>
    106. 

  106. 

  107. 

  108. 

  109. 

  110. <div class="section">
    111. 

  111.   <div class="section-title">
    112. 

  112.   </div> <!-- .section-title -->
    113. 

  113.   <div class="section-content">
    114. 

  114.     <div class="method-description">
    115. 

  115.       
    116. 

  116.         <pre class="syntax"><code class="ebnf">Game#gameSpeed &rarr; Number</code></pre>
    117. 

  117. 

  118.       
    119. 

  119. 

  120.       <p>Read-only. The current target updates-per-second the game is attepting
    121. 

  121. to achieve. If you must dynamically change the game speed during
    122. 

  122. runtime, use <code><a href="../../../../core api/Game/prototype/setGameSpeed/index.html" title="Game#setGameSpeed (instance method)">Game#setGameSpeed</a></code> instead.</p>
    123. 

  123. 

  124. <p>The default game speed attempted is <strong>30</strong> (thirty) updates per second.</p>
    125. 

  125.       
    126. 

  126.       
    127. 

  127. 

  128. 

  129. 

  130. 

  131.       
    132. 

  132.     </div>
    133. 

  133.   </div> <!-- .section-content -->
    134. 

  134. </div> <!-- .section -->
    135. 

  135. 

  136.       </div> <!-- #main -->
    137. 

  137.       
    138. 

  138.       <div id="footer">
    139. 

  139.         <p><a href="http://www.simplegameframework.com">Simple Game Framework</a>  API Specification v0.1.</p>
    140. 

  140.         <p>
    141. 

  141.           
    142. 

  142.             Last updated on July 20, 2010 at 00:54 UTC.
    143. 

  143.           
    144. 

  144.           Generated by <a href="http://pdoc.org">PDoc</a>.
    145. 

  145.           Uses <a href="http://famfamfam.com/lab/icons/silk/" title="famfamfam.com: Silk Icons">Silk Icons</a> and portions of <a href="http://github.com/280north/aristo/tree/master" title="280north's aristo at master - GitHub">Aristo</a>.
    146. 

  146.         </p>
    147. 

  147.         <p>footer...</p>
    148. 

  148.       </div> <!-- #footer -->
    149. 

  149. 

  150.     </div> <!-- #page -->
    151. 

  151.   </body>
    152. 

  152. </html>
    153. 

  153.