Skip to content
This repository has been archived by the owner on Mar 19, 2019. It is now read-only.

Using VaQuoleUI

Jump to bottom
Vladimir Alyamkin edited this page Jul 9, 2014 · 16 revisions

General principles

VaQuoleUI provides two actor components that you can use:

  1. VaQuoleHUDComponent - best for on-screen HUD elements or full-screen menus
  2. VaQuoleSceneUIComponent - shoud be used to show UI directly in scene (Doom 3 style)

Both components are inherited from VaQuoleUIComponent class and have the same core. Transparent background is supported for both components.

Common steps are:

  1. Add UI component to the desired blueprint
  2. Configure URL to be opened, transparency, texture size, input type, etc.
  3. Setup how and when page widget will receive input (for Scene UI primarly)
  4. Setup communication between player and widget using JavaScript calls/events
  5. Play the game

Realization details depend on type of used component, because game usage purposes are different for them at most cases. Read more about each way by following the links above.

FAQ

How to load local web application with UIComponent?

You should set the URL as vaquole://Relative/Path/To/MyPage.html, where the path is relative to your project directory (where .uproject file is located).

How to open url that requires https connection?

Check SSL support article.

Is transparent background supported?

Yes, it is. Set bTransparent=true in component defaults. Web page background should be filled with the white color.

Does VaQuoleUI support curved surfaces?

Yes, but it has its limitations. Check surface mapping section to know more.

Clone this wiki locally