#KeyBindingField

KeyBindingField in UIToolbox is a field for a key or button binding in a settings screen. Its value is an Input System control path such as <Keyboard>/space or <Gamepad>/buttonSouth. A click, Enter or the gamepad submit button starts the capture. The next key or button becomes the value. The capture is the Input System interactive rebind on a temporary action, so the paths are generic: a press on any gamepad gives <Gamepad>/.... The field needs the Input System package and an active input handler that includes it.

<tb:KeyBindingField name="jump" label="Jump" value="&lt;Keyboard&gt;/space" />
<tb:KeyBindingField name="jumpPad" label="Jump (pad)" devices="Gamepad" />

// Apply the value to an action. An empty value turns the binding off.
jumpField.RegisterValueChangedCallback(evt => jumpAction.ApplyBindingOverride(0, evt.newValue));

• Escape, a click elsewhere or the loss of focus cancels the capture. With Mouse in Devices, a click elsewhere binds that mouse button instead.
• Delete and Backspace clear the value.
• During the capture, and for the rest of the frame after it, the field keeps the UI events of the pressed key. Tab, the arrows or Escape do not also move the focus or close a window.
• A click on the field during the capture does not start a new capture. With Mouse in Devices, the button of that click becomes the value. Without it, the click does nothing and the capture goes on.

#Conflicts

Some games let two actions have the same key, so the check is optional. Give the fields that must be different the same conflict-group:

<tb:KeyBindingField label="Jump" value="&lt;Keyboard&gt;/space" conflict-group="keys" />
<tb:KeyBindingField label="Crouch" value="&lt;Keyboard&gt;/c" conflict-group="keys" />

• When two fields of the group have the same value, each gets the error look of FieldError: a border and a label in --tb-color-danger.
• The field that changed last also shows an error callout, for example "Also assigned to Jump". The text is the tb.key-conflict text of ToolboxText.
• The field keeps the value. The error goes away when the values are different again. To refuse a value, set the old value again in your value callback when HasConflict is true.
• Empty values are never a conflict.
• The check is for the fields in one panel. For bindings in other screens, compare the values in your code and use FieldError.Show.

#Styling