Skip to content

Aurum Blueprint and C++ API

One per local player. Blueprint: Get Assetpro Menu Subsystem. C++: LocalPlayer->GetSubsystem<UAFMMenuSubsystem>().

Function What it does
Show Startup Menu Shows the first-run pages if needed, then the press start screen or the main menu.
Show Main Menu, Show Press Start Screen Shows that screen.
Show Pause Menu, Hide Pause Menu, Toggle Pause Menu, Is Pause Menu Open Pause menu control. Hide closes anything opened on top of it too.
Begin New Game Flow Character creation, difficulty, intro card (each when turned on), then the New Game Level.
Open Character Creation, Open Difficulty Select, Open Intro Card Opens one step of the flow.
Confirm Character, Confirm Difficulty, Finish New Game Flow Moves the flow on from your own screens.
Get Pending Character The character made in this New Game so far.
Start New Game Opens the New Game Level at once (the save subsystem starts a new game with the pending character).
Show Death Screen, Hide Death Screen, Is Death Screen Open The death screen.
Open Settings, Open Settings Tabs, Open Settings Page The settings menu, the tabbed settings screen, or one page with the categories you pass.
Open Credits, Open Chapter Select, Open Controller Layout Opens that screen.
Open Codex, Open Document The codex (on a category), or a letter in the document reader.
Open Extras, Open Gallery, Open Jukebox, Open Photo Mode Opens that screen.
Open Load Game, Open Save Game, Get Save Subsystem The slot screens, and the Assetpro Save Subsystem.
Open First Run, Finish First Run, Needs First Run The first-run pages.
Start Chapter, Unlock Chapter, Is Chapter Unlocked, Reset Chapter Progress Chapters. See Chapters and the world map.
Show Confirm Dialog A modal dialog from a Dialog Descriptor (title, message, confirm / cancel / alternate text, destructive, timeout). The result is Confirmed, Cancelled or Alternate.
Push Screen, Get Root Layout Pushes any activatable widget onto a layer (Game, Game Menu, Menu, Modal); the root layout.
Execute Menu Entry Runs an entry as if it was clicked.
Set / Clear / Is Menu Entry Enabled Turns entries on or off.
Open Menu Level, Restart Level, Return To Main Menu, Quit Game The menu actions.
Close All Menus, Is Any Menu Open Closes every menu, popup and dialog.
On Menu Action (event) Fires with the Id after any entry runs.
On Pause Menu Changed (event) Fires when the pause menu opens or closes.
On Chapter Started (event) Fires with the chapter Id before its level opens.
On Character Confirmed, On Character Randomised (events) Character creation finished, or Randomise rolled a new character.

Blueprint: Get Assetpro HUD. C++: LocalPlayer->GetSubsystem<UAFMHUDSubsystem>(). Its functions are listed under HUD.

One per game. Blueprint: Get Assetpro Save Subsystem. C++: GameInstance->GetSubsystem<UAFMSaveSubsystem>().

Function What it does
Save To Manual Slot, Save To New Slot, Autosave, Quick Save Saves (asynchronously). False when saving is not allowed now.
Load Save, Load Newest Save, Quick Load Opens the save’s level and puts the player back.
Delete Save, Is Saving Deletes a save; a save is being written.
Get Saves, Has Any Save, Get Newest Save, Find Save, Get Free Manual Slot, Get Manual Save Count, Get Thumbnail, Make Slot Name The saves and their details.
Set Saving Allowed, Is Saving Allowed, Get Saving Blocked Reason, Is In Game When saving is possible.
Begin New Game, Set Current Chapter, Get Current Chapter, Get Playtime The game being played (New Game and Start Chapter call Begin New Game).
Set Save Summary, Get Save Summary The objective line on the cards’ details.
Set Save Extra, Remove Save Extra, Get Save Extra, Get Save Extras Your facts for the save cards.
Set Character Profile, Get Character Profile, Has Character Profile The character made at New Game.
Get Loaded Save The save this session was loaded from.
On Gather Save Data, On Save Loaded, On Save Finished, On Saves Changed (events) Fill in and read your data; react to saves.

One per game. Blueprint: Get Game Instance Subsystem (AFM Codex Subsystem). C++: GameInstance->GetSubsystem<UAFMCodexSubsystem>().

Function What it does
Unlock Codex Entry, Is Codex Entry Unlocked Adds an entry (optionally announced on the HUD); whether it is unlocked.
Mark Codex Entry Read, Is Codex Entry New The “new” mark.
Get Entries, Get Category Entries, Find Entry, Get Latest Unlocked The entries.
Get Unlocked Count, Get Total Count Counts for a category (None: all).
Set Journal Quest, Set Journal Objective Done, Get Journal Heading, Get Journal Text, Get Journal Objectives The journal.
Reset Codex Back to the entries known from the start, and no quest (New Game does it).
On Codex Entry Unlocked, On Document Read Aloud (events) An entry was unlocked; Read Aloud was pressed in the reader.

One per game. Blueprint: Get Game Instance Subsystem (AFM Extras Subsystem). C++: GameInstance->GetSubsystem<UAFMExtrasSubsystem>().

Function What it does
Unlock Extra, Is Extra Unlocked, Unlock All Extras, Reset Extras Gallery pictures, tracks and cinematics.
Play Track, Stop Track, Toggle Pause Track, Play Next Track, Set Loop Track The music room’s player.
Is Track Playing, Is Track Paused, Is Looping Track, Get Current Track, Get Track Time, Get Track Duration Its state.
Play Cinematic Fires On Cinematic Requested, or opens the cinematic’s Level.
On Extra Unlocked, On Cinematic Requested, On Jukebox Changed (events) React to unlocks, play cinematics, duck your music.

Blueprint: Get Assetpro Settings Subsystem. Besides the getters listed under Settings:

Function What it does
Apply And Save Applies video settings and saves everything.
Revert Unsaved Changes, Has Unsaved Changes Throws away changes made since the last apply; whether there are any.
Confirm Display Mode, Revert Display Mode, Is Display Change Pending Answers “Keep display settings?” from code.
Apply User Settings, Apply To Player Controller Pushes every saved value to the engine, or the per-player values (field of view, vibration) to a controller.
Set Custom Setting Value, Set Difficulty Sets a custom setting, or the difficulty.
Is First Run Done, Mark First Run Done, Reset First Run, Is Content Warning Hidden, Set Content Warning Hidden The first run.
On Setting Changed, On Settings Applied (events) React to changes.
Node What it does
Get Assetpro Menu Subsystem, Get Assetpro HUD The menus and the HUD of a player (the first local one by default).
Get Assetpro Save Subsystem, Get Assetpro Settings Subsystem Saves and settings.
Get Active Theme, Set Runtime Theme The theme in use, and swapping it at runtime.
Get Active Menu Config The Menu Config in use.
Show Confirmation Dialog A confirmation dialog in one node, with an On Result event.
Play UI Sound Plays one of the active theme’s interface sounds at the Interface volume.
Class Use
AFMMainMenuGameMode GameMode for main menu levels. No pawn; the startup menu appears automatically.
AFMPlayerController Escape and gamepad Start toggle the pause menu (also while paused); F5 and F9 quick save and quick load; applies saved settings. Show Main Menu On Begin Play, Enable Pause Menu Input and Enable Quick Save Input switch these.
AFMMainMenuPlayerController Used by AFMMainMenuGameMode. Shows the startup menu and never opens the pause menu.
AFMSaveGame The save written to each slot; make a child with your own variables. See Save and load slots.
AFMCharacterPreview The character turning in character creation’s mirror; make a child for your own character.
AFMCameraModifier_FieldOfView Applies the Field of View setting to the player’s view. Added to every local player’s camera for you.
AFMCameraModifier_Drain Takes colour from the player’s view while the pause menu is open. Added and driven for you.
AFMInteractionVolume, AFMSubtitleTrigger, AFMCheckpointVolume The HUD volumes. See HUD.
AFMPlayerMappableKeyProfile The key profile that keeps cleared bindings unbound. See Controls and key rebinding.
Assetpro Look Settings Input modifier for sensitivity and invert Y on your Look mappings.

FAFMPaint (filled shapes, lines, diamonds, dividers, corner filigree, flourishes, shield outlines, value bars), FAFMQuadBatch (many solid quads in one draw) and FAFMEffects (Are Reduced, Try Flash: the three-a-second limit) are exported for your own Slate widgets.

Command What it does
AFM.ListSettings Prints the Id of every built-in setting, for Hidden Settings.