Struct InputCommand 

pub struct InputCommand {
    pub kind: InputKind,
    pub action: InputAction,
    pub key: Option<String>,
    pub text: Option<String>,
    pub button: Option<Value>,
    pub x: Option<f32>,
    pub y: Option<f32>,
    pub unit: Option<String>,
    pub clear: bool,
}

Parameters for the bevy_fairy/input BRP method.

A field this does not name is refused by deny_unknown_fields, and a field it names that the chosen kind does not read is refused by refuse_unread_fields (private): a modifier or a position that changes nothing must not come back as success: true.

Fields

kind: InputKind

What kind of input to inject.

action: InputAction

What action to perform. Defaults to InputAction::Tap, and InputKind::Cursor ignores it — a position has no press and no release, so requiring a meaningless one would be a field a caller has to supply and cannot get right.

key: Option<String>

Key name — any KeyCode variant, e.g. "KeyW", "Space", "ArrowLeft", "F5", "Numpad7", "ShiftLeft".

It carries its logical half whenever Bevy spells the same name in Key, which covers every named key a text field matches. So "Escape" leaves a tool and closes a name field from one request, the way a real Escape does — see logical_for.

text: Option<String>

What to type, one message per character. "site_67" is one call and one frame.

Not an alternative spelling of key, and not the same request: key names a key on the keyboard, text is what should arrive. Neither can express the other — text cannot say which key produced a character, and key cannot produce é. Sending both is refused, because there is no order between two intents.

button: Option<Value>

Mouse button — any MouseButton variant: "Left", "Right", "Middle", "Back", "Forward", or {"Other": 3}.

x: Option<f32>

Scroll amounts, used by InputKind::Scroll. Positive y scrolls up.

y: Option<f32>

unit: Option<String>

Scroll unit: "Line" (default) or "Pixel".

clear: bool

InputKind::Cursor only: put the pointer back under the real mouse.

A separate flag rather than “omit x and y”, because omitting a coordinate is much more likely to be a caller bug than an intent to release the pointer, and the two must not look alike.

Trait Implementations

impl Debug for InputCommand

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InputCommand

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.