Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Cosine256 committed Aug 26, 2023
1 parent 3f8ea90 commit ed98333
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/game_data/spel2.lua

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions docs/generate.py
Original file line number Diff line number Diff line change
Expand Up @@ -592,6 +592,8 @@ def print_lf(lf):
"Camera",
"QuestsInfo",
"PlayerSlot",
"JournalProgressStickerSlot",
"JournalProgressStainSlot"
]
):
cat = "State types"
Expand Down
33 changes: 33 additions & 0 deletions docs/src/includes/_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -2423,6 +2423,33 @@ int | [leader](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=leader)
array<[Inventory](#Inventory), MAX_PLAYERS> | [player_inventory](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=player_inventory) |
array<[SelectPlayerSlot](#SelectPlayerSlot), MAX_PLAYERS> | [player_select](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=player_select) |

### JournalProgressStainSlot

Used in [StateMemory](#StateMemory)

Type | Name | Description
---- | ---- | -----------
float | [x](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=x) |
float | [y](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=y) |
float | [angle](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=angle) |
float | [scale](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=scale) |
int | [texture_column](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=texture_column) |
int | [texture_row](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=texture_row) |
int | [texture_range](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=texture_range) |

### JournalProgressStickerSlot

Used in [StateMemory](#StateMemory)

Type | Name | Description
---- | ---- | -----------
int | [theme](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=theme) |
int | [grid_position](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=grid_position) |
[ENT_TYPE](#ENT_TYPE) | [entity_type](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=entity_type) |
float | [x](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=x) |
float | [y](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=y) |
float | [angle](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=angle) |

### PlayerSlot


Expand Down Expand Up @@ -2570,6 +2597,12 @@ int | [time_startup](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=ti
int | [storage_uid](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=storage_uid) | entity uid of the first floor_storage entity
array<[ENT_TYPE](#ENT_TYPE), 99> | [waddler_storage](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=waddler_storage) |
array<int, 99> | [waddler_metadata](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=waddler_metadata) |
int | [journal_progress_sticker_count](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=journal_progress_sticker_count) |
array<[JournalProgressStickerSlot](#JournalProgressStickerSlot), 40> | [journal_progress_sticker_slots](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=journal_progress_sticker_slots) | stickers for notable items and entities in journal progress page
int | [journal_progress_stain_count](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=journal_progress_stain_count) |
array<[JournalProgressStainSlot](#JournalProgressStainSlot), 30> | [journal_progress_stain_slots](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=journal_progress_stain_slots) | blood splats and paw prints in journal progress page
int | [journal_progress_theme_count](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=journal_progress_theme_count) |
array<int, 9> | [journal_progress_theme_slots](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=journal_progress_theme_slots) | visited themes in journal progress page
[ThemeInfo](#ThemeInfo) | [theme_info](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=theme_info) | Points to the current [ThemeInfo](#ThemeInfo)
[LogicList](#LogicList) | [logic](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=logic) | Level logic like dice game and cutscenes
[LiquidPhysics](#LiquidPhysics) | [liquid](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=liquid) |
Expand Down

0 comments on commit ed98333

Please sign in to comment.