Class InputConfiguration

constructor

• new InputConfiguration(isInternalConstructor?): InputConfiguration

• Parameters

  • OptionalisInternalConstructor: boolean

  Returns InputConfiguration

profile

• get profile(): InputConfigurationProfile

• The current profile to dynamically remap buttons to other button codes.

  Returns InputConfigurationProfile
• set profile(value): void

• Parameters

  • value: InputConfigurationProfile

  Returns void

repeatInterval

• get repeatInterval(): number

• Sets repeat interval for held virtual buttons. Buttons will be continously triggered in interval increments as long as they button is being held.

  Returns number
• set repeatInterval(value): void

• Parameters

  • value: number

  Returns void

getAxis

• getAxis(name, category?): VirtualAxis

• Gets a previously registered virtual button with the specified name and category.

  Parameters

  • name: string

    Unique name used to access the virtual button.
  • Optionalcategory: string

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

  Returns VirtualAxis

  The axis or null if not registered.

getButton

• getButton(name, category?): VirtualButton

• Gets a previously registered virtual button with the specified name and category.

  Parameters

  • name: string

    Unique name used to access the virtual button.
  • Optionalcategory: string

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

  Returns VirtualButton

  true upon success.

registerAxis

• registerAxis(options): VirtualAxis

• Registers the virtual axis.

  Parameters

  • options: {
        axis: VirtualAxis;
    } | {
        category?: string;
        deadZone?: number;
        invert?: boolean;
        name: string;
        sensitivity?: number;
        type: EnumValue<InputAxis, number>;
    }

    Options object for the function call.

  Returns VirtualAxis

  The axis or null if not, or already registered.

registerButton

• registerButton(options): VirtualButton

• Registers the virtual button.

  Parameters

  • options: {
        button: VirtualButton;
    } | {
        buttonCodes: readonly EnumValue<ButtonCode, number>[];
        category?: string;
        modifiers?: EnumValue<ButtonModifier, number>;
        name: string;
        repeatable?: boolean;
    }

    Options object for the function call.

  Returns VirtualButton

  The newly created button or null if failed, or if it was already registered.

unregisterAxis

• unregisterAxis(options): boolean

• Unregisters a virtual virtualAxis with the specified name. You will no longer be able to retrieve valid values for that virtualAxis.

  Parameters

  • options: {
        category?: string;
        name: string;
    } | {
        axis: VirtualAxis;
    }

    Options object for the function call.

  Returns boolean

  true if the axis was unregistered.

  Note

  Each category only support each name uniquely.

unregisterButton

• unregisterButton(options): boolean

• Unregisters all virtual buttons with the matching name and category for all button codes. Events will no longer be generated for that button.

  Parameters

  • options: {
        category?: string;
        name: string;
    } | {
        button: VirtualButton;
    }

    Options object for the function call.

  Returns boolean

  true if the buttons was unregistered.

  Note

  Each category only support each name uniquely.

ReadonlyonButtonBindingChanged