Documentation from 1e66cb5 [no CI]

corsixth_lua/_0_1_app.html

@@ -22,7 +22,7 @@
  </ul>
  <div class="content">
  <h2 class="class">App Class</h2>
-<h3 class="class">CorsixTH 0.69-rc1</h3> 
+<h3 class="class">CorsixTH 0.69.0</h3> 
 <div class="class_info">
  <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L31">line 31 of Lua/app.lua</a>.
 </div>
@@ -375,7 +375,7 @@
  <td class="d">?</td>
  </tr>
  </table></p><p>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1867">line 1867 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1868">line 1868 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">
@@ -431,14 +431,14 @@ is a part of a campaign. if not part of a campaign then campaign_info is nil.</t
  <h5><a name="_0_1_app_1abandon">function App:abandon()</a></h5>
  <p>
  Exits the game completely without saving the config i.e. Alt+F4 for Quit Application<br/><br/>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1942">line 1942 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1943">line 1943 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">
  <h5><a name="_0_1_app_1after_load">function App:afterLoad()</a></h5>
  <p>
  This function is automatically called after loading a game and serves for compatibility.<br/><br/>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1947">line 1947 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1948">line 1948 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">
@@ -459,7 +459,7 @@ is a part of a campaign. if not part of a campaign then campaign_info is nil.</t
  <td class="d"> What graphics set is used</td>
  </tr>
  </table></p><p>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1842">line 1842 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1843">line 1843 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">
@@ -467,7 +467,7 @@ is a part of a campaign. if not part of a campaign then campaign_info is nil.</t
  <p>
  that any current version with a patch in its name (Beta, RC, etc) will be older<br/><br/>
  than the update table's version if their major, minor, and revision components match.<br/><br/>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L2013">line 2013 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L2014">line 2014 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">
@@ -527,7 +527,7 @@ This will give translators an idea which strings are missing in their translatio
 - method(version) reports the difference between two savegame versions</td>
  </tr>
  </table></p><p>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1764">line 1764 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1765">line 1765 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">
@@ -568,7 +568,7 @@ This will give translators an idea which strings are missing in their translatio
  <h5><a name="_0_1_app_1exit">function App:exit()</a></h5>
  <p>
  Exits the game completely (no confirmation window)<br/><br/>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1935">line 1935 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1936">line 1936 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">
@@ -602,7 +602,7 @@ This will give translators an idea which strings are missing in their translatio
  <h5><a name="_0_1_app_1finish_video_update">function App:finishVideoUpdate()</a></h5>
  <p>
  Update / start any resources relying on a video object<br/><br/>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L2106">line 2106 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L2107">line 2107 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">
@@ -621,7 +621,7 @@ This will give translators an idea which strings are missing in their translatio
  <h5><a name="_0_1_app_1gamelog_header">function App:gamelogHeader()</a></h5>
  <p>
  Generate information about user's system and the program<br/><br/>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L2126">line 2126 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L2127">line 2127 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">
@@ -635,7 +635,7 @@ This will give translators an idea which strings are missing in their translatio
  <h5><a name="_0_1_app_1get_current_version">function App:getCurrentVersion()</a></h5>
  <p>
  Retrieve the current savegame version as defined in the application.<br/><br/>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1722">line 1722 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1723">line 1723 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">
@@ -678,7 +678,7 @@ This will give translators an idea which strings are missing in their translatio
  <td class="d"> What to lookup, uses application version if blank</td>
  </tr>
  </table></p><p>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1727">line 1727 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1728">line 1728 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">
@@ -695,7 +695,7 @@ This will give translators an idea which strings are missing in their translatio
  <td class="d"> The version to look up</td>
  </tr>
  </table></p><p>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1752">line 1752 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1753">line 1753 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">
@@ -750,7 +750,7 @@ TODO: Integrate other directory initialisations into this function<br/><br/>
  <div class="method">
  <h5><a name="_0_1_app_1is_audio_enabled">function App:isAudioEnabled()</a></h5>
  <p>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L2114">line 2114 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L2115">line 2115 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">
@@ -771,13 +771,13 @@ TODO: Integrate other directory initialisations into this function<br/><br/>
  <div class="method">
  <h5><a name="_0_1_app_1is_update_check_available">function App:isUpdateCheckAvailable()</a></h5>
  <p>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L2122">line 2122 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L2123">line 2123 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">
  <h5><a name="_0_1_app_1is_update_check_disabled_by_config">function App:isUpdateCheckDisabledByConfig()</a></h5>
  <p>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L2118">line 2118 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L2119">line 2119 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">
@@ -792,7 +792,7 @@ TODO: Integrate other directory initialisations into this function<br/><br/>
  <td class="d">?</td>
  </tr>
  </table></p><p>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1825">line 1825 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1826">line 1826 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">
@@ -909,7 +909,7 @@ TODO: Integrate other directory initialisations into this function<br/><br/>
  <h5><a name="_0_1_app_1map_edit">function App:mapEdit()</a></h5>
  <p>
  Begin the map editor<br/><br/>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1930">line 1930 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1931">line 1931 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">
@@ -1143,20 +1143,20 @@ TODO: Integrate other directory initialisations into this function<br/><br/>
  <h5><a name="_0_1_app_1prepare_video_update">function App:prepareVideoUpdate()</a></h5>
  <p>
  Free up / stop any resources relying on the current video object<br/><br/>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L2100">line 2100 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L2101">line 2101 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">
  <h5><a name="_0_1_app_1quick_load">function App:quickLoad()</a></h5>
  <p>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1832">line 1832 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1833">line 1833 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">
  <h5><a name="_0_1_app_1quick_save">function App:quickSave()</a></h5>
  <p>
  Omit the usual file extension so this file cannot be seen from the normal load and save screen and cannot be overwritten<br/><br/>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1819">line 1819 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1820">line 1820 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">
@@ -1273,7 +1273,7 @@ meta-directories, and get resolved to real directories in the function.</td>
  <td class="d"> Optional message to the player</td>
  </tr>
  </table></p><p>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1901">line 1901 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1902">line 1902 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">
@@ -1294,7 +1294,7 @@ meta-directories, and get resolved to real directories in the function.</td>
  <td class="d">?</td>
  </tr>
  </table></p><p>
- <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1815">line 1815 of Lua/app.lua</a>.
+ <strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/app.lua#L1816">line 1816 of Lua/app.lua</a>.
  </p>
  </div>
  <div class="method">

corsixth_lua/class_hierarchy.html

@@ -36,7 +36,7 @@
  <span><a href="_0_1_announcer.html" class="class">Announcer</a> - Announces audible messages to the player.</span>
 </li>
  <li>
- <span><a href="_0_1_app.html" class="class">App</a> - CorsixTH 0.69-rc1</span>
+ <span><a href="_0_1_app.html" class="class">App</a> - CorsixTH 0.69.0</span>
 </li>
  <li>
  <span><a href="_0_1_audio.html" class="class">Audio</a> - Layer which handles the Lua-facing side of loading and playing audio.</span>

corsixth_lua/class_list.html

@@ -49,7 +49,7 @@
  </tr>
  <tr>
  <td><a href="_0_1_app.html">App</a></td>
- <td>CorsixTH 0.69-rc1</td>
+ <td>CorsixTH 0.69.0</td>
  </tr>
  <tr>
  <td><a href="_0_1_atom_analyser.html">AtomAnalyser</a></td>

corsixth_lua/index.html

@@ -49,7 +49,7 @@
  </tr>
  <tr>
  <td><a href="_0_1_app.html">App</a></td>
- <td>CorsixTH 0.69-rc1</td>
+ <td>CorsixTH 0.69.0</td>
  </tr>
  <tr>
  <td><a href="_0_1_atom_analyser.html">AtomAnalyser</a></td>