Module livesplit_core::component

The component module provides all the different components available. A Component allows querying different kinds of information from a Timer. This information is provided as state objects in a way that can easily be visualized by any kind of User Interface.

Modules

blank_space	Provides the Blank Space Component and relevant types for using it. The Blank Space Component is simply an empty component that doesn't show anything other than a background. It mostly serves as padding between other components.
current_comparison	Provides the Current Comparison Component and relevant types for using it. The Current Comparison Component is a component that shows the name of the comparison that is currently selected to be compared against.
current_pace	Provides the Current Pace Component and relevant types for using it. The Current Pace Component is a component that shows a prediction of the current attempt's final time, if the current attempt's pace matches the chosen comparison for the remainder of the run.
delta	Provides the Delta Component and relevant types for using it. The Delta Component is a component that shows the how far ahead or behind the current attempt is compared to the chosen comparison.
detailed_timer	Provides the Detailed Timer Component and relevant types for using it. The Detailed Timer Component is a component that shows two timers, one for the total time of the current attempt and one showing the time of just the current segment. Other information, like segment times of up to two comparisons, the segment icon, and the segment's name, can also be shown.
graph	Provides the Graph Component and relevant types for using it. The Graph Component visualizes how far the current attempt has been ahead or behind the chosen comparison throughout the whole attempt. All the individual deltas are shown as points in a graph.
possible_time_save	Provides the Possible Time Save Component and relevant types for using it. The Possible Time Save Component is a component that shows how much time the chosen comparison could've saved for the current segment, based on the Best Segments. This component also allows showing the Total Possible Time Save for the remainder of the current attempt.
previous_segment	Provides the Previous Segment Component and relevant types for using it. The Previous Segment Component is a component that shows how much time was saved or lost during the previous segment based on the chosen comparison. Additionally, the potential time save for the previous segment can be displayed. This component switches to a Live Segment view that shows active time loss whenever the runner is losing time on the current segment.
separator	Provides the Separator Component and relevant types for using it. The Separator Component is a simple component that only serves to render separators between components.
splits	Provides the Splits Component and relevant types for using it. The Splits Component is the main component for visualizing all the split times. Each segment is shown in a tabular fashion showing the segment icon, segment name, the delta compared to the chosen comparison, and the split time. The list provides scrolling functionality, so not every segment needs to be shown all the time.
sum_of_best	Provides the Sum of Best Segments Component. The Sum of Best Segments Component shows the fastest possible time to complete a run of this category, based on information collected from all the previous attempts. This often matches up with the sum of the best segment times of all the segments, but that may not always be the case, as skipped segments may introduce combined segments that may be faster than the actual sum of their best segment times. The name is therefore a bit misleading, but sticks around for historical reasons.
text	Provides the Text Component and relevant types for using it. The Text Component simply visualizes any given text. This can either be a single centered text, or split up into a left and right text, which is suitable for a situation where you have a label and a value.
timer	Provides the Timer Component and relevant types for using it. The Timer Component is a component that shows the total time of the current attempt as a digital clock. The color of the time shown is based on a how well the current attempt is doing compared to the chosen comparison.
title	Provides the Title Component and relevant types for using it. 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.
total_playtime	Provides the Total Playtime Component and relevant types for using it. The Total Playtime is a component that shows the total amount of time that the current category has been played for.