Struct DebugMenuScreen 

pub struct DebugMenuScreen<G: GameData> { /* private fields */ }

The debug menu the Debug key opens: the game’s tools, in its order, then each installed module’s (Install::debug_entry), in install order, then the engine’s: while the platform records the run or plays a record (Ctx::session_recording), “Save session”, and “Debug view” (DebugViewScreen). Cancel closes it. A tool that opens nothing leaves the menu on it, its names read again.

Implementations

impl<G: GameData> DebugMenuScreen<G>

pub const NAME: &'static str = "debug_menu"

Name reported by Screen::name.

pub fn new(ctx: &Ctx<G>, entries: Vec<DebugEntry<G>>) -> Self

The menu of the game’s entries, then the entries of the modules installed on ctx, made now, then the engine’s, its first tool focused.

pub fn menu(&self) -> &Menu<usize>

The menu: its items, each standing for its tool’s index, and focus.

pub fn focused(self, index: usize) -> Self

The same menu focused on tool index.

pub fn view(&self, ctx: &Ctx<G>) -> DebugMenuView

What the menu shows: its title, the tools and the help line, naming the keys of the device used last.

Trait Implementations

impl<G: GameData> Debug for DebugMenuScreen<G>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<G: GameData> Screen<G> for DebugMenuScreen<G>

fn actions(&self) -> Option<Vec<G::Action>>

Its menu’s.

fn name(&self) -> &'static str

A stable, unique snake_case name, for tests and debugging.

fn update( &mut self, ctx: &mut Ctx<G>, input: &FrameInput<G::Action>, ) -> Transition<G>

Handles one frame: input holds this frame’s actions (often none) and elapsed time. Called only while this screen is on top.

fn draw(&self, ctx: &Ctx<G>, buf: &mut GlyphBuffer)

Paints the screen. An opaque screen must cover the whole buffer.

fn debug_draw(&self, ctx: &Ctx<G>, out: &mut Gizmos)

Hands in what the debug view shows of this screen (ADR-0085): its gizmos, each in its channel, in console pixels, built from self and ctx alone, so looking changes nothing. A channel’s helper (the grid kit’s layout_gizmos) does the work. Called after draw on every screen drawn, bottom up, only while debug tools are on (Ctx::debug_tools). Does nothing unless the screen has something to show.

fn is_overlay(&self) -> bool

Whether the screen below shows through (drawn first, then this one).

fn state_hash(&self) -> Option<StateHash>

The hash of the game’s state this screen holds, which goes in each frame’s hash in a session record (Game::state_hash), most simply shuyi_core::state_hash(&self.rules).ok(): so a playback that plays differently is found at the frame the state moved. None unless the screen opts in.

fn as_any(&self) -> Option<&dyn Any>

This screen as Any, for tests that look inside a screen on the stack (ScreenStack::find). None unless the screen opts in.

fn as_any_mut(&mut self) -> Option<&mut dyn Any>

as_any, mutable (ScreenStack::find_mut).

fn covered(&mut self, _ctx: &mut Ctx<G>)

Called when a screen is pushed on top of this one (Transition::Push): it is no longer updated until it is uncovered. Not called when the screen above swaps itself for another (Transition::Replace). Does nothing unless the screen needs it.

fn uncovered( &mut self, ctx: &mut Ctx<G>, result: Option<ScreenResult>, ) -> Transition<G>

Called when the screen above pops and this one is on top again: result is what it popped with (Transition::PopWith), None after a plain Transition::Pop. The transition returned is applied at once, as if from update, so a screen can act on the answer in the same frame: push the next screen, or pop with an answer of its own. By default, nothing happens.