StevesUEHelpers/doc/InputImage.md
2020-10-26 15:11:35 +00:00

1.4 KiB

InputImage

InputImage is a subclass of Image which can be told to display an image of a keyboard key, mouse button, gamepad stick / button, etc. It can also look up the key currently assigned as input for an associated Action or Axis, changing dynamically based on what the current input method is (mouse, keyboard, gamepad).

Here's an example of the icons changing as the player moves a gamepad stick or touches keyboard/mouse:

Dynamic InputImage

InputImage requires a UiTheme to operate, which links to the images it needs.

Properties

Binding Type

  • "Action" if the image should display the current mapping for an input action
  • "Axis" to look up an input axis
  • "Key" to manually specify a key (which can be gamepad or mouse too)

Action or Axis Name

The name of the input action or axis that should be looked up to determine the key that we'll need an image for.

You can leave this blank if you set Binding Type to "Key".

Key

If you don't want the InputImage to look up an action, but want to manually specify an input action, then drop down this list and pick a key (which can be a gamepad button, mouse axis etc as well as a keybaord key) and the InputImage will display that.

Custom Theme

This is an optional link to a UiTheme you want to use for this InputImage. If blank, the default UiTheme is used.