Struct livesplit_core::component::title::Component

pub struct Component { /* fields omitted */ }

The Title Component is a component that shows the name of the game and the category that is being run. Additionally, the game icon, the attempt count, and the total number of finished runs can be shown.

Methods

impl Component

pub fn new() -> Self

Creates a new Title Component.

pub fn with_settings(settings: Settings) -> Self

Creates a new Title Component with the given settings.

pub fn settings(&self) -> &Settings

Accesses the settings of the component.

pub fn settings_mut(&mut self) -> &mut Settings

Grants mutable access to the settings of the component.

pub fn name(&self) -> Cow<str>

Accesses the name of the component.

pub fn state(&mut self, timer: &Timer) -> State

Calculates the component's state based on the timer provided.

pub fn remount(&mut self)

Remounts the component as if it was freshly initialized. The game icon shown by this component is only provided in the state objects whenever the icon changes or whenever the component's state is first queried. Remounting returns the game icon again, whenever its state is queried the next time.

pub fn settings_description(&self) -> SettingsDescription

Accesses a generic description of the settings available for this component and their current values.

pub fn set_value(&mut self, index: usize, value: Value)

Sets a setting's value by its index to the given value.

Panics

This panics if the type of the value to be set is not compatible with the type of the setting's value. A panic can also occur if the index of the setting provided is out of bounds.

Trait Implementations

impl From<Component> for Component

fn from(original: Component) -> Component

Performs the conversion.

impl Clone for Component

fn clone(&self) -> Component

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Component

fn default() -> Component

Returns the "default value" for a type.