Struct UiContext 

pub struct UiContext<'a> {
    pub input: RawInput<'a>,
    pub speech: &'a mut Speech,
    pub audio: &'a mut Audio,
    pub lang: &'a Lang,
    /* private fields */
}

Everything a widget may use while it updates.

Fields

input: RawInput<'a>

Keyboard state (never blocked for widgets).

speech: &'a mut Speech

Speech output.

audio: &'a mut Audio

Audio output.

lang: &'a Lang

Translations, for texts the widget speaks by itself (see crate::lang).

Implementations

impl UiContext<'_>

pub fn emit(&mut self, event: UiEvent)

Reports an event to the game.

pub fn play(&mut self, sound: UiSound, custom: Option<&UiSounds>)

Plays one of the interface sounds, using custom if given, else the global set.

pub fn play_named(&mut self, name: &str)

Plays a sound by name in the UI volume group.

pub fn key(&self, key: Key) -> bool

Shortcut: key went down or repeats.