Updated EOP Docs for version: M2TWEOP-2.2.1

youneuoy · May 18, 2023 · 2225bb6 · 2225bb6
1 parent 7cb1b60
commit 2225bb6
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 7 deletions.
diff --git a/docs/_static/LuaLib/extra/readme_imgui.md.html b/docs/_static/LuaLib/extra/readme_imgui.md.html
@@ -272,7 +272,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: 2023-05-11 10:31:49</p>
+        <p class="lastUpdatedMessage">Last updated: 2023-05-18 11:11:43</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>

diff --git a/docs/_static/LuaLib/index.html b/docs/_static/LuaLib/index.html
@@ -663,7 +663,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: 2023-05-11 10:31:49</p>
+        <p class="lastUpdatedMessage">Last updated: 2023-05-18 11:11:43</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>
@@ -2525,7 +2525,11 @@ <h3>Returns:</h3>
 
     <h3>Usage:</h3>
     <ul>
-        <pre class="example"><span class="keyword">local</span> testImage={x=<span class="number">0</span>,y=<span class="number">0</span>,img=<span class="keyword">nil</span>};
+        <pre class="example"><span class="comment">-- This function supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga.
+</span><span class="comment">-- Recommended to use .dds for best performance
+</span><span class="comment">-- Note: Doing image scaling and format conversion at load time can be slow. Store images in the format and resolution they will be used.
+</span><span class="comment">-- More info: https://learn.microsoft.com/en-us/windows/win32/direct3d9/d3dxcreatetexturefromfileex
+</span><span class="keyword">local</span> testImage = { x = <span class="number">0</span>, y = <span class="number">0</span>, img = <span class="keyword">nil</span>};
 testImage.x, testImage.y, testImage.img=M2TWEOP.loadTexture(M2TWEOP.getModPath()..<span class="string">"/youneuoy_textures/test.dds"</span>);</pre>
     </ul>
 
@@ -2552,7 +2556,7 @@ <h3>Parameters:</h3>
 
     <h3>Usage:</h3>
     <ul>
-        <pre class="example"><span class="keyword">local</span> testImage={x=<span class="number">0</span>,y=<span class="number">0</span>,img=<span class="keyword">nil</span>};
+        <pre class="example"><span class="keyword">local</span> testImage = { x = <span class="number">0</span>, y = <span class="number">0</span>, img = <span class="keyword">nil</span>};
 testImage.x, testImage.y, testImage.img=M2TWEOP.loadTexture(M2TWEOP.getModPath()..<span class="string">"/youneuoy_textures/test.dds"</span>);
 M2TWEOP.unloadTexture(testImage.img);</pre>
     </ul>
@@ -16041,11 +16045,34 @@ <h3>Fields:</h3>
     <ul>
         <li><span class="parameter">battleState</span>
             <span class="types"><span class="type">int</span></span>
-         0-not in battle,5-active battle,9-results screen,etc
+
+
+<pre><code>    0 not in battle
+    1 prebattle scroll
+    2 delay (also for preconflict phase of successful ambushes)
+    3 deployment
+    4
+    5 conflict (also for pause)
+    6 victory scroll
+    7 pursuit
+    8
+    9 postbattle scroll (not for autoresolved battles)
+</code></pre>
+
         </li>
         <li><span class="parameter">battleType</span>
             <span class="types"><span class="type">int</span></span>
-         3 = siege, 4 = sally out, rest unknown for now, you can experiment.
+
+
+<pre><code>    0 succesful ambush
+    1 failed ambush
+    2 normal
+    3 siege
+    4 sally besieger
+    5 naval
+    6 withdrawal?
+</code></pre>
+
         </li>
         <li><span class="parameter">isNightBattle</span>
             <span class="types"><span class="type">int</span></span>
@@ -16447,6 +16474,18 @@ <h3>Fields:</h3>
             <span class="types"><span class="type">int</span></span>
 
 
+<pre><code>    0 = "DO_NOTHING"
+    1 = "ATTACK_ALL"
+    2 = "DEFEND"
+    3 = "DEFEND_FEATURE"
+    4 = "HIDE"
+    5 = "AMBUSH"
+    6 = "SCOUT"
+    7 = "WITHDRAW"
+    8 = "ATTACK_SETTLEMENT"
+    9 = "DEFEND_SETTLEMENT"
+    10 = "SALLY_OUT"
+</code></pre>
 
         </li>
         <li><span class="parameter">unitCount</span>

diff --git a/docs/_static/LuaLib/readme_imgui.md.html b/docs/_static/LuaLib/readme_imgui.md.html
@@ -272,7 +272,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: 2023-05-11 10:31:49</p>
+        <p class="lastUpdatedMessage">Last updated: 2023-05-18 11:11:43</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>