Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Don't include raiding units in Units::isActive; make getPosition return invalid coords #4959

Open
wants to merge 10 commits into
base: develop
Choose a base branch
from
Open

Don't include raiding units in Units::isActive; make getPosition return invalid coords #4959

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e2f1598
Update Units.cpp
Bumber64 Sep 24, 2024
6f51b36
Update Units.h
Bumber64 Sep 24, 2024
b0da75d
Update Lua API.rst
Bumber64 Sep 24, 2024
556a8bd
Update changelog.txt
Bumber64 Sep 24, 2024
8d1ddb7
Update RemoteTools.cpp
Bumber64 Sep 24, 2024
6f196e2
Update changelog.txt
Bumber64 Sep 24, 2024
2750fcf
Update Items.h
Bumber64 Sep 24, 2024
e9158d4
Merge branch 'DFHack:develop' into unit_is_active
Bumber64 Sep 26, 2024
2995ab9
Update changelog.txt
Bumber64 Sep 26, 2024
84e9a09
Merge branch 'DFHack:develop' into unit_is_active
Bumber64 Sep 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/changelog.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ Template for new versions:
## New Features

## Fixes
- ``Units::getPosition``, ``Items::getPosition``: return invalid coord for inactive units, items held by units off map
- ``Units::isUnitInBox``, ``Units::getUnitsInBox``: don't include inactive units
- ``Units::isActive``: return false for units off map

## Misc Improvements
- DFHack text edit fields now delete the character at the cursor when you hit the Delete key
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/Lua API.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1643,7 +1643,7 @@ Units module

Returns the true *x,y,z* of the unit, or *nil* if invalid. You should
generally use this method instead of reading *unit.pos* directly since
that field can be inaccurate when the unit is caged.
that field can be inaccurate when the unit is caged, off map, or dead.

* ``dfhack.units.teleport(unit, pos)``

Expand Down
2 changes: 1 addition & 1 deletion library/RemoteTools.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -584,7 +584,7 @@ static command_result ListUnits(color_ostream &stream,

if (in->scan_all())
{
auto &vec = df::unit::get_vector();
auto &vec = df::global::world->units.active;

for (size_t i = 0; i < vec.size(); i++)
{
Expand Down
2 changes: 1 addition & 1 deletion library/include/modules/Items.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ DFHACK_EXPORT df::building *getHolderBuilding(df::item *item);
// Get unit that holds the item or NULL.
DFHACK_EXPORT df::unit *getHolderUnit(df::item *item);

// Returns the true position of the item (non-trivial if in inventory).
// Get the true position of the item (non-trivial if in inventory). Return invalid coord if holder off map.
DFHACK_EXPORT df::coord getPosition(df::item *item);

/// Returns the title of a codex or "tool", either as the codex title or as the title of the
Expand Down
2 changes: 1 addition & 1 deletion library/include/modules/Units.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ inline auto citizensRange(std::vector<df::unit *> &vec, bool exclude_residents =
DFHACK_EXPORT void forCitizens(std::function<void(df::unit *)> fn, bool exclude_residents = false, bool include_insane = false);
DFHACK_EXPORT bool getCitizens(std::vector<df::unit *> &citizens, bool exclude_residents = false, bool include_insane = false);

// Returns the true position of the unit (non-trivial in case of caged).
// Get the true position of the unit (non-trivial in case of caged or inactive). Returns invalid coord if dead or off map.
DFHACK_EXPORT df::coord getPosition(df::unit *unit);

// Moves unit and any riders to the target coordinates. Sets tile occupancy flags.
Expand Down
10 changes: 8 additions & 2 deletions library/modules/Units.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,11 @@ constexpr uint32_t exclude_flags2 = (

bool Units::isActive(df::unit *unit) {
CHECK_NULL_POINTER(unit);
return !unit->flags1.bits.inactive;
if (unit->flags1.bits.inactive)
return false;
else if (unit->flags1.bits.move_state || unit->flags1.bits.can_swap)
return true; // These are always unset when leaving the map
return linear_index(world->units.active, &df::unit::id, unit->id) >= 0;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Units::isActive is used in many many places. I'm worried that adding an O(N) search for every call will be a performance killer. I'm also concerned that changing the behavior of this function will break existing callers, both Lua and C++. I'd like to see some research done on those two points before merging this PR.

Copy link
Contributor Author

@Bumber64 Bumber64 Sep 28, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did a check on my fort, and all of my units in units.active had at least one of inactive, move_state, or can_swap set. There was an inactive unit without the other two flags set that had its pos directly above my well. It's possible the combination could represent a ghost or climbing unit? Probably not going to be a performance consideration given how infrequently those occur. Then there's the actual raiding units, which you won't hit while iterating units.active, and for which the check is mandatory when iterating units.all.

I went through all the uses of isActive, getPosition, getUnitsInBox, and isUnitInBox I could find, as well as the inactive flag. There's no change in behavior to anything iterating the units.active vector (or indirectly through forCitizens/getCitizens). isDead is used instead of isActive for the case of actual dead units. Anything iterating units.all wasn't properly considering raiding units, which was just RemoteTools.cpp/spectate.

I don't fully understand plugins/preserve-rooms.cpp but it didn't look like the changes break anything. You'd know better than me.

}

bool Units::isVisible(df::unit *unit) {
Expand Down Expand Up @@ -658,7 +662,7 @@ bool Units::isGreatDanger(df::unit *unit) {

bool Units::isUnitInBox(df::unit *u, const cuboid &box) {
CHECK_NULL_POINTER(u);
return box.containsPos(getPosition(u));
return isActive(u) ? box.containsPos(getPosition(u)) : false;
}

bool Units::getUnitsInBox(vector<df::unit *> &units, const cuboid &box, std::function<bool(df::unit *)> filter) {
Expand Down Expand Up @@ -743,6 +747,8 @@ bool Units::getCitizens(vector<df::unit *> &citizens, bool exclude_residents, bo

df::coord Units::getPosition(df::unit *unit) {
CHECK_NULL_POINTER(unit);
if (!isActive(unit))
return df::coord();
if (unit->flags1.bits.caged) {
if (auto cage = getContainer(unit))
return Items::getPosition(cage);
Expand Down