Skip to content

Commit

Permalink
Updated EOP Docs for version: M2TWEOP-3.1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@EddieEldridge
EddieEldridge committed Mar 22, 2024
1 parent 00ee0d1 commit 9adb9d6
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/_static/LuaLib/extra/readme_imgui.md.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ <h2 class="bannerText">Medieval 2: Total War - Engine Overhaul Project Lua Plugi
<h3 class="welcomeMessage">Welcome to the EOP Lua Plugin Documentation!</h3>
<br>
<h3 class="disclaimerMessage">Please note that many of the examples require additional checks and not all functions are fully documented. If you need additional help, we welcome you to join the Discord!</h3>
<p class="lastUpdatedMessage">Last updated: 2024-03-05 20:14:24</p>
<p class="lastUpdatedMessage">Last updated: 2024-03-22 13:51:45</p>
<a target="_blank" href="https://discord.gg/Epqjm8u2WK">
<img class="discordImage" src="https://img.shields.io/discord/713369537948549191?color=282828&label=DISCORD&style=for-the-badge"/>
</a>
Expand Down
59 changes: 48 additions & 11 deletions docs/_static/LuaLib/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ <h2>Data Types</h2>
<li><a href="#M2TWEOP.toggleDeveloperMode">M2TWEOP.toggleDeveloperMode ()</a></li>
<li><a href="#M2TWEOP.reloadScript">M2TWEOP.reloadScript ()</a></li>
<li><a href="#M2TWEOP.restartLua">M2TWEOP.restartLua ()</a></li>
<li><a href="#M2TWEOP.saveGame">M2TWEOP.saveGame (path)</a></li>
<li><a href="#M2TWEOP.getGameVersion">M2TWEOP.getGameVersion ()</a></li>
<li><a href="#M2TWEOP.setPerfectSpy">M2TWEOP.setPerfectSpy (set)</a></li>
<li><a href="#M2TWEOP.getLocalFactionID">M2TWEOP.getLocalFactionID ()</a></li>
Expand Down Expand Up @@ -1137,7 +1138,7 @@ <h2 class="bannerText">Medieval 2: Total War - Engine Overhaul Project Lua Plugi
<h3 class="welcomeMessage">Welcome to the EOP Lua Plugin Documentation!</h3>
<br>
<h3 class="disclaimerMessage">Please note that many of the examples require additional checks and not all functions are fully documented. If you need additional help, we welcome you to join the Discord!</h3>
<p class="lastUpdatedMessage">Last updated: 2024-03-05 20:14:24</p>
<p class="lastUpdatedMessage">Last updated: 2024-03-22 13:51:45</p>
<a target="_blank" href="https://discord.gg/Epqjm8u2WK">
<img class="discordImage" src="https://img.shields.io/discord/713369537948549191?color=282828&label=DISCORD&style=for-the-badge"/>
</a>
Expand Down Expand Up @@ -1191,6 +1192,10 @@ <h2><a href="#M2TWEOP">M2TWEOP </a></h2>
<td class="summary">Restart the lua plugin (onPluginLoad fires).</td>
</tr>
<tr>
<td class="name" nowrap><a href="#M2TWEOP.saveGame">M2TWEOP.saveGame (path)</a></td>
<td class="summary">Save the game.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#M2TWEOP.getGameVersion">M2TWEOP.getGameVersion ()</a></td>
<td class="summary">Function to get the game version.</td>
</tr>
Expand Down Expand Up @@ -3952,6 +3957,12 @@ <h3>Fields:</h3>



</li>
<li><span class="parameter">restartLua</span>
<span class="types"><a class="type" href="index.html#M2TWEOP.restartLua">restartLua</a></span>



</li>
<li><span class="parameter">toggleDeveloperMode</span>
<span class="types"><a class="type" href="index.html#M2TWEOP.toggleDeveloperMode">toggleDeveloperMode</a></span>
Expand All @@ -3960,7 +3971,7 @@ <h3>Fields:</h3>

</li>
<li><span class="parameter">saveGame</span>
<span class="types"><span class="type">saveGame</span></span>
<span class="types"><a class="type" href="index.html#M2TWEOP.saveGame">saveGame</a></span>



Expand Down Expand Up @@ -4247,6 +4258,32 @@ <h3>Usage:</h3>
<pre class="example"><code class="language-lua" >M2TWEOP.restartLua();</code></pre>
</ul>

</dd>
<dt>
<a name = "M2TWEOP.saveGame"></a>
<strong>M2TWEOP.saveGame (path)</strong>
</dt>
<dd>
<div class="functionDescription">
Save the game.
</div>

<h3>Parameters:</h3>
<ul>
<li><span class="parameter">path</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
(start from mods)
</li>
</ul>




<h3>Usage:</h3>
<ul>
<pre class="example"><code class="language-lua" >M2TWEOP.saveGame(mods/bare_geomod/saves/newsave.sav);</code></pre>
</ul>

</dd>
<dt>
<a name = "M2TWEOP.getGameVersion"></a>
Expand Down Expand Up @@ -6495,7 +6532,7 @@ <h3>Fields:</h3>

</li>
<li><span class="parameter">kill</span>
<span class="types"><a class="type" href="index.html#unit:kill">kill</a></span>
<span class="types"><a class="type" href="index.html#character:kill">kill</a></span>



Expand Down Expand Up @@ -7677,7 +7714,7 @@ <h3>Fields:</h3>

</li>
<li><span class="parameter">kill</span>
<span class="types"><a class="type" href="index.html#unit:kill">kill</a></span>
<span class="types"><a class="type" href="index.html#character:kill">kill</a></span>



Expand Down Expand Up @@ -9600,7 +9637,7 @@ <h3>Fields:</h3>

</li>
<li><span class="parameter">getFort</span>
<span class="types"><a class="type" href="index.html#campaignStruct:getFort">getFort</a></span>
<span class="types"><a class="type" href="index.html#region:getFort">getFort</a></span>



Expand Down Expand Up @@ -10982,7 +11019,7 @@ <h3>Fields:</h3>

</li>
<li><span class="parameter">getConstructionValue</span>
<span class="types"><a class="type" href="index.html#aiPersonality:getConstructionValue">getConstructionValue</a></span>
<span class="types"><a class="type" href="index.html#aiProductionController:getConstructionValue">getConstructionValue</a></span>



Expand Down Expand Up @@ -11274,7 +11311,7 @@ <h3>Fields:</h3>

</li>
<li><span class="parameter">getConstructionValue</span>
<span class="types"><a class="type" href="index.html#aiPersonality:getConstructionValue">getConstructionValue</a></span>
<span class="types"><a class="type" href="index.html#aiProductionController:getConstructionValue">getConstructionValue</a></span>



Expand Down Expand Up @@ -12148,7 +12185,7 @@ <h3>Fields:</h3>

</li>
<li><span class="parameter">getSiege</span>
<span class="types"><a class="type" href="index.html#settlementStruct:getSiege">getSiege</a></span>
<span class="types"><a class="type" href="index.html#fortStruct:getSiege">getSiege</a></span>



Expand Down Expand Up @@ -12603,7 +12640,7 @@ <h3>Fields:</h3>

</li>
<li><span class="parameter">getSiege</span>
<span class="types"><a class="type" href="index.html#settlementStruct:getSiege">getSiege</a></span>
<span class="types"><a class="type" href="index.html#fortStruct:getSiege">getSiege</a></span>



Expand Down Expand Up @@ -27601,7 +27638,7 @@ <h3>Fields:</h3>

</li>
<li><span class="parameter">getFort</span>
<span class="types"><a class="type" href="index.html#campaignStruct:getFort">getFort</a></span>
<span class="types"><a class="type" href="index.html#region:getFort">getFort</a></span>



Expand Down Expand Up @@ -29086,7 +29123,7 @@ <h3>Fields:</h3>

</li>
<li><span class="parameter">getFort</span>
<span class="types"><a class="type" href="index.html#campaignStruct:getFort">getFort</a></span>
<span class="types"><a class="type" href="index.html#region:getFort">getFort</a></span>



Expand Down
2 changes: 1 addition & 1 deletion docs/_static/LuaLib/readme_imgui.md.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ <h2 class="bannerText">Medieval 2: Total War - Engine Overhaul Project Lua Plugi
<h3 class="welcomeMessage">Welcome to the EOP Lua Plugin Documentation!</h3>
<br>
<h3 class="disclaimerMessage">Please note that many of the examples require additional checks and not all functions are fully documented. If you need additional help, we welcome you to join the Discord!</h3>
<p class="lastUpdatedMessage">Last updated: 2024-03-05 20:14:24</p>
<p class="lastUpdatedMessage">Last updated: 2024-03-22 13:51:45</p>
<a target="_blank" href="https://discord.gg/Epqjm8u2WK">
<img class="discordImage" src="https://img.shields.io/discord/713369537948549191?color=282828&label=DISCORD&style=for-the-badge"/>
</a>
Expand Down

0 comments on commit 9adb9d6

Please sign in to comment.