Class InputConfigurationProfile

The InputConfigurationProfile allows remapping of an existing InputConfiguration to other ButtonCodes. This works by adressing a button by its name and category and remapping the triggering button codes to the values specified in the binding.

Hierarchy

  • FrameworkObject
    • InputConfigurationProfile

Constructors

Properties

Methods

Events

Constructors

Methods

  • Removes the binding for the button with the specified name in the category. If no category is specified, the default category will be used.

    Parameters

    • name: string
    • Optionalcategory: string

    Returns boolean

    true if the binding was removed.

  • Registers a new binding for a virtual button, or updates a previously registered binding.

    Parameters

    • name: string

      Unique name used to access the virtual button. Must be unique in the category.

    • buttonCodes: EnumValue<ButtonCode, number>[]

      Physical buttons the virtual button is triggered by.

    • Optionalmodifiers: EnumValue<ButtonModifier, number>

      Modifiers required to be pressed with the physical button to trigger the virtual button.

    • Optionalcategory: string

      The category of the button, if undefined, the default category will be used.

    Returns boolean

    true if the binding was registered.

    Each category only supports each name uniquely.

Events

onBindingChanged: Event<[string, string], void>

Triggered when the bindings changed.