Struct LayoutPickerScreen 

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

Shows every layout and saves the one picked. Asked for by a key press while no layout is chosen, it can’t be cancelled with a key (the keyboard needs a layout), but any controller button closes it without choosing: that player is on the controller. Pops itself once a layout is picked.

Implementations

impl<G: GameData> LayoutPickerScreen<G>

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

Its Screen::name.

pub fn new(ctx: &Ctx<G>, legend: &'static Legend<G::Action>) -> Self

The picker with the first layout focused, its legend listing legend.

pub fn change(ctx: &Ctx<G>, legend: &'static Legend<G::Action>) -> Self

The picker as the options open it, to switch layout: the layout in use focused, and Cancel backs out without changing anything.

pub fn focused(&self) -> Option<Layout>

The focused layout (None only for a keymap with no layouts, which the loader refuses).

pub fn help(ctx: &Ctx<G>) -> String

The bottom help line: every Cursor up and Cursor down key, then every Confirm key, from the active keymap (before any layout is chosen, the layout picker’s own keys).

pub fn legend(&self, ctx: &Ctx<G>, km: &Keymap<G::Action>) -> Vec<LegendRow>

The legend for km, in ctx’s language: the keys and what they do; an action with no key shows ! not mapped. Always its keyboard keys: the screen is about the keyboard’s layouts.

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

The screen as it is now, as plain data for a skin to paint (glyph::paint): each layout with its legend and what every key of its keyboard does, the one in focus, and the help line.

Trait Implementations

impl<G: GameData> Clone for LayoutPickerScreen<G>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<G: GameData> Screen<G> for LayoutPickerScreen<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 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 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_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.