Struct genie_hki::HotkeyGroup

pub struct HotkeyGroup { /* fields omitted */ }

Represents a group of Hotkeys.

Different groups may have different numbers of hotkeys.

Implementations

impl HotkeyGroup

pub fn hotkey(&self, index: usize) -> Option<&Hotkey>

Returns an immutable reference to a single hotkey, if that hotkey is present in this HotkeyGroup.

pub fn hotkey_mut(&mut self, index: usize) -> Option<&mut Hotkey>

Get a mutable reference to a single hotkey. This way, you can edit or replace the mapping.

pub fn unbind(&self, index: usize) -> Result<Self, HotkeyIndexError>

Returns a hotkey group equivalent to this group but with the hotkey at index unbound so that the key is 0 and all modifier keys are false. Returns an error if the index does not exist.

pub fn bind(
    &self,
    index: usize,
    key: i32,
    ctrl: bool,
    alt: bool,
    shift: bool
) -> Result<Self, HotkeyIndexError>

Returns a hotkey group equivalent to this group but with the hotkey at index bound with the given key and modifier keys. Returns an error if the index does not exist.

pub fn num_hotkeys(&self) -> usize

Returns the number of hotkeys in this HotkeyGroup.

use std::fs::File;
use genie_hki::HotkeyInfo;
let mut f = File::open("test/files/aoc1.hki")?;
let info = HotkeyInfo::from(&mut f)?;
// Villager hotkeys are group 3 in AoC and HD Edition.
let group = info.group(3).expect("file does not contain villager hotkeys");
assert_eq!(28, group.num_hotkeys());

pub fn iter(&self) -> impl Iterator<Item = &Hotkey>

Returns an iterator over this group's hotkeys.

pub fn to_string_lang(&self, lang_file: &LangFile, sk: &StringKey) -> String

Returns a string representation of this hotkey group, using the strings from lang_file and the group name string key sk.

Trait Implementations

impl Clone for HotkeyGroup

fn clone(&self) -> HotkeyGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HotkeyGroup

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Display for HotkeyGroup

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for HotkeyGroup

impl IntoIterator for HotkeyGroup

type Item = Hotkey

The type of the elements being iterated over.

type IntoIter = IntoIter<Hotkey>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a HotkeyGroup

type Item = &'a Hotkey

The type of the elements being iterated over.

type IntoIter = Iter<'a, Hotkey>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut HotkeyGroup

type Item = &'a mut Hotkey

The type of the elements being iterated over.

type IntoIter = IterMut<'a, Hotkey>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<HotkeyGroup> for HotkeyGroup

fn eq(&self, other: &HotkeyGroup) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &HotkeyGroup) -> bool

This method tests for !=.

impl StructuralEq for HotkeyGroup

impl StructuralPartialEq for HotkeyGroup