SsimnJS Docs

Installation

Add the kit to your project and make your first widget clickable.

Copy the kit

Close UEFN. Copy the WorldUIKit folder into your project's Content folder. Open the project and build the Verse code (Verse > Build Verse Code).

Place your widget

Drag your Widget Blueprint from the Content Browser into the level: it becomes a widget entity. Set its scale (10 is a good start) and turn it to face the players.

Add the component

Select the widget entity. In the Details panel, add interactive_widget_component.

Describe its elements

Open the online editor, paste your widget and place the clickable zones (see Online editor). Download the two files it writes, <wbp>_layout.verse and <wbp>_logic.verse, and save them in Content, next to the WorldUIKit folder. Build the Verse code, then add the <wbp>_layout and <wbp>_logic components to the widget entity.

The kit draws nothing on your widget: in your WBP, create the Verse fields the editor lists and bind them, so that the widget shows hover, clicks and states itself (see Effects and animations).

You can also skip the editor and fill the Elements list of interactive_widget_component by hand (see Elements). The elements are then clickable, but the widget shows no state.

Write your actions

Open <wbp>_logic.verse and replace each Print with your code. See Actions in Verse.

Play

Launch a session, aim at an element and click.

Folder layout

Content/
├─ WorldUIKit/             the kit, replaced as a whole by updates
├─ wbp_shop_layout.verse   written by the editor
└─ wbp_shop_logic.verse    your actions

Keep your files outside WorldUIKit

An update replaces the whole WorldUIKit folder. Save the generated files next to it, never inside it.

Updating the kit

Close UEFN, replace the WorldUIKit folder with the new one, open the project and build the Verse code. Your layout and logic files are outside the folder, so they are kept. Read the changelog first.

Scale and size

A widget unit measures 0.0263 cm at scale 1 (CmPerUnit), so a 1200 × 800 widget at scale 10 is about 3.2 m × 2.1 m. Players can aim at it from up to 50 m (MaxDistance, in centimetres).

On this page