fix: Dump dvar of IW4 menu items without edit field data (#1063)

* fix: Dump dvar of IW4 menu items without edit field data

* fix: ensure dvar property sets edit field features

* chore: add comment explaining why additional dump location for dvar is there

* fix: test data that has invalid type and dvar combinations

---------

Co-authored-by: Jan Laupetin <[email protected]>
This commit is contained in:
wroyandJan Laupetin authored and GitHub committed 2026-11-16 23:32:09 +01:00
1 parent 28605c74ae
commit 7b24b776fa
8 files changed
+58 -5

No files matched your search

@@ -852,8 +852,10 @@ void ItemScopeSequences::AddSequences(const FeatureLevel featureLevel, const boo
}));
// special
AddSequence(std::make_unique<GenericStringPropertySequence>("dvar",
[](const MenuFileParserState* state, const TokenPos&, const std::string& value)
[](const MenuFileParserState* state, const TokenPos& pos, const std::string& value)
{
ItemScopeOperations::EnsureHasEditFieldFeatures(
*state->m_current_item, state->m_feature_level, pos);
state->m_current_item->m_dvar = value;
}));
AddSequence(std::make_unique<GenericStringPropertySequence>("focusSound",
@@ -740,7 +740,11 @@ namespace
}
if (!item.typeData.editField)
{
// Usually dvar should be unset here, but older OAT versions did not set editField even when dvar was set.
WriteStringProperty("dvar", item.dvar);
return;
}
const auto& editField = *item.typeData.editField;
if (std::fabs(-1.0f - editField.defVal) >= std::numeric_limits<float>::epsilon()
@@ -93,7 +93,7 @@ TEST_CASE("MenuListLoaderIW3: Loads dumped menus and preserves IW3 data", "[iw3]
name "empty_text"
text ""
rect 10 20 180 24 1 2
type 1
type 0
visible 1
forecolor 0.9 0.9 1 0.07
dvar "ui_fallback_text"
@@ -99,7 +99,7 @@ TEST_CASE("MenuListLoaderT4: Loads dumped menus and preserves T4 data", "[t4][me
name "empty_text"
text ""
rect 10 20 180 24 1 2
type 1
type 0
visible 1
forecolor 0.9 0.9 1 0.07
dvar "ui_fallback_text"
@@ -434,4 +434,27 @@ namespace test::parsing::menu::sequence::item
REQUIRE(multiValueFeatures->m_step_names == std::vector<std::string>{"@MPUI_RULES_5MINUTES", ""});
REQUIRE(multiValueFeatures->m_string_values == std::vector<std::string>{"5", "0"});
}
TEST_CASE("ItemScopeSequences: Ensure dvar sets edit field properties", "[parsing][sequence][menu]")
{
ItemSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Identifier(pos, new std::string("dvar")),
SimpleParserValue::String(pos, new std::string("foobar")),
SimpleParserValue::EndOfFile(pos),
});
const auto result = helper.PerformTest();
REQUIRE(result);
REQUIRE(helper.m_consumed_token_count == 2);
const auto* item = helper.m_state->m_current_item;
REQUIRE(item);
REQUIRE(item->m_dvar == "foobar");
REQUIRE(item->m_feature_type == CommonItemFeatureType::EDIT_FIELD);
REQUIRE(item->m_edit_field_features);
}
} // namespace test::parsing::menu::sequence::item
@@ -1,5 +1,6 @@
#include "Game/IW4/Menu/MenuWriterIW4.h"
#include "Game/IW4/IW4.h"
#include "Parsing/Menu/MenuFileReader.h"
#include "SearchPath/MockSearchPath.h"
@@ -149,4 +150,27 @@ namespace
REQUIRE(parsed->m_menus.size() == 1);
CHECK(parsed->m_menus[0]->m_visible_expression);
}
TEST_CASE("MenuWriterIW4: Writes the dvar of a text item without edit field data", "[iw4][menu]")
{
itemDef_s item{};
item.window.name = "tip";
item.type = ITEM_TYPE_TEXT;
item.dvar = "didyouknow";
itemDef_s* items[]{&item};
menuDef_t menu{};
menu.window.name = "connect";
menu.items = items;
menu.itemCount = 1;
std::ostringstream ss;
const auto writer = menu::CreateMenuWriterIW4(ss);
writer->Start();
writer->WriteMenu(menu);
writer->End();
REQUIRE(ss.str().find("dvar \"didyouknow\"") != std::string::npos);
}
} // namespace
@@ -17,7 +17,7 @@
name "empty_text"
text ""
rect 10 20 180 24 1 2
type 1
type 4
visible 1
forecolor 0.9 0.9 1 0.07
dvar "ui_fallback_text"
@@ -21,7 +21,7 @@
name "empty_text"
text ""
rect 10 20 180 24 1 2
type 1
type 4
visible 1
forecolor 0.9 0.9 1 0.07
dvar "ui_fallback_text"