Migration

Changes that need a change in projects or plugins that use Pulse Foundation.

Requests without a player are refused

Pulse::Requests::Admit is stricter (see Results: Protecting the server):

  • No player: in a network game (listen or dedicated server) a requester that belongs to no controller is refused (warning in the log, timeline event, no answer). Before, it was let in. Standalone games, AI controllers, the listen server host and Admit(nullptr, ...) (the server’s own call) are let in as before. Server code that passes a world actor as the requester of its own work passes nullptr instead, or the project turns off Refuse Without Player (Project Settings > Pulse > Foundation > Requests).
  • No request component: a player controller without UPulseRequestComponent that cannot get one is refused instead of let in (on the server this only happens without a player controller).
  • Total rate: all kinds of requests of one player together are limited to 30 per second with a burst of 60 (Total Rate). Games with many quick requests raise it or switch it off.
  • C++: FPulseRequestGuardSettings has a constructor now and FPulseRequestGuardState the members Total and bHasTotal; nothing to change for code that uses them.

Prop tracks and state overrides

Keyframes motions of Pulse props hold property tracks and states hold overrides (see Visual: Animatable properties).

  • Assets: props saved before keep their data: old keys, state poses and material values convert when the prop loads (the log names each prop). Open and re-save converted props; until then they convert on every load. Smooth keys use the new smooth curve, and a material value a state does not set goes back to its base value instead of staying.
  • C++ and Blueprint: FPulsePropMotion::Keys, FPulsePropState::Poses and FPulsePropState::MaterialValues are gone; use FPulsePropMotion::Tracks (with Duration as the clip length) and FPulsePropState::Overrides. The namespace Pulse::Visual::Keys became Pulse::Visual::Tracks, Keys::Blend is Motion::Blend, and States::Blend takes a function for the base value and kind of a property. FPulsePropKey, FPulsePropPartPose and FPulsePropMaterialValue remain only for loading old data.
  • Visual types of your own can declare animatable properties in FPulseVisualType::Properties; without them their parts take the common properties (location, rotation, scale, visibility).

Editor kit in its own module

The editor kit (cards, config workshop, graph, preview, level tools, timeline, views, tasks, tuning and attribute workshops) moved from PulseFoundationEditor to the new Editor module PulseFoundationEditorKit.

  • Build.cs: a module that includes a kit header adds PulseFoundationEditorKit next to PulseFoundationEditor (public if one of its public headers includes a kit header). Include paths stay Kit/.... Modules that only use Kit/PulseEditorKit.h, Kit/PulseEditorKitStyle.h, Kit/Graph/PulseGraphTypes.h, Kit/PulseAssetDefinition.h or Kit/PulseAssetFactory.h need nothing new.
  • Export macro: kit types are PULSEFOUNDATIONEDITORKIT_API.
  • Saved data: config templates, editor settings classes, the graph classes and two enums have class redirects in DefaultPulseFoundation.ini, so saved templates load unchanged. The Config Workshop, Graphs, Cards and Icon Renderer settings are copied once from their old sections.
  • UPulseAssetFactory::Template is a UObject (a UPulseConfigTemplate of the kit). Setting it is unchanged; code that reads it casts.
  • Learn: the check PulseFoundation.Learn.HasConfigAsset keeps its name and comes from the kit. Pulse::Editor::Learn::GetProjectPackages() is public for checks of your own.

PulseFoundation plugin documentation.

This site uses Just the Docs, a documentation theme for Jekyll.