Struct Ask 

pub struct Ask<T> { /* private fields */ }

A question and its answers, each a T the screen acts on.

Implementations

impl<T: Copy + PartialEq> Ask<T>

pub const ACTIONS: &'static [UiAction] = crate::input::NAVIGATION

What a question reacts to (handle), for the screen that shows it to declare (Screen::actions).

pub fn new( key: &'static str, answers: impl IntoIterator<Item = (T, &'static str)>, ) -> Self

The question of the text key key with answers (each an answer and the text key of its name), the first in focus. Cancel does nothing until cancelled_by names an answer.

pub fn focused_on(self, answer: T) -> Self

The same question focused on answer (on the first while it isn’t one of the answers).

pub fn cancelled_by(self, answer: T) -> Self

The same question, which Cancel answers with answer (going back, say).

pub fn key(&self) -> &'static str

The text key of the question; also what names it.

pub fn focus(&self) -> Option<T>

The answer in focus; None with no answers.

pub fn cancel(&self) -> Option<T>

What Cancel answers, if anything.

pub fn handle<A: ActionSet, V>( &mut self, action: A, audio: &mut AudioQueue<V>, ) -> Option<T>

An action while the question is open. The cursor’s keys move the focus to the next answer (right and down) or the one before (left and up), going round at the ends, with the menu’s move sound on audio. Confirm gives the answer in focus, Cancel the answer it stands for (cancelled_by); anything else gives nothing. An answer’s own sound is the screen’s to play: what it does may still be refused.

pub fn view<G: GameData>(&self, ctx: &Ctx<G>) -> AskView<T>

The question as it is now, as plain data for a skin to paint (glyph::paint): its text and its answers, or the line naming its keys, in the player’s language naming the active keys.

pub fn view_with_keys<G: GameData>( &self, ctx: &Ctx<G>, keys: HelpKeys<'_, G::Action>, args: &[(&str, &dyn Display)], ) -> AskView<T>

view, naming the keys keys has rather than the active ones, and filling the question’s placeholders from args (Ctx::text_with_keys).

impl Ask<bool>

pub fn yes_no(key: &'static str, keys: &'static str) -> Self

A yes/no question of the text key key: Confirm answers yes (true) and Cancel no (false). It shows no answers to move between, but the line of the text key keys, which names the keys for yes and no.

Trait Implementations

impl<T: Clone> Clone for Ask<T>

fn clone(&self) -> Ask<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Ask<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Ask<T>

impl<T: PartialEq> PartialEq for Ask<T>

fn eq(&self, other: &Ask<T>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T: PartialEq> StructuralPartialEq for Ask<T>