Struct livesplit_core::layout::Layout

pub struct Layout {
    pub components: Vec<Component>,
    // some fields omitted
}

A Layout allows you to combine multiple components together to visualize a variety of information the runner is interested in.

Fields

components: Vec<Component>

All of the layout's components.

Methods

impl Layout

pub fn new() -> Self

Creates a new empty layout with no components.

pub fn default_layout() -> Self

Creates a new default layout that contains a default set of components in order to provide a good default layout for runners. Which components are provided by this and how they are configured may change in the future.

pub fn from_settings(layout_settings: LayoutSettings) -> Self

Creates a new layout from the layout settings of the whole layout.

pub fn general_settings(&self) -> &GeneralSettings

Accesses the general settings of the layout that apply to all components.

pub fn general_settings_mut(&mut self) -> &mut GeneralSettings

Grants mutable access to the general settings of the layout that apply to all components.

pub fn push<C: Into<Component>>(&mut self, component: C)

Adds a new component to the end of the layout.

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

Calculates the layout's state based on the timer provided. You can use this to visualize all of the components of a layout.

pub fn settings(&self) -> LayoutSettings

Accesses the settings of the layout.

pub fn scroll_up(&mut self)

Scrolls up all the components in the layout that can be scrolled up.

pub fn scroll_down(&mut self)

Scrolls down all the components in the layout that can be scrolled down.

pub fn remount(&mut self)

Remounts all the components as if they were freshly initialized. Some components may only provide some information whenever it changes or when their state is first queried. Remounting returns this information again, whenever the layout's state is queried the next time.

Trait Implementations

impl Clone for Layout

fn clone(&self) -> Layout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Layout

fn default() -> Layout

Returns the "default value" for a type.