Actions

UI Actions are used to define the action that is going to happen after an interactable element has been clicked inside the virtual experience. A simple way to think about actions and models is this: When an action is executed, I want this model to be sent to the User Interface.

We support various types of actions with these Action Models, including Product Description Page, Media, Information, AR Viewer, iFrame Viewer, and Custom.

You can create these actions either manually or through an automated process. We'll first cover the manual method before discussing the automated approach.

Creating a Action Model Data Asset

To create a Clickable Style Model Data Asset in Unreal Engine, follow these steps:

1. Right-click in the Content Browser.
2. Go to Miscellaneous -> Data Asset.
3. Search for "Action Model" and select the type.
4. Click "Create" to create the asset.
5. The Action Model Data Asset contains configurations based on the event type. By default, it is set to click, but you can change that using the Event dropdown.


The Action Model supports three event types: "click", "over", and "out". You can configure them by selecting the desired option from the event dropdown, as shown below.



The Action Model also supports different content types: “Product Description Page (PDP)”, “Media”, “Information (INFO)”, “Augmented Reality Viewer (AR)”, “iFrame Viewer”, and “Custom” You can switch between the content types and assign the models, as demonstrated below.



PDP Model

The "PDP" model is used to define the product's PDP (Product Detail Page) information and can be attached to an Action Model. Actions can be defined, such as opening the PDP model when clicking on the product in the virtual tour. The following information is passed through the PDP model. The "PDP" model is used to define the product's PDP (Product Detail Page) information and can be attached to an Action Model. Actions can be defined, such as opening the PDP model when clicking on the product in the virtual tour. The following information is passed through the PDP model. The "PDP" model is used to define the product's PDP (Product Detail Page) information and can be attached to an Action Model. Actions can be defined, such as opening the PDP model when clicking on the product in the virtual tour. The following information is passed through the PDP model.

To define the new PDP model, follow these steps:

1. Right-click in the Content Browser.
2. Navigate to Miscellaneous -> Data Asset.
3. Search for "PDP Model" and select the type.
4. Click "Create" to generate the asset.
5. The PDP Model Data Asset contains configurations for the PDP information.


Key	Description
parent_id	The unique identifier for the parent product.
parent_sku	The stock-keeping unit (SKU) for the parent product.
market	The market or region where the product is being sold.
title	The title or name of the product.
short_description	A brief description of the product.
long_description	A more detailed description of the product.
category	The category to which the product belongs.
brand	The brand associated with the product.
collection	The collection that the product is part of.
currency	The currency used for the product pricing.
gender	The intended gender for the product (e.g., male, female, unisex).
age_group	The age group for which the product is targeted.
default_url	The default URL for the product's online page.
tags	Tags associated with the product for categorization.
base_price	The base price of the product.
variants_selection_order	The order in which product variants (e.g., color, size) are selected.
variants	A list of variants for the product, including color and size options.
bDefault	Indicates if this variant is the default selection.
variant_id	The unique identifier for the specific variant.
variant_sku	The SKU for the variant.
in_stock	Indicates whether the variant is currently in stock.
available_stock	The number of units available for the variant.
media	A list of media (e.g., images, videos) associated with the product variant.
media_plugin_integration	Plugin integrations for media associated with the product.
color_swatch	The color swatch identifier for the product variant.
momenti_url	URL for the Momenti experience, if applicable.
three_dimension_model	URL for the 3D model of the product.
retail_price	The retail price of the variant.
sale_price	The sale price of the variant, if applicable.
turnTableURL	The URL for the turntable feature associated with the product.

Key	Description
bDefault	Indicates if this is the default variant.
variant_id	The unique identifier for the specific variant.
variant_sku	The SKU for this variant.
short_description	A brief description of the variant.
long_description	A detailed description of the variant.
in_stock	Indicates whether this variant is currently in stock.
variants	A list of attributes for this variant, such as color or size.
name	The name of the specific variant (e.g., color, size).
variant_type	The type of variant (e.g., color, size).
value	The value for the variant (e.g., color code, size value).
price	The price for this specific variant.
available_stock	The number of units available for this variant.
variant_sku	The SKU for the specific variant (empty if not available).

Info Model

The "Info" model is used to display brief information about a product in the virtual environment. Actions can be defined, such as opening the product information when the product is clicked in the virtual tour. The following information is passed through the "Info" model.

To define a new Info model, follow these steps:

6. Right-click in the Content Browser.
7. Navigate to Miscellaneous -> Data Asset.
8. Search for "Info Model" and select the type.
9. Click "Create" to generate the asset.
10. The Info Model Data Asset contains configurations for the information.


Key	Description
imageURLs	The URL or references for the images to display in the info model.
title	The title or main heading for the info model.
subtitle	The subtitle or secondary heading for the info model.
description	A brief description or body text for the info model.
moreCTA	Call-to-action link or button text for "More" information.

Custom Model

The "Custom" model can be used to send custom key-value pair information upon an action. This information can later be utilized by the virtual tours to trigger specific custom actions.

To define a new custom model, follow these steps:

11. Right-click in the Content Browser.
12. Navigate to Miscellaneous -> Data Asset.
13. Search for "Custom Model" and select the type.
14. Click "Create" to generate the asset.
15. The Custom Model Data Asset contains configurations for the custom key value pairs.

AR Model

The AR model allows you to visualize 3D models within the experience.

To create a new AR model, follow these steps:

1. Right-click in the Content Browser.
2. Go to Miscellaneous → Data Asset.
3. Search for "ARModel" and select the corresponding type.
4. Click "Create" to generate the asset.
5. The AR Data Asset contains all necessary configurations for the AR Viewer.

iFrame Model

The iFrame model allows you to embed websites or iframes within the experience.

To create a new iFrame model, follow these steps:

1. Right-click in the Content Browser.
2. Navigate to Miscellaneous → Data Asset.
3. Search for "iFrame" and select the appropriate type.
4. Click "Create" to generate the asset.
5. The iFrame Data Asset contains all necessary configurations for the iFrame Viewer.

Media Model

The Media model allows you to embed videos and images within the experience.

To create a new Media model, follow these steps:

1. Right-click in the Content Browser.
2. Navigate to Miscellaneous → Data Asset.
3. Search for "Media" and select the appropriate type.
4. Click "Create" to generate the asset.
5. The Media Data Asset contains all necessary configurations for the Media Viewer.


Key	Description
URLs	The URL or references for the Videos, Images to display in the Media model.

Automated Action Model Creation Process

To streamline the process of creating action models, assets, and attaching them to interactables, we now support direct editing within the Details Panel of interactables placed in the scene.

Using the Action Type dropdown, you can specify the type of interactable action. Once selected, the relevant properties will appear below the dropdown for configuration. This automatically creates and attaches the corresponding action models and action type assets to the interactable, significantly reducing the number of steps required.

If you forget to save your action models or action type assets, you can simply clear the action models array on the interactable and make a slight modification to any Action Type property. This will automatically regenerate the entire asset.

Help & Support

If you have questions, suggestions, or feature requests, please join the Official Emperia Discord channel!

You can find support here through private support tickets or general conversation. You will also have the opportunity to showcase your work and chat with like-minded individuals across industries using Creator Tools, Unreal Engine, those creating immersive experiences, and more!

If you prefer, you can also reach out to us via email.

On this page

• Actions
• Creating a Action Model Data Asset
• AR Model
• iFrame Model
• Media Model
• Automated Action Model Creation Process
• Help & Support