Adventure Mode Site Helpers: SC_NEW_MAP_AVAILABLE state change and World::GetCurrentSiteIdsWithExtraRange
#5475
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ab9rf
requested changes
Aug 15, 2025
| DFHACK_EXPORT df::unit * getAdventurer(); | ||
|
|
||
| DFHACK_EXPORT int32_t GetCurrentSiteId(); | ||
| DFHACK_EXPORT void GetCurrentSiteIdsWithExtraRange(std::vector<int32_t>& ids, const int32_t x_range = 0, const int32_t y_range = 0, const uint32_t max = UINT_MAX); |
There was a problem hiding this comment.
Needs to be documented in docs/dev/Lua API.rst
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
After doing some research on the ways to properly get access to site IDs in Adventure Mode, I realized the
SC_MAP_LOADEDstate change only triggers on transitioning from no map to having a map loaded. The logic can easily be expanded to also consider the cases when there is a map and the map changes. For this, I propose a new state change, which I have tentatively calledSC_NEW_MAP_AVAILABLE.In the same vein, while
World::GetCurrentSiteIdshould correctly return the current site ID (or -1 if no site), some practical use cases may benefit from being able to get all sites in a caller-provided range around the adventurer. For this reason, I propose the introduction ofWorld::GetCurrentSiteIdsWithExtraRange, which extends the logic of the former function to take anstd::vectoras an in-parameter and return all applicable sites, optionally with extra range in x and y and a maximum number of sites to be return (which would be ordered by ID and not distance...).