Struct livesplit_core::component::title::State

pub struct State {
    pub background: Gradient,
    pub text_color: Option<Color>,
    pub icon_change: Option<String>,
    pub line1: String,
    pub line2: Option<String>,
    pub is_centered: bool,
    pub finished_runs: Option<u32>,
    pub attempts: Option<u32>,
}

The state object describes the information to visualize for this component.

Fields

background: Gradient

The background shown behind the component.

text_color: Option<Color>

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

icon_change: Option<String>

The game's icon encoded as a Data URL. This value is only specified whenever the icon changes. If you explicitly want to query this value, remount the component. The String itself may be empty. This indicates that there is no icon.

line1: String

The first title line to show. This is either the game's name, or a combination of the game's name and the category.

line2: Option<String>

By default the category name is shown on the second line. Based on the settings, it can however instead be shown in a single line together with the game name.

is_centered: bool

Specifies whether the title should centered or aligned to the left instead.

finished_runs: Option<u32>

The amount of successfully finished attempts. If None is specified, the amount of successfully finished attempts isn't supposed to be shown.

attempts: Option<u32>

The amount of total attempts. If None is specified, the amount of total attempts isn't supposed to be shown.

Methods

impl State

pub fn write_json<W>(&self, writer: W) -> Result<()> where
    W: Write, 

Encodes the state object's information as JSON.

Trait Implementations

impl Serialize for State

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 State

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

Deserialize this value from the given Serde deserializer.