update docs

spelunky-fyi · Dec 8, 2023 · 2c842c4 · 2c842c4
1 parent ccc729b
commit 2c842c4
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 0 deletions.
diff --git a/docs/game_data/spel2.lua b/docs/game_data/spel2.lua
diff --git a/docs/src/includes/_globals.md b/docs/src/includes/_globals.md
@@ -1708,6 +1708,24 @@ Reverse of some random hash function
 
 Access the [PauseAPI](#PauseAPI), or directly call `pause(true)` to enable current `pause.pause_type`
 
+### play_adventure
+
+
+> Search script examples for [play_adventure](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=play_adventure)
+
+#### nil play_adventure()
+
+Initializes some adventure run related values and loads the character select screen, as if starting a new adventure run from the Play menu. Character select can be skipped by changing `state.screen_next` right after calling this function, maybe with `warp()`. If player isn't already selected, make sure to set `state.items.player_select` and `state.items.player_count` appropriately too.
+
+### play_seeded
+
+
+> Search script examples for [play_seeded](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=play_seeded)
+
+#### nil play_seeded(optional<int> seed)
+
+Initializes some seedeed run related values and loads the character select screen, as if starting a new seeded run after entering the seed.
+
 ### register_console_command
 
 

diff --git a/docs/src/includes/_types.md b/docs/src/includes/_types.md
@@ -11,6 +11,7 @@ Used in [ArenaState](#ArenaState)
 
 Type | Name | Description
 ---- | ---- | -----------
+array&lt;bool, 40&gt; | [list](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=list) | 
 bool | [dwelling_1](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=dwelling_1) | 
 bool | [dwelling_2](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=dwelling_2) | 
 bool | [dwelling_3](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=dwelling_3) | 
@@ -809,6 +810,8 @@ vector&lt;int&gt; | [selected_uids](https://github.com/spelunky-fyi/overlunky/se
 int | [hovered_uid](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=hovered_uid) | Currently hovered entity uid or -1 if nothing is hovered.
 optional&lt;int&gt; | [set_selected_uid](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=set_selected_uid) | Set currently selected uid in the entity picker or -1 to clear selection.
 optional&lt;vector&lt;int&gt;&gt; | [set_selected_uids](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=set_selected_uids) | Set currently selected uids in the entity finder.
+int | [held_modifiers](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=held_modifiers) | Bitmask of modifier KEYs that are currently held
+int | [block_modifiers](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=block_modifiers) | Bitmask of modifier KEYs that will block all game input
 
 ### PRNG