> For the complete documentation index, see [llms.txt](https://dante-3.gitbook.io/dante-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dante-3.gitbook.io/dante-docs/modular-experience-system/blueprint-reference.md).
# Blueprint Reference
All Blueprint nodes, async actions, subsystem methods, and function library functions.
***
## Async Actions
### Wait For Experience Ready
Waits for the experience loading process to complete. Fires immediately if already loaded.
```
UAsyncAction_ExperienceReady::WaitForExperienceReady(WorldContextObject)
├── [Output] OnReady(Experience)
└── [Input] WorldContextObject (auto-filled)
```
| Pin | Type | Description |
| ------------------ | ---------- | ------------------------------------------- |
| WorldContextObject | `UObject*` | Auto-filled |
| OnReady | Delegate | Called with `UModularExperienceDefinition*` |
**Usage scenario:** Waiting for the experience to load in an actor's BeginPlay, then performing setup once loaded.
***
### Open User Facing Experience (By ID)
Opens a User Facing Experience by PrimaryAssetId: loads the asset, initiates map travel.
```
UAsyncAction_OpenUserFacingExperience::OpenUserFacingExperience(
WorldContextObject, UserFacingExperienceId, bServerTravel)
├── [Output] OnLoaded(Experience)
└── [Output] OnFailed(ErrorReason)
```
| Pin | Type | Default | Description |
| ---------------------- | ----------------- | ------- | ----------------------------------- |
| WorldContextObject | `UObject*` | Auto | Widget or actor |
| UserFacingExperienceId | `FPrimaryAssetId` | — | UFE asset ID |
| bServerTravel | `bool` | `false` | `true` = ServerTravel (multiplayer) |
| OnLoaded | Delegate | — | Travel initiated |
| OnFailed | Delegate | — | With error message |
***
### Open User Facing Experience (Direct Reference)
Same operation using a direct object reference:
```
UAsyncAction_OpenUserFacingExperience::OpenUserFacingExperienceFromObject(
WorldContextObject, UserFacingExperience, bServerTravel)
```
Skips the async load step if the asset is already loaded.
***
## Subsystem (UModularExperienceSubsystem)
Automatically created in every world as a World Subsystem. Accessed from Blueprints via the `Get Subsystem` node.
### Properties
| Property | Type | Description |
| ------------------- | ---------------------------- | --------------------------------------------------------- |
| `OnExperienceReady` | `Dynamic Multicast Delegate` | Fires when the experience is loaded. Blueprint Assignable |
### Methods
#### Get Experience Manager
```cpp
UFUNCTION(BlueprintPure, DisplayName = "Get Experience Manager")
UModularExperienceManagerComponent* GetExperienceManager() const;
```
Returns the manager component on the GameState.
#### Is Experience Loaded
```cpp
UFUNCTION(BlueprintPure)
bool IsExperienceLoaded() const;
```
#### Get Current Experience
```cpp
UFUNCTION(BlueprintPure)
const UModularExperienceDefinition* GetCurrentExperience() const;
```
#### Wait For Experience Ready
```cpp
UFUNCTION(BlueprintCallable, DisplayName = "Wait For Experience Ready")
void WaitForExperienceReady();
```
Receives a notification when the experience is ready via the `OnExperienceReady` delegate. If already loaded, fires on the next frame.
***
## Function Library (UModularExperienceFunctionLibrary)
Static Blueprint helper functions. Performs quick queries without accessing the subsystem.
### Experience Queries
| Function | Return | Description |
| ---------------------------------------------- | ------------------------------------- | --------------------------------------- |
| `GetExperienceManager(WorldContext)` | `UModularExperienceManagerComponent*` | Returns the manager component |
| `GetCurrentExperienceDefinition(WorldContext)` | `UModularExperienceDefinition*` | Returns the loaded experience |
| `GetCurrentExperienceId(WorldContext)` | `FPrimaryAssetId` | Returns the loaded experience ID |
| `IsExperienceLoaded(WorldContext)` | `bool` | Checks whether the experience is loaded |
| `GetExperienceSubsystem(WorldContext)` | `UModularExperienceSubsystem*` | Returns the subsystem |
### User Facing Experience Queries
| Function | Return | Description |
| --------------------------------------- | ------------------------------------ | --------------------------------------- |
| `GetUserFacingExperienceIdByName(Name)` | `FPrimaryAssetId` | Creates a PrimaryAssetId from a name |
| `GetAllUserFacingExperiences()` | `TArray` | Returns all discovered UFEs (sync load) |
### Action Lookup
| Function | Return | Description |
| ------------------------------------------- | --------------------- | ------------------------------------------------- |
| `FindActionInDefinition(Definition, Class)` | `UGameFeatureAction*` | Searches for an action in the definition by class |
| `FindFacingActionInExperience(UFE, Class)` | `UMES_FacingAction*` | Searches for a facing action in the UFE by class |
***
## Experience Manager Component (Blueprint API)
### ChangeCurrentExperience
```cpp
UFUNCTION(BlueprintCallable, Category = "Experience")
void ChangeCurrentExperience(FPrimaryAssetId ExperienceId);
```
Starts the experience loading process. **Can only be called once.**
### IsExperienceLoaded
```cpp
UFUNCTION(BlueprintPure, Category = "Experience")
bool IsExperienceLoaded() const;
```
### GetCurrentExperience
```cpp
UFUNCTION(BlueprintPure, Category = "Experience")
const UModularExperienceDefinition* GetCurrentExperience() const;
```
***
## Experience Definition (Blueprint API)
### Get Action By Class
```cpp
UFUNCTION(BlueprintPure, DisplayName = "Get Action By Class",
meta = (DeterminesOutputType = "ActionClass"))
UGameFeatureAction* GetActionByClass(TSubclassOf ActionClass) const;
```
Returns the first action of the specified class. Thanks to `DeterminesOutputType`, there is no need to cast the output.
***
## User Facing Experience (Blueprint API)
### Get Facing Action By Class
```cpp
UFUNCTION(BlueprintPure, DisplayName = "Get Facing Action By Class",
meta = (DeterminesOutputType = "ActionClass"))
UMES_FacingAction* GetFacingActionByClass(TSubclassOf ActionClass) const;
```
***
## Typical Blueprint Flows
{% stepper %}
{% step %}
### Opening an Experience from Menu
```
[Button Click]
└── Open User Facing Experience (By ID)
├── ExperienceId: "MES_UserFacingExperience:UFE_TeamDeathmatch"
├── bServerTravel: false
├── OnLoaded → [Log: "Traveling..."]
└── OnFailed → [Show Error Widget]
```
{% endstep %}
{% step %}
### Showing UI When Experience Loads
```
[Actor BeginPlay]
└── Wait For Experience Ready
└── OnReady(Experience)
└── Get Action By Class (UMyUIAction)
└── [Create HUD widget]
```
{% endstep %}
{% step %}
### Menu Listing All Experiences
```
[Widget Construct]
└── Get All User Facing Experiences
└── [For Each Experience]
└── Get Facing Action By Class (DisplayInfo)
└── [Create list item: Title, Thumbnail, Description]
```
{% endstep %}
{% endstepper %}