Units in bunkers / transport do not get included in frames

[edran]

No description provided.

[dgant]

Presumptive cause (as I learned today): BWAPI's Game.getAllUnits() and Player.getUnits() do not (by design!) return units inside dropships/refineries/bunkers/carriers/etc. unless complete map vision is enabled.

From BWAPI's standpoint, this is a feature. From TC's, it may be a hindrance.

[ebetica]

@tscmoo do you know if this is the case? I thought you said at one point that getAllUnits worked.

[tscmoo]

As memory serves, getAllUnits should work, yes. I also thought we changed TC to use getAllUnits at some point, but it appears not.

[dgant]

Player.getUnits is a subset of what Game.getAllUnits returns, all of which flow from the "is there a sprite" check which causes units inside other things to be hidden (except with CompleteMapInformation).

• Visibility check: https://github.com/bwapi/bwapi/blob/59b14af21b3c881ce06af8b1ea1d63fa3c8b2df0/bwapi/BWAPI/Source/BWAPI/UnitUpdate.cpp#L66
• Exclusion from accessibility: https://github.com/bwapi/bwapi/blob/59b14af21b3c881ce06af8b1ea1d63fa3c8b2df0/bwapi/BWAPI/Source/BWAPI/UnitImpl.cpp#L187
• Population of accessibleUnits: https://github.com/bwapi/bwapi/blob/59b14af21b3c881ce06af8b1ea1d63fa3c8b2df0/bwapi/BWAPI/Source/BWAPI/GameUnits.cpp#L159
• Definition of getAllUnits: https://github.com/bwapi/bwapi/blob/59b14af21b3c881ce06af8b1ea1d63fa3c8b2df0/bwapi/Shared/GameShared.cpp#L20
• Population of a player's units (iterating through accessibleUnits): https://github.com/bwapi/bwapi/blob/59b14af21b3c881ce06af8b1ea1d63fa3c8b2df0/bwapi/BWAPI/Source/BWAPI/GameUnits.cpp#L394
• Definition of getUnits:
  https://github.com/bwapi/bwapi/blob/59b14af21b3c881ce06af8b1ea1d63fa3c8b2df0/bwapi/Shared/PlayerShared.cpp#L16

[ebetica]

#257 might solve this...

[dgant]

Still affected by the visibility check. There's no escaping that short of tracking unit creation/destruction from within TorchCraft (which I wouldn't recommend we do).

[dgant]

I propose closing this as "won't fix" -- it's a BWAPI limitation. We could work around it, but that's be an opinionated API change when I think we'd rather TorchCraft transparently relay BWAPI data.