Sam SungandClaude Opus 5.5
fd386e75ae
Part of #41: the comments of `benilla-ui` (the Lua UI engine, its FrameXML loader and its widgets) are rewritten to the rule in `docs/METHOD.md`, which is what the code does and the reference fact behind it, in a line. 43,140 comment lines become 15,161. - **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: - `0x64a480` is the case-sensitive compare (a byte `repz cmpsb`), and `0x64a4c0` the case-insensitive one. - A frame's id sits at `+0xb0`, not `+0xb4`. `EnableKeyboard`/`IsKeyboardEnabled` are `0x776ec0`/`0x776f90`. - A region's unpinned edge has no fallback to its owner's rect: the owner supplies only the scale. - `$parent` expands to the nearest named ancestor, or "Top" when none is named (`0x76c5b0`), not simply to the parent. - A StatusBar fills from its internal normalised fraction, not from `GetValue()`. - The addresses of `StartDuel` and `StartDuelUnit` were swapped. - Many "untraced" notes now give the traced reference fact: the drag threshold, the per-grip sizing edges, the empty-`autoFocus` skip, and `SetTexCoordModifiesRect`'s default. - Stock FrameXML line citations are checked against the stock 1.12 files and corrected. `ref-` file names become the stock file names. - **Deviation labels.** "Deviation:" now marks only a choice with a reason. A surface that exists only for the retired Era addon target says so plainly: it is not 1.12. - **Verification.** Every file strips to identical code, and `cargo fmt --check` is clean. Nine 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. Behaviour differences the rewrite surfaced are filed as their own issues (#131–#142), and more are being validated. The comments here state what the code does. 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>
82 lines
3.0 KiB
Rust
82 lines
3.0 KiB
Rust
//! The four summon globals the `CONFIRM_SUMMON` dialog calls (`StaticPopup.lua:1336-1357`); 1.12
|
|
//! has no `CancelSummon`, as declining sends nothing. The reference resolves the summoner
|
|
//! (`0xb4e358`), zone (`0xb4e354`) and deadline (`0xb4e350`) at call time; the app pushes the
|
|
//! answers each frame, so a name still in flight reads `""` and fills in on a later tick.
|
|
|
|
use mlua::Lua;
|
|
|
|
use super::Model;
|
|
|
|
/// The dialog's three reads, never nil: with nothing pending or resolved they are `""`, `""` and
|
|
/// 0, as the reference's getters answer (`0x882748` is its shared `""`).
|
|
#[derive(Debug, Clone, Default, PartialEq, Eq)]
|
|
pub struct SummonConfirmUiState {
|
|
/// The summoner's name from the name cache (`0x55f080`), `""` while the query is out.
|
|
pub summoner: String,
|
|
/// The summoner's zone name out of `AreaTable.dbc`, or `""` if the id names no row.
|
|
pub area: String,
|
|
/// Milliseconds left, 0 when nothing is pending or it ran out; the binding truncates to
|
|
/// seconds, as `0x48b660` does.
|
|
pub time_left_ms: u32,
|
|
}
|
|
|
|
impl super::UiScript {
|
|
/// Push the three resolved reads, each frame.
|
|
pub fn set_summon_confirm(&mut self, state: SummonConfirmUiState) {
|
|
let mut model = self.model_mut();
|
|
if model.summon_confirm != state {
|
|
model.summon_confirm = state;
|
|
}
|
|
}
|
|
|
|
/// Drain the `ConfirmSummon()` calls, each a `CMSG_SUMMON_RESPONSE`.
|
|
pub fn take_summon_confirms(&mut self) -> u32 {
|
|
std::mem::take(&mut self.model_mut().summon_confirms)
|
|
}
|
|
}
|
|
|
|
pub(super) fn install(lua: &Lua) -> mlua::Result<()> {
|
|
let g = lua.globals();
|
|
|
|
// `0x48b6a0`: a string on every path.
|
|
g.set(
|
|
"GetSummonConfirmSummoner",
|
|
lua.create_function(|lua, ()| {
|
|
let model = lua.app_data_ref::<Model>().expect("model app_data");
|
|
lua.create_string(&model.summon_confirm.summoner)
|
|
})?,
|
|
)?;
|
|
|
|
// `0x48b720`: the summoner's zone straight from `AreaTable.dbc`, with no parent walk and no
|
|
// GlobalString fallback, unlike the innkeeper question's chain (`0x5dfe5e`).
|
|
g.set(
|
|
"GetSummonConfirmAreaName",
|
|
lua.create_function(|lua, ()| {
|
|
let model = lua.app_data_ref::<Model>().expect("model app_data");
|
|
lua.create_string(&model.summon_confirm.area)
|
|
})?,
|
|
)?;
|
|
|
|
// Whole seconds, truncated (`0x48b660`); the dialog reads it once in `OnShow` and counts down
|
|
// locally from there.
|
|
g.set(
|
|
"GetSummonConfirmTimeLeft",
|
|
lua.create_function(|lua, ()| {
|
|
let model = lua.app_data_ref::<Model>().expect("model app_data");
|
|
Ok(f64::from(model.summon_confirm.time_left_ms / 1000))
|
|
})?,
|
|
)?;
|
|
|
|
// The dialog's Accept, the only packet in the flow.
|
|
g.set(
|
|
"ConfirmSummon",
|
|
lua.create_function(|lua, ()| {
|
|
let mut model = lua.app_data_mut::<Model>().expect("model app_data");
|
|
model.summon_confirms += 1;
|
|
Ok(())
|
|
})?,
|
|
)?;
|
|
|
|
Ok(())
|
|
}
|