Struct ProfilesScreen 

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

The profiles, the one in use marked, and a row to add one. Cancel closes it.

Implementations

impl<G: GameData> ProfilesScreen<G>

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

Name reported by Screen::name.

pub fn new(ctx: &Ctx<G>) -> Self

The screen focused on the profile in use.

pub fn painted_by(self, paint: Paint<G>) -> Self

The same screen with its view painted by paint instead of glyph::paint: a game’s look for a device of its own.

pub fn opening_after_add(self, open: AfterAdd<G>) -> Self

The same screen opening the screen open makes in its place once a profile is added (and in use), instead of closing: the game’s first-launch setup for the new profile, say.

pub fn rows(ctx: &Ctx<G>) -> Vec<RowKind>

Every row, top to bottom.

pub fn focused(&self, ctx: &Ctx<G>) -> RowKind

The focused row.

pub fn actions_for(ctx: &Ctx<G>, id: ProfileId) -> Vec<ProfileAction>

What can be done to id: use it unless it is in use, rename it, delete it unless it is the only one.

pub fn naming(&self) -> Option<NamePurpose>

What the name box is for, while it is open.

pub fn typed(&self) -> Option<&str>

The name typed so far, while the name box is open.

pub fn message(&self) -> Option<&str>

The text key of the message under the panel, if any.

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

The screen as it is now, as plain data for a skin to paint (glyph::paint).

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

The bottom help line, naming the keys of the active keymap (or the text box’s own keys while typing).

Trait Implementations

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

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

Formats the value using the given formatter.

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

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

Its rows, its menus and questions, and the name grid.

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.