Skip to content

fix(coop): harnessEquip/harnessSetArmor enforce the real craft-capacity gate #122

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

Closed
NonPolynomialTim wants to merge 1 commit into from
Closed

fix(coop): harnessEquip/harnessSetArmor enforce the real craft-capacity gate #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
124 changes: 46 additions & 78 deletions src/Basescape/CraftWeaponsState.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,54 +162,28 @@ void CraftWeaponsState::btnCancelClick(Action *)
}

/**
* Equips the weapon on the craft and returns to the previous screen.
* @param action Pointer to an action.
* Capacity gate shared by lstWeaponsClick (UI) and harnessEquip (test), so the
* harness cannot reach an over-capacity state the UI blocks. Returns the STR_
* error key of the first craft-capacity limit mounting @a refWeapon in this slot
* would violate, or "" if it fits. No state-stack side effects.
*/
void CraftWeaponsState::lstWeaponsClick(Action *)
std::string CraftWeaponsState::equipCapacityError(const RuleCraftWeapon* refWeapon) const
{
CraftWeapon *current = _craft->getWeapons()->at(_weapon);

const RuleCraftWeapon* refWeapon = _weapons[_lstWeapons->getSelectedRow()];
const RuleCraftWeapon* currWeapon = current ? current->getRules() : nullptr;
{
int refCapBonus1 = refWeapon ? refWeapon->getBonusStats().soldiers : 0;
int currCapBonus1 = currWeapon ? currWeapon->getBonusStats().soldiers : 0;
int diff1 = (refCapBonus1 - currCapBonus1);
if (diff1)
{
if ((_craft->getMaxUnitsRaw() - _craft->getSpaceUsed() + diff1) < 0)
{
_game->popState();
_game->pushState(new ErrorMessageState(
tr("STR_NOT_ENOUGH_CARGO_SPACE"),
_palette,
_game->getMod()->getInterface("craftWeapons")->getElement("errorMessage")->color,
"BACK14.SCR",
_game->getMod()->getInterface("craftWeapons")->getElement("errorPalette")->color)
);
return;
}
}
if (diff1 && (_craft->getMaxUnitsRaw() - _craft->getSpaceUsed() + diff1) < 0)
return "STR_NOT_ENOUGH_CARGO_SPACE";
}
{
int refCapBonus2 = refWeapon ? refWeapon->getBonusStats().vehicles : 0;
int currCapBonus2 = currWeapon ? currWeapon->getBonusStats().vehicles : 0;
int diff2 = (refCapBonus2 - currCapBonus2);
if (diff2)
{
if ((_craft->getMaxVehiclesAndLargeSoldiersRaw() - _craft->getNumVehiclesAndLargeSoldiers() + diff2) < 0)
{
_game->popState();
_game->pushState(new ErrorMessageState(
tr("STR_NOT_ENOUGH_HWP_CAPACITY"),
_palette,
_game->getMod()->getInterface("craftWeapons")->getElement("errorMessage")->color,
"BACK14.SCR",
_game->getMod()->getInterface("craftWeapons")->getElement("errorPalette")->color)
);
return;
}
}
if (diff2 && (_craft->getMaxVehiclesAndLargeSoldiersRaw() - _craft->getNumVehiclesAndLargeSoldiers() + diff2) < 0)
return "STR_NOT_ENOUGH_HWP_CAPACITY";
}
{
int refCapBonus3 = refWeapon ? refWeapon->getBonusStats().maxItems : 0;
Expand All @@ -228,51 +202,40 @@ void CraftWeaponsState::lstWeaponsClick(Action *)
for (auto& itemType : _game->getMod()->getItemsList())
{
RuleItem* rule = _game->getMod()->getItem(itemType);

Unit* isVehicle = rule->getVehicleUnit();
int cQty = 0;
if (isVehicle)
{
cQty = _craft->getVehicleCount(itemType);
}
else
{
cQty = _craft->getItems()->getItem(rule);
totalItems += cQty;
totalItemStorageSize += cQty * rule->getSize();
}
}
}
if (diff3)
{
if ((_craft->getMaxItemsRaw() - totalItems + diff3) < 0)
{
_game->popState();
_game->pushState(new ErrorMessageState(
tr("STR_NOT_ENOUGH_STORAGE_SPACE_1"),
_palette,
_game->getMod()->getInterface("craftWeapons")->getElement("errorMessage")->color,
"BACK14.SCR",
_game->getMod()->getInterface("craftWeapons")->getElement("errorPalette")->color)
);
return;
}
}
if (diff4_b)
{
if ((_craft->getMaxStorageSpaceRaw() - totalItemStorageSize + diff4) < 0.0)
{
_game->popState();
_game->pushState(new ErrorMessageState(
tr("STR_NOT_ENOUGH_STORAGE_SPACE_2"),
_palette,
_game->getMod()->getInterface("craftWeapons")->getElement("errorMessage")->color,
"BACK14.SCR",
_game->getMod()->getInterface("craftWeapons")->getElement("errorPalette")->color)
);
return;
if (rule->getVehicleUnit())
continue; // vehicles count against HWP capacity, checked above
int cQty = _craft->getItems()->getItem(rule);
totalItems += cQty;
totalItemStorageSize += cQty * rule->getSize();
}
}
if (diff3 && (_craft->getMaxItemsRaw() - totalItems + diff3) < 0)
return "STR_NOT_ENOUGH_STORAGE_SPACE_1";
if (diff4_b && (_craft->getMaxStorageSpaceRaw() - totalItemStorageSize + diff4) < 0.0)
return "STR_NOT_ENOUGH_STORAGE_SPACE_2";
}
return "";
}

/**
* Equips the weapon on the craft and returns to the previous screen.
* @param action Pointer to an action.
*/
void CraftWeaponsState::lstWeaponsClick(Action *)
{
const RuleCraftWeapon* refWeapon = _weapons[_lstWeapons->getSelectedRow()];
std::string capErr = equipCapacityError(refWeapon);
if (!capErr.empty())
{
_game->popState();
_game->pushState(new ErrorMessageState(
tr(capErr),
_palette,
_game->getMod()->getInterface("craftWeapons")->getElement("errorMessage")->color,
"BACK14.SCR",
_game->getMod()->getInterface("craftWeapons")->getElement("errorPalette")->color)
);
return;
}

equipSelectedWeapon(_weapons[_lstWeapons->getSelectedRow()]);
Expand Down Expand Up @@ -336,6 +299,11 @@ bool CraftWeaponsState::harnessEquip(const std::string& weaponType)
std::string t = _weapons[i] ? _weapons[i]->getType() : "";
if (t == weaponType)
{
// Enforce the SAME capacity gate lstWeaponsClick applies, so the
// harness cannot mount into an over-capacity craft a real player is
// blocked from. Return false as "click refused".
if (!equipCapacityError(_weapons[i]).empty())
return false;
equipSelectedWeapon(_weapons[i]);
return true;
}
Expand Down
4 changes: 4 additions & 0 deletions src/Basescape/CraftWeaponsState.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ class CraftWeaponsState : public State
/// SHARED (PRD-J09 GAP-5b): mount @a selRule (0 = dismount) in this slot -
/// routes craft_rearm in SHARED, mutates the shared stores locally in SEPARATE.
void equipSelectedWeapon(RuleCraftWeapon* selRule);
/// Capacity gate shared by lstWeaponsClick (UI) and harnessEquip (test):
/// STR_ error key of the first craft-capacity limit mounting @a refWeapon in
/// this slot would violate, or "" if it fits. No state-stack side effects.
std::string equipCapacityError(const RuleCraftWeapon* refWeapon) const;
public:
/// Creates the Craft Weapons state.
CraftWeaponsState(Base *base, size_t craft, size_t weapon);
Expand Down
7 changes: 7 additions & 0 deletions src/Basescape/SoldierArmorState.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,13 @@ bool SoldierArmorState::harnessSetArmor(const std::string& armorType)
{
Armor* next = _game->getMod()->getArmor(armorType, false);
if (!next) return false;
// Enforce the SAME craft-space gate lstArmorClick applies, so the
// harness cannot reach an over-capacity state a real player is blocked
// from (STR_NOT_ENOUGH_CRAFT_SPACE). Return false as "click refused".
Soldier* soldier = _base->getSoldiers()->at(_soldier);
Craft* craft = soldier->getCraft();
if (craft && !craft->validateArmorChange(soldier->getArmor()->getSize(), next->getSize()))
return false;
applyArmorSelection(next);
return true;
}
Expand Down
Loading