Struct basalt::input::builder::InputHoldBuilder

pub struct InputHoldBuilder<'a> { /* private fields */ }

Builder returned by on_hold.

Implementations

impl<'a> InputHoldBuilder<'a>

pub fn keys<C: KeyCombo>(self, combo: C) -> Self

Add a list of Key’s to the combination used.

Notes

• This adds to any previous combo call.

// Example Inputs
.keys(Qwerty::Q)
.keys((Qwerty::LCtrl, MouseButton::Left))
.keys(vec![Qwerty::LCtrl, Qwerty::A])
.keys([Qwerty::A, Qwerty::D])

pub fn weight(self, weight: i16) -> Self

Assigns a weight.

Notes

• Higher weights get called first and may not pass events.

pub fn delay(self, delay: Option<Duration>) -> Self

Set the delay (How long to be held before activation).

Default: None

pub fn interval(self, intvl: Duration) -> Self

Set the interval.

Default: Duration::from_millis(15)

pub fn call<F: FnMut(InputHookTarget, &LocalKeyState, Option<Duration>) -> InputHookCtrl + Send + 'static>(
    self,
    method: F
) -> Self

Assign a function to call.

Notes

• Calling this multiple times will not add additional methods.
• NoPass varients of InputHookCtrl will be treated like their normal varients.

pub fn finish(self) -> Result<InputHookID, InputError>

Finish building, validate, and submit it to Input.

Possible Errors

• NoKeys: No call to key or keys was made.
• NoMethod: No method was added. See call.
• NoTarget: No call to bin() or window() was made.