Merge remote-tracking branch 'upstream/main' into online-compat-stuff…

…-pt2
spelunky-fyi · Dec 4, 2024 · 819a4b2 · 819a4b2
2 parents bb18b48 + 1615ce1
commit 819a4b2
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 6 deletions.
diff --git a/docs/index.html b/docs/index.html
@@ -4698,7 +4698,7 @@ <h3 id='get_local_players'>get_local_players</h3>
 <blockquote>
 <p>Search script examples for <a href="https://github.com/spelunky-fyi/overlunky/search?l=Lua&amp;q=get_local_players">get_local_players</a></p>
 </blockquote>
-<h4 id='nil-get_local_players'>nil get_local_players()</h4>
+<h4 id='vector-lt-Player-gt-get_local_players'>vector&lt;<a href="#Player">Player</a>&gt; get_local_players()</h4>
 <p>Get the thread-local version of players</p>
 <h3 id='get_player'>get_player</h3>
 <blockquote>
@@ -5223,13 +5223,13 @@ <h3 id='get_local_prng'>get_local_prng</h3>
 <blockquote>
 <p>Search script examples for <a href="https://github.com/spelunky-fyi/overlunky/search?l=Lua&amp;q=get_local_prng">get_local_prng</a></p>
 </blockquote>
-<h4 id='nil-get_local_prng'>nil get_local_prng()</h4>
+<h4 id='PRNG-get_local_prng'><a href="#PRNG">PRNG</a> get_local_prng()</h4>
 <p>Get the thread-local version of prng</p>
 <h3 id='get_local_state'>get_local_state</h3>
 <blockquote>
 <p>Search script examples for <a href="https://github.com/spelunky-fyi/overlunky/search?l=Lua&amp;q=get_local_state">get_local_state</a></p>
 </blockquote>
-<h4 id='nil-get_local_state'>nil get_local_state()</h4>
+<h4 id='StateMemory-get_local_state'><a href="#StateMemory">StateMemory</a> get_local_state()</h4>
 <p>Get the thread-local version of state</p>
 <h3 id='get_ms'>get_ms</h3>
 <blockquote>
@@ -17709,6 +17709,11 @@ <h3 id='StateMemory'>StateMemory</h3>
 <td><a href="https://github.com/spelunky-fyi/overlunky/search?l=Lua&amp;q=room_owners">room_owners</a></td>
 <td>Holds info about owned rooms and items (shops, challenge rooms, vault etc.)</td>
 </tr>
+<tr>
+<td>any</td>
+<td><a href="https://github.com/spelunky-fyi/overlunky/search?l=Lua&amp;q=user_data">user_data</a></td>
+<td>You can store a table (or lua primitive) here and it will store data correctly in online multiplayer, by having a different copy on each state and being copied over when the game does.<br/>Doesn&#39;t support recursive tables / cyclic references. Metatables will be transferred by reference instead of being copied<br/></td>
+</tr>
 </tbody></table>
 <h2 id='Texture-types'>Texture types</h2><h3 id='TextRenderingInfo'>TextRenderingInfo</h3>
 <table><thead>

diff --git a/docs/light.html b/docs/light.html
@@ -4698,7 +4698,7 @@ <h3 id='get_local_players'>get_local_players</h3>
 <blockquote>
 <p>Search script examples for <a href="https://github.com/spelunky-fyi/overlunky/search?l=Lua&amp;q=get_local_players">get_local_players</a></p>
 </blockquote>
-<h4 id='nil-get_local_players'>nil get_local_players()</h4>
+<h4 id='vector-lt-Player-gt-get_local_players'>vector&lt;<a href="#Player">Player</a>&gt; get_local_players()</h4>
 <p>Get the thread-local version of players</p>
 <h3 id='get_player'>get_player</h3>
 <blockquote>
@@ -5223,13 +5223,13 @@ <h3 id='get_local_prng'>get_local_prng</h3>
 <blockquote>
 <p>Search script examples for <a href="https://github.com/spelunky-fyi/overlunky/search?l=Lua&amp;q=get_local_prng">get_local_prng</a></p>
 </blockquote>
-<h4 id='nil-get_local_prng'>nil get_local_prng()</h4>
+<h4 id='PRNG-get_local_prng'><a href="#PRNG">PRNG</a> get_local_prng()</h4>
 <p>Get the thread-local version of prng</p>
 <h3 id='get_local_state'>get_local_state</h3>
 <blockquote>
 <p>Search script examples for <a href="https://github.com/spelunky-fyi/overlunky/search?l=Lua&amp;q=get_local_state">get_local_state</a></p>
 </blockquote>
-<h4 id='nil-get_local_state'>nil get_local_state()</h4>
+<h4 id='StateMemory-get_local_state'><a href="#StateMemory">StateMemory</a> get_local_state()</h4>
 <p>Get the thread-local version of state</p>
 <h3 id='get_ms'>get_ms</h3>
 <blockquote>
@@ -17709,6 +17709,11 @@ <h3 id='StateMemory'>StateMemory</h3>
 <td><a href="https://github.com/spelunky-fyi/overlunky/search?l=Lua&amp;q=room_owners">room_owners</a></td>
 <td>Holds info about owned rooms and items (shops, challenge rooms, vault etc.)</td>
 </tr>
+<tr>
+<td>any</td>
+<td><a href="https://github.com/spelunky-fyi/overlunky/search?l=Lua&amp;q=user_data">user_data</a></td>
+<td>You can store a table (or lua primitive) here and it will store data correctly in online multiplayer, by having a different copy on each state and being copied over when the game does.<br/>Doesn&#39;t support recursive tables / cyclic references. Metatables will be transferred by reference instead of being copied<br/></td>
+</tr>
 </tbody></table>
 <h2 id='Texture-types'>Texture types</h2><h3 id='TextRenderingInfo'>TextRenderingInfo</h3>
 <table><thead>