SamandClaude Fable 5
6ec7cc915b
- ReloadUI() tears the UI down and rebuilds it in place without leaving the world — the reference's own pair, one frame apart - a model's particle clouds and ribbon trails are admitted by one rule — distance, far clip, frustum, window, room — and a building's light sources ride their rooms too, so torches stop lighting receivers through walls - a mouse-wheel notch is a press and its release, dispatched in the same frame as the reference does - the binding registry is checked against the install's own Bindings.xml and DefaultBindings.wtf, so its transcribed defaults cannot drift silently Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
89 lines
4.4 KiB
Rust
89 lines
4.4 KiB
Rust
//! The **session API** (decisions 0674, 1291) — the four exit globals the game menu's Logout and
|
|
//! Exit Game buttons call, the two dialogs' answers to them, and `ReloadUI()`.
|
|
//!
|
|
//! The shape is [`super::duel`]'s: nothing to read, only the outbound half. Each call queues a
|
|
//! [`SessionRequest`] the app drains ([`super::UiScript::take_session_requests`]) and turns into a
|
|
//! packet or a process exit, so the engine keeps no reach into ECS/net (decision 0068 §3).
|
|
//!
|
|
//! What each one means, and where the reference puts it:
|
|
//!
|
|
//! - `Logout()` — ask to leave the world (`CMSG_LOGOUT_REQUEST`; the client's own
|
|
//! `ClientServices::SendLogout`, wow-re `system/net/ledger.tsv` 0x5ab000). The **server** decides
|
|
//! whether that is instant or a 20-second countdown, and says so in `SMSG_LOGOUT_RESPONSE`; the
|
|
//! client's whole job is to narrate the answer, which is the CAMP dialog.
|
|
//! - `Quit()` — the same request, plus a standing intent to end the *process* rather than return to
|
|
//! character select when the logout completes. That is why Exit Game shows the same countdown
|
|
//! under a different name (QUIT_TIMER "%d %s until exit").
|
|
//! - `CancelLogout()` — call off either one (`CMSG_LOGOUT_CANCEL`); the server acks with
|
|
//! `SMSG_LOGOUT_CANCEL_ACK`, which is what fires `LOGOUT_CANCEL` and takes the dialog down.
|
|
//! - `ForceQuit()` — the QUIT dialog's "Exit now": end the process immediately, without waiting out
|
|
//! the server's clock. (Its logout sibling `ForceLogout()` is deliberately absent: the reference's
|
|
//! own CAMP dialog has the force button commented out — "uncomment once forced logouts are
|
|
//! completely implemented (they currently have a failure case)" — so 1.12 ships no way to call it
|
|
//! from the UI, and neither do we.)
|
|
|
|
use mlua::Lua;
|
|
|
|
use super::Model;
|
|
|
|
/// Outbound session-exit intents queued by the Era API calls, drained by the app
|
|
/// ([`super::UiScript::take_session_requests`]). Plain data — [`super::DuelRequest`]'s twin.
|
|
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
|
pub enum SessionRequest {
|
|
/// `Logout()` — leave the world back to character select.
|
|
Logout,
|
|
/// `Quit()` — leave the world and end the process once it completes.
|
|
Quit,
|
|
/// `CancelLogout()` — call off a pending logout or quit.
|
|
CancelLogout,
|
|
/// `ForceQuit()` — end the process now, no server round trip.
|
|
ForceQuit,
|
|
/// `ReloadUI()` — tear this VM down and build a fresh one, without leaving the world.
|
|
///
|
|
/// The reference's `ReloadUI 0x4884d0` reads no arguments and returns no values; it only sets
|
|
/// `ds:0xb4b3f4`, and the per-frame callback `0x495590` runs the teardown/rebuild pair
|
|
/// (`0x490bd0` → `0x48fbf0`) on the NEXT frame — a deferral that doubles as the reentrancy
|
|
/// guard: the Lua state being destroyed is never the one mid-way through executing the call.
|
|
/// Queuing an intent the app runs outside any VM call is that same guard in this engine's
|
|
/// shape (wow-re `system/ui/scratch/savedvariables-protocol.md` §2, byte-verified).
|
|
ReloadUi,
|
|
}
|
|
|
|
impl super::UiScript {
|
|
/// Drain the session-exit intents queued since the last call.
|
|
pub fn take_session_requests(&mut self) -> Vec<SessionRequest> {
|
|
std::mem::take(&mut self.model_mut().session_requests)
|
|
}
|
|
|
|
/// Queue an intent from the app side — the `/logout` and `/camp` slash commands, which benilla
|
|
/// parses in Rust rather than through `SlashCmdList` (the [`super::UiScript::queue_duel_request`]
|
|
/// posture), so they enter the same queue and get the same dialog.
|
|
pub fn queue_session_request(&mut self, request: SessionRequest) {
|
|
self.model_mut().session_requests.push(request);
|
|
}
|
|
}
|
|
|
|
/// Register the five session globals — the four exit verbs, and `ReloadUI`.
|
|
pub(super) fn install(lua: &Lua) -> mlua::Result<()> {
|
|
let g = lua.globals();
|
|
|
|
for (name, request) in [
|
|
("Logout", SessionRequest::Logout),
|
|
("Quit", SessionRequest::Quit),
|
|
("CancelLogout", SessionRequest::CancelLogout),
|
|
("ForceQuit", SessionRequest::ForceQuit),
|
|
("ReloadUI", SessionRequest::ReloadUi),
|
|
] {
|
|
g.set(
|
|
name,
|
|
lua.create_function(move |lua, ()| {
|
|
let mut model = lua.app_data_mut::<Model>().expect("model app_data");
|
|
model.session_requests.push(request);
|
|
Ok(())
|
|
})?,
|
|
)?;
|
|
}
|
|
|
|
Ok(())
|
|
}
|