Sam SungandClaude Opus 5.5
f98c1a5396
Part of #41: the last of five `benilla-app` pieces. This one is everything the others did not cover: the addon harness, the settings registry, the glue screens (login, realm list, character select and create), key bindings, the minimap, nameplates, the loading screen, transports, the performance instruments, the smaller modules, the integration tests, and the UI asset files (`OptionsFrame.xml`, `benilla.toc` and the rest). Their comments are rewritten to the rule in `docs/METHOD.md`, which is what the code does and the reference fact behind it, in a line. 27,351 comment lines become 11,010. Fixes #33. Fixes #103. - **The mechanical strip.** The citations that were only a private record number go first, and each edit is shown to be a pure removal. - **Wrong facts corrected.** The rewrite corrects the comments that stated wrong facts. Among them: - The weapon trail's emissive is 0 (`0x70ca30`): the trail is a type-5 render record, so its ambient-only light term is exact. - The camera-style dropdown writes "1", "2", "0" (`UIOptionsFrame.lua:525,536,547`); several register-site addresses in the settings table are corrected. - The graphics settings are held until `RestartGx`, as in 1.12; `Fonts.xml`'s early load no longer carries a false reason. - vmangos sends a player-name invalidation after a rename (`CharacterHandler.cpp:839`), and the cinematic camera's announce packet has an empty handler there (`MiscHandler.cpp:919`). - Stock FrameXML and GlueXML line citations are checked against the stock 1.12 files, and vmangos line citations against the pinned revision. - **Deviation labels.** "Deviation:" now marks only a choice with its recorded reason. Declining to copy a reference defect is stated plainly, and so is an unbuilt behaviour or an untraced one. - **Verification.** Every file strips to identical code, apart from test literals in `login/`, `death/` and `ui_script/death_tests.rs` that now use placeholder account and character names, and `cargo fmt --check` is clean. Six second readers compared every file old against new, restored the facts the rewrite had dropped, and checked each new citation against the code, the stock files, vmangos and the reference. A second commit corrects one comment in `benilla-ui` (`unit_is_grey`: the reference's exclusion is players only). A third lowers `ui_script_wall`'s ceiling from 45 to 40: five gameplay files named `UiScript` only in comments the rewrite removed, and the ratchet asks for the number to follow. Behaviour differences the rewrite surfaced are filed as their own issues (#339 to #353 among them). String literals are untouched; they are #92. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
458 lines
18 KiB
Rust
458 lines
18 KiB
Rust
//! The delete confirm dialog (`CharacterDeleteDialog`): typing `DELETE_CONFIRM_STRING` ("DELETE")
|
||
//! arms Okay, which sends `CMSG_CHAR_DELETE` (`gsTitleOptionOK`); Cancel or Escape close it
|
||
//! (`gsTitleOptionExit`). The target is snapshotted at open, so a roster refresh cannot retarget.
|
||
|
||
use benilla_ui::widget::EditBoxState;
|
||
use bevy::input::keyboard::KeyboardInput;
|
||
|
||
use crate::textinput::{self, HostClipboard};
|
||
use bevy::prelude::*;
|
||
|
||
use crate::glue::art::{tc_rect, GlueArt, GOLD};
|
||
use crate::glue::backdrop::{backdrop_border, tiled_bg_node};
|
||
use crate::glue::widgets::{
|
||
caret_bar, glue_button, outlined_text, overlay, paint_glue_field, GlueBtnKind, GlueDisabled,
|
||
GlueFieldPart, GlueText,
|
||
};
|
||
use crate::glue_strings::GlueStrings;
|
||
use crate::net::{CharPick, CharRequest};
|
||
use crate::sound::GlueSound;
|
||
|
||
use super::wow_font;
|
||
|
||
/// The delete dialog's state.
|
||
#[derive(Resource, Default)]
|
||
pub(super) struct DeleteDialog {
|
||
pub(super) open: bool,
|
||
/// The snapshotted target: guid, name, level, class name.
|
||
target: Option<(u64, String, u8, &'static str)>,
|
||
/// The confirm box's text; the reference's `letters="32"` cap is its `max_letters`.
|
||
pub(super) typed: EditBoxState,
|
||
/// The spawned dialog root, while up.
|
||
root: Option<Entity>,
|
||
/// The glue scale the tree was built at; a resize rebuilds it.
|
||
spawned_s: f32,
|
||
}
|
||
|
||
impl DeleteDialog {
|
||
pub(super) fn open_for(&mut self, guid: u64, name: String, level: u8, class: &'static str) {
|
||
self.open = true;
|
||
self.target = Some((guid, name, level, class));
|
||
self.typed.set_text("");
|
||
}
|
||
|
||
pub(super) fn close(&mut self) {
|
||
self.open = false;
|
||
self.target = None;
|
||
self.typed.set_text("");
|
||
}
|
||
|
||
/// The typed text matches `DELETE_CONFIRM_STRING`, case-insensitive (the reference's
|
||
/// `strupper`).
|
||
fn armed(&self, confirm: &str) -> bool {
|
||
self.typed.text.eq_ignore_ascii_case(confirm)
|
||
}
|
||
}
|
||
|
||
/// The dialog's action buttons.
|
||
#[derive(Component, Clone, Copy, PartialEq, Eq)]
|
||
pub(super) enum DialogAction {
|
||
Okay,
|
||
Cancel,
|
||
}
|
||
|
||
/// The typed-text line inside the edit box.
|
||
#[derive(Component)]
|
||
pub(super) struct TypedText;
|
||
/// The edit box's caret bar; the dialog's one field always holds the focus.
|
||
#[derive(Component)]
|
||
pub(super) struct DeleteCaret;
|
||
/// The dialog root (despawned on close).
|
||
#[derive(Component)]
|
||
struct DialogUi;
|
||
|
||
/// Spawn or despawn the dialog, feed its typing and run Okay, Cancel, Enter and Escape. Runs
|
||
/// before the list refresh, so a delete's roster update repaints the frame it lands.
|
||
#[allow(clippy::type_complexity)]
|
||
pub(super) fn drive_delete_dialog(
|
||
mut commands: Commands,
|
||
mut dialog: ResMut<DeleteDialog>,
|
||
art: Res<GlueArt>,
|
||
assets: Res<AssetServer>,
|
||
strings: Option<Res<GlueStrings>>,
|
||
pick: Res<CharPick>,
|
||
keys: Res<ButtonInput<KeyCode>>,
|
||
mut keyboard: MessageReader<KeyboardInput>,
|
||
mut sounds: MessageWriter<GlueSound>,
|
||
buttons: Query<(Entity, &DialogAction)>,
|
||
clicks: Res<crate::glue::GlueClicks>,
|
||
mut okay: Query<(&DialogAction, &mut GlueDisabled)>,
|
||
mut parts: Query<(
|
||
&crate::glue::widgets::GlueFieldPart,
|
||
Option<&mut Text>,
|
||
&mut Visibility,
|
||
)>,
|
||
mut clipboard: NonSendMut<HostClipboard>,
|
||
// The window drives the glue scale; its raw handle carries the Wayland clipboard's display.
|
||
window: Query<
|
||
(&Window, Option<&bevy::window::RawHandleWrapper>),
|
||
With<bevy::window::PrimaryWindow>,
|
||
>,
|
||
time: Res<Time>,
|
||
) {
|
||
let empty = GlueStrings::default();
|
||
let strings = strings.as_deref().unwrap_or(&empty);
|
||
let confirm = strings.text("DELETE_CONFIRM_STRING", "DELETE");
|
||
|
||
if !dialog.open {
|
||
if let Some(root) = dialog.root.take() {
|
||
commands.entity(root).despawn();
|
||
}
|
||
keyboard.clear();
|
||
return;
|
||
}
|
||
|
||
// Respawn on a glue-scale change; the typed text lives in the resource and survives.
|
||
let s = crate::glue::screen_scale(window.single().ok().map(|(w, _)| w));
|
||
if dialog.root.is_some() && dialog.spawned_s != s {
|
||
if let Some(root) = dialog.root.take() {
|
||
commands.entity(root).despawn();
|
||
}
|
||
}
|
||
if dialog.root.is_none() {
|
||
dialog.root = Some(spawn_dialog(
|
||
&mut commands,
|
||
&art,
|
||
&assets,
|
||
strings,
|
||
&dialog,
|
||
s,
|
||
));
|
||
dialog.spawned_s = s;
|
||
}
|
||
|
||
// Enter and Escape pass through unclaimed to the key handling below.
|
||
let mods = textinput::mods_now(&keys);
|
||
let wl = textinput::wayland_display(window.iter().next().and_then(|(_, h)| h));
|
||
for ev in keyboard.read() {
|
||
textinput::feed_key(
|
||
&mut dialog.typed,
|
||
ev,
|
||
mods,
|
||
&mut clipboard,
|
||
wl,
|
||
textinput::CharFilter::Any,
|
||
);
|
||
}
|
||
textinput::tick_caret(&mut dialog.typed, true, time.delta_secs());
|
||
paint_glue_field(&dialog.typed, true, parts.iter_mut());
|
||
|
||
let armed = dialog.armed(confirm);
|
||
for (action, mut disabled) in &mut okay {
|
||
if *action == DialogAction::Okay && disabled.0 == armed {
|
||
disabled.0 = !armed;
|
||
}
|
||
}
|
||
|
||
let mut do_delete = false;
|
||
let mut do_cancel = false;
|
||
// Both buttons fire on release, so a press can slide off.
|
||
for (entity, action) in &buttons {
|
||
if !clicks.hit(entity) {
|
||
continue;
|
||
}
|
||
match action {
|
||
DialogAction::Okay if armed => do_delete = true,
|
||
DialogAction::Okay => {}
|
||
DialogAction::Cancel => do_cancel = true,
|
||
}
|
||
}
|
||
if (keys.just_pressed(KeyCode::Enter) || keys.just_pressed(KeyCode::NumpadEnter)) && armed {
|
||
do_delete = true;
|
||
}
|
||
if keys.just_pressed(KeyCode::Escape) {
|
||
do_cancel = true;
|
||
}
|
||
if do_delete {
|
||
if let Some((guid, name, _, _)) = &dialog.target {
|
||
info!("char select: deleting {name}");
|
||
let _ = pick.0.send(CharRequest::Delete(*guid));
|
||
}
|
||
sounds.write(GlueSound("gsTitleOptionOK"));
|
||
dialog.close();
|
||
} else if do_cancel {
|
||
sounds.write(GlueSound("gsTitleOptionExit"));
|
||
dialog.close();
|
||
}
|
||
}
|
||
|
||
/// Build `CharacterDeleteDialog`'s layout: the 512×256 DialogBox centered, the question, the
|
||
/// instructions, the alert icon, the edit box, Okay and Cancel. The vertical positions resolve the
|
||
/// reference's anchor chain: Text1 TOP (0,-16), instructions 20 below, the box 5 below (top 102).
|
||
fn spawn_dialog(
|
||
commands: &mut Commands,
|
||
art: &GlueArt,
|
||
assets: &AssetServer,
|
||
strings: &GlueStrings,
|
||
dialog: &DeleteDialog,
|
||
s: f32,
|
||
) -> Entity {
|
||
let px = |v: f32| Val::Px(v * s);
|
||
let font = wow_font(assets);
|
||
let (name, level, class) = dialog
|
||
.target
|
||
.as_ref()
|
||
.map(|(_, n, l, c)| (n.clone(), *l, *c))
|
||
.unwrap_or_default();
|
||
// `CONFIRM_CHAR_DELETE`'s `|cffffffff` span splits it: gold lead above, white identity below.
|
||
let raw = strings.text(
|
||
"CONFIRM_CHAR_DELETE",
|
||
"Do you want to delete\n|cffffffff%s Level %d %s|r?",
|
||
);
|
||
let filled = raw
|
||
.replacen("%s", &name, 1)
|
||
.replacen("%d", &level.to_string(), 1)
|
||
.replacen("%s", class, 1);
|
||
let (lead, identity) = match filled.split_once("|cffffffff") {
|
||
Some((a, b)) => (a.trim_end_matches('\n').to_string(), b.replace("|r", "")),
|
||
None => (filled.clone(), String::new()),
|
||
};
|
||
|
||
commands
|
||
.spawn((
|
||
DialogUi,
|
||
GlobalZIndex(1200), // over the select screen's 1100
|
||
Node {
|
||
width: Val::Percent(100.0),
|
||
height: Val::Percent(100.0),
|
||
justify_content: JustifyContent::Center,
|
||
align_items: AlignItems::Center,
|
||
..default()
|
||
},
|
||
))
|
||
.with_children(|overlay_ui| {
|
||
let mut boxed = overlay_ui.spawn(Node {
|
||
width: px(512.0),
|
||
height: px(256.0),
|
||
..default()
|
||
});
|
||
boxed.with_children(|b| {
|
||
// Background tiled at 32 inside insets (11,12,12,11), the 32-edge border over it.
|
||
if let (Some(bg), Some(border)) = (&art.dialog_bg, &art.dialog_border) {
|
||
b.spawn((
|
||
tiled_bg_node(bg.clone(), 32.0, s, Color::WHITE),
|
||
Node {
|
||
position_type: PositionType::Absolute,
|
||
left: px(11.0),
|
||
right: px(12.0),
|
||
top: px(12.0),
|
||
bottom: px(11.0),
|
||
..default()
|
||
},
|
||
));
|
||
backdrop_border(b, border, 32.0, Color::WHITE);
|
||
} else {
|
||
b.spawn((
|
||
BackgroundColor(Color::srgba(0.05, 0.05, 0.08, 0.95)),
|
||
overlay(),
|
||
));
|
||
}
|
||
// The 64² alert icon at LEFT (12,10): its center is 118 from the top.
|
||
if let Some(alert) = &art.dialog_alert {
|
||
b.spawn((
|
||
ImageNode::new(alert.clone()),
|
||
Node {
|
||
position_type: PositionType::Absolute,
|
||
left: px(12.0),
|
||
top: px(86.0),
|
||
width: px(64.0),
|
||
height: px(64.0),
|
||
..default()
|
||
},
|
||
));
|
||
}
|
||
// GlueFontNormalLarge, 18.
|
||
for (top, text, color) in [
|
||
(16.0, lead.as_str(), GOLD),
|
||
(40.0, identity.as_str(), Color::WHITE),
|
||
] {
|
||
outlined_text(
|
||
b,
|
||
Node {
|
||
position_type: PositionType::Absolute,
|
||
top: px(top),
|
||
width: Val::Percent(100.0),
|
||
justify_content: JustifyContent::Center,
|
||
..default()
|
||
},
|
||
(),
|
||
(),
|
||
GlueText {
|
||
text,
|
||
size: 18.0,
|
||
color,
|
||
wrap: false,
|
||
},
|
||
&font,
|
||
s,
|
||
);
|
||
}
|
||
outlined_text(
|
||
b,
|
||
Node {
|
||
position_type: PositionType::Absolute,
|
||
top: px(83.0),
|
||
width: Val::Percent(100.0),
|
||
justify_content: JustifyContent::Center,
|
||
..default()
|
||
},
|
||
(),
|
||
(),
|
||
GlueText {
|
||
text: strings.text(
|
||
"CONFIRM_CHAR_DELETE_INSTRUCTIONS",
|
||
"Type \"DELETE\" into the field to confirm.",
|
||
),
|
||
size: 12.0,
|
||
color: GOLD,
|
||
wrap: false,
|
||
},
|
||
&font,
|
||
s,
|
||
);
|
||
// `CharacterDeleteEditBox`, 130×32: the `UI-ChatInputBorder-Left/Right` 75×32
|
||
// pieces overhang by 10 each side; the text has no TextInsets.
|
||
b.spawn((Node {
|
||
position_type: PositionType::Absolute,
|
||
top: px(102.0),
|
||
width: Val::Percent(100.0),
|
||
justify_content: JustifyContent::Center,
|
||
..default()
|
||
},))
|
||
.with_children(|row| {
|
||
let framed =
|
||
art.chat_input_left.is_some() && art.chat_input_right.is_some();
|
||
let mut boxed = row.spawn(Node {
|
||
width: px(130.0),
|
||
height: px(32.0),
|
||
..default()
|
||
});
|
||
if !framed {
|
||
boxed.insert(BackgroundColor(Color::srgba(0.0, 0.0, 0.0, 0.5)));
|
||
}
|
||
boxed.with_children(|b| {
|
||
if let (Some((left, lsize)), Some((right, rsize))) =
|
||
(&art.chat_input_left, &art.chat_input_right)
|
||
{
|
||
b.spawn((
|
||
ImageNode {
|
||
image: left.clone(),
|
||
rect: Some(tc_rect(*lsize, [0.0, 0.292_968_75, 0.0, 1.0])),
|
||
..default()
|
||
},
|
||
Node {
|
||
position_type: PositionType::Absolute,
|
||
left: px(-10.0),
|
||
top: px(0.0),
|
||
width: px(75.0),
|
||
height: px(32.0),
|
||
..default()
|
||
},
|
||
));
|
||
b.spawn((
|
||
ImageNode {
|
||
image: right.clone(),
|
||
rect: Some(tc_rect(*rsize, [0.707_031_25, 1.0, 0.0, 1.0])),
|
||
..default()
|
||
},
|
||
Node {
|
||
position_type: PositionType::Absolute,
|
||
right: px(-10.0),
|
||
top: px(0.0),
|
||
width: px(75.0),
|
||
height: px(32.0),
|
||
..default()
|
||
},
|
||
));
|
||
}
|
||
b.spawn((Node {
|
||
position_type: PositionType::Absolute,
|
||
left: px(0.0),
|
||
right: px(0.0),
|
||
top: px(0.0),
|
||
bottom: px(0.0),
|
||
align_items: AlignItems::Center,
|
||
..default()
|
||
},))
|
||
.with_children(|f| {
|
||
// The five-part field row: segments either side of the
|
||
// selection, a caret slot at each edge.
|
||
let segment = |f: &mut ChildSpawnerCommands, part| {
|
||
outlined_text(
|
||
f,
|
||
Node::default(),
|
||
(),
|
||
(TypedText, part),
|
||
GlueText {
|
||
text: "",
|
||
size: 15.0, // GlueFontHighlight
|
||
color: Color::WHITE,
|
||
wrap: false,
|
||
},
|
||
&font,
|
||
s,
|
||
);
|
||
};
|
||
segment(f, GlueFieldPart::Before);
|
||
caret_bar(
|
||
f,
|
||
(DeleteCaret, GlueFieldPart::CaretAtStart),
|
||
15.0,
|
||
s,
|
||
);
|
||
segment(f, GlueFieldPart::Selected);
|
||
caret_bar(f, (DeleteCaret, GlueFieldPart::CaretAtEnd), 15.0, s);
|
||
segment(f, GlueFieldPart::After);
|
||
});
|
||
});
|
||
});
|
||
// The `GlueDialogButtonTemplate` pair, 200×40 at bottom 16: Okay's right edge at
|
||
// center -6, Cancel's left edge at center +7.
|
||
b.spawn((Node {
|
||
position_type: PositionType::Absolute,
|
||
bottom: px(16.0),
|
||
width: Val::Percent(100.0),
|
||
justify_content: JustifyContent::Center,
|
||
column_gap: px(13.0),
|
||
flex_direction: FlexDirection::Row,
|
||
..default()
|
||
},))
|
||
.with_children(|row| {
|
||
glue_button(
|
||
row,
|
||
art,
|
||
&font,
|
||
DialogAction::Okay,
|
||
strings.text("OKAY", "Okay"),
|
||
200.0,
|
||
40.0,
|
||
GlueBtnKind::Dialog,
|
||
s,
|
||
);
|
||
glue_button(
|
||
row,
|
||
art,
|
||
&font,
|
||
DialogAction::Cancel,
|
||
strings.text("CANCEL", "Cancel"),
|
||
200.0,
|
||
40.0,
|
||
GlueBtnKind::Dialog,
|
||
s,
|
||
);
|
||
});
|
||
});
|
||
})
|
||
.id()
|
||
}
|