gromandClaude Opus 5
81d96af35d
This checkout had no git history at all, so this one commit carries the whole
of the Everwood work as a single import on top of chairmanpow/benilla-octo's
`main` (706cd71). The two trees have genuinely diverged — each has files the
other does not — so this is a fork point, not a catch-up.
Today's work, which is the reason a baseline exists at all:
- Booth previews no longer cast world shadows (`NO_BOOTH_SHADOW`). Portrait
characters were entering the sun's shadow cascades, so every skinned-rig
shadow specialization compiled live mid-frame; the hitch detector logged
"main thread blocked 1316 ms" beside a `compiled LIVE` warning. This was
the Fashion/Tmog stutter.
- Per-pane dress-up: each `DressUpModel` pane assembles and stages its own
tried-on look instead of every pane mirroring the live player.
- Item template cache is append-only JSONL written on the IO pool, replacing
an 11.6 MB whole-map JSON rewrite on the main thread every 10 s.
- `WOW_SYSTEM_TIMING` rebuilt per-thread: it took 2 mutexes per system enter
and 4 per exit, costing 15 ms a frame (590 fps -> 60) and corrupting the
measurements it was taken to produce.
- The visibility-churn sweep moved to its own `WOW_FLASH_CHURN` switch, so a
frame-cost reading no longer pays 2.7 ms a frame for it.
Local state (`benilla-config/`, `logs/`, `target/`) is excluded by the
existing .gitignore; the account credential it holds is not in this commit.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SgstFWtn1RxEJ5kVrpgYwn
875 lines
33 KiB
Rust
875 lines
33 KiB
Rust
//! The stock questgiver window (`QuestFrame.xml`), driven engine-only through the quest events.
|
|
|
|
use benilla_ui::script::{QuestPanel, QuestState, ScriptValue, SoundRequest, UiScript};
|
|
|
|
use super::test_ui::load_ui as load_xml;
|
|
|
|
/// Stock `QuestFrame_OnShow` and `QuestFrame_OnHide` play `igQuestListOpen` and `igQuestListClose`
|
|
/// (`QuestFrame.lua:285`, `:294`).
|
|
#[test]
|
|
fn questgiver_show_hide_plays_open_and_close_kits() {
|
|
benilla_formats::wow_data_or_skip!();
|
|
let mut s = UiScript::new().unwrap();
|
|
s.set_screen_size(1024.0, 768.0);
|
|
load_xml(&s, "Interface\\FrameXML\\Fonts.xml");
|
|
load_xml(&s, r"Interface\FrameXML\MoneyFrame.lua");
|
|
load_xml(&s, r"Interface\FrameXML\MoneyFrame.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\GlobalStrings.lua");
|
|
load_xml(&s, r"Interface\FrameXML\UIParent.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\GameTooltip.xml");
|
|
load_xml(&s, r"Interface\FrameXML\UIPanelTemplates.lua");
|
|
load_xml(&s, r"Interface\FrameXML\UIPanelTemplates.xml");
|
|
load_xml(&s, r"Interface\FrameXML\BasicControls.xml");
|
|
load_xml(&s, r"Interface\FrameXML\LocaleProperties.lua");
|
|
load_xml(&s, r"Interface\FrameXML\StaticPopup.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\BasicControls.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\ItemButtonTemplate.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\QuestFrame.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\QuestLogFrame.xml");
|
|
|
|
assert!(
|
|
s.take_sounds().is_empty(),
|
|
"no sound at load (never transitions)"
|
|
);
|
|
|
|
s.set_quest(Some(QuestState {
|
|
panel: QuestPanel::Detail,
|
|
title: "A Threat Within".into(),
|
|
body: "Speak with the captain.".into(),
|
|
objectives: "Report to the captain.".into(),
|
|
..QuestState::default()
|
|
}));
|
|
s.fire_event("QUEST_DETAIL", vec![]);
|
|
assert!(s.errors().is_empty(), "script errors: {:?}", s.errors());
|
|
assert!(
|
|
s.eval::<bool>("return QuestFrame:IsVisible()").unwrap(),
|
|
"the questgiver window opened onto the left slot"
|
|
);
|
|
assert_eq!(
|
|
s.take_sounds(),
|
|
vec![SoundRequest::KitName("igQuestListOpen".into())],
|
|
"opening the questgiver window plays igQuestListOpen"
|
|
);
|
|
|
|
s.fire_event("QUEST_FINISHED", vec![]);
|
|
assert!(s.errors().is_empty(), "script errors: {:?}", s.errors());
|
|
assert!(
|
|
!s.eval::<bool>("return QuestFrame:IsVisible()").unwrap(),
|
|
"QUEST_FINISHED hid the questgiver window"
|
|
);
|
|
assert_eq!(
|
|
s.take_sounds(),
|
|
vec![SoundRequest::KitName("igQuestListClose".into())],
|
|
"closing the questgiver window plays igQuestListClose"
|
|
);
|
|
}
|
|
|
|
/// Each stock `QuestFrame*Panel_OnShow` hides its three siblings; only the window's own show and
|
|
/// hide play a sound.
|
|
#[test]
|
|
fn panel_events_show_exactly_one_child_panel_and_hide_the_others() {
|
|
benilla_formats::wow_data_or_skip!();
|
|
let mut s = UiScript::new().unwrap();
|
|
s.set_screen_size(1024.0, 768.0);
|
|
load_xml(&s, "Interface\\FrameXML\\Fonts.xml");
|
|
load_xml(&s, r"Interface\FrameXML\MoneyFrame.lua");
|
|
load_xml(&s, r"Interface\FrameXML\MoneyFrame.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\GlobalStrings.lua");
|
|
load_xml(&s, r"Interface\FrameXML\UIParent.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\GameTooltip.xml");
|
|
load_xml(&s, r"Interface\FrameXML\UIPanelTemplates.lua");
|
|
load_xml(&s, r"Interface\FrameXML\UIPanelTemplates.xml");
|
|
load_xml(&s, r"Interface\FrameXML\BasicControls.xml");
|
|
load_xml(&s, r"Interface\FrameXML\LocaleProperties.lua");
|
|
load_xml(&s, r"Interface\FrameXML\StaticPopup.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\BasicControls.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\ItemButtonTemplate.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\QuestFrame.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\QuestLogFrame.xml");
|
|
|
|
let panels = [
|
|
"QuestFrameGreetingPanel",
|
|
"QuestFrameDetailPanel",
|
|
"QuestFrameProgressPanel",
|
|
"QuestFrameRewardPanel",
|
|
];
|
|
let is_shown =
|
|
|s: &UiScript, name: &str| s.eval::<bool>(&format!("return {name}:IsShown()")).unwrap();
|
|
|
|
s.set_quest(Some(QuestState {
|
|
panel: QuestPanel::Greeting,
|
|
greeting: "What can I do for you?".into(),
|
|
active_titles: vec!["Report to Goldshire".into()],
|
|
..QuestState::default()
|
|
}));
|
|
s.set_unit(
|
|
"npc",
|
|
Some(benilla_ui::script::UnitState {
|
|
exists: true,
|
|
name: Some("Deputy Willem".into()),
|
|
..Default::default()
|
|
}),
|
|
);
|
|
s.fire_event("QUEST_GREETING", vec![]);
|
|
assert!(s.errors().is_empty(), "script errors: {:?}", s.errors());
|
|
for name in panels {
|
|
assert_eq!(
|
|
is_shown(&s, name),
|
|
name == "QuestFrameGreetingPanel",
|
|
"only the greeting panel is shown after QUEST_GREETING"
|
|
);
|
|
}
|
|
assert_eq!(
|
|
s.eval::<String>("return QuestFrameNpcNameText:GetText()")
|
|
.unwrap(),
|
|
"Deputy Willem"
|
|
);
|
|
// Drain the first show's open sound; the switch below must play none.
|
|
s.take_sounds();
|
|
|
|
s.set_quest(Some(QuestState {
|
|
panel: QuestPanel::Detail,
|
|
title: "A Threat Within".into(),
|
|
..QuestState::default()
|
|
}));
|
|
s.set_unit(
|
|
"npc",
|
|
Some(benilla_ui::script::UnitState {
|
|
exists: true,
|
|
name: Some("Deputy Willem".into()),
|
|
..Default::default()
|
|
}),
|
|
);
|
|
s.fire_event("QUEST_DETAIL", vec![]);
|
|
assert!(s.errors().is_empty(), "script errors: {:?}", s.errors());
|
|
for name in panels {
|
|
assert_eq!(
|
|
is_shown(&s, name),
|
|
name == "QuestFrameDetailPanel",
|
|
"only the detail panel is shown after QUEST_DETAIL"
|
|
);
|
|
}
|
|
assert!(
|
|
s.take_sounds().is_empty(),
|
|
"a panel switch with the window already open plays no kit (only OnShow/OnHide of the window do)"
|
|
);
|
|
}
|
|
|
|
/// Stock `QuestFrameItems_Update` fills one pool of 10 per panel: choices, the spell row, then
|
|
/// fixed rewards, so two choices and one reward are `Item1`, `Item2` and `Item3`.
|
|
#[test]
|
|
fn detail_panel_reward_grid_follows_the_refs_two_per_row_layout() {
|
|
benilla_formats::wow_data_or_skip!();
|
|
let mut s = UiScript::new().unwrap();
|
|
s.set_screen_size(1024.0, 768.0);
|
|
load_xml(&s, "Interface\\FrameXML\\Fonts.xml");
|
|
load_xml(&s, r"Interface\FrameXML\MoneyFrame.lua");
|
|
load_xml(&s, r"Interface\FrameXML\MoneyFrame.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\GlobalStrings.lua");
|
|
load_xml(&s, r"Interface\FrameXML\UIParent.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\GameTooltip.xml");
|
|
load_xml(&s, r"Interface\FrameXML\UIPanelTemplates.lua");
|
|
load_xml(&s, r"Interface\FrameXML\UIPanelTemplates.xml");
|
|
load_xml(&s, r"Interface\FrameXML\BasicControls.xml");
|
|
load_xml(&s, r"Interface\FrameXML\LocaleProperties.lua");
|
|
load_xml(&s, r"Interface\FrameXML\StaticPopup.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\BasicControls.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\ItemButtonTemplate.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\QuestFrame.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\QuestLogFrame.xml");
|
|
|
|
let choice = |name: &str, quality: u32| benilla_ui::script::QuestItemView {
|
|
item_id: 0,
|
|
name: Some(name.into()),
|
|
texture: None,
|
|
count: 1,
|
|
quality,
|
|
usable: true,
|
|
..Default::default()
|
|
};
|
|
s.set_quest(Some(QuestState {
|
|
panel: QuestPanel::Detail,
|
|
title: "A Threat Within".into(),
|
|
body: "Kill the kobolds infesting the mine.".into(),
|
|
objectives: "Slay 10 Kobold Vermin.".into(),
|
|
choices: vec![choice("Worn Sword", 1), choice("Worn Mace", 1)],
|
|
rewards: vec![choice("Militia Hammer", 1)],
|
|
reward_money: 150,
|
|
..QuestState::default()
|
|
}));
|
|
s.set_unit(
|
|
"npc",
|
|
Some(benilla_ui::script::UnitState {
|
|
exists: true,
|
|
name: Some("Marshal McBride".into()),
|
|
..Default::default()
|
|
}),
|
|
);
|
|
s.fire_event("QUEST_DETAIL", vec![]);
|
|
assert!(s.errors().is_empty(), "script errors: {:?}", s.errors());
|
|
|
|
assert!(s.eval::<bool>("return QuestDetailItem1:IsShown()").unwrap());
|
|
assert!(s.eval::<bool>("return QuestDetailItem2:IsShown()").unwrap());
|
|
assert!(!s.eval::<bool>("return QuestDetailItem4:IsShown()").unwrap());
|
|
assert_eq!(
|
|
s.eval::<String>("return QuestDetailItem1Name:GetText()")
|
|
.unwrap(),
|
|
"Worn Sword"
|
|
);
|
|
assert_eq!(
|
|
s.eval::<String>("return QuestDetailItemChooseText:GetText()")
|
|
.unwrap(),
|
|
"You will be able to choose one of these rewards:"
|
|
);
|
|
assert_eq!(
|
|
s.eval::<String>("return QuestDetailItemReceiveText:GetText()")
|
|
.unwrap(),
|
|
"You will also receive:",
|
|
"choices present -> the ref's \"also\" wording (QuestFrame.lua:461-462)"
|
|
);
|
|
assert!(s.eval::<bool>("return QuestDetailItem3:IsShown()").unwrap());
|
|
assert!(!s.eval::<bool>("return QuestDetailItem4:IsShown()").unwrap());
|
|
assert_eq!(
|
|
s.eval::<String>("return QuestDetailItem3Name:GetText()")
|
|
.unwrap(),
|
|
"Militia Hammer"
|
|
);
|
|
assert_eq!(
|
|
s.eval::<String>("return QuestDetailRewardTitleText:GetText()")
|
|
.unwrap(),
|
|
"Rewards"
|
|
);
|
|
|
|
// Detail rows run `QuestItem_OnClick`, which has no select arm (`QuestFrame.lua:115-125`).
|
|
s.run("QuestDetailItem1:Click()").ok();
|
|
assert!(s.errors().is_empty(), "script errors: {:?}", s.errors());
|
|
// Only the reward panel's update (`QuestFrame.lua:519`) and its row clicks set `itemChoice`.
|
|
assert_eq!(
|
|
s.eval::<i64>("return QuestFrameRewardPanel.itemChoice or 0")
|
|
.unwrap(),
|
|
0,
|
|
"a detail-panel row never selects a reward"
|
|
);
|
|
}
|
|
|
|
/// A reward row click selects its choice (`QuestFrame.lua:136-139`).
|
|
#[test]
|
|
fn reward_panel_choice_click_selects_and_completes_with_zero_based_index() {
|
|
benilla_formats::wow_data_or_skip!();
|
|
let mut s = UiScript::new().unwrap();
|
|
s.set_screen_size(1024.0, 768.0);
|
|
load_xml(&s, "Interface\\FrameXML\\Fonts.xml");
|
|
load_xml(&s, r"Interface\FrameXML\MoneyFrame.lua");
|
|
load_xml(&s, r"Interface\FrameXML\MoneyFrame.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\GlobalStrings.lua");
|
|
load_xml(&s, r"Interface\FrameXML\UIParent.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\GameTooltip.xml");
|
|
load_xml(&s, r"Interface\FrameXML\UIPanelTemplates.lua");
|
|
load_xml(&s, r"Interface\FrameXML\UIPanelTemplates.xml");
|
|
load_xml(&s, r"Interface\FrameXML\BasicControls.xml");
|
|
load_xml(&s, r"Interface\FrameXML\LocaleProperties.lua");
|
|
load_xml(&s, r"Interface\FrameXML\StaticPopup.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\BasicControls.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\ItemButtonTemplate.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\QuestFrame.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\QuestLogFrame.xml");
|
|
|
|
let choice = |name: &str| benilla_ui::script::QuestItemView {
|
|
item_id: 0,
|
|
name: Some(name.into()),
|
|
texture: None,
|
|
count: 1,
|
|
quality: 1,
|
|
usable: true,
|
|
..Default::default()
|
|
};
|
|
s.set_quest(Some(QuestState {
|
|
panel: QuestPanel::Reward,
|
|
title: "A Threat Within".into(),
|
|
body: "Well done.".into(),
|
|
choices: vec![choice("Worn Sword"), choice("Worn Mace")],
|
|
..QuestState::default()
|
|
}));
|
|
s.set_unit(
|
|
"npc",
|
|
Some(benilla_ui::script::UnitState {
|
|
exists: true,
|
|
name: Some("Marshal McBride".into()),
|
|
..Default::default()
|
|
}),
|
|
);
|
|
s.fire_event("QUEST_COMPLETE", vec![]);
|
|
assert!(s.errors().is_empty(), "script errors: {:?}", s.errors());
|
|
|
|
assert!(
|
|
!s.eval::<bool>("return QuestRewardItemHighlight:IsShown()")
|
|
.unwrap(),
|
|
"no row picked yet"
|
|
);
|
|
// No choice picked: `QuestChooseRewardError()` instead (`QuestFrame.lua:97-98`).
|
|
s.run("QuestFrameCompleteQuestButton:Click()").unwrap();
|
|
assert!(
|
|
s.take_quest_actions().is_empty(),
|
|
"must pick a choice first"
|
|
);
|
|
|
|
s.run("QuestRewardItem2:Click()").unwrap();
|
|
assert!(s.errors().is_empty(), "script errors: {:?}", s.errors());
|
|
assert!(
|
|
s.eval::<bool>("return QuestRewardItemHighlight:IsShown()")
|
|
.unwrap(),
|
|
"picking a choice row shows the highlight"
|
|
);
|
|
|
|
s.run("QuestFrameCompleteQuestButton:Click()").unwrap();
|
|
assert_eq!(
|
|
s.take_quest_actions(),
|
|
vec![benilla_ui::script::QuestAction::Reward(1)],
|
|
"row 2 (1-based) -> wire index 1 (0-based)"
|
|
);
|
|
}
|
|
|
|
/// Goodbye only hides the window, with no `DeclineQuest()` (`QuestFrame.xml:748-752`).
|
|
#[test]
|
|
fn greeting_goodbye_button_closes_the_window() {
|
|
benilla_formats::wow_data_or_skip!();
|
|
let mut s = UiScript::new().unwrap();
|
|
s.set_screen_size(1024.0, 768.0);
|
|
load_xml(&s, "Interface\\FrameXML\\Fonts.xml");
|
|
load_xml(&s, r"Interface\FrameXML\MoneyFrame.lua");
|
|
load_xml(&s, r"Interface\FrameXML\MoneyFrame.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\GlobalStrings.lua");
|
|
load_xml(&s, r"Interface\FrameXML\UIParent.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\GameTooltip.xml");
|
|
load_xml(&s, r"Interface\FrameXML\UIPanelTemplates.lua");
|
|
load_xml(&s, r"Interface\FrameXML\UIPanelTemplates.xml");
|
|
load_xml(&s, r"Interface\FrameXML\BasicControls.xml");
|
|
load_xml(&s, r"Interface\FrameXML\LocaleProperties.lua");
|
|
load_xml(&s, r"Interface\FrameXML\StaticPopup.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\BasicControls.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\ItemButtonTemplate.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\QuestFrame.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\QuestLogFrame.xml");
|
|
|
|
s.set_quest(Some(QuestState {
|
|
panel: QuestPanel::Greeting,
|
|
greeting: "Hello".into(),
|
|
..QuestState::default()
|
|
}));
|
|
s.set_unit(
|
|
"npc",
|
|
Some(benilla_ui::script::UnitState {
|
|
exists: true,
|
|
name: Some("Deputy Willem".into()),
|
|
..Default::default()
|
|
}),
|
|
);
|
|
s.fire_event("QUEST_GREETING", vec![]);
|
|
assert!(s.errors().is_empty(), "script errors: {:?}", s.errors());
|
|
assert!(s.eval::<bool>("return QuestFrame:IsVisible()").unwrap());
|
|
|
|
s.run("QuestFrameGreetingGoodbyeButton:Click()").unwrap();
|
|
assert!(s.errors().is_empty(), "script errors: {:?}", s.errors());
|
|
assert!(
|
|
!s.eval::<bool>("return QuestFrame:IsVisible()").unwrap(),
|
|
"Goodbye closes the questgiver window"
|
|
);
|
|
}
|
|
|
|
/// Accept and Decline keep real on-window rects through the instant-text arm's one frame of
|
|
/// disabled Accept; the test plants `QUEST_FADING_DISABLE = "1"`, the default being `"0"`.
|
|
#[test]
|
|
fn detail_panel_action_buttons_resolve_to_real_onscreen_rects() {
|
|
benilla_formats::wow_data_or_skip!();
|
|
let mut s = UiScript::new().unwrap();
|
|
s.set_screen_size(1024.0, 768.0);
|
|
load_xml(&s, "Interface\\FrameXML\\Fonts.xml");
|
|
load_xml(&s, r"Interface\FrameXML\MoneyFrame.lua");
|
|
load_xml(&s, r"Interface\FrameXML\MoneyFrame.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\GlobalStrings.lua");
|
|
load_xml(&s, r"Interface\FrameXML\UIParent.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\GameTooltip.xml");
|
|
load_xml(&s, r"Interface\FrameXML\UIPanelTemplates.lua");
|
|
load_xml(&s, r"Interface\FrameXML\UIPanelTemplates.xml");
|
|
load_xml(&s, r"Interface\FrameXML\BasicControls.xml");
|
|
load_xml(&s, r"Interface\FrameXML\LocaleProperties.lua");
|
|
load_xml(&s, r"Interface\FrameXML\StaticPopup.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\BasicControls.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\ItemButtonTemplate.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\QuestFrame.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\QuestLogFrame.xml");
|
|
s.eval::<()>(r#"QUEST_FADING_DISABLE = "1""#).unwrap();
|
|
s.set_quest(Some(QuestState {
|
|
panel: QuestPanel::Detail,
|
|
title: "A Threat Within".into(),
|
|
body: "Kill kobolds.".into(),
|
|
..QuestState::default()
|
|
}));
|
|
s.set_unit(
|
|
"npc",
|
|
Some(benilla_ui::script::UnitState {
|
|
exists: true,
|
|
name: Some("Deputy Willem".into()),
|
|
..Default::default()
|
|
}),
|
|
);
|
|
s.fire_event("QUEST_DETAIL", vec![]);
|
|
assert!(s.errors().is_empty(), "script errors: {:?}", s.errors());
|
|
assert!(s
|
|
.eval::<bool>("return QuestFrameAcceptButton:IsShown()")
|
|
.unwrap());
|
|
assert!(s
|
|
.eval::<bool>("return QuestFrameDeclineButton:IsShown()")
|
|
.unwrap());
|
|
|
|
s.resolve();
|
|
let button_art = |s: &mut UiScript| {
|
|
let mut v = Vec::new();
|
|
for q in s.extract() {
|
|
if let benilla_ui::script::QuadContent::Texture { path: Some(p), .. } = &q.content {
|
|
if p.starts_with("Interface\\Buttons\\UI-Panel-Button-") {
|
|
v.push((
|
|
p.clone(),
|
|
q.rect.expect("button quad carries a resolved rect"),
|
|
));
|
|
}
|
|
}
|
|
}
|
|
v
|
|
};
|
|
|
|
// `OnShow` still disables Accept and zeroes the block; the reveal just starts at 1024
|
|
// (`QuestFrame.lua:543-551`).
|
|
let writing = button_art(&mut s);
|
|
assert_eq!(
|
|
writing.len(),
|
|
2,
|
|
"Accept + Decline both extract a real rect (not dropped for being unshown)"
|
|
);
|
|
assert!(
|
|
writing
|
|
.iter()
|
|
.any(|(p, _)| p.ends_with("UI-Panel-Button-Disabled")),
|
|
"Accept draws the Disabled art inside the one-frame arm window"
|
|
);
|
|
for (_, r) in &writing {
|
|
assert!(
|
|
r.top <= 512.0 && r.bottom >= 0.0 && r.left >= 0.0 && r.right <= 384.0,
|
|
"button {r:?} must land inside the 384x512 window, not off-screen/at the origin"
|
|
);
|
|
}
|
|
|
|
// The first `OnUpdate` scratches once, snaps the block opaque and enables Accept
|
|
// (`QuestFrame.lua:554-568`).
|
|
let scratches = |sounds: Vec<SoundRequest>| {
|
|
sounds
|
|
.iter()
|
|
.filter(|r| **r == SoundRequest::KitName("WriteQuest".into()))
|
|
.count()
|
|
};
|
|
s.tick(0.05);
|
|
assert!(s.errors().is_empty(), "tick errors: {:?}", s.errors());
|
|
assert_eq!(
|
|
scratches(s.take_sounds()),
|
|
1,
|
|
"instant text keeps the writing sound: one scratch on the wake tick"
|
|
);
|
|
assert!(s
|
|
.eval::<bool>("return QuestFrameAcceptButton:IsEnabled() ~= 0")
|
|
.unwrap());
|
|
assert_eq!(
|
|
s.eval::<f32>("return TextAlphaDependentFrame:GetAlpha()")
|
|
.unwrap(),
|
|
1.0,
|
|
"the block snaps straight to opaque — no QUESTINFO_FADE_IN ramp in instant mode"
|
|
);
|
|
s.tick(0.5);
|
|
assert_eq!(
|
|
scratches(s.take_sounds()),
|
|
0,
|
|
"the quill stops after the single instant-mode scratch"
|
|
);
|
|
s.resolve();
|
|
let written = button_art(&mut s);
|
|
assert!(
|
|
written
|
|
.iter()
|
|
.all(|(p, _)| p.ends_with("UI-Panel-Button-Up")),
|
|
"both buttons draw live art once the text has written on: {written:?}"
|
|
);
|
|
}
|
|
|
|
/// With the default `QUEST_FADING_DISABLE = "0"` the text writes on at 40 chars/s, scratching each
|
|
/// tick with Accept disabled, then the block fades in (`QuestFrame.lua:5-6`, `:554-568`).
|
|
#[test]
|
|
fn write_on_still_fades_when_instant_text_is_off() {
|
|
benilla_formats::wow_data_or_skip!();
|
|
let mut s = UiScript::new().unwrap();
|
|
s.set_screen_size(1024.0, 768.0);
|
|
load_xml(&s, "Interface\\FrameXML\\Fonts.xml");
|
|
load_xml(&s, r"Interface\FrameXML\MoneyFrame.lua");
|
|
load_xml(&s, r"Interface\FrameXML\MoneyFrame.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\GlobalStrings.lua");
|
|
load_xml(&s, r"Interface\FrameXML\UIParent.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\GameTooltip.xml");
|
|
load_xml(&s, r"Interface\FrameXML\UIPanelTemplates.lua");
|
|
load_xml(&s, r"Interface\FrameXML\UIPanelTemplates.xml");
|
|
load_xml(&s, r"Interface\FrameXML\BasicControls.xml");
|
|
load_xml(&s, r"Interface\FrameXML\LocaleProperties.lua");
|
|
load_xml(&s, r"Interface\FrameXML\StaticPopup.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\BasicControls.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\ItemButtonTemplate.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\QuestFrame.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\QuestLogFrame.xml");
|
|
s.eval::<()>(r#"QUEST_FADING_DISABLE = "0""#).unwrap();
|
|
s.set_quest(Some(QuestState {
|
|
panel: QuestPanel::Detail,
|
|
title: "A Threat Within".into(),
|
|
body: "Kill kobolds.".into(),
|
|
..QuestState::default()
|
|
}));
|
|
s.set_unit(
|
|
"npc",
|
|
Some(benilla_ui::script::UnitState {
|
|
exists: true,
|
|
name: Some("Deputy Willem".into()),
|
|
..Default::default()
|
|
}),
|
|
);
|
|
s.fire_event("QUEST_DETAIL", vec![]);
|
|
assert!(s.errors().is_empty(), "script errors: {:?}", s.errors());
|
|
|
|
// Mid-write: the reveal is at char 4 of 13.
|
|
s.tick(0.1);
|
|
assert!(
|
|
s.take_sounds()
|
|
.iter()
|
|
.any(|r| *r == SoundRequest::KitName("WriteQuest".into())),
|
|
"the write-on scratches the WriteQuest quill each tick"
|
|
);
|
|
assert!(!s
|
|
.eval::<bool>("return QuestFrameAcceptButton:IsEnabled() ~= 0")
|
|
.unwrap());
|
|
|
|
// Half a second more ends the 13-char gradient: Accept wakes and the block is mid-fade.
|
|
s.tick(0.5);
|
|
assert!(s.errors().is_empty(), "tick errors: {:?}", s.errors());
|
|
assert!(s
|
|
.eval::<bool>("return QuestFrameAcceptButton:IsEnabled() ~= 0")
|
|
.unwrap());
|
|
let alpha = s
|
|
.eval::<f32>("return TextAlphaDependentFrame:GetAlpha()")
|
|
.unwrap();
|
|
assert!(
|
|
alpha < 1.0,
|
|
"fading mode ramps the block in (got alpha {alpha})"
|
|
);
|
|
s.tick(1.1);
|
|
assert_eq!(
|
|
s.eval::<f32>("return TextAlphaDependentFrame:GetAlpha()")
|
|
.unwrap(),
|
|
1.0,
|
|
"the fade completes at opaque"
|
|
);
|
|
}
|
|
|
|
/// Every quest event but `QUEST_FINISHED`, `QUEST_ITEM_UPDATE` over a shown window included,
|
|
/// re-reads `UnitName("npc")` into the title bar (`QuestFrame.lua:26`, `:62-63`).
|
|
#[test]
|
|
fn npc_name_reaches_the_title_bar_on_open_and_on_refresh() {
|
|
benilla_formats::wow_data_or_skip!();
|
|
let mut s = UiScript::new().unwrap();
|
|
s.set_screen_size(1024.0, 768.0);
|
|
load_xml(&s, "Interface\\FrameXML\\Fonts.xml");
|
|
load_xml(&s, r"Interface\FrameXML\MoneyFrame.lua");
|
|
load_xml(&s, r"Interface\FrameXML\MoneyFrame.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\GlobalStrings.lua");
|
|
load_xml(&s, r"Interface\FrameXML\UIParent.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\GameTooltip.xml");
|
|
load_xml(&s, r"Interface\FrameXML\UIPanelTemplates.lua");
|
|
load_xml(&s, r"Interface\FrameXML\UIPanelTemplates.xml");
|
|
load_xml(&s, r"Interface\FrameXML\BasicControls.xml");
|
|
load_xml(&s, r"Interface\FrameXML\LocaleProperties.lua");
|
|
load_xml(&s, r"Interface\FrameXML\StaticPopup.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\BasicControls.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\ItemButtonTemplate.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\QuestFrame.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\QuestLogFrame.xml");
|
|
|
|
s.set_quest(Some(QuestState {
|
|
panel: QuestPanel::Detail,
|
|
title: "A Threat Within".into(),
|
|
body: "Kill things.".into(),
|
|
..QuestState::default()
|
|
}));
|
|
s.set_unit(
|
|
"npc",
|
|
Some(benilla_ui::script::UnitState {
|
|
exists: true,
|
|
name: Some("Marshal McBride".into()),
|
|
..Default::default()
|
|
}),
|
|
);
|
|
s.fire_event("QUEST_DETAIL", vec![]);
|
|
assert!(s.errors().is_empty(), "script errors: {:?}", s.errors());
|
|
assert_eq!(
|
|
s.eval::<String>("return getglobal('QuestFrameNpcNameText'):GetText() or ''")
|
|
.unwrap(),
|
|
"Marshal McBride",
|
|
"the panel-open event's arg1 lands in the title bar"
|
|
);
|
|
s.resolve();
|
|
let name_quad = s
|
|
.extract()
|
|
.into_iter()
|
|
.find(|q| {
|
|
matches!(&q.content,
|
|
benilla_ui::script::QuadContent::Text { text: Some(t), .. } if t == "Marshal McBride")
|
|
})
|
|
.expect("the NPC-name FontString extracts a quad");
|
|
assert!(
|
|
name_quad.rect.is_some(),
|
|
"the NPC-name quad carries a resolved rect (got None — under-constrained)"
|
|
);
|
|
|
|
// A cleared name comes back on the refresh.
|
|
s.run("getglobal('QuestFrameNpcNameText'):SetText('')")
|
|
.unwrap();
|
|
s.fire_event(
|
|
"QUEST_ITEM_UPDATE",
|
|
vec![ScriptValue::Str("Marshal McBride".into())],
|
|
);
|
|
assert_eq!(
|
|
s.eval::<String>("return getglobal('QuestFrameNpcNameText'):GetText() or ''")
|
|
.unwrap(),
|
|
"Marshal McBride",
|
|
"the QUEST_ITEM_UPDATE refresh also carries the name"
|
|
);
|
|
}
|
|
|
|
/// A title that wraps at the row label's 275px (`QuestFrameTemplates.xml:202`) grows its row, or
|
|
/// the rows below overlap it.
|
|
#[test]
|
|
fn greeting_panel_title_rows_grow_to_their_wrapped_titles() {
|
|
benilla_formats::wow_data_or_skip!();
|
|
let mut s = UiScript::new().unwrap();
|
|
s.set_screen_size(1024.0, 768.0);
|
|
// Stock sizes each row right after `SetText`, `GetTextHeight() + 2` (`QuestFrame.lua:245`), so
|
|
// the measure must be synchronous, as the app's is.
|
|
s.set_text_measurer(Box::new(super::FixedWidthFont(7.0)));
|
|
load_xml(&s, "Interface\\FrameXML\\Fonts.xml");
|
|
load_xml(&s, r"Interface\FrameXML\MoneyFrame.lua");
|
|
load_xml(&s, r"Interface\FrameXML\MoneyFrame.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\GlobalStrings.lua");
|
|
load_xml(&s, r"Interface\FrameXML\UIParent.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\GameTooltip.xml");
|
|
load_xml(&s, r"Interface\FrameXML\UIPanelTemplates.lua");
|
|
load_xml(&s, r"Interface\FrameXML\UIPanelTemplates.xml");
|
|
load_xml(&s, r"Interface\FrameXML\BasicControls.xml");
|
|
load_xml(&s, r"Interface\FrameXML\LocaleProperties.lua");
|
|
load_xml(&s, r"Interface\FrameXML\StaticPopup.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\BasicControls.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\ItemButtonTemplate.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\QuestFrame.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\QuestLogFrame.xml");
|
|
|
|
s.set_quest(Some(QuestState {
|
|
panel: QuestPanel::Greeting,
|
|
greeting: "What can I do for you?".into(),
|
|
active_titles: vec![
|
|
"Deliver Thomas' Report to Marshal Dughan in Goldshire before the Defias move again"
|
|
.into(),
|
|
"Investigate the Echo Ridge Mine and report back to Marshal McBride at once".into(),
|
|
],
|
|
..QuestState::default()
|
|
}));
|
|
s.set_unit(
|
|
"npc",
|
|
Some(benilla_ui::script::UnitState {
|
|
exists: true,
|
|
name: Some("Deputy Willem".into()),
|
|
..Default::default()
|
|
}),
|
|
);
|
|
s.fire_event("QUEST_GREETING", vec![]);
|
|
assert!(s.errors().is_empty(), "script errors: {:?}", s.errors());
|
|
|
|
let answer_measures = |s: &mut UiScript| {
|
|
let answers: Vec<(u32, f32, f32, u64)> = s
|
|
.fontstrings_needing_measure()
|
|
.into_iter()
|
|
.map(|r| {
|
|
let ink = r.text.chars().count() as f32 * 6.0;
|
|
match r.wrap_width {
|
|
Some(w) => (r.id, ink.min(w), (ink / w).ceil().max(1.0) * 14.0, r.key),
|
|
None => (r.id, ink, 14.0, r.key),
|
|
}
|
|
})
|
|
.collect();
|
|
s.set_measured_text_unwrapped(&answers);
|
|
};
|
|
answer_measures(&mut s);
|
|
s.resolve();
|
|
s.tick(0.016);
|
|
answer_measures(&mut s);
|
|
s.resolve();
|
|
assert!(s.errors().is_empty(), "script errors: {:?}", s.errors());
|
|
|
|
let row = |i: u32| -> (f32, f32, f32) {
|
|
s.eval::<(f32, f32, f32)>(&format!(
|
|
"local b = getglobal('QuestTitleButton{i}')\n\
|
|
return b:GetTop(), b:GetBottom(), b:GetFontString():GetHeight()"
|
|
))
|
|
.unwrap()
|
|
};
|
|
let (t1, b1, h1) = row(1);
|
|
let (t2, b2, h2) = row(2);
|
|
assert!(h1 >= 24.0 && h2 >= 24.0, "both titles wrap: {h1}, {h2}");
|
|
assert!(
|
|
(t1 - b1 - (h1 + 2.0)).abs() < 0.5,
|
|
"row 1 is its wrapped title + 2: got {}, title {h1}",
|
|
t1 - b1
|
|
);
|
|
assert!(
|
|
(t2 - b2 - (h2 + 2.0)).abs() < 0.5,
|
|
"row 2 is its wrapped title + 2: got {}, title {h2}",
|
|
t2 - b2
|
|
);
|
|
assert!(
|
|
t2 <= b1 + 0.5,
|
|
"row 2 starts at/below row 1's bottom: row1 bottom {b1}, row2 top {t2}"
|
|
);
|
|
}
|
|
|
|
/// Stock `QuestRewardItem_OnClick` (`QuestFrame.lua:127-141`): ctrl previews, shift posts the
|
|
/// link, and only a plain click selects. The ctrl arm runs last: the dressing room takes the
|
|
/// questgiver window's left slot (`UIParent.lua:24`, `:41`).
|
|
#[test]
|
|
fn reward_rows_preview_and_post_without_selecting_the_choice() {
|
|
benilla_formats::wow_data_or_skip!();
|
|
let mut s = UiScript::new().unwrap();
|
|
s.set_screen_size(1024.0, 768.0);
|
|
load_xml(&s, "Interface\\FrameXML\\Fonts.xml");
|
|
load_xml(&s, r"Interface\FrameXML\MoneyFrame.lua");
|
|
load_xml(&s, r"Interface\FrameXML\MoneyFrame.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\GlobalStrings.lua");
|
|
load_xml(&s, r"Interface\FrameXML\UIParent.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\GameTooltip.xml");
|
|
load_xml(&s, r"Interface\FrameXML\UIPanelTemplates.lua");
|
|
load_xml(&s, r"Interface\FrameXML\UIPanelTemplates.xml");
|
|
load_xml(&s, r"Interface\FrameXML\BasicControls.xml");
|
|
load_xml(&s, r"Interface\FrameXML\LocaleProperties.lua");
|
|
load_xml(&s, r"Interface\FrameXML\StaticPopup.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\BasicControls.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\ItemButtonTemplate.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\QuestFrame.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\QuestLogFrame.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\DressUpFrame.xml"); // DressUpItemLink lives here
|
|
load_xml(&s, "Interface\\FrameXML\\UIMenu.xml"); // the kit its menus build from
|
|
load_xml(&s, "Interface\\FrameXML\\ChatFrame.xml"); // ChatFrameEditBox lives here
|
|
load_xml(&s, "Interface\\FrameXML\\UIDropDownMenu.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\UIPanelTemplates.lua");
|
|
load_xml(&s, "Interface\\FrameXML\\UIPanelTemplates.xml");
|
|
load_xml(&s, "Interface\\FrameXML\\FloatingChatFrame.xml");
|
|
|
|
const SWORD: &str = "|cffffffff|Hitem:2299:0:0:0|h[Worn Sword]|h|r";
|
|
const MACE: &str = "|cffffffff|Hitem:2300:0:0:0|h[Worn Mace]|h|r";
|
|
let item = |id: u32, name: &str, link: &str| benilla_ui::script::QuestItemView {
|
|
item_id: id,
|
|
name: Some(name.into()),
|
|
texture: None,
|
|
count: 1,
|
|
quality: 1,
|
|
usable: true,
|
|
link: Some(link.into()),
|
|
};
|
|
s.set_quest(Some(QuestState {
|
|
panel: QuestPanel::Reward,
|
|
title: "A Threat Within".into(),
|
|
body: "Well done.".into(),
|
|
choices: vec![
|
|
item(2299, "Worn Sword", SWORD),
|
|
item(2300, "Worn Mace", MACE),
|
|
],
|
|
rewards: vec![item(
|
|
2504,
|
|
"Worn Shortbow",
|
|
"|cffffffff|Hitem:2504:0:0:0|h[Worn Shortbow]|h|r",
|
|
)],
|
|
..QuestState::default()
|
|
}));
|
|
s.set_unit(
|
|
"npc",
|
|
Some(benilla_ui::script::UnitState {
|
|
exists: true,
|
|
name: Some("Marshal McBride".into()),
|
|
..Default::default()
|
|
}),
|
|
);
|
|
s.fire_event("QUEST_COMPLETE", vec![]);
|
|
assert!(s.errors().is_empty(), "script errors: {:?}", s.errors());
|
|
|
|
// A plain click selects row 2; the modified clicks below aim at row 1.
|
|
s.run("QuestRewardItem2:Click()").unwrap();
|
|
assert_eq!(
|
|
s.eval::<i64>("return QuestFrameRewardPanel.itemChoice")
|
|
.unwrap(),
|
|
2,
|
|
"a plain click still selects the reward choice"
|
|
);
|
|
assert!(s
|
|
.eval::<bool>("return QuestRewardItemHighlight:IsShown()")
|
|
.unwrap());
|
|
assert!(
|
|
s.take_dressup_intent_kinds().is_empty(),
|
|
"a plain click never opens the dressing room"
|
|
);
|
|
|
|
assert!(s.focus_editbox("ChatFrameEditBox"));
|
|
s.set_modifiers(true, false, false);
|
|
s.run("QuestRewardItem1:Click()").unwrap();
|
|
s.set_modifiers(false, false, false);
|
|
assert_eq!(
|
|
s.eval::<String>("return ChatFrameEditBox:GetText()")
|
|
.unwrap(),
|
|
SWORD,
|
|
"shift-click posted choice 1's link"
|
|
);
|
|
assert_eq!(
|
|
s.eval::<i64>("return QuestFrameRewardPanel.itemChoice")
|
|
.unwrap(),
|
|
2,
|
|
"the shift arm returns — it must NOT also select the clicked choice"
|
|
);
|
|
|
|
// A fixed reward row posts too; only `this.type == "choice"` selects (`QuestFrame.lua:136`).
|
|
s.run("ChatFrameEditBox:SetText(\"\")").unwrap();
|
|
s.set_modifiers(true, false, false);
|
|
s.run("QuestRewardItem3:Click()").unwrap();
|
|
s.set_modifiers(false, false, false);
|
|
assert_eq!(
|
|
s.eval::<String>("return ChatFrameEditBox:GetText()")
|
|
.unwrap(),
|
|
"|cffffffff|Hitem:2504:0:0:0|h[Worn Shortbow]|h|r"
|
|
);
|
|
|
|
s.set_modifiers(false, true, false);
|
|
s.run("QuestRewardItem1:Click()").unwrap();
|
|
s.set_modifiers(false, false, false);
|
|
assert_eq!(
|
|
s.take_dressup_intent_kinds(),
|
|
vec![
|
|
benilla_ui::script::DressUpIntent::Dress,
|
|
benilla_ui::script::DressUpIntent::TryOn(2299)
|
|
],
|
|
"ctrl-click opened the room wearing choice 1"
|
|
);
|
|
assert_eq!(
|
|
s.eval::<i64>("return QuestFrameRewardPanel.itemChoice")
|
|
.unwrap(),
|
|
2,
|
|
"the ctrl arm returns — it must NOT also select the clicked choice"
|
|
);
|
|
assert!(s.errors().is_empty(), "script errors: {:?}", s.errors());
|
|
}
|