Struct Settings 

pub struct Settings<S: GameSettings> {
    pub text_speed: TextSpeed,
    pub fullscreen: bool,
    pub theme: S::Theme,
    pub music_volume: u8,
    pub sound_volume: u8,
    pub voices: bool,
    pub voice_volume: u8,
    pub frame_cap: FrameCap,
    pub game: S,
    /* private fields */
}

Everything an options screen sets: the engine’s settings and the game’s. The defaults are a new player’s.

Fields

text_speed: TextSpeed

How fast dialogue text is revealed.

fullscreen: bool

Whether the game fills the screen.

theme: S::Theme

The color theme: the palette the game draws with.

music_volume: u8

Music volume, 0 (silent) to MAX_VOLUME.

sound_volume: u8

Sound volume, 0 (silent) to MAX_VOLUME.

voices: bool

Whether voice clips play (Ctx::play_voice). Turning it off stops the one playing.

voice_volume: u8

Voice volume, 0 (silent) to MAX_VOLUME.

frame_cap: FrameCap

The most frames a second the platform shows: the game’s GameSettings::DEFAULT_FRAME_CAP until the player picks another. Every change of it takes the next serial, which the platform reports once it has applied it; a game that wants to know when asks with Ctx::request_frame_cap.

game: S

The game’s own settings.

Implementations

impl<S: GameSettings> Settings<S>

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

The layout the player picked, if they have.

pub fn with_layout(self, layout: Layout) -> Self

The same settings with layout as the one picked.

pub fn with_layout_of(self, other: &Self) -> Self

The same settings with other’s layout picked (or none): to compare two settings but for the layout.

pub fn restored(&self) -> Self

The defaults, keeping what isn’t a preference with a default: the layout picked (an options screen’s “Restore defaults”).

pub fn music_factor(&self) -> f32

The multiplier on the music’s volume, 0–1.

pub fn sound_factor(&self) -> f32

The multiplier on every sound’s volume, 0–1.

pub fn voice_factor(&self) -> f32

The multiplier on every voice clip’s volume, 0–1.

pub fn to_ron(&self) -> String

The saved form (GameSettings::to_ron).

pub fn from_ron(text: &str) -> Result<Self, String>

Reads the saved form (GameSettings::from_ron).

Trait Implementations

impl<S: Clone + GameSettings> Clone for Settings<S>

where S::Theme: Clone,

fn clone(&self) -> Settings<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug + GameSettings> Debug for Settings<S>

where S::Theme: Debug,

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

Formats the value using the given formatter.

impl<S: GameSettings> Default for Settings<S>

fn default() -> Self

Returns the “default value” for a type.

impl<S: Eq + GameSettings> Eq for Settings<S>

where S::Theme: Eq,

impl<S: PartialEq + GameSettings> PartialEq for Settings<S>

where S::Theme: PartialEq,

fn eq(&self, other: &Settings<S>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<S: PartialEq + GameSettings> StructuralPartialEq for Settings<S>

where S::Theme: PartialEq,