Struct livesplit_core::HotkeySystem

pub struct HotkeySystem { /* fields omitted */ }

With a Hotkey System the runner can use hotkeys on their keyboard to control the Timer. The hotkeys are global, so the application doesn't need to be in focus. The behavior of the hotkeys depends on the platform and is stubbed out on platforms that don't support hotkeys. You can turn off a Hotkey System temporarily. By default the Hotkey System is activated.

Methods

impl HotkeySystem

pub fn new(timer: SharedTimer) -> Result<Self>

Creates a new Hotkey System for a Timer with the default hotkeys.

pub fn with_config(timer: SharedTimer, config: HotkeyConfig) -> Result<Self>

Creates a new Hotkey System for a Timer with a custom configuration for the hotkeys.

pub fn set_split(&mut self, hotkey: Option<KeyCode>) -> Result<()>

Sets the key to use for splitting and starting a new attempt.

pub fn set_reset(&mut self, hotkey: Option<KeyCode>) -> Result<()>

Sets the key to use for resetting the current attempt.

pub fn set_pause(&mut self, hotkey: Option<KeyCode>) -> Result<()>

Sets the key to use for pausing the current attempt and starting a new attempt.

pub fn set_skip(&mut self, hotkey: Option<KeyCode>) -> Result<()>

Sets the key to use for skipping the current split.

pub fn set_undo(&mut self, hotkey: Option<KeyCode>) -> Result<()>

Sets the key to use for undoing the last split.

pub fn set_previous_comparison(&mut self, hotkey: Option<KeyCode>) -> Result<()>

Sets the key to use for switching to the previous comparison.

pub fn set_next_comparison(&mut self, hotkey: Option<KeyCode>) -> Result<()>

Sets the key to use for switching to the next comparison.

pub fn set_undo_all_pauses(&mut self, hotkey: Option<KeyCode>) -> Result<()>

Sets the key to use for removing all the pause times from the current time.

pub fn set_toggle_timing_method(
    &mut self,
    hotkey: Option<KeyCode>
) -> Result<()>

Sets the key to use for toggling between the Real Time and Game Time timing methods.

pub fn deactivate(&self)

Deactivates the Hotkey System. No hotkeys will go through until it gets activated again. If it's already deactivated, nothing happens.

pub fn activate(&self)

Activates a previously deactivated Hotkey System. If it's already active, nothing happens.

pub fn config(&self) -> HotkeyConfig

Returns the hotkey configuration currently in use by the Hotkey System.

pub fn set_config(&mut self, config: HotkeyConfig) -> Result<()>

Applies a new hotkey configuration to the Hotkey System. Each hotkey is changed to the one specified in the configuration. This operation may fail if you provide a hotkey configuration where a hotkey is used for multiple operations.