Skip to main content
Version: Next

Create Custom Keyboard

You can create your own keyboard and add it to the keyboard selection. In order to do so, please follow the next steps:

Step 01​


  1. Open the content browser and select any RegistrableAssets folder.

Keyboard

  1. Right click to open the asset creation menu. Select Miscellaneous>DataAsset.

Keyboard

  1. Select the class KeyboardDescription and give a name to your fresh data asset.

Keyboard

  1. Skyreal scan all the RegistrableAssets folder at its launching.Therefore, you need to restart Skyreal to use your new KeyboardDescription.

  2. We will get back to this data asset later, now we need to create the keyboard itself.

Step 02​

Keyboard Blueprint​

There is two types of Keyboard, the 2D and the 3D. Both have a corresponding Blueprint type and need to inherit from a specific class.

KeyboardBlueprint typeClass to inherit from
2DWidgetBlueprintCustomizableWidgetKeyboard
3DActorCustomizable3DKeyboard

2D Keyboard: WidgetBlueprint​

Once you created your WidgetBlueprint, double click on it to open it.

Click on the Graph button in the upper right corner.

Keyboard

Click on Class Settings.

Keyboard

Reparent the blueprint with the corresponding class by clicking on dropdown menu Parent Class and select CustomizableWidgetKeyboard.

Keyboard

3D Keyboard : Actor​

For a 3D Keyboard, the process is similar. The only difference is the reparent class button's location.

It is now on the right side of the screen.ya

Click on Class settings

Click on the dropdown menu: Parent Class

Select the class: Customizable3DKeyboard

Keyboard

Step 03​

Back to Keyboard Description​

Now that we have a keyboard blueprint and a keyboard description, we must connect the first one to the second.

  1. Open you keyboard description

  2. Give it a name on the Skr Display Name text field

  3. Link the description to your KeyboardBlueprint (2D or 3D)

Keyboard
  1. Give it an icon
Keyboard

You can now pick your creation within the the keyboard selection's dropdown menu

Keyboard

Step 04​

Call the input functions​

There is three functions to use in order to print what you want on the text box

  • Write (You need to pass a string as parameter otherwise this will print nothing)

  • Erase

  • Validate

To call them, simply call the corresponding function.

Here I decided to use the OnClicked event from my buttons.

Keyboard