Skip to content

Commit

Permalink
Updated EOP Docs for version: M2TWEOP-3.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
@FynnTW
FynnTW committed Mar 30, 2024
1 parent a54f2d3 commit 5157f98
Show file tree
Hide file tree
Showing 3 changed files with 134 additions and 5 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-22 13:51:45</p>
<p class="lastUpdatedMessage">Last updated: 2024-03-30 15:32:32</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
135 changes: 132 additions & 3 deletions docs/_static/LuaLib/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,7 @@ <h2>Data Types</h2>
<li><a href="#factionStruct:getBattleVsFactionStats">factionStruct:getBattleVsFactionStats (targetFactionID)</a></li>
<li><a href="#factionStruct:getAiFactionValues">factionStruct:getAiFactionValues ()</a></li>
<li><a href="#factionStruct:getInterFactionLTGD">factionStruct:getInterFactionLTGD (targetFaction)</a></li>
<li><a href="#factionStruct:setCharacterNameFaction">factionStruct:setCharacterNameFaction (characterTypeIndex, factionID)</a></li>
</details>


Expand Down Expand Up @@ -929,6 +930,8 @@ <h2>Data Types</h2>
<li><a href="#tileStruct">tileStruct</a></li>
<li><a href="#tileStruct:factionHasArmyNearTile">tileStruct:factionHasArmyNearTile (factionID)</a></li>
<li><a href="#tileStruct:factionHasCharacterOnTile">tileStruct:factionHasCharacterOnTile (factionID)</a></li>
<li><a href="#tileStruct:getTileCharacterCount">tileStruct:getTileCharacterCount ()</a></li>
<li><a href="#tileStruct:getTileCharacterAtIndex">tileStruct:getTileCharacterAtIndex (index)</a></li>
</details>


Expand Down Expand Up @@ -1138,7 +1141,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-22 13:51:45</p>
<p class="lastUpdatedMessage">Last updated: 2024-03-30 15:32:32</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 @@ -1807,6 +1810,10 @@ <h2><a href="#FactionStruct">FactionStruct </a></h2>
<td class="name" nowrap><a href="#factionStruct:getInterFactionLTGD">factionStruct:getInterFactionLTGD (targetFaction)</a></td>
<td class="summary">Get various statistics the long term goal director uses versus a target faction.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#factionStruct:setCharacterNameFaction">factionStruct:setCharacterNameFaction (characterTypeIndex, factionID)</a></td>
<td class="summary">Set the faction characters of a specific type draw their names from.</td>
</tr>
</table>
<h2><a href="#aiFaction">aiFaction </a></h2>
<table class="function_list">
Expand Down Expand Up @@ -3497,6 +3504,14 @@ <h2><a href="#Tile">Tile </a></h2>
<td class="name" nowrap><a href="#tileStruct:factionHasCharacterOnTile">tileStruct:factionHasCharacterOnTile (factionID)</a></td>
<td class="summary">Check if a faction has a character on a tile.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#tileStruct:getTileCharacterCount">tileStruct:getTileCharacterCount ()</a></td>
<td class="summary">Get amount of characters on a tile.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#tileStruct:getTileCharacterAtIndex">tileStruct:getTileCharacterAtIndex (index)</a></td>
<td class="summary">Get a character on a tile.</td>
</tr>
</table>
<h2><a href="#RegionStruct">RegionStruct </a></h2>
<table class="function_list">
Expand Down Expand Up @@ -9731,6 +9746,12 @@ <h3>Fields:</h3>



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



</li>
</ul>

Expand Down Expand Up @@ -10474,6 +10495,40 @@ <h3>Usage:</h3>
<pre class="example"><code class="language-lua" ><span class="keyword">local</span> iLTGD = fac:getInterFactionLTGD(targetFac)</code></pre>
</ul>

</dd>
<dt>
<a name = "factionStruct:setCharacterNameFaction"></a>
<strong>factionStruct:setCharacterNameFaction (characterTypeIndex, factionID)</strong>
</dt>
<dd>
<div class="functionDescription">
Set the faction characters of a specific type draw their names from.
</div>

<h3>Parameters:</h3>
<ul>
<li><span class="parameter">characterTypeIndex</span>
<span class="types"><span class="type">int</span></span>



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



</li>
</ul>




<h3>Usage:</h3>
<ul>
<pre class="example"><code class="language-lua" >fac:setCharacterNameFaction(characterType.spy, <span class="number">2</span>)</code></pre>
</ul>

</dd>
</dl>
<h2 class="section-header "><a name="aiFaction"></a>aiFaction </h2>
Expand Down Expand Up @@ -12185,7 +12240,7 @@ <h3>Fields:</h3>

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



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

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



Expand Down Expand Up @@ -28791,6 +28846,18 @@ <h3>Fields:</h3>



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



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



</li>
</ul>

Expand Down Expand Up @@ -28866,6 +28933,68 @@ <h3>Usage:</h3>
<pre class="example"><code class="language-lua" ><span class="keyword">local</span> hasCharacterOnTile = tile:factionHasCharacterOnTile(<span class="number">3</span>);</code></pre>
</ul>

</dd>
<dt>
<a name = "tileStruct:getTileCharacterCount"></a>
<strong>tileStruct:getTileCharacterCount ()</strong>
</dt>
<dd>
<div class="functionDescription">
Get amount of characters on a tile.
</div>


<h3>Returns:</h3>
<ol>

<span class="types"><span class="type">int</span></span>
characterCount
</ol>



<h3>Usage:</h3>
<ul>
<pre class="example"><code class="language-lua" ><span class="keyword">local</span> tileCharacterCount = tile:getTileCharacterCount();</code></pre>
</ul>

</dd>
<dt>
<a name = "tileStruct:getTileCharacterAtIndex"></a>
<strong>tileStruct:getTileCharacterAtIndex (index)</strong>
</dt>
<dd>
<div class="functionDescription">
Get a character on a tile.
</div>

<h3>Parameters:</h3>
<ul>
<li><span class="parameter">index</span>
<span class="types"><span class="type">int</span></span>



</li>
</ul>

<h3>Returns:</h3>
<ol>

<span class="types"><a class="type" href="index.html#character">character</a></span>
char
</ol>



<h3>Usage:</h3>
<ul>
<pre class="example"><code class="language-lua" ><span class="keyword">local</span> tileCharacterCount = tile:getTileCharacterCount();
<span class="keyword">for</span> i=<span class="number">0</span>,tileCharacterCount -<span class="number">1</span> <span class="keyword">do</span>
<span class="keyword">local</span> character = tile:getTileCharacterAtIndex(i);
<span class="keyword">end</span></code></pre>
</ul>

</dd>
</dl>
<h2 class="section-header "><a name="RegionStruct"></a>RegionStruct </h2>
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-22 13:51:45</p>
<p class="lastUpdatedMessage">Last updated: 2024-03-30 15:32:32</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 5157f98

Please sign in to comment.