For convenience, most Consequence settings live inside your project at Consequence.app ↗, so that you can easily change them any time.
However, some settings are better inside your Unreal Engine project, usually because they refer to specific project files or directories or are Unreal-specific.
Editor Settings are only for functionality and content not available inside your packaged game. Find these settings inside Project Settings → Plugins → Consequence Editor Settings.
| Setting | Description |
|---|---|
| Consequence Export JSON Directory | The path of the directory where your Consequence Client submits its ConsequenceExport.json file, as well as where Consequence updates the .json file used for "Export Localization Key Mapping," provided that setting is enabled. These are stored as relative paths for convenience, and we recommend keeping these JSON files outside of the Content directory, preferably in a Consequence folder at the same level as the Content directory (this is the default). This directory will be created on first import if it does not exist. |
| Consequence String Tables Directory | The directory containing all String Tables that Consequence should access, including the UI_Consequence table reserved for strings added in Consequence. E.g. ../../../[YourProject]/Content/UI/StringTables |
| Consequence Ak Event Parent Directory | If set, specifies the top-level directory containing all VO AkEvent Uassets to associate with Consequence lines. E.g. ../../../[YourProject]/Content/WwiseAudio/Events/VO |
| Consequence Facial Animation Parent Directory | If set, specifies the top-level directory containing all Facial AnimSequence assets to associate with Consequence lines. E.g. ../../../[YourProject]/Content/Animation/FacialAnimation |
| Consequence Facial Animation Asset UID Prefix | This string must come after everything else in the animation's filename, but before the 6-digit UID that links the line from Consequence to the facial animation. For example, if this setting was set to faceanim, the full asset path might be something like: /Game/Animation/FacialAnimation/Character1/Level1/export_faceanim_001234. |
| Database Submit Message | A prefix string that is prepended to the Source Control submit message for the import. A default value is provided: ## Consequence\r\n- Consequence database import. |
| Show Consequence Button In Level Editor Toolbar | Whether or not to show the Consequence button in the level editor toolbar. The window this button opens is also available from the Build → Consequence main menu. |
| Export Localization Key Mapping | Whether or not to update and export a JSON file for every import process showing a mapping between line UIDs and the IDs used in the .po files for Localization. If set, this file will be output to your Consequence Export JSON Directory after each import and submitted along with the other modified files. |
Runtime Settings are settings your finished game needs to access while it is running. Find these settings inside Project Settings → Plugins → Consequence Runtime Settings.
| Setting | Description |
|---|---|
| Consequence Database Asset | Points to your Consequence Database inside your project, which contains all the data imported from Consequence (follow Uplugin Setup Instructions for how to create it; it is a Data Asset inheriting from the ConsequenceDatabase type). |
| Auto Create Consequence Subtitle Widget | This setting specifies whether to automatically create the default subtitle widget for Consequence on startup. You can override the Subtitle Widget Class setting and still use this option. If set to true, whenever BeginPlay runs on a new game world, Consequence will check if this subtitle widget exists, and create one and add it to the viewport if it does not. |
| Print Debug String Subtitles | Whether to print debug subtitles to screen. Useful for debugging when the default subtitle widget is not in use or operable. |
| Use Consequence Default Data Manager | Whether to use the Default Data Manager, Consequence's built-in solution for fact and data storage. This option can be turned off if you opt to implement the IConsequenceFactSource and IConsequenceSavedEventDataSource interfaces to manage saved event and fact data in your game code. If you create your own managers, just ensure that they register themselves with Consequence on startup. |
| Subtitle Widget Class | The widget to auto-create and add to the viewport at runtime if the Auto Create Consequence Subtitle Widget option is true. |
| Scripting Manager Class | If set, we initialize this Blueprint at runtime to enable adding scripting hooks for specific Consequence events. |
| Facial Animation Pre Roll Time | The time in seconds that facial animations should start ahead of audio in order to give the face time to reach the start position for the first sound. Default: 125ms. |
| Facial Animation Slot Name | The default name of the animation blueprint slot on which to play facial animations as dynamic montages. |
| Speaker Ak Component Tag | If set, Consequence will look for an AkComponent with this tag on each speaker actor at the moment that their audio is to be played, and post the Wwise event on that specific component. If set to None (default), Consequence will post the Wwise event on the actor and allow Wwise to find the first AkComponent to use. |
| Dialogue Asset Async Load Priority | The priority number passed to the streaming system when loading sound and facial animation assets at the start of dialogue events. Higher values are higher priority. If your dialogue is playing significantly after when it is triggered, it may be caught behind higher-priority loads of other assets in your game, in which case you should try increasing this number further. Dialogue must be loaded quickly, as it is generally loaded just-in-time and the assets required are very small, whereas other assets in your loading queue (characters, levels, etc) may be much larger and delay loading the audio or animations for your dialogue. |