Coming from PulseCore 1.x
PulseGameplay is the successor of PulseCore 1.x and a product of its own on Fab. PulseCore 1.x stays on Fab and only gets fixes. Owners of PulseCore get PulseGameplay for free through Pulse HUB.
This page lists what changes for a project on the published PulseCore 1.1.0 (modules PulseAbility, PulseEditor, PulseGameCore and PulseHUD). Work through it top to bottom: the plugin itself, required plugin, removed and renamed API, settings, assets, changed behaviour, redirects. Everything else in PulseGameplay is new and needs no migration (see New modules).
What moved where
| PulseCore 1.x | PulseGameplay |
|---|---|
Plugin PulseCore (PulseCore.uplugin, “Pulse Core”) | Plugin PulseGameplay (PulseGameplay.uplugin, “Pulse Gameplay”) |
Module names (PulseAbility, PulseEditor, PulseHUD, …) | Unchanged; the new modules keep their names too (PulseInventory, PulseCombat, …) |
Content under /PulseCore/ | Content under /PulseGameplay/; package redirects lead /PulseCore/<Folder>/... there |
Config/BasePulseCore.ini | Config/DefaultPulseGameplay.ini (core redirects), Config/Tags/PulseGameplay.ini (tags) |
Docs at luq-studios.de/PulseCore | Docs at luq-studios.de/PulseGameplay |
| Bridges named after PulseCore | PulseGameplaySaveBridge, PulseDialogGameplayBridge, PulseQuestGameplayBridge, PulseBuildGameplayBridge, PulseWorldGameplayBridge, PulseWaterGameplayBridge |
- Remove PulseCore from the project (its folder under
Plugins/, or disable the Fab install) and add PulseGameplay. Both have the same module names, so only one of them can be enabled. Replace aPulseCoreentry in thePluginslist of your.uprojectwithPulseGameplay. - Assets of the project that reference
/PulseCore/...load through the package redirects ofConfig/DefaultPulseGameplay.ini. Save them once to store the new paths. - Modules of your own keep their
Build.csdependencies: the module names did not change. - The bridges have new module and class names (core redirects in the
Config/Default<Bridge>.iniof each bridge). Their settings moved to new ini sections, for example[/Script/PulseGameplaySaveBridge.PulseGameplaySaveBridgeSettings]instead of[/Script/PulseCoreSaveBridge.PulseCoreSaveBridgeSettings]: plugins cannot redirect ini sections, so move the keys inDefaultGame.iniby hand (or list the old section in[SectionNameRemap]of the project’sConfig/ConfigRedirects.ini). - The grant cheat is
PulseGameplayGrant(wasPulseCoreGrant); the example map is/PulseGameplay/Examples/LV_PulseGameplay_Example, the example assets named after the plugin areBP_PulseGameplayExample_*andDA_PulseGameplayExample_*(object redirects lead the old names there).
Required plugin: PulseFoundation
The helper module PulseGameCore moved into PulseFoundation (1.0 or newer), the shared base of all Pulse plugins. The module keeps its name, classes and paths, so includes, Build.cs dependencies on PulseGameCore and assets that reference /Script/PulseGameCore keep working. The redirects of PulseCore 1.1.0 (TraceParams → PulseTraceParams, GameCoreSettings → PulseGameCoreSettings) moved with it into Config/DefaultPulseFoundation.ini.
- Add the plugin
PulseFoundationto the project. PulseGameplay lists it as a dependency, so it is enabled with PulseGameplay; projects whose own modules usePulseGameCoreshould also enable it in their.uproject. - Delete the old PulseCore folder before you add PulseGameplay, or at least a stale
Binaries/<Platform>/*PulseGameCore*in it: the editor reports a module that is not part of the plugin anymore. PulseAbilityandPulseHUDdepend onPulseFoundation(andPulseHUDonPulseFoundationUI). Modules of your own that use the moved types below add those modules to theirBuild.cs.
Removed and renamed API
Session nodes (PulseGameCore)
The online session nodes of PulseCore 1.1.0 are gone without a replacement in PulseGameplay: Pulse Create Session, Pulse Start Session, Pulse End Session, Pulse Find Sessions, Pulse Join Session (UPulseCreateSessionAsyncAction and the other UPulse*SessionAsyncAction classes, also the empty UPulseUpdateSessionAsyncAction), PulseOnlineHelpers.h with FPulseSessionSettings and its types, and the details customization of session settings in PulseEditor.
Sessions are part of the plugin Pulse Online. Blueprints that used the nodes load with them missing: replace them with the session requests of Pulse Online, or with the engine’s online session nodes. C++ that included Online/PulseOnlineHelpers.h or the action headers needs the same.
Input manager (PulseHUD → PulseFoundationUI)
The player input manager moved to the module PulseFoundationUI of PulseFoundation. Core redirects (Config/DefaultPulseGameplay.ini) move saved assets and Blueprints; C++ changes by hand.
| PulseCore 1.1.0 (PulseHUD) | PulseGameplay |
|---|---|
UPulsePlayerInputManager (Subsystems/PulsePlayerInputManager.h) | UPulsePlayerInputManager of PulseFoundationUI (PulsePlayerInputManager.h), class redirect |
IPulsePlayerInputManagerOwner (Interfaces/PulsePlayerInputManagerOwner.h) | IPulsePlayerInputManagerOwner of PulseFoundationUI (PulsePlayerInputManagerOwner.h), class redirect |
FPulseInputContext, EPulseInputMode, EPulseShowMouseCursorMode | the same names in PulseFoundationUI, struct and enum redirects |
AddInputContext returns FPulseHUDHandle | returns FPulseHandle (PulseFoundation) |
RemoveInputContext(FPulseHUDHandle) | Remove Input Context (K2_RemoveInputContext, takes the handle by reference and invalidates it; function redirect); C++ RemoveInputContext(const FPulseHandle&) returns whether a context was removed |
Pulse::HUD::GetPlayerInputManager | Pulse::UI::GetPlayerInputManager (Blueprint: Get Player Input Manager of UPulseHUDLibrary) |
FPulseInputContextEntry | private to the input manager |
New: AddInputContextForWidget (the context goes away with the widget), HasInputContext, RefreshInput.
HUD module
| PulseCore 1.1.0 | PulseGameplay |
|---|---|
FPulseHUDModule (PulseHUD.h), Pulse::HUD::GetSettingsFast() | Pulse::HUD::GetSettings() (returns const UPulseHUDSettings*) |
FPulseHUDHandle in HUD/PulseHUDHelpers.h | in PulseHUDTypes.h (included by PulseHUDHelpers.h); used by notifications, highlights and progress overlays of the HUD, not by the input manager |
UPulseHUDSettings derives from UObject and is registered by the module | derives from UPulseDeveloperSettings (a UDeveloperSettings); same class, ini section and settings page |
UPulseHUDHelpers (Is Valid HUD Handle, HUD Handle To String, Get HUD From Widget), Pulse::HUD::GetHUD and the rich text decorator URichTextBlockInputActionDecorator keep their names.
Settings and ini keys
The input manager keys left [/Script/PulseHUD.PulseHUDSettings] for the UI settings of PulseFoundation, with the same names and defaults. Config keys are not redirected: move them in DefaultGame.ini by hand.
Input manager keys in DefaultGame.ini
; PulseCore 1.1.0
[/Script/PulseHUD.PulseHUDSettings]
bEnablePlayerInputManager=True
bClearContextsOnControllerChange=True
bShowMouseCursorByDefault=False
DefaultInputMode=Game
; PulseGameplay
[/Script/PulseFoundationUI.PulseUISettings]
bEnablePlayerInputManager=True
bClearContextsOnControllerChange=True
bShowMouseCursorByDefault=False
DefaultInputMode=Game
The other keys in [/Script/PulseHUD.PulseHUDSettings] are new and off or empty by default: the Pulse HUD itself (bEnableHUD, HUDLayoutClass, Style, …) only starts when you turn on bEnableHUD (see HUD system).
Assets
- Blueprints that use the input manager, its context struct or its enums load through the redirects. Variables that store an input context handle are
Pulse HUD Handlein PulseCore 1.1.0 and must becomePulse Handleby hand (the old struct still exists, so they load without an error but no longer connect to Add Input Context / Remove Input Context). Refresh the Remove Input Context nodes once. - Blueprints with the session nodes: see Session nodes.
- The Blueprint macro library
/PulseCore/Macros/BML_Generalis/PulseGameplay/Macros/BML_General(package redirect).
Interaction
The interaction module keeps its API; it gained prompts, holding, conditions and costs (see Interaction system). Existing interactables keep working, with these changes:
IPulseInteractableInterfacehas three new functions with defaults:GetInteractionInfo,OnInteractionCompletedandGetInteractableTags. Classes that implement the interface need no change.- An interaction now completes: right when it starts (hold time 0, the default) or after the hold time. Effects that should respect holding, conditions or costs belong into
OnInteractionCompleted;OnInteractionStartedstill fires when the input goes down. UPulseInteractableComponent::CanBeInteractedWithalso checks the newConditionsandCosts(Pulse conditions and costs of PulseFoundation); the costs are paid on the server when the interaction completes. Both lists are empty by default.UPulseRepInteractAbilitysendsServerStartInteraction/ServerEndInteractionto the server (in PulseCore 1.1.0 a client ran them locally), and the server no longer fails RPC validation when client and server disagree for a moment; it ignores the call instead. The server checksCanBeInteractedWithagain, and a client that floods start requests is rate limited.GetInteractionTimecounts world seconds instead of real seconds (FPlatformTime): it stops while the game is paused and follows slow motion, like the new hold timer. The hold state of the ability is one value,FPulseInteractHoldState(GetHoldState), and replaces the start time of PulseCore 1.1.0.- The query task finds interactables that are already in range when the ability activates (in PulseCore 1.1.0 they had to leave and enter again).
PulseAbilitydepends onEnhancedInput(public, forFPulseInteractionInfo::InputAction) and onPulseFoundation.- Started, completed and ended interactions also go to the message bus of PulseFoundation (
Pulse.Message.Interact.*, see Messages). - Stamina costs. A GAS cost effect on the interact ability keeps working, but only with a stamina attribute of an ability system. To pay stamina with and without GAS, remove the cost effect and add an Attribute cost (
FPulseCost_Attributeof PulseFoundation,Attribute=Pulse.Stat.Stamina,Amount) toCostsof the interactable component.
Changed behaviour of the input manager
- Contexts with equal priority keep their push order: the newest wins.
- Remove Input Context invalidates the handle in Blueprint.
- Widgets that the UI host of PulseFoundation opens on its Menu and Modal layers get an input context of their layer (Layer Inputs of the presenter). This only concerns widgets opened through the UI host, which PulseCore 1.1.0 did not have.
Rich text input action decorator
The key icons of URichTextBlockInputActionDecorator follow the owning local player of the rich text widget. Before, they always used the player index of the decorator, which showed the keys of the wrong player in split screen. Without an owning player the decorator falls back to its player index as before.
Redirects
All in Config/DefaultPulseGameplay.ini unless noted.
| Kind | Old | New |
|---|---|---|
| Class | /Script/PulseHUD.PulsePlayerInputManager | /Script/PulseFoundationUI.PulsePlayerInputManager |
| Class | /Script/PulseHUD.PulsePlayerInputManagerOwner | /Script/PulseFoundationUI.PulsePlayerInputManagerOwner |
| Struct | /Script/PulseHUD.PulseInputContext | /Script/PulseFoundationUI.PulseInputContext |
| Enum | /Script/PulseHUD.EPulseInputMode | /Script/PulseFoundationUI.EPulseInputMode |
| Enum | /Script/PulseHUD.EPulseShowMouseCursorMode | /Script/PulseFoundationUI.EPulseShowMouseCursorMode |
| Function | PulsePlayerInputManager.RemoveInputContext | /Script/PulseFoundationUI.PulsePlayerInputManager.K2_RemoveInputContext |
Struct (DefaultPulseFoundation.ini of PulseFoundation) | /Script/PulseGameCore.TraceParams | /Script/PulseGameCore.PulseTraceParams |
Class (DefaultPulseFoundation.ini of PulseFoundation) | /Script/PulseGameCore.GameCoreSettings | /Script/PulseGameCore.PulseGameCoreSettings |
| Package (wildcard per content folder) | /PulseCore/<Folder>/... | /PulseGameplay/<Folder>/... |
FPulseHUDHandle is not redirected to FPulseHandle (both exist); ini keys are not redirected.
New modules
New in PulseGameplay; nothing has to change for them, enable what you need:
| Module | Content |
|---|---|
PulseInventory, PulseInventoryInteract, PulseInventoryUI, PulseInventoryEffects | Grid inventory with equipment, hotbar, pickups, loot and item effects (Inventory system) |
PulseCrafting, PulseGathering | Recipes, crafting stations, resource nodes (Crafting, Gathering) |
PulseAttributes | Health, shield and stamina on the attributes of PulseFoundation (Attributes) |
PulseCombat, PulseCombatMelee, PulseCombatRanged, PulseCombatInventory, PulseCombatHUD | Combat on the Gameplay Ability System (Combat) |
PulseInteractUI | Interaction prompt widget |
PulseMap, PulseMapUI, PulseStatusHUD, PulseRespawn, PulseRespawnUI, PulseLocks | Maps, status HUD, respawn, locks (Map, Status HUD, Respawn, Locks) |
PulseSettings, PulseFrontend | Settings menu and frontend (Settings menu, Frontend) |
The HUD of PulseHUD (layout, stacks, modals, notifications, markers, tooltips, overlays) is new in PulseGameplay as well: PulseCore 1.1.0 only had the input manager and the rich text decorator. See HUD system.