fix some links in the doc

spelunky-fyi · Dec 28, 2024 · 2bf11fb · 2bf11fb
1 parent 28bcb86
commit 2bf11fb
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 6 deletions.
diff --git a/docs/game_data/spel2.lua b/docs/game_data/spel2.lua
diff --git a/docs/parse_source.py b/docs/parse_source.py
@@ -1013,7 +1013,7 @@ def run_parse():
             if c:
                 comment.append(c.group(1))
 
-    print_collecting_info("enums")
+    print_collecting_info("enums") # TODO: should probably improve how this handles comments
     for file in api_files:
         data = open(file, "r").read()
         data = data.replace("\n", "")
@@ -1022,7 +1022,7 @@ def run_parse():
         for type in m:
             name = type[0]
             attr = type[1]
-            attr = attr.replace("//", "")
+            attr = attr.replace("//,", ",")
             attr = attr.replace('",', ",")
             attr = attr.split('"')
             vars = []

diff --git a/docs/src/includes/_enums.md b/docs/src/includes/_enums.md
@@ -185,7 +185,7 @@ Name | Data | Description
 Name | Data | Description
 ---- | ---- | -----------
 [ALTAR_DICE_CLIMBINGGLOVES](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=DROP.ALTAR_DICE_CLIMBINGGLOVES) | 0 | 
-...see [drops.cpp](https:github.com/spelunky-fyi/overlunky/blob/main/src/game_api/drops.cpp) for a list of possible drops... |  | 
+...see [drops.cpp](https://github.com/spelunky-fyi/overlunky/blob/main/src/game_api/drops.cpp) for a list of possible drops... |  | 
 [YETI_PITCHERSMITT](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=DROP.YETI_PITCHERSMITT) | 85 | 
 
 ## DROPCHANCE
@@ -197,7 +197,7 @@ Name | Data | Description
 Name | Data | Description
 ---- | ---- | -----------
 [BONEBLOCK_SKELETONKEY](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=DROPCHANCE.BONEBLOCK_SKELETONKEY) | 0 | 
-...see [drops.cpp](https:github.com/spelunky-fyi/overlunky/blob/main/src/game_api/drops.cpp) for a list of possible dropchances... |  | 
+...see [drops.cpp](https://github.com/spelunky-fyi/overlunky/blob/main/src/game_api/drops.cpp) for a list of possible dropchances... |  | 
 [YETI_PITCHERSMITT](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=DROPCHANCE.YETI_PITCHERSMITT) | 10 | 
 
 ## DYNAMIC_TEXTURE
@@ -835,7 +835,7 @@ Name | Data | Description
 [ACTIVEFLOOR](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=MASK.ACTIVEFLOOR) | 0x80 | All ACTIVEFLOOR_* entities<br/>Various types, all `Movable`<br/>
 [FLOOR](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=MASK.FLOOR) | 0x100 | All FLOOR_* and FLOORSTYLED_* entities<br/>Various types, all `Floor`<br/>
 [DECORATION](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=MASK.DECORATION) | 0x200 | All DECORATION_* entities except: DECORATION_CHAINANDBLOCKS_CHAINDECORATION, DECORATION_SLIDINGWALL_CHAINDECORATION, DECORATION_PALACE_PORTRAIT<br/>Also includes: EMBED_GOLD, ENT_TYPE_EMBED_GOLD_BIG<br/>Various types, all `Entity`<br/>
-[BG](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=MASK.BG) | 0x400 | All MIDBG* entities and most of the BG_* entities<br/>does not include: a lot .. check [default_flags_more_flags.txt](internal/entity.type.default_flags_more_flags.txt) for full list<br/>Also includes: DECORATION_PALACE_PORTRAIT<br/>Various types, all `Entity`<br/>
+[BG](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=MASK.BG) | 0x400 | All MIDBG* entities and most of the BG_* entities<br/>does not include: a lot .. check `1024` in [search_flags](https:<br/>github.com/spelunky-fyi/overlunky/blob/main/docs/game_data/search_flags.json) for full list of included entities<br/>Also includes: DECORATION_PALACE_PORTRAIT<br/>Various types, all `Entity`<br/>
 [SHADOW](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=MASK.SHADOW) | 0x800 | All the BG_* entities excluded from `BG` (MASK.BG &#124; MASK.SHADOW) will get you all BG_* entities plus one extra decoration mentioned above<br/>Various types, all `Entity`<br/>
 [LOGICAL](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=MASK.LOGICAL) | 0x1000 | All LOGICAL_* entities<br/>Also includes: ITEM_POWERUP_*, FX_COMPASS, FX_SPECIALCOMPASS, FX_LEADER_FLAG, FX_PLAYERINDICATOR, FX_PLAYERINDICATORPORTRAIT<br/>Various types, all `Entity`<br/>
 [WATER](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=MASK.WATER) | 0x2000 | Only: LIQUID_WATER, LIQUID_COARSE_WATER, LIQUID_IMPOSTOR_LAKE<br/>Various types, all `Entity`<br/>

diff --git a/docs/src/includes/_globals.md b/docs/src/includes/_globals.md
@@ -869,6 +869,7 @@ Poisons entity, to cure poison set [Movable](#Movable).`poison_tick_timer` to -1
 
 Changes a particular drop, e.g. what Van Horsing throws at you (use e.g. replace_drop([DROP](#DROP).VAN_HORSING_DIAMOND, [ENT_TYPE](#ENT_TYPE).ITEM_PLASMACANNON))
 Use `0` as type to reset this drop to default, use `-1` as drop_id to reset all to default
+Check all the available drops [here](https://github.com/spelunky-fyi/overlunky/blob/main/src/game_api/drops.cpp)
 
 ### set_boss_door_control_enabled
 

diff --git a/src/game_api/script/usertypes/drops_lua.cpp b/src/game_api/script/usertypes/drops_lua.cpp
@@ -19,6 +19,7 @@ void register_usertypes(sol::state& lua)
     lua["set_drop_chance"] = set_drop_chance;
     /// Changes a particular drop, e.g. what Van Horsing throws at you (use e.g. replace_drop(DROP.VAN_HORSING_DIAMOND, ENT_TYPE.ITEM_PLASMACANNON))
     /// Use `0` as type to reset this drop to default, use `-1` as drop_id to reset all to default
+    /// Check all the available drops [here](https://github.com/spelunky-fyi/overlunky/blob/main/src/game_api/drops.cpp)
     lua["replace_drop"] = replace_drop;
 
     lua.create_named_table("DROPCHANCE"

diff --git a/src/game_api/script/usertypes/entity_lua.cpp b/src/game_api/script/usertypes/entity_lua.cpp
@@ -494,7 +494,7 @@ void register_usertypes(sol::state& lua)
     // Various types, all `Entity`
     // BG
     // All MIDBG* entities and most of the BG_* entities
-    // does not include: a lot .. check [default_flags_more_flags.txt](internal/entity.type.default_flags_more_flags.txt) for full list
+    // does not include: a lot .. check `1024` in [search_flags](https://github.com/spelunky-fyi/overlunky/blob/main/docs/game_data/search_flags.json) for full list of included entities
     // Also includes: DECORATION_PALACE_PORTRAIT
     // Various types, all `Entity`
     // SHADOW