Skip to content

Commit

Permalink
Updated EOP Docs for version: M2TWEOP-3.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@FynnTW
FynnTW committed Feb 13, 2024
1 parent edd2262 commit 6080245
Show file tree
Hide file tree
Showing 3 changed files with 211 additions and 16 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-02-06 06:50:31</p>
<p class="lastUpdatedMessage">Last updated: 2024-02-13 19:09:49</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
223 changes: 209 additions & 14 deletions docs/_static/LuaLib/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ <h2>Data Types</h2>
<summary><a href="#M2TWEOP">M2TWEOP </a></summary>
<li><a href="#M2TWEOP">M2TWEOP</a></li>
<li><a href="#M2TWEOP.getModPath">M2TWEOP.getModPath ()</a></li>
<li><a href="#M2TWEOP.toggleConsole">M2TWEOP.toggleConsole ()</a></li>
<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>
Expand All @@ -62,6 +66,7 @@ <h2>Data Types</h2>
<li><a href="#M2TWEOP.toggleUnitsBMapHighlight">M2TWEOP.toggleUnitsBMapHighlight ()</a></li>
<li><a href="#M2TWEOP.getBattleCamCoords">M2TWEOP.getBattleCamCoords ()</a></li>
<li><a href="#M2TWEOP.setReligionsLimit">M2TWEOP.setReligionsLimit (newLimit)</a></li>
<li><a href="#M2TWEOP.setEquipmentCosts">M2TWEOP.setEquipmentCosts (equipmentType, newCost)</a></li>
<li><a href="#M2TWEOP.isTileFree">M2TWEOP.isTileFree (X, Y)</a></li>
<li><a href="#M2TWEOP.getGameTileCoordsWithCursor">M2TWEOP.getGameTileCoordsWithCursor ()</a></li>
<li><a href="#M2TWEOP.getTileRegionID">M2TWEOP.getTileRegionID (x, y)</a></li>
Expand Down Expand Up @@ -1133,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-02-06 06:50:31</p>
<p class="lastUpdatedMessage">Last updated: 2024-02-13 19:09:49</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 @@ -1171,6 +1176,22 @@ <h2><a href="#M2TWEOP">M2TWEOP </a></h2>
<td class="summary">Function to return the path to the mod folder, starts from the drive not the game folder.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#M2TWEOP.toggleConsole">M2TWEOP.toggleConsole ()</a></td>
<td class="summary">Open/close the lua console.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#M2TWEOP.toggleDeveloperMode">M2TWEOP.toggleDeveloperMode ()</a></td>
<td class="summary">Toggle developer mode.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#M2TWEOP.reloadScript">M2TWEOP.reloadScript ()</a></td>
<td class="summary">Reload the lua script (without restarting the plugin itself, onPluginLoad doesn't fire).</td>
</tr>
<tr>
<td class="name" nowrap><a href="#M2TWEOP.restartLua">M2TWEOP.restartLua ()</a></td>
<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>
Expand Down Expand Up @@ -1240,7 +1261,11 @@ <h2><a href="#M2TWEOP">M2TWEOP </a></h2>
</tr>
<tr>
<td class="name" nowrap><a href="#M2TWEOP.setReligionsLimit">M2TWEOP.setReligionsLimit (newLimit)</a></td>
<td class="summary">Set the maximum number of religions in the mod (per descr_religions.txt)</td>
<td class="summary">Set the maximum number of religions in the mod (per descr_religions.txt).</td>
</tr>
<tr>
<td class="name" nowrap><a href="#M2TWEOP.setEquipmentCosts">M2TWEOP.setEquipmentCosts (equipmentType, newCost)</a></td>
<td class="summary">Set the siege points required to make different siege equipment.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#M2TWEOP.isTileFree">M2TWEOP.isTileFree (X, Y)</a></td>
Expand Down Expand Up @@ -3920,6 +3945,30 @@ <h3>Fields:</h3>



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



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



</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>



</li>
<li><span class="parameter">saveGame</span>
<span class="types"><a class="type" href="index.html#M2TWEOP.saveGame">saveGame</a></span>
Expand Down Expand Up @@ -3998,6 +4047,12 @@ <h3>Fields:</h3>



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



</li>
<li><span class="parameter">isTileFree</span>
<span class="types"><a class="type" href="index.html#M2TWEOP.isTileFree">isTileFree</a></span>
Expand Down Expand Up @@ -4127,6 +4182,82 @@ <h3>Usage:</h3>
<span class="global">print</span>(mPath);</code></pre>
</ul>

</dd>
<dt>
<a name = "M2TWEOP.toggleConsole"></a>
<strong>M2TWEOP.toggleConsole ()</strong>
</dt>
<dd>
<div class="functionDescription">
Open/close the lua console.
</div>





<h3>Usage:</h3>
<ul>
<pre class="example"><code class="language-lua" >M2TWEOP.toggleConsole();</code></pre>
</ul>

</dd>
<dt>
<a name = "M2TWEOP.toggleDeveloperMode"></a>
<strong>M2TWEOP.toggleDeveloperMode ()</strong>
</dt>
<dd>
<div class="functionDescription">
Toggle developer mode.
</div>





<h3>Usage:</h3>
<ul>
<pre class="example"><code class="language-lua" >M2TWEOP.toggleDeveloperMode();</code></pre>
</ul>

</dd>
<dt>
<a name = "M2TWEOP.reloadScript"></a>
<strong>M2TWEOP.reloadScript ()</strong>
</dt>
<dd>
<div class="functionDescription">
Reload the lua script (without restarting the plugin itself, onPluginLoad doesn't fire).
</div>





<h3>Usage:</h3>
<ul>
<pre class="example"><code class="language-lua" >M2TWEOP.reloadScript();</code></pre>
</ul>

</dd>
<dt>
<a name = "M2TWEOP.restartLua"></a>
<strong>M2TWEOP.restartLua ()</strong>
</dt>
<dd>
<div class="functionDescription">
Restart the lua plugin (onPluginLoad fires).
</div>





<h3>Usage:</h3>
<ul>
<pre class="example"><code class="language-lua" >M2TWEOP.restartLua();</code></pre>
</ul>

</dd>
<dt>
<a name = "M2TWEOP.saveGame"></a>
Expand Down Expand Up @@ -4598,7 +4729,7 @@ <h3>Usage:</h3>
</dt>
<dd>
<div class="functionDescription">
Set the maximum number of religions in the mod (per descr_religions.txt)
Set the maximum number of religions in the mod (per descr_religions.txt). Do not use religions > 10 in CombatVsReligion attributes!
</div>

<h3>Parameters:</h3>
Expand All @@ -4617,6 +4748,38 @@ <h3>Usage:</h3>
<pre class="example"><code class="language-lua" >M2TWEOP.setReligionsLimit(<span class="number">25</span>);</code></pre>
</ul>

</dd>
<dt>
<a name = "M2TWEOP.setEquipmentCosts"></a>
<strong>M2TWEOP.setEquipmentCosts (equipmentType, newCost)</strong>
</dt>
<dd>
<div class="functionDescription">
Set the siege points required to make different siege equipment.
</div>

<h3>Parameters:</h3>
<ul>
<li><span class="parameter">equipmentType</span>
<span class="types"><span class="type">int</span></span>
0 = ram, 1 = ladder, 2 = siege tower
</li>
<li><span class="parameter">newCost</span>
<span class="types"><span class="type">int</span></span>



</li>
</ul>




<h3>Usage:</h3>
<ul>
<pre class="example"><code class="language-lua" >M2TWEOP.setEquipmentCosts(<span class="number">0</span>, <span class="number">25</span>);</code></pre>
</ul>

</dd>
<dt>
<a name = "M2TWEOP.isTileFree"></a>
Expand Down Expand Up @@ -6369,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 @@ -7395,6 +7558,12 @@ <h3>Fields:</h3>



</li>
<li><span class="parameter">regionID</span>
<span class="types"><span class="type">int</span></span>



</li>
<li><span class="parameter">isMarkedToKill</span>
<span class="types"><span class="type">int</span></span>
Expand Down Expand Up @@ -7545,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 @@ -8413,6 +8582,14 @@ <h3>Fields:</h3>



</li>
<li><span class="parameter">combatVsReligion</span>
<span class="types"><span class="type">int[10]</span></span>
Maximum 10. EVEN IF YOU SET RELIGION LIMIT.
</li>
<li><span class="parameter">combatVsFaction</span>
<span class="types"><span class="type">int[31]</span></span>
Maximum 31.
</li>
</ul>

Expand Down Expand Up @@ -9080,12 +9257,6 @@ <h3>Fields:</h3>



</li>
<li><span class="parameter">traitPoints</span>
<span class="types"><span class="type">int</span></span>



</li>
<li><span class="parameter">levels</span>
<span class="types"><a class="type" href="index.html#traitLevel">traitLevel[10]</a></span>
Expand Down Expand Up @@ -12014,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 @@ -12469,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 @@ -13946,6 +14117,12 @@ <h3>Fields:</h3>



</li>
<li><span class="parameter">regionID</span>
<span class="types"><span class="type">int</span></span>



</li>
<li><span class="parameter">settlement</span>
<span class="types"><a class="type" href="index.html#settlementStruct">settlementStruct</a></span>
Expand Down Expand Up @@ -14815,6 +14992,18 @@ <h3>Fields:</h3>



</li>
<li><span class="parameter">siegeTurns</span>
<span class="types"><span class="type">integer</span></span>



</li>
<li><span class="parameter">soldierCount</span>
<span class="types"><span class="type">integer</span></span>



</li>
</ul>

Expand Down Expand Up @@ -31031,7 +31220,7 @@ <h3>Returns:</h3>

<h3>Usage:</h3>
<ul>
<pre class="example"><code class="language-lua" ><span class="keyword">local</span> objective = battleObjective:getType(<span class="number">0</span>)</code></pre>
<pre class="example"><code class="language-lua" ><span class="keyword">local</span> objective = battleObjective:getType()</code></pre>
</ul>

</dd>
Expand Down Expand Up @@ -31289,6 +31478,12 @@ <h3>Fields:</h3>



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



</li>
<li><span class="parameter">settlementWallsBreached</span>
<span class="types"><span class="type">int</span></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-02-06 06:50:31</p>
<p class="lastUpdatedMessage">Last updated: 2024-02-13 19:09:49</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 6080245

Please sign in to comment.