Struct livesplit_core::component::title::Settings

pub struct Settings {
    pub background: Gradient,
    pub text_color: Option<Color>,
    pub show_game_name: bool,
    pub show_category_name: bool,
    pub show_finished_runs_count: bool,
    pub show_attempt_count: bool,
    pub text_alignment: Alignment,
    pub display_as_single_line: bool,
    pub display_game_icon: bool,
    pub show_region: bool,
    pub show_platform: bool,
    pub show_variables: bool,
}

The Settings for this component.

Fields

background: Gradient

The background shown behind the component.

text_color: Option<Color>

The color of the title text. If None is specified, the color is taken from the layout.

show_game_name: bool

Specifies whether the game name should be part of the title that is being shown.

show_category_name: bool

Specifies whether the category name should be part of the title that is being shown.

show_finished_runs_count: bool

Specifies whether the amount of successfully finished attempts should be shown.

show_attempt_count: bool

Specifies whether the total amount of attempts should be shown.

text_alignment: Alignment

Specifies the alignment of the title.

display_as_single_line: bool

Specifies if the title should be shown as a single line, instead of being separated into one line for the game name and one for the category name.

display_game_icon: bool

Specifies whether the game's icon should be shown, in case there is a game icon stored in the Run.

show_region: bool

The category name can be extended by additional information. This extends it by the game's region, if it is provided by the run's metadata.

show_platform: bool

The category name can be extended by additional information. This extends it by the platform the game is being played on, if it is provided by the run's metadata.

show_variables: bool

The category name can be extended by additional information. This extends it by additional variables provided by the run's metadata.

Trait Implementations

impl Default for Settings

fn default() -> Self

Returns the "default value" for a type.

impl Clone for Settings

fn clone(&self) -> Settings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Serialize for Settings

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Settings where
    Settings: Default, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.