Pages in Documentation

../images/architecture/2021/ui3-faq/thumbs/01.jpg
6 FAQ + Tips
../images/architecture/2021/splexamples/thumbs/01.jpg
3 Examples
../images/architecture/2020/books/thumbs/01.jpg
Books
../images/architecture/2020/doors/thumbs/01.jpg
Doors
../images/architecture/2020/spline/thumbs/01.jpg
1 Spline BP
../images/architecture/2020/railings/thumbs/01.jpg
2 Railings
../images/architecture/2019/guide1/thumbs/01.jpg
UI 1 - Part 1
../images/architecture/2018/03/thumbs/06.jpg
UI 1
../images/architecture/2019/guide2/thumbs/01.jpg
Ui 1 - Part 2
../images/architecture/2019/ui2/thumbs/01.jpg
1 Overview
../images/architecture/2019/ui2features/thumbs/04.jpg
2 UI Features
../images/architecture/2019/ui2start/thumbs/01.jpg
3 Get Started
../images/architecture/2019/ui2info/thumbs/08.jpg
4 Info Map
../images/architecture/2019/ui2act/thumbs/01.jpg
5 BP Actors
../images/architecture/2020/clients/thumbs/01.jpg
6 Manage Clients
../images/architecture/2020/faq/thumbs/03.jpg
7 FAQ
../images/architecture/2019/ui2examples/thumbs/06.jpg
8 Tutorials
../images/architecture/2021/ui3/thumbs/01.jpg
UI3 Overview
../images/architecture/2021/ui3-start/thumbs/02.jpg
2 Get Started
../images/architecture/2021/ui3-infomap/thumbs/02.jpg
3 Info Map
../images/architecture/2021/ui3-var/thumbs/01.jpg
4 Variations
../images/architecture/2021/ui3-actors/thumbs/01.jpg
5 More BP Actors

UI3 Game Modes

The Game Mode defines the type of interface and controls for your project.

Content:

World Settings

Game Mode Keyboard

Game Mode Touch

Game Mode Gamepad

Game Mode VR

Input settings for other controllers.

World Settings

The Game Mode holds the information which Character and Input Controller will be used in your project.

The Game Mode can be selected in the World Properties. Each (persistent) level has its own World Properties. If you only have one level then this is the persistent level. This way you can have multiple different Game Modes in the same Project.

There are 4 Game Modes to choose from:

  • SDotUI3_GameModeKeyboard for keyboard and mouse support
  • SDotUI3_GameModeTouch for touch controls
  • SDotUI3_GameModeGamepad for XBOX Gamepad support
  • SDotUI3_GameModeVR for VR headsets with a controller or gamepad.

Read on for more details about how to use these Game Modes.

Put all your assets into sub levels if you want to use the same scene for different game modes. Then create a persistent level for each game mode and add the asset levels as sub levels. Put a copy of the UI3 Info Map in the persistent level for each game mode and make the necessary changes for the game mode. Now any changes to the scene in the sub levels will lead to all versions to be changed as those share the same sub levels.

image

Game Mode Keyboard

SDotUI3_GameModeKeyboard

This is the default Game Mode.

Technically this Game Mode uses the SDotUI3_CharacterV3 and the SDotUI3_ControllerKeyMouse. The Game Mode itself is empty.

image
This image shows the input controls for Keyboard and Mouse. The Player can use the WASD keys to move around and the Mouse to look around, or to select an item in the scene and interface.

You can use the defaults for anything regarding the look and functionality of the interface.

Tip: click on the little yellow arrow next to the value to set the parameter back to its default value.

image

Game Mode Touch

SDotUI3_GameModeTouch

Use this Game Mode for touch screen devices. Also use it if you want to Pixel Stream onto a touch screen device.

Technically this Game Mode uses the SDotUI3_CharacterV3 and the SDotUI3_ControllerTouch. The Game Mode itself is empty.

During development it might be useful to simulate the touch screen input with the mouse. You can find this setting in the Project Settings -> Input. Or use the Keyboard Game Mode during development.

image

To test the controls without having a touch screen input device:

Project Settings -> Input - > Mouse Properties
Use Mouse for Touch Lets you test touch screen controls without a touch input device.

Settings in the Info Map blueprint:

Info Map -> Project Settings
Use Mouse Move The touch controller blueprint should enable this no matter what is set here.
UI Design
Button Text Size Main menu button size:
12 - (default) works well for standard interface use
20 - It's better for touch screen to increase the size
Scene Presets
> advanced display
Save Slot Size The size of the user save slot circles
56 x 56 - default
90 x 90 - Increase the size for touch screen controls
Floorplan
> advanced display
Dot Size The size of the dot indicating a point to teleport in the floorplan widget
16 - default
32 - Increase the size for touch screen controls
Info and Help
Info Media > 0 By default the control scheme is used as the first Info Media
Image Replace the current image with the image that shows the touch control scheme.

image

Game Mode Gamepad

SDotUI3_GameModeGamepad

Use this Game Mode with a XBox gamepad controller or any other controller. Find some more info for the use of other controllers at the end of the page.

Technically this Game Mode uses the SDotUI3_CharacterV3 and the SDotUI3_ControllerGamepad. The controller blueprint contains all the blueprints to navigate the Main menu.

image

Settings in the Info Map blueprint:

Project Settings
Use Mouse Move If true a target circle will be displayed on the floor. Once the move button (depends on the controller used) is clicked the player will slide to the circles position.
UI Design
> advanced display
Icon A Lets you replace the default gamepad face button down icon. This is used to select menu items (like enter).
Icon B Lets you replace the default gamepad face button right icon. This is used to toggle the menu visibility and move sliders to the right.
Icon X Lets you replace the default gamepad face button left icon. This is used to cancel and move sliders to the left.
Info and Help
Info Media > 0 By default the control scheme is used as the first Info Media
Image Replace the current image with the image that shows the control scheme of the connected controller. There are images for Gamepad, VIVE and Oculus Rift controller available.

How to use a different controller with the user interface is explained at the end of this page.

image

Game Mode VR

SDotUI3_GameModeVR

Use this Game Mode for VR scenes. You can use a XBox gamepad controller, a VIVE controller or the Oculus Rift controller by default. Find some more info for the use of other controllers at the end of the page.

Technically this Game Mode uses the SDotUI3_CharacterV3 and the SDotUI3_ControllerGamepad. The controller blueprint contains all the blueprints to navigate the Main menu. The game mode blueprint has some additional blueprints for VR to work.

image

Settings in the Info Map blueprint:

Project Settings
Use Mouse Move If true a target circle will be displayed on the floor. Once the move button (depends on the controller used) is clicked the player will slide to the circles position.
UI Design
Button Text Size Main menu button size:
12 - (default) works well for standard interface use
16-20 - You can increase the Main Menu size on the tablet to be more readable.
> advanced display
Preview Brightness The preview and info images can be over exposed and barely visible on the VR tablet in your scene. You can darker them with this value. In the example scene I had to use a brightness of 0.05
Slot Saved
Saved Slot
Turn down the color brightness if the save slot indicators are too bright and appear white on the VR tablet in the scene.
Icon A Lets you replace the default gamepad face button down icon. This is used to select menu items (like enter). There are button images in the Tex directory for VIVE and Oculus Rift controller.
Icon B Lets you replace the default gamepad face button right icon. This is used to toggle the menu visibility and move sliders to the right.
Icon X Lets you replace the default gamepad face button left icon. This is used to cancel and move sliders to the left.
Floorplan
Fade Block Teleport With this tickbox enabled the screen will fade black while the player is teleported to a new location. May be needed to avoid VR sickness.
Info and Help
Info Media > 0 By default the control scheme is used as the first Info Media
Image Replace the current image with the image that shows the control scheme of the connected controller. There are images for Gamepad, VIVE and Oculus Rift controller available.

image

Input settings for other controllers.

You can use other controllers if they are generally supported in Unreal. You may have to activate them through a plug-in or they may become available once they are connected.

Once they work you have to add their buttons to the input controls in the Project Settings. Open the settings and navigate to Input by clicking on the link on the left side. Then add your controller buttons to the Bindings. This should be somewhat self explanatory.

Action Mappings are button clicks like ENTER, or shortcuts like I for a screenshot.

Axis Mappings are movement controls like player movement forward or mouse looking to the side. Anything that isn't a simple click.

Detailed information is on the Unreal Engine Documentation about Input.

Unreal Engine Documentation - Input

image
Top of page