API reference

Module

Type Header Purpose
IPulseFoundation PulseFoundation.h Module interface: Get(), IsAvailable(), GetVersionString(); version macros, LogPulseFoundation
PULSE_FOUNDATION_VERSION_AT_LEAST(Major, Minor) PulseFoundation.h Compile-time version check
PULSE_WITH_DEBUG (module definition) 1 in non-shipping builds

Distribution

Namespace Pulse::Foundation, header Distribution/PulseDistribution.h. See Fab packages and separate plugins.

Function Purpose
GetHostPluginName() Plugin that holds this copy: PulseFoundation or the plugin of a Fab package
GetModuleName(), GetModulePrefix() Real name of the main module and the prefix of all modules (empty for the separate plugin)
IsBundled() True inside a Fab package
GetContentRoot(), MakeContentRoot(Plugin), MakeContentPath(Path) Content root of this copy (/PulseFoundation or /<Plugin>/Foundation) and full asset paths below it
FindCopies(Plugins), GetEnabledCopies() The copies of Pulse Foundation among plugins, the separate plugin first; the one of this process
IsActiveCopy(), IsActiveCopy(Copies, Plugin), HasCopyConflict() Whether this copy runs; whether several copies are enabled
MakeConflictMessage(Copies), JoinDisplayNames(Names) Texts for the conflict notice

Messages

Type Purpose
UPulseMessageSubsystem Get, Listen, Listen<T>, ListenWeak, Unlisten, Broadcast, Broadcast<T> (all with FPulseContext); Blueprint Broadcast Pulse Message, Listen (Pulse Message), Unlisten (Pulse Message)
UPulseListenForMessageAction Blueprint node Listen For Pulse Message (channel, payload, context)
UPulseMessageRelayComponent RelayToAll, RelayToOwner (with context), ForwardToClients, ForwardToClientsReliable, FindMessageRelay; the context carries the player id, clients find the player state again
Pulse::Messages::RegisterChannel, RegisterChannel<T>, UnregisterChannel, FindChannel, GetChannels, DescribeChannels Channel register (FChannelInfo: channel, payload, origin, description)
EPulseMessageOrigin Server, Client, Both
FPulseMessageTrigger Channel, match, conditions, value path, server only; Matches, PassesConditions, GetValue, Validate (editor)
Pulse::Messages::BindTrigger, UnbindTrigger, ShouldListen, MakeTriggerContext, FindValueProperty, ReadPayloadValue Listening for triggers, value paths
UPulseWaitForMessageTriggerAction Blueprint node Wait For Pulse Message Trigger
FPulseMessageRouter Plain router (tests, custom buses); Broadcast with a prepare callback for the listeners’ context
EPulseMessageMatch Exact, Partial

Players

Function (Pulse::Player / UPulsePlayerLibrary) Purpose
GetController, GetPlayerController, GetPlayerState, GetPawn, GetLocalPlayer Resolve a player from any of its actors
GetPlayerActors Actor, controller, player state, pawn
GetPlayerId, FindPlayerStateById (Blueprint Get Pulse Player Id, Find Pulse Player State By Id) The stable id of a player, and its player state found again by that id on every machine
GetPlayerIdKind, ParsePlayerIdKind (Blueprint Get Pulse Player Id Kind, Parse Pulse Player Id Kind), EPulsePlayerIdKind What a player id is made from: Online, PlayInEditor, LocalProfile, Session, Provider, None (Default ids)
MakeDefaultPlayerId (also with OutKind) The default id: persistent online id, PIE slot, local profile or session id, never the player name
GatherPlayerIdSources, ChooseDefaultPlayerId, FPlayerIdSources The default id as pure parts: its sources and the decision
MakePlayInEditorPlayerId, MakeLocalProfilePlayerId, MakeSessionPlayerId, IsPersistentNetId, IsPersistentNetIdType, FindPlayInEditorSlot, GetLocalProfileKey Parts of the default ids
FindComponentOnPlayer, FindInterfaceOnPlayer Find a component or interface on the player’s actors
UPulsePlayerIdentityProvider Provider of the player ids: GetPlayerId(PlayerState), GetPlayerIdKind(PlayerState) (BlueprintNativeEvents; default: MakeDefaultPlayerId and its kind) (Who a player is)
UPulsePlayerIdentitySubsystem Game instance: Get, GetIdentityProvider, SetIdentityProvider, SetIdentityProviderClass, ResetIdentityProvider

Context and conditions

Type / function Purpose
FPulseContext Player, instigator, target, source, tags, amount and extra data of a condition, cost, reward or message (Conditions)
FPulseContext::GetPlayerController, GetPlayerState, GetPawn, FindPlayerComponent, GetExtra The player’s actors and components, the extra data
FPulseContextIds (PlayerId, SourceAsset, SourceTag), FPulseContext::Ids The ids of the player and the source next to the pointers (Conditions)
FPulseContext::GetIds, GetPlayerId, GetSourceAsset, SetPlayer, SetSource The ids a context names (live pointers win), change player or source and drop the old ids
Pulse::Context::GetSourceAssetPath, FillIds, FillPlayerId, ResolveFromIds The asset an object is; store the ids of a context that is kept; find the player state and the loaded source of the ids again
UPulseContextLibrary Blueprint: Make Pulse Context, Get Context Player Controller / Player State / Pawn, Find Context Player Component, Get Context Ids, Get Context Player Id, Set Pulse Context Player / Source
EPulseConditionResult Passed, Failed, Unknown (data missing here, the server decides)
FPulseCondition Base of conditions: Evaluate(Context), GetDisplayText(Context)
FPulseConditionList Mode (All, Any), Conditions; Evaluate, GetDisplayLines, IsEmpty, Add<T>
FPulseCondition_All, _Any, _Not Nested logic
FPulseCondition_ContextTags, _ActorHasTags, _ActorTagQuery, _ActorIsClass, _CompareAmount Conditions on the context
UPulseConditionObject, FPulseCondition_Blueprint Conditions made in Blueprint, one instance per entry
Pulse::Conditions::CombineAll, CombineAny, Invert, EvaluateAll, GetMissingDataResult, Compare, GetActorTags, GetContextActorTags, FindWorld, HasAuthority Helpers for own conditions
FPulseCostContext Context of a payment: Fraction, Offset, bReverse
FPulseCost Base of costs: CanPay, Pay, Refund (authority), GetDisplayText, GetLines
FPulseCostList Costs; CanPayAll, PayAll (all or nothing), RefundAll, GetDisplayLines, GetLines, IsEmpty, Add<T>
FPulseCostLine UI line of a cost: label, icon, have, need, IsMet
Pulse::Costs::GetAmount, GetEntryText Whole amounts rounded over the whole cost, entry lines
Pulse::Costs::FPaymentScope, FHeldPaymentScope, IsInPaymentScope (Conditions/PulsePaymentScope.h) Payment scope (RAII, game thread, nested scopes join the current one) that PayAll and the exchange runs open around a payment and its refunds (Payment scopes)
Pulse::Costs::IPaymentScopeParticipant (Enter, Leave), FPaymentScopeParticipantFactory, RegisterPaymentScopeParticipant, UnregisterPaymentScopeParticipant Participants of plugins, made per scope (PulseInventory: the item cost ledger)
FPulseReward Base of rewards: Grant (authority), Reapply, GetDisplayText
FPulseRewardList Rewards; GrantAll, ReapplyAll, GetDisplayLines, IsEmpty, Add<T>
UPulseRewardObject, FPulseReward_Blueprint Rewards made in Blueprint, one instance per entry
UPulseConditionLibrary Blueprint: Evaluate Conditions, Get Condition Lines, Make Pulse Cost Context, Can Pay / Pay / Refund Costs, Get Cost Lines, Grant Rewards, Get Reward Lines
FPulseExchangeStep::GetHolders The holders a step changes, locked by Pulse::Exchange::RunAsync while a step waits (Holder lock)
Pulse::Exchange::IsHolderLocked, OnHolderLockChanged (Exchange/PulseHolderLock.h) Whether a run that has not settled locks a holder (plugins refuse changes by players with Pulse.Result.Failure.Busy); event when a holder becomes locked or free
Pulse::Exchange::FHolderLockScope (Lock, IsLocking, GetHolders, IsOpen), FHolderLockPart (IsJoined) Lock scope over several frames and its current parts (game thread)
Pulse::Exchange::IHolderLockParticipant (Lock, Unlock), FHolderLockParticipantFactory, RegisterHolderLockParticipant, UnregisterHolderLockParticipant Participants of plugins, made per lock scope

Strategies

See Rules as structs.

Type / function Purpose
UPulseStrategyObject Base of the Blueprint classes of struct strategies: GetWorld (the world of the call, else the outer), FWorldScope, GetScopeWorld; base of UPulseConditionObject, UPulseCostObject, UPulseRewardObject
Pulse::Strategies::Call, Run, GetEntryText Forward a function of a _Blueprint entry to its object with the world of the call; the text of an entry

Teams

Type / function Purpose
Pulse::Team::GetTeam, IsSameTeam, SetTeam, FindTeamSource The team of any actor: own source, the player’s player state, the pawn of a controller, owners (Teams)
IPulseTeamInterface Own team logic: GetPulseTeam, SetPulseTeam (wins over a team component)
UPulseTeamComponent Replicated team tag (push model), GetTeam, SetTeam (authority), OnTeamChanged, OnTeamChangedNative
UPulseTeamLibrary Blueprint: Get Actor Team, Is Same Team, Set Actor Team
Pulse::Foundation::Tags::Team, Team_Player, Team_Enemy Pulse.Team, Pulse.Team.Player, Pulse.Team.Enemy

Sounds

Type / function Purpose
FPulseSoundRef A sound asset or a Pulse Sound event; IsSet, Validate (editor) (Sounds)
Pulse::Sound::Play, GetResolver Plays a reference 2D, at a location or attached (FPulseSoundPlayParams, EPulseSoundPlacement), returns EPulseSoundPlayResult
IPulseSoundResolver Modular feature of Pulse Sound that plays the events
UPulseSoundLibrary Blueprint: Play Pulse Sound Ref, Is Pulse Sound Ref Set

Movement (PulseMovement)

Type / function Purpose
UPulseCharacterMovementComponent Character movement that carries movement features: Features, FirstFeatureMode, FindFeature, FindMovement, IsLiveMove (Movement features)
UPulseCharacterMovementComponent::DispatchBuiltInPhys, PhysEngineMode Asks the features for the physics of a built-in mode; runs the engine’s physics of a mode without them
UPulseMovementFeature Base of a movement feature: custom modes (PhysCustom, GetMaxSpeed), input bits, move data, corrections, jump hooks
UPulseMovementFeature::PhysBuiltIn, ModifyCalcVelocity, GetBuiltInMaxSpeed, GetBuiltInMaxAcceleration, IsInWater, GetImmersionDepth Hooks of the built-in modes (walking, nav walking, falling, flying, swimming) and of water
Pulse::Movement::IsBuiltInMode, AssignCustomModes, AssignInputBits, CanCombineMoves, FMovePayload Pure helpers of the component

Visuals and props (PulseVisual)

Type / function Purpose
FPulseVisualRef A static mesh, skeletal mesh, Niagara system, sound or prop with the settings of its type (Settings) and scale; IsSet, Get<T>, Load<T>, IsA<T>, GetAssetClass, GetTypeName, GetSettings<T>, GetTypeSettingsStruct, HasFittingSettings, FitSettingsToType, MakeFittingSettings, GetLoadPaths, Validate (editor); meta data PulseVisualTypes and PulseVisualRequired (Pulse::Visual::RequiredMetaKey) (Visuals and props)
FPulseVisualTypeSettings, FPulseVisualTypeSettings_StaticMesh, _SkeletalMesh, _Niagara, _Sound Settings of a visual type in TInstancedStruct<FPulseVisualTypeSettings> (override materials, material parameters, animation, Niagara user parameters, volume and pitch, auto activation, start time, attenuation, concurrency and sound class of sounds; SetAutoActivate) (Settings of a type)
FPulseVisualMaterialParameters, Pulse::Visual::ApplyMaterialParameters Scalar, vector and texture material parameters by name (IsEmpty, GetTypeHash) and the function that sets them on a mesh component through one dynamic material instance per slot that has them (returns the number made) (Material parameters)
UPulseVisualAudioComponent The audio component the sound type spawns: plays from its StartTime when it activates and when SetPlaying starts it (Sound settings)
Pulse::Visual::ResolveSettings<T> The settings a builder uses, typed: the runtime settings of the spawn params, else those of the reference, else the defaults
Pulse::Visual::RegisterType, UnregisterType (by name, or by name and builder), FindType, FindTypeForClass, GetTypeNames, GetTypeDisplayName, JoinTypeDisplayNames The register of visual types (FPulseVisualType: name, asset class, SettingsStruct, IPulseVisualBuilder, animatable Properties); a replaced type comes back when its replacement is unregistered
FPulseVisualPropertyDesc, EPulseVisualValueKind, FPulseVisualPropertyName An animatable property of a visual type: Id, DisplayName, ValueKind (Float, Vector, Color, Bool), bNeedsName, bOpacity, Default, Range, Apply, optional ReadBase and ListNames (names a visual offers, with their defaults) (Animatable properties)
FPulsePropValue A value of a property in four numbers: FromFloat, FromVector, FromColor, FromBool, GetFloat, GetVector, GetColor, GetBool, Equals
Pulse::Visual::PropertyIds Ids of the built-in properties: Location, Rotation, Scale, Visible (every part), Opacity, MaterialScalar, MaterialVector (meshes), UserFloat, UserVector, UserColor (Niagara), Volume, Pitch (sound)
Pulse::Visual::FindProperty, GetProperties, GetCommonProperties, IsTransformProperty, LerpValue, MakeBuiltInProperties Look up the properties of a type (common ones first), the four common properties, whether an id poses the part (Location, Rotation, Scale), blend two values by kind (a Bool switches at the end), the descriptors of the built-in types
Pulse::Visual::Spawn, AddInstance, RemoveInstances, SetPlaying, CanPlay, IsLooping, HasSocket Make a component (FPulseVisualSpawnParams: name, transform, socket, collision, optional runtime Settings) or instances (FPulseVisualInstance) of a visual; SetPlaying starts what it plays (the rate is a factor on the PlayRate of the settings); CanPlay tells whether a component plays anything at all (false by default, so custom types that play override it), IsLooping whether that starts over by itself (true where the type cannot tell)
Pulse::Visual::GatherLoadPaths (reference, or reference and spawn params), GatherSettingsLoadPaths, IPulseVisualBuilder::GatherLoadPaths What a visual needs loaded before it spawns: the asset, the soft references of its fitting settings (and of runtime settings with the params) and what its builder loads (the parts of a prop)
Pulse::Visual::ParseTypes, IsClassAllowed, ValidateObject (editor) Type filters and the check of every visual reference of an object
UPulseVisualLibrary Blueprint: Spawn Pulse Visual, Add Pulse Visual Instance, Is Set, Get Pulse Visual Type, Load Pulse Visual Asset, Get Pulse Visual Types, Get Pulse Visual Settings, Set Pulse Visual Settings, Fit Pulse Visual Settings To Type, Load Pulse Visual (latent, loads everything before Spawn)
UPulseProp Prop data asset: parts (FPulsePropPart), motions (FPulsePropMotion, tracks of Keyframes clips), states (FPulsePropState, overrides), events (FPulsePropEvent, triggers, steps), collision; OpacityParameter and GetOpacityParameter (its own, else the one of the settings), ConvertOldData (what PostLoad runs for props saved before tracks, custom version PulseProp 1, and 2 DistanceLevels: props saved before keep no levels; UpgradeData runs both, Pulse::Visual::Prop::FDataVersion) (Old prop data); distance levels: Levels (FPulsePropLevel, FPulsePropLevelPart, EPulsePropLevelShow), SetDefaultLevels, RunsMotionOnLevel, FiresEventOnLevel, FindLevelPart, GetNewMotionLastLevel (Distance levels)
FPulsePropProperty, FPulsePropTrack, FPulsePropTrackKey, EPulsePropKeyInterp A property of a part (PropertyId, ParamName), a track of a Keyframes clip (Property, Keys), a key (Time, Value, Interp: Smooth, Linear, Step) (Keyframes)
FPulsePropOverride A value a state sets on a part (Part, none for every part; Property; Value) (States)
FPulsePropKey, FPulsePropPartPose, FPulsePropMaterialValue Old data only: the deprecated Keys, Poses and MaterialValues load into them and are converted into tracks and overrides; not for new code
UPulsePropComponent Builds and drives a prop: SetProp, SetState, TriggerEvent, GetRate, IsEventPlaying, GetEventPlayCount, GetEventStartTimes, GetPartComponent, GetPartPivot, GetCollisionComponents, ResetParts, RebuildParts, Advance; OnStateChanged, OnEventStarted; for tools and specs GetPropertyValue (the value of a property of a part now, after overrides and tracks), GetPropertySlotCount, CountDynamicMaterials; distance levels: GetLevel, SetLevelOverride, GetViewDistance, UpdateLevel (Distance levels)
UPulsePropComponent preview (editor) What the prop editor drives a preview with: SetPreviewDrive (EPulsePropPreviewDrive: Off, Manual moved by Advance, Simulate ticks and runs the triggers), GetPreviewDrive, PreviewRestart (parts at rest, clocks at 0, a state without blend; with Advance(t) the pose of playing t seconds), PreviewBaseValues (no state values: the base pose of the editor), RefreshRestTransforms (rest transforms of the asset without a new build), PreviewStartEvent and PreviewPlayMotion (without authority checks), GetPreviewClocks (FPulsePropPreviewClocks)
Pulse::Visual::Editor::OnValidateProp (editor) Called at the end of UPulseProp::IsDataValid; editor modules add checks of their own (the Check of the prop editor)
APulsePropActor Replicated actor with a prop component as its root
UPulsePropLevelSubsystem The level manager of a world (overridable): Register, Unregister, MoveProp, GetPropLevel, SetBudgetOverride, SetExtraViews (view points besides the local cameras), SetExtraServerViews (server views besides the player pawns), HasLevels (false on a dedicated server), GetStats (FPulsePropLevelStats, with the cameras and server views of the live band), CountAssets; GatherViews and GatherServerViews to override (Level manager)
Pulse::Visual::Levels::FLevelGrid, SelectByDistance, Select, GetPartShow The search grid of the level manager as a plain class (AddTable, Add, Remove, Move, Update with a budget, CountLevels), the level for a distance with hysteresis, what a part shows on a level (Level manager)
FPulsePropMessage Payload of Send Message steps
Pulse::Visual::Motion, Tracks, States, Pose, Timeline, Random Pure rules of props: shapes, property tracks, state blends, the poses of the parts in one frame (Pose::Gather), due steps, Local Same times
Pulse::Visual::Tracks::Evaluate, ToPose, SetChannel, GetChannel, GetLength, FindTrack, ShowsWithOpacity The value of a track at a time (Smooth with clamped tangents, Linear, Step; each number on its own), the transform tracks of a clip as a pose, one channel of a pose, the length of a clip, the track of a property, whether a part shows at an opacity (Pulse::Visual::Keys is gone)
Pulse::Visual::States::FValues, FPropertyKey, MakeValues, AddOverrides, Blend, BlendProperties, GetBlendAlpha What a state sets (rate, poses by part, other properties by part, id and parameter), its overrides as values, the blend into a new state (a property one side does not set blends from or to its base; Visible on at the start, off at the end)
UPulseProp instances Category Instances of a prop: NearRadius, Priority, FarCullDistance, FarCustomData (FPulsePropFarValue), bPersistInstanceStates, GpuMotions (EPulsePropGpuMotions: Default, On, Off); FarStandIn of a part and Runs On GPU Far Away of a motion; the bake: Baked (FPulsePropBake), GetBake (a stale bake is made again first in the editor), IsBakeStale (Many instances)
UPulsePropInstancesComponent Pulse Prop Instances: many props without an actor each. Instances (FPulsePropPlacedInstance: prop, transform, start state, seed, id), SetId, bLocalOnly; AddInstance, AddInstances (FPulsePropInstanceDesc), Add Prop Instance, Remove Prop Instance, RemoveInstances (many in one batch; bInKeepStates keeps the state entries of the server for instances made again with the same ids), ForgetStates (drops those entries of ids that are not made again), Set Prop Instance Hidden, Find Prop Instance (from a hit), FindInstanceById (Find Prop Instance By Id), GetKey, GetSet, Is Prop Instance Valid / Get Prop Instance Prop / Get Prop Instance Transform (Component), Get Prop Instance Face (EPulsePropInstanceFace: Hidden, Loading, Far, Promoting, Live), Get Prop Instance Level, SetInstanceLevel (tools and specs), Get Prop Instance Live Component, Are Prop Instances Ready, Get Num Prop Instances, GetRenderers; SetInstanceState (with bInPersist), GetInstanceState, TriggerInstanceEvent (both answer with FPulseResult), IsInstanceLive, HasInstanceAuthority, ForEachInstance; GatherStats (FPulsePropInstancesStats); On Ready, On Instance Promoted, On Instance Demoted, On Instance State Changed, On Instance Event Started (and ...Native) (Many instances)
APulsePropInstancesActor Pulse Prop Instances Actor: an actor with the component as its root (GetInstancesComponent); Build Prop Instances and Pack into Prop Instances make them (Placing and packing)
FPulsePropInstanceHandle, FPulsePropInstanceKey The handle of an instance on this machine (component, slot, generation; IsSet; never saved or replicated) and its key on every machine and in saves (Set, Id, IsValid, ToString; MakeSet from a GUID: a 64-bit hash, never 0, but 0 for an invalid GUID; MakeId from a GUID: the lower 32 bits of the hash, never 0)
UPulsePropInstanceLibrary Blueprint: Set Prop Instance State (advanced pin Persist), Get Prop Instance State, Trigger Prop Instance Event, the variants (Result), Is Prop Instance Live, Get Prop Instance Live Component, Get Prop Instance Transform, Get Prop Instance Prop, Get Prop Instance Id (an int32 with the bits of the id), Is Prop Instance Valid, Get Prop Instances Component
Pulse::Visual::Tags::Result_StaleHandle, Result_NotAuthority, Result_UnknownState, Result_UnknownEvent, Result_NotLive, Result_AlreadyPlaying Reasons of the handle functions (Pulse.Visual.Result.*, texts registered at startup)
UPulsePropComponent and instances GetInstanceHandle of a live prop (its instance), bLoadAsync (load the assets of the prop first, then build); the pool hooks ParkInPool, TakeFromPool and IsParkedInPool belong to the level manager
UPulsePropLevelSubsystem and instances The live band and its pool: RegisterInstanceOwner, UnregisterInstanceOwner, AcquireLiveProp, ReleaseLiveProp, TrimPool; GatherViewDirections to override beside GatherViews; the budget per machine and its two shares (cameras, server views) in Pulse::Visual::Instances::Budget::GetLimits, views in Budget::Measure; the stats MaxServerViewLive and LiveTrimmed of FPulsePropLevelStats
UPulsePropAssetCache Loads props for instances once per world (AddUser, RemoveUser, GetState, GetProp, GetBounds from the asset registry tag PulseInstanceBounds), and the near assets of live props (RequestNear, ReleaseNear, IsNearReady, TrimNear), GetStats
UPulsePropMotionClock Writes the time of GPU motions into the parameter collection once per frame (PulsePropTime, PulsePropWrapCount); AddUser, RemoveUser, GetCollection
UPulsePropReplicationSubsystem The replication of instance states through the Net Cells channel Pulse.NetCells.Channel.Props (Pulse::Visual::Tags::NetCells_Channel_Props, layer Near, Keep on loss, registered by PulseVisual): WriteEntry (a location or FPulseNetCellPlace::KeepPlace), RemoveEntry, FindEntry (TOptional: the server’s own value, on a client the bytes Net Cells has, kept ones too), ApplyKnown (a client retries the entry that waited for the instance), Maintain, FindOwner, ShouldReplicate and SetReplicationForced (forwarded to Net Cells), GetStats with FPulsePropReplicationStats (cells and entries of the channel, known, pending, Sim records, written, applied) (Many instances)
FPulsePropInstanceRep, Pulse::Visual::PropNet::Encode, Decode, MakeKey, Format, MaxNameBytes An entry (set and id, state, the server time of the change, the Replicated events FPulsePropEventRep: event, count, start time; ExpireTime stays on the server) and its compact codec in the channel (format byte, names as plain string and number, times finite; key A = set, B = id)
FPulsePropInstanceSimState, Pulse::Visual::Instances::Sim::MakeRecordId, ParseRecordId The Pulse Sim kind of kept instance states (set, id, state, change time; record id PulseProp_<set hex>_<id>)
Pulse::Visual::Instances::Bake The bake as plain functions: GatherInput, Make, IsCurrent, IsGpuMotion, UsesGpuMotions, GetLevelEntries, GetEntryTransform; FPulsePropBake with FPulsePropBakedPart, FPulsePropBakedEntry, FPulsePropBakedLevel, FPulsePropBakedMotion, FPulsePropBakedCurves
Pulse::Visual::Instances::CustomData, GpuMotion The custom data layout (MakeLayout, Pack, the wrap of the GPU clock: WrapTime, GetWrapCount, GetWrapCycles, GetCarried, MakePhaseBase) and the GPU motions (MakeParameters, ApplyParameters, EvaluateOffset: the offset the material computes, GetMaxDisplacement, CheckDisplacement)
Pulse::Visual::Instances::Band, Budget, CatchUp Pure rules of live props: promote or demote at a distance (Band::Decide), score and choose within the budget (Budget::Score, IsBehind, Choose), catch up a new live prop (CatchUp::GetPhase, GetState, TakeUnseen, GetEventOffset)
Pulse::Visual::Instances::FSlotTable, FIndexMap, FarView, FRendererIdentity Slots with generations and a free list, the map from slots to mesh instances (swap remove), what a prop shows far away (FarView::Classify, Summarize), the identity of a renderer (MakeRendererIdentity)
APulsePropActor packing Editor only: bKeepAsActor (stays an actor when packed), InstanceId and InstanceSetId (kept by Unpack for the next Pack), BuildSetId (made editor only by Build Prop Instances); console Pulse.Visual.BuildPropInstances, PackPropInstances, UnpackPropInstances, CheckPropInstances (Placing and packing)
Spawn Pulse Props (add-on Pulse Foundation PCG, module PulseVisualPCG) The PCG node and its types are documented in the add-on: Pulse Foundation PCG (PCG)
UPulseVisualSettings Project Settings > Pulse > Visual

Areas

Type / function Purpose
UPulseAreaComponent Pulse Area: shape, tags, priority, falloff, conditions, functions (Find Function), Fixed Area Name, Get / Set Area Id, Get Area Origin (EPulseAreaOrigin: RuntimeId, Fixed, Placed, Spawned), Has Stable Area Id
APulseArea The actor Pulse Area: the component as root (Static), a spline, box and sphere views in the editor
UPulseAreaFunction, EPulseAreaFunctionNet What an area does: Where, Wants Player Events, On Area Start / End, On Player Entered / Left, Can Use Area, Get Area
UPulseAreaFunction_Messages, UPulseAreaFunction_Adjustments The functions Messages (Pulse.Message.Area.*) and Adjustments (a tuning source of the area)
UPulseAreaSubsystem Find Pulse Areas, Find Pulse Areas With Function, FindFunctions<T>, Get Pulse Area At / Id At, Find Pulse Area By Id, Is Player In Pulse Area (by tag or id), GetPlayersInside, OnAreaPlayerNative (by pawn), OnAreaOccupantNative (by player key), GetIndex
FPulseAreaId, UPulseAreaIdLibrary Area ids (stable for placed actors, from a name or a guid)
FPulseAreaHit, FPulseAreaMessage Query hits and the payload of Pulse.Message.Area.* (both with the area id)
FPulseCondition_InArea Condition In Area (by tag or one area)
Pulse::Area::FShape Shape math (depth, weight, bounds)
Pulse::Area::FAreaIndex, FAreaDesc, DiffInside, MakeAreaId, MakeStableAreaName The areas as plain data (pure, for specs and bridges)
Pulse::Area::MakeOccupantKey The key of a player for “who is inside”

Tuning

Type / function Purpose
FPulseTuningKnob, Pulse::Tuning::RegisterKnob, UnregisterKnob, FindKnob, GetKnobs, DescribeKnobs The register of tuning knobs (Pulse.Tuning.*): kind, bounds, defaults, per player
FPulseTuningValue, FPulseTuningSource, FPulseTuningData, FPulseDifficultyLevel Values with filters, sources under a key, the tuning of a world with the difficulty level
Pulse::Tuning::Evaluate, ApplyValue, ApplyCountValue, RoundCount, DoesValueApply Pure evaluation (FPulseTuningEvaluation with the contributions of the sources)
Pulse::Tuning::ValidateSource, PutSource, TakeSource, PutDifficulty, PutLowestDifficulty, ParseRules, MergeStates, GetChangedKnobs Pure changes and the server rules
Pulse::Tuning::Apply, ApplyCount, IsOn, GetChoice, GetDifficulty, GetLowestDifficulty The knobs in a world
UPulseTuningSubsystem Sources and difficulty of a world: SetSource, RemoveSource, FindSource, SetDifficulty, ResetLowestDifficulty, SetLowestDifficulty, ApplyServerRules, OnTuningChangedNative
APulseTuningState Sends the tuning: shared to everyone, personal to its player
UPulseTuningLibrary Blueprint: Apply Tuning, Apply Tuning Count, Is Tuning On, Get Tuning Choice, Evaluate Tuning, Get / Find Tuning Knob(s), Set / Remove / Find Tuning Source, Get / Set Difficulty, Get / Set Lowest Difficulty, Get Tuning Generation
FPulseCondition_Difficulty, FPulseCondition_Tuning Conditions Difficulty and Tuning Knob
FPulseTuningChangedMessage Payload of Pulse.Message.Tuning.Changed (also which adjustments and targets changed)
FPulseAdjustment, FPulseAdjustment_Tuning, FPulseAdjustment_Swap Adjustments: base (target, text, check) and the types Set Tuning Knob and Swap Asset
UPulseTuningPreset Values and adjustments as a data asset; sources name it and only send the reference
FPulseReward_Adjustments Reward Give Adjustments (a source with a fixed key, Revoke removes it)
Pulse::Adjustments::Collect<T>, Resolve, ResolveObject, DoesAdjustmentApply, GetData Adjustments of a type for a target, assets to use instead (pure and in a world)
Pulse::Tuning::ValidateValue, ForEachValue, ForEachAdjustment, FillAdjustmentChanges Values and adjustments of a source with its presets
Pulse::Costs::GetTuningFactor, ResolveTuning, FPulseCostContext::TuningFactor, Pulse::Rewards::GetAmount Tuning of costs and rewards

Attributes

Attributes (health, stamina, hunger, armor) behind one contract, answered by the Pulse Attributes component, the GAS adapter or a source of the game.

Type / function Purpose
IPulseAttributeSource (Attributes/PulseAttributeSource.h) The contract: Read, Change, Modify, GetCapabilities, OnOwnerTagsChanged, each with a default answer (unknown, refused, empty); C++ only
UPulseAttributeSourceComponent Base of sources made in Blueprint: On Read, On Change, On Modify, On Get Capabilities; Notify Attribute Changed, Notify Depleted, Notify Restored
FPulseAttributeValue Answer of Read: value (clamped), base, min, max, percent, rate per second, band, kind, bKnown, bDepleted, bHasBase; MakeUnknown, IsKnown, GetTimeToReach
FPulseAttributeReadRequest, FPulseAttributeChangeRequest, FPulseAttributeChangeResult Read one attribute; change it (EPulseAttributeChangeOp: Add, Set, AddPercentOfMax, SetPercentOfMax, Reset) with a context; before, after, applied and the result
FPulseAttributeModifierSpec, FPulseAttributeModifierInfo, FPulseAttributeModifyRequest, FPulseAttributeModifyResult Modifiers (EPulseAttributeModifierTarget Value, Min, Max, Rate; EPulseAttributeModifierOp Add, Multiply; duration on the game clock, source key, effect tag, visibility, saved); add, remove by id or source key, list (EPulseAttributeModifyOp)
FPulseAttributeCapabilities, FPulseAttributeCapabilitiesRequest What a source knows and can do: attributes, change, modify, rates, replicated modifiers, only its own actor (vehicles), source name, what defines it
FPulseAttributeResultDetails Details of the reasons Pulse.Result.Failure.Attribute.* ({Attribute}, AttributeTag) (Results)
EPulseAttributeKind, EPulseAttributeVisibility, EPulseAttributeChangeCause, EPulseAttributeEventKind Pool or stat; who sees it; why a value changed; kinds of attribute events
Pulse::Attributes::FindSource, GetSourceActor The source of any actor (the actor, its first component, a controller or player state to its pawn, then the player state; no owners, no attach parents)
Pulse::Attributes::Read, Change, Modify, GetModifiers, GetCapabilities, HasAttribute The contract through the source of an actor; Change and Modify check the source and the authority first
Pulse::Attributes::IsOwnActorOnly Whether the source of an actor answers only for itself (a vehicle such as a boat hull); kept by the subsystem for ready sources
Pulse::Attributes::NotifyOwnerTagsChanged, GatherOwnerTags Tell a source that pause or override tags changed; the owner tags of an actor or player without the source itself
Pulse::Attributes::GetDisplayName, MakeFailure, RegisterChannels, UnregisterChannels Name from the stat register; a failed result with details; the channels Pulse.Message.Attribute.*
FPulseAttributeChangedMessage, FPulseAttributeEdgeMessage, FPulseAttributeRangeMessage Payloads of Pulse.Message.Attribute.Changed, .Depleted / .Restored, .RangeChanged (Message channels)
FPulseAttributeEvent, UPulseAttributeSubsystem Events of the sources of a world: Get, NotifySourceReady, NotifySourceRemoved, Dispatch, WatchActor, RemoveWatch, GetSources, GetRecentEvents; OnAttributeEventNative, OnAttributeEvent, OnSourceReady, OnSourceRemoved; snapshot category Attributes
UPulseAttributeLibrary Blueprint: Read Attribute, Get Attribute Value, Get Attribute Percent, Has Attribute, Change Attribute, Add Attribute Modifier, Remove Attribute Modifiers, Get Attribute Modifiers, Get Time To Reach, Find Attribute Source, Notify Owner Tags Changed
UPulseWaitForAttributeAction Blueprint node Wait For Attribute (compare a value or percent; On Reached, On Failed; no tick)
FPulseCondition_Attribute, FPulseCost_Attribute, FPulseReward_ChangeAttribute (Attributes/PulseAttributeEntries.h) The condition Attribute, the cost Attribute and the reward Change Attribute for every Pulse list (Conditions); Check, GetExactAmount, GetTunedAmount without a world
Pulse::Foundation::Tags::Stat_Health, Stat_MaxHealth, Stat_Stamina, Stat_MaxStamina Pulse.Stat.Health, .MaxHealth, .Stamina, .MaxStamina, registered as stats
Pulse::Foundation::Tags::Message_Attribute, _Changed, _Depleted, _Restored, _RangeChanged The channels of the attribute events
Pulse::Foundation::Tags::Result_Failure_Attribute_Unknown, _NotAuthority, _Refused The reasons of attribute requests
Pulse::Foundation::Tags::CostKind_Attribute, RewardKind_Attribute, Tuning_Attributes_RateGain, Tuning_Attributes_RateLoss Kinds of the entries for the cost and reward tuning; the knobs of rising and falling rates (Tuning knobs)
Pulse::Foundation::Tags::Save_Attribute_Values, Attribute_Band_Exhausted Save identity of the Pulse Attributes component; the band of the default stamina while exhausted
UPulseAttributeProfile (Attributes/PulseAttributeProfile.h) Data asset with the attributes of an actor: Parent (entries of the child replace those of the parent by tag), Attributes, Usage (EPulseAttributeProfileUsage Component, GASRules); Resolve, HasParentCycle, Validate, CheckUsage, IsDataValid
FPulseAttributeDefinition, FPulseAttributeBound, FPulseAttributeRate, FPulseAttributeRateOverride, FPulseAttributeBand, FPulseAttributeProfileIssue One attribute of a profile: kind, start (EPulseAttributeStart), bounds (EPulseAttributeBoundKind None, Value, Attribute), rate per EPulseAttributePeriod, rate overrides, pause tags, bands, EPulseAttributeMaxChangeRule, visibility, saved; a problem of a profile with its path
Pulse::Attributes::ValidateDefinitions Checks resolved definitions (duplicates, cycles of bounds, rates on bound targets, bands, GAS rules)
Pulse::Attributes::MakeDefaultProfile, EPulseAttributeDefaultProfile (Attributes/PulseAttributeDefaults.h) The default profiles as C++ data: ProjectDefault, PlayerDefault, Enemy, Destructible
Pulse::Attributes::RegisterDefinitions, UnregisterDefinitions, AppendRegisteredDefinitions, GetDefinitionOwners, EPulseAttributeDefinitionTarget Attributes of plugins for players, other actors or all, mixed into every resolved profile (an entry of the profile wins, the first owner of a tag keeps it)
Pulse::Attributes::Store (Attributes/PulseAttributeStore.h) The rules as pure functions on FPulseAttributeStore (FPulseAttributeState, FPulseAttributeActiveModifier, FPulseAttributeEnvironment): ResolveOrder, MakeStore, Evaluate, GetRate, AdvanceTo, PlanChange, PlanAddModifier, PlanRemoveModifiers, PlanExpire, PlanEnvironment, PlanReset, PlanExternalDelta, PlanExternalBounds, GetNextEvent, HasPendingRestore, PlanReleasePending, Saturate, ApplyPlan, ShiftTimes, GetModifiers; plans (FPulseAttributePlan) with notices (FPulseAttributeNotice)
FPulseAttributeSaveData, FPulseAttributeSaveEntry, FPulseAttributeModifierSave (Attributes/PulseAttributeSave.h), Pulse::Attributes::Save::CurrentVersion Save format version 1: values without stamps, the band, saved modifiers with their remaining time; Store::MakeSaveData, PlanLoad (never clamps), WriteSaveBytes, ReadSaveBytes
Cheats PulseAttributeList, PulseAttributeSet, PulseAttributeAdd, PulseAttributeModifier, PulseAttributeReset On the actor in view or the own pawn, on the server (Console)

Simulation

Type / function Purpose
UPulseSimSubsystem Pulse Sim of a world: Get Pulse Sim (GetPulseSim, Blueprint and Python), Add / Remove Pulse Sim Record, Get Pulse Sim Record, Set Pulse Sim State, FindRecord, EditRecord, CatchUp, GetStats, GetStore, OnRecordChangedNative, OnRecordsLoadingNative and OnRecordsLoadedNative (around a load into the running world), SetLoadedLocationProvider, UpdateViewSpawns, FindSpawnedActor
UPulseSimViewComponent Pulse Sim View: shows a record on an actor, adds it from Default State, On Record Changed, Get / Set Pulse Sim State, GetStateAs<T>, EditRecord; for actors Pulse Sim spawns: Is Spawned By Sim, On Write Back, Write Back Location
FPulseSimRecord, FPulseSimState, FPulseSimContext A record, the base of kinds (GetViewSpawn), what a kind sees (FindLinked, EditLinked, MoveTo, Notify)
FPulseSimViewSpawn, EPulseSimViewSpawnMode The actor of a record while its place is loaded: class and mode (Local, Server)
IPulseSimLoadedLocationProvider, Pulse::Sim::FAlwaysLoadedLocations, FWorldPartitionLoadedLocations Whether a place is loaded (UPulseSimSubsystem::SetLoadedLocationProvider); Pulse::Sim::Spawn::Decide is the rule
FPulseSimDebugInfo, Pulse::Sim::Debug What a kind shows on the map of the debugger (FPulseSimState::GetDebugInfo); the map as data: BuildMapView, CompareWithServer, FindNearest, FMapTransform
IPulseDebugLocator, IPulseDebugMapBackground, FPulseDebugLocation Modular features for the map of the debugger: loaded things without a record, a picture of the world (Pulse::Debug::GatherDebugLocations, FindDebugMapBackground)
FPulseSimPath, FPulseSimPathTravel, FPulseSimPathEvent, Pulse::Sim::Path Paths on the game clock: MakePath, GetLocationAt, GetPhaseAt, GetNextEvent, GetCellLocationAt, Pack, Unpack
FPulseSimState_Timer Kind: an event every interval
Pulse::Sim::FStore The records without a world: Add, AdvanceTo, Edit, RunDue, RunSteps, ShiftTimes, Save, Load
UPulseSimSettings, Pulse::Sim::GetOfflineCatchUpSeconds Settings and the offline rule
FPulseSimMessage, FPulseSimSaveData Payload of Pulse.Message.Sim.*, the saved records
Pulse::Sim::Replication Records on the wire through the Net Cells channel Pulse.NetCells.Channel.Sim (Pulse::Foundation::Tags::NetCells_Channel_Sim): MakeRecordKey, EncodeRecord, DecodeRecord (Format, MaxIdBytes, HeaderBytes), GetKindHash, FindKindByHash (a miss looks again after 5 s or ForgetMissedKinds), ForgetMissedKinds, WriteClientPayload (without NotReplicated fields), ReadClientPayload (version check, strict Pulse::NetCells::ReadValue: no rest bytes, finite values, no asset loads)

Net Cells

Type / function Purpose
Pulse::NetCells::FChannel, RegisterChannel, UnregisterChannel, FindChannel, GetChannels Channels of Net Cells: tag, layer, loss behaviour, value struct or raw bytes, cap, options
GetChannelTable, GetChannelIndex, GetChannelTableHash, GetChannelDisplayName, GetEffectiveCap, GetMaxRepArraySize, ItemOverhead, GetItemWireBytes, GetMaxValueBytes The channel table items refer to, size limits (wire bytes of an item)
UPulseNetCellSubsystem Server: Write<T>, WriteStruct, WriteBytes, MarkDirty, Remove, RemoveAll, FindEntryPlace, SetChannelWriter, SetPresenceQuery, RefreshPresence, SetWorldLayer, ResetLayer (empties a layer for a new world definition: entries, actors, tombstones, presence, dormancy; returns the entries removed; clients drop what the layer brought through its reset epoch, Changing the world layer); both: TuneWorldLayer (radius, rate, empty wait and dormancy of a layer with cells), IsLayerEmpty, GetLayerEpoch, FindLayer, ReadEntry<T>, ReadEntryStruct, FindEntryBytes, GetEntryState, ForEachEntry, ForEachEntryInCell, GetStats; client: SetChannelHandler, ClearChannelHandler, RetryEntry, RetryWaiting, MarkDecodeFailed, GetWaitingEntries; spec test mode: SetReplicationForced, AddLoopbackClient, AddLoopbackReceiver, SetLoopbackView, SetLoopbackHandler, PumpLoopback, ClearLoopback, GetLoopbackEntryState, FindLoopbackEntryBytes, GetLoopbackStats
FPulseNetCellKey, FPulseNetCellPlace, FPulseNetCellEvent, FPulseNetCellLayer Key (FromName, ToString, Parse), place (location, Global, KeepPlace), client event (Read<T>, Result), layer
EPulseNetCellLoss, EPulseNetCellLayerKind, EPulseNetCellPresence, EPulseNetCellEventKind, EPulseNetCellApply, EPulseNetCellEntryState Keep / Delete / ResetCell, Grid / Global, presence, events, handler result, entry state
FPulseNetCellHandler, FPulseNetCellWriter, FPulseNetCellPresenceQuery Client handler (batch per channel), pull writer, presence of Near Sources layers
FPulseNetCellStats, FPulseNetCellLayerStats, FPulseNetCellChannelStats, FPulseNetCellWaitingEntry What a machine knows
Pulse::NetCells::WriteValue, ReadValue, AreValuesFinite, FByteWriter, FByteReader, HashKey, IsInPiece Tagged values without NotReplicated fields, compact codecs, the piece of a key
APulseNetCellActorBase, APulseNetCellActor, APulseNetCellRegionActor, APulseNetCellGlobalActor, FPulseNetCellItem, FPulseNetCellItemArray Cell actors (spawned by the subsystem, with the reset epoch of their layer) and their fast array
APulseNetCellStateActor, FPulseNetCellLayerEpoch Always relevant actor with the reset epochs of the layers (spawned by the server with the first ResetLayer)
UPulseNetCellSettings, Pulse::NetCells::GetSettings Settings (Project Settings > Pulse > Foundation > Net Cells)
UPulseNetCellLibrary Get Pulse Net Cells, Get Net Cell Stats, Get Net Cell Channel Stats, Get Net Cell Entry State
UPulseNetCellCheats, Pulse::Foundation::Tags::NetCells_Channel_Debug Cheats PulseNetCellsInfo, PulseNetCellsFill, PulseNetCellsClear, PulseNetCellsLayer, PulseNetCellsReset; the debug channel the fill writes (only with PULSE_WITH_DEBUG) (Debugging)
SPulseNetCellsPage, Pulse::Editor::NetCellsPage::BuildPageData, GetSignature Pulse Debugger page Net Cells (PulseFoundation.NetCells, module PulseFoundationDebugger): one column per world, tiles, layer, channel and waiting tables; snapshot category Net Cells of UPulseNetCellSubsystem

Results and requests

See Results of requests.

Type / function Purpose
Pulse::Requests::Admit Lets a request in on the server before any work (guard per player; null requester = the server’s own call; refuses a requester without a player in network games)
Pulse::Requests::CheckReach, HasLineOfSight Whether the body of a player is within a range (+ Reach Tolerance) of a place or an actor (Pulse.Result.Failure.OutOfReach); whether nothing blocks a channel from its eyes to a place or an actor; the player, its owner chain up to the controller, the target, an ignore list and every actor attached to them do not block (Reach)
FPulseRequestGuardSettings, FPulseRequestRate Rate per kind (Rate, KindRates), TotalRate of all kinds per player, open requests, suspicion, bRefuseWithoutPlayer, ReachTolerance, bRecordInTimeline
Pulse::Requests::Guard::Admit, NoteReply, FindRate, CheckRequester, FPulseRequestGuardState, EPulseRequestAdmission, EPulseRequesterCheck The guard as pure functions: tokens per kind and in total, open requests, suspicious answers; how a requester is treated (Guard, Admit, Refuse)

Providers

See Providers.

Type / function Purpose
UPulseProvider Base of exchangeable backends: Initialize / Deinitialize (events On Initialize, On Deinitialize), IsInitialized, HasEnded, GetProviderOwner, FinishRequest (Blueprint protected), CancelRequest, CancelAllRequests, IsRequestOpen, GetOpenRequestCount, GetUndeliveredCount, DeliverAnswers, TakePostedAnswers, GetDelivery, GetInbox, GetDefaultTimeout, GetWorld (outer, else owner); protected BeginProviderRequest(Operation, Callback, Timeout), CanStartRequests, SetDelivery; snapshot category Providers
EPulseProviderDelivery Inline (callback inside Finish Request) or Next Tick
FPulseProviderInbox Post(RequestId, Result, Payload) from any thread; the provider takes the answers on the game thread
FPulseProviderCallback TFunction<void(const FPulseResult&, const FInstancedStruct&)>, called exactly once per request
TPulseProviderSlot<T> The active provider of one purpose: Init(Owner, ClassFromSettings), Get, GetIfActive, CanSet, Set, SetClass, Reset, Shutdown, OnChanged
Pulse::Providers::MakeCallback<T>, MakeResultCallback, MissingPayload, ReportUnusableClass, ReportRefusedProvider Typed callback (a success without a T becomes Pulse.Result.Failure.Invalid), callback without data, the logs of the slot

Subsystems

See Replacing and switching off subsystems.

Type / function Purpose
EPulseSubsystemTraits What a subsystem allows: Overridable, Switchable, Both
Pulse::Subsystems::ShouldCreate(Subsystem, Outer, Traits) Last condition of ShouldCreateSubsystem: false when a derived class replaces it (Overridable) or the list turns it off (Switchable)
Pulse::Subsystems::IsDisabled, FindCreatedClass, InitializeDependency<T> Whether the list turns a class off; the class created instead of a class; InitializeDependency of the created class (the base or its replacement)
Pulse::Subsystems::ValidateDisabledSubsystems Editor: warnings for entries of the list that are not switchable or missing
Pulse::Subsystems::FScopedDisabledSubsystems Specs: replaces the list while it lives
UPulseFoundationSettings::DisabledSubsystems The list (Project Settings > Pulse > Foundation > Subsystems)

Definitions

See Definitions.

Type / function Purpose
FPulseDefinitionId Kind (Type) and Name of a definition: IsValid, ToString (Type:Name), FromString, ToPrimaryAssetId, from a primary asset id
Pulse::Definitions::FindDefinition<T>, LoadDefinitionSynchronous<T>, LoadDefinition, GetDefinitionId, GetDefinitionIds, GetAssetPath Find (ready now), load at once or asynchronously, the id of a definition, every id of a kind, where the asset manager keeps an id (with redirects); without a game instance the asset manager
Pulse::Definitions::RegisterAssetType, MakeAssetTypeScanPaths, IsAssetTypeConflicting A kind registered with the asset manager in code (/Game and plugin content, optional Always Cook; a kind the project lists with other settings is left alone with a warning) (Registering a kind in code)
UPulseDefinitionSubsystem Game instance: Get, the functions above, CancelLoad, RegisterDefinition, UnregisterDefinition, IsDefinitionRegistered, GetCatalog, SetCatalog, SetCatalogClass, ResetCatalog, NotifyDefinitionsChanged, FindCatalogType, OnDefinitionsChanged / OnDefinitionsChangedNative; snapshot category Definitions
UPulseDefinitionCatalog Provider of one kind (default: the asset manager): FindDefinition, LoadDefinitionSynchronous, LoadDefinition(RequestId, Id), GetDefinitionId, GetDefinitionIds (BlueprintNativeEvents), FinishLoadDefinition, RequestDefinition, NotifyChanged (new content)
FPulseDefinitionResolver Ids a component received back to definitions: Resolve / Resolve<T> (ready now, loaded at once, else asynchronously with a callback on the game thread; same ids share one load), IsPending, GetNumPending, CancelAll, CheckDefinitionId (primary asset id matches, warning once per id)
UPulseDefinitionLibrary Blueprint: Find Pulse Definition, Load Pulse Definition Synchronous (output of the class picked), Get Pulse Definition Id, Get Pulse Definition Ids, Is Valid, To String, Make Pulse Definition Id From String / From Primary Asset Id, To Primary Asset Id
UPulseLoadDefinitionAsyncAction Blueprint node Load Pulse Definition (On Loaded, On Failed with the result)

Game phases

See Game phases.

Type / function Purpose
UPulseGamePhaseSubsystem Game instance: Get, GetPhase, GetPreviousPhase, IsInPhase(Phase, bExact), GetSecondsInPhase, SetPhase(Phase, bWaitForLoadingHolds), GetWaitingPhase, FlushWaitingPhase, GetPhaseSource, GetPhaseSourceIfActive, SetPhaseSource, SetPhaseSourceClass, ResetPhaseSource, GetHistory, OnPhaseChanged / OnPhaseChangedNative; snapshot category Phase
UPulseGamePhaseSource The provider that leads the phases (default: level changes and Menu Maps): OnLevelTravelStarted(MapName), OnWorldReady(World) (BlueprintNativeEvents), protected SetPhase, IsMenuMap, GetPhaseSubsystem, bWaitForLoadingHolds
FPulseGamePhaseMessage, FPulseGamePhaseChange Payload of Pulse.Message.Phase.Changed and of the events (From, To, SecondsInFrom); one change of the history
Pulse::Phase IsLoadingPhase, ShouldWaitForHolds, IsInPhase, ResolveWorldPhase, AddToHistory, GetPhaseName, MaxHistory
UPulseGamePhaseLibrary Blueprint: Get Game Phase, Is In Game Phase
UPulseWaitForGamePhaseAction Blueprint node Wait For Game Phase (Reached with the phase of now)
Pulse::Foundation::Tags::Phase_* Phase, Phase_Boot, Phase_Menu, Phase_Menu_Splash, Phase_Menu_Title, Phase_Loading, Phase_InGame, Message_Phase_Changed

Byte transfer

See Byte transfer.

Type / function Purpose
Pulse::Transfer::RegisterChannel, UnregisterChannel, FindChannel, Allows, FPulseTransferChannel, EPulseTransferDirection Channels: way, most bytes, receiver
FPulseTransferDone, FPulseTransferReceived The callbacks: the result of a send; player, channel, way and bytes where they arrived
Pulse::Transfer::Send(Player, Channel, Bytes, Done) Bytes to the client of a player (server) or to the server (client), in chunks with a window
UPulseByteTransferComponent Carries the RPCs; added to every player controller at login while a channel is registered
FPulseTransferSender, FPulseTransferReceiver The rules of both sides (pure)
Pulse::Transfer::ChunkSize, Window, TimeoutSeconds, MaxRunning 8 KB, 4 chunks of all transfers of a player and way, 30 s, 2 transfers at once
Pulse.Result.Failure.Refused (Pulse::Foundation::Tags::Result_Failure_Refused) The other side did not take it

Serialization

Type / function Purpose
Pulse::Serialization::StructToBytes, BytesToStruct, ReadVersioned, GetStructVersion Struct bytes
InstancedStructToBytes, BytesToInstancedStruct Instanced struct bytes with type
EPulseReadResult Success, Empty, Corrupt, TooNew
Pulse::Serialization::CompressBytes, DecompressBytes, PackedHeaderSize Packed bytes (Oodle or stored, size and check sum in a header); unpacking checks the size against a limit before it allocates
Pulse::Serialization::FNoAssetLoadScope, CanLoadAssets Reading bytes loads no assets while a scope lives (bytes from clients)
FPulseImportReport, FPulseImportMessage, UPulseImportReportLibrary Import reports
IPulseByteSaveable (GetSaveId, GetSaveIdentity, SaveToBytes, LoadFromBytes, timing, GetSaveListFields) Objects that save themselves as bytes, with short values for save lists
FPulseSaveIdentity, EPulseSaveScope What an object saves (tag, key, scope) for stable save keys
FPulseSaveKeyParts, Pulse::Serialization::MakeSaveKey, GatherSaveKeyParts, GetSaveKeyStability, EPulseSaveKeyStability Save keys from their parts (pure) and how stable they are; a player actor without player id has no key (bPlayerWithoutId)
Pulse::Serialization::MakeStableLevelName, GetStreamedLevelName Level names that are the same on every machine (no PIE prefix)
Pulse::Serialization::DescribeSaveId How far the default save id of an object can be trusted (checks)

Player settings

Type Purpose
UPulseSettingsSubsystem Per local player: register, query, set, apply, revert, reset, save, events
UPulseSettingsRegistry The registry behind the subsystem (C++ events OnSettingChanged, OnSettingsChanged, OnPendingChanged; SetStorage, GetStorage, IsLoading, HasLoaded)
UPulsePlayerSettingsStorage, FPulsePlayerSettingsValues Where the player settings are kept (a provider): LoadSettings, SaveSettings (BlueprintNativeEvents), FinishLoadSettings, C++ RequestLoad, RequestSave; the default uses GameUserSettings.ini
UPulseSettingsSubsystem::GetSettingsStorage, SetSettingsStorage, SetSettingsStorageClass, ResetSettingsStorage, IsLoadingSettings, HasLoadedSettings The storage of a local player at runtime (the same storage again loads again)
Pulse::Settings::Storage::MakeFileKey, ExtractPlayer, ReplacePlayer The file of the default storage: every local player in one map (P<Index>:<Id>)
UPulsePlayerSettings, FPulsePlayerSettingsDeclarer, FPulseSettingDescriptorBuilder Settings from properties
UPulseSettingsCollection Settings asset
FPulseSettingDescriptor, FPulseSettingOption, EPulseSettingType, EPulseSettingApplyMode Descriptor types
FPulseSettingSource + _Property, _CVar, _GameUserSettings, _SoundClassVolume, _InputKey, _Custom Sources
FPulseSettingSource::CanWriteValue, EPulseSettingWriteCheck Whether a source takes a value, checked before Apply writes anything
UPulseSettingsRegistry::ApplyWithResult, UPulseSettingsSubsystem::ApplyChangesWithResult Apply with a result: refused values stay pending, values without target are dropped
UPulseSettingsRegistry::SetValues (optionally all or nothing), ResetToDefaultsWithResult, UPulseSettingsSubsystem::ResetToDefaultsWithResult Several values in one step (conditions see the values of the step)
FPulseSettingContext::GetValue, PlannedValues The value a condition sees: planned value first, then the registry
FPulseSettingsApplyReport, FPulseSettingRejection, FPulseSettingsPending, FPulseSettingChange Details of the results, pending values
UPulseSettingValueProvider Blueprint provider for custom sources
FPulseSettingCondition + _SettingValue, _Platform Conditions
FPulseSettingSource_Nanite, FPulseSettingCondition_NaniteAvailable, EPulseNaniteAvailability, FPulseNaniteFacts The Nanite setting: source of r.Nanite, condition (Hide covers the hidden cases, Disable the disabled ones), why Nanite cannot be switched
Pulse::Graphics TAG_Setting_Nanite, GetNaniteAvailability, GatherNaniteFacts, IsNaniteRendering, GetNaniteAvailabilityText, MakeNaniteDescription, MakeNaniteDescriptor; pure rules ResolveNaniteAvailability, ShouldHideNaniteSetting, IsNaniteConditionMet, ResolveNaniteShownValue, ShouldWriteNanite, IsLockedForGameSettings
UPulseNaniteLibrary Blueprint: Get Nanite Availability, Get Nanite Availability Text, Is Nanite Rendering
FPulseSettingChangedMessage Payload of Pulse.Message.Settings.Changed
Pulse::Settings::BoolToValue, ValueToBool, FloatToValue, NormalizeValue, FormatValue, GetCategoryDisplayName, GetTabCategory Helpers

UI host (PulseFoundationUI)

See Where widgets of plugins show.

Type / function Purpose
UPulseUIPresenter UI host of a local player: OpenWidget, OpenWidgetOnLayer (C++ also with a setup before the activation), CloseLayer, CloseWidgets, CloseWidget, FindWidget, FindWidgetOnLayer, IsHostReady, OnHostReady / OnHostReadyNative, NotifyHostReady, AddGameplayWidget, RemoveGameplayWidget, FindGameplayWidget, AddGameplayHideRequest, RemoveGameplayHideRequest, IsGameplayHidden, ShowNotification (returns a handle), HideNotification, ShowProgress, UpdateProgress, HideProgress, ShowTooltip, HideTooltip, ShowModal (C++ with callback, Blueprint Show Modal), FinishModal, CloseModal, CloseAllModals, IsModalOpen, GetNumOpenModals, GetLayerZOrder, OnModalFinished; for hosts InitializePresenter, DeinitializePresenter, HandlePlayerControllerChanged (Blueprint: On Initialize Presenter, On Deinitialize Presenter, On Player Controller Changed), protected PrepareWidget, RememberWidget, ApplyLayerInput, PresentModal, DismissModal; LayerInputs (FPulseUILayerInput per layer)
FPulseUINotification, FPulseUIProgressRequest, FPulseUITooltipRequest, UPulseUITooltipWidget, EPulseUIModalActionRole, Pulse::UI::Presenter::GetActionRole Notifications (kinds Pulse.UI.Notification.Info, Success, Warning, Error, Subtitle; priority, widget class), progress overlays, tooltips and their base widget (On Tooltip Request Set), roles of modal buttons (Blueprint: Get Modal Action Role, Make Message Modal Request, Make Confirm Modal Request of UPulseUIPresenterLibrary, Get Action Role of UPulseUIModal)
UPulseUIPresenterSubsystem, UPulseUIPresenterLibrary, Pulse::UI::GetPresenter The presenter of a local player: GetPresenter, SetPresenter, SetPresenterClass, OnHostReady / OnHostReadyNative (forwards the event of the presenter of now, again after SetPresenter and SetPresenterClass when the new host is ready); the presenter is made when the player gets a controller, SetPresenterClass makes it right away when the player has one, GetPresenter returns null while the presenter of before ends; Blueprint Get Pulse UI Presenter, Is UI Host Configured
EPulseUIModuleActivation When a UI module of a plugin turns on: WithUIHost (default), Always, Never
FPulseUIGameplayWidgetPlacement, FPulseUIGameplayWidgetSlot A gameplay widget a module may add by code (bAddByCode, WidgetClass, Placement); the slot of a module: Ensure (the widget of the host, else one added by code; its own leaves when the host shows another, a widget of another controller is forgotten), Remove (only its own), Reset, Get
UPulseUIModal Base of the modal widget of the default presenter: On Request, Choose, GetRequest, back key answers the cancel action
FPulseUIPlacement, FPulseUIModalRequest, FPulseUIModalAction Where a gameplay widget sits (anchor, offset, size, or bFill with Padding); title, message, buttons, content class, payload of a modal (MakeMessage, MakeConfirm, GetCancelActionId)
Pulse::UI::Presenter ResolvePresenterClass, GetViewportPosition, SetDefaultPresenterClass (removes the check: register the class first), GetDefaultPresenterClass, SetDefaultPresenterCheck, GetDefaultPresenterCheck, IsHostConfigured, ShouldActivateModule, ActionConfirm, ActionCancel, ActionClose
Pulse::UI::Tags::Layer_* Layer, Layer_Game, Layer_Menu, Layer_Modal, Layer_Overlay
UPulsePlayerInputManager, Pulse::UI::GetPlayerInputManager Input contexts of a local player (local player subsystem, setting bEnablePlayerInputManager): AddInputContext, AddInputContextForWidget, RemoveInputContext (Blueprint Remove Input Context), HasInputContext, RefreshInput, GetNumInputContexts; handles are FPulseHandle; debug category “UI”. See Input contexts
FPulseInputContext, EPulseShowMouseCursorMode, EPulseInputMode, FPulseUILayerInput An input context (MakeMenu, MakeGameAndMenu), the input context of a layer of the presenter
Pulse::UI::Input ResolveInputContexts (to FPulseResolvedInputState), FindLayerInput
IPulsePlayerInputManagerOwner Local player classes decide whether they get an input manager (ShouldCreateInputManager)
UPulseUIMarkerSubsystem, UPulseUIMarkerLibrary, Pulse::UI::GetMarkers Marker register of a local player (local player subsystem, always there): AddMarker, UpdateMarker, RemoveMarker (Blueprint Remove Marker), RemoveMarkersForActor, RemoveMarkersOfKind, FindMarker (Blueprint Find Marker), FindMarkerForActor, GetMarkerRecords, Get Markers (channels, kinds), GetNumMarkers, OnMarkerChanged / OnMarkerChangedNative; library Get Pulse UI Markers, Add Marker, Update Marker, Remove Marker, Remove Markers For Actor; debug category “UI”. See Markers
FPulseUIMarkerData, FPulseUIMarkerRecord, EPulseUIMarkerChannels, EPulseUIMarkerChange, EPulseUIDistanceUnits Data of a marker (GetLocation, IsActorGone, NeedsDistance, GetMaxDistanceCm, IsInRange), a registered marker (handle, data, channels, presentation), the channels Compass, Screen, Map, the kinds of change, the units
FPulseUIMarkerList The markers as plain data, without a world: Add, Update, Remove, RemoveIf, RemoveGoneActors, Find, FindByActor, Filter, Num, HasActorsToWatch, GetRecords; every change reported after it was made
Pulse::UI::Markers ToCentimeters, ConvertDistance, FormatDistance, MatchesFilter, AllChannels
Pulse::UI::Tags::Marker, Marker_Generic Pulse.UI.Marker (plugins declare their kinds below it), Pulse.UI.Marker.Generic
UPulseUISettings (Input) bEnablePlayerInputManager, bClearContextsOnControllerChange, bShowMouseCursorByDefault, DefaultInputMode

View models (PulseFoundationMVVM)

Type Purpose
UMVVMPulsePlayerViewModel Base of view models bound to a player (BindToPlayer, OnBoundToPlayer)
UPulsePlayerViewModelResolver Resolver that creates and binds them
UMVVMPulseSettings, UMVVMPulseSettingsCategory, UMVVMPulseSetting Settings menus; SettingViewModelClass and CategoryViewModelClass give the classes of the rows, tabs and sections
Pulse::MVVM::ResolveViewModelClass Class of a view model that code creates: from a setting (soft class, loaded synchronously) or a property, the base class when it is empty or does not fit

Debugging

Type / function Purpose
IPulseDebugSnapshotProvider, FPulseDebugSnapshot (+ Section, Row, Shape, FPulseDebugSummary), EPulseDebugValueKind, EPulseDebugState Snapshots, value kinds and summaries
Pulse::Debug::RegisterSnapshotProvider, UnregisterSnapshotProvider, GetSnapshotProviders, GatherSnapshot, AddSnapshotToVisualLog Snapshot registry
PULSE_DEBUG_EVENT, Pulse::Debug::RecordEvent, GetEvents, GetTimelineWorlds, GetTimelineWorldLabel, ClearTimeline, IsTimelineRecording Timeline
Pulse::Debug::BeginSpan, EndSpan, GetNumOpenSpans, RecordMarker, FPulseDebugEvent::Phase / SpanId Timeline spans and markers
Pulse::Debug::GetWorldDebugName, GetWorldDebugLabel World names of timelines and reports (PIE instances apart)
FPulseReport, FPulseReportEntry, FPulseReportBuilder, FPulseReportRecorder, FPulseReportPolicy Reports
Pulse::Debug::OnReportSubmitted, GetRecentReports, Pulse::Debug::Reports::* Report events and files
UPulseCheatExtension (ForwardToServer, PrintCheatMessage, ResolveTag), Pulse::Debug::DescribeResult, UPulseFoundationCheats Cheats: forward to the server, print, a tag from an argument (short names under a root), a result as a line (Debugging)
IPulseFoundationDebug::RegisterSnapshotCategory Gameplay debugger categories
UPulseDebugLibrary (Blueprint, Pulse\|Debug), FPulseDebugSpanHandle Timeline events, spans, markers, events, snapshots and reports from Blueprints
UPulseDebugSnapshotComponent (Pulse Debug Snapshot), UPulseDebugSnapshotBuilder Snapshot provider for Blueprint actors (On Gather Snapshot)
UPulseDebugReportBuilder Report built in Blueprints (Begin Pulse Report)
UPulseDebuggerEditorLibrary::OpenPulseDebugger Opens the Pulse Debugger from Editor Utility Blueprints
IPulseFoundationEditor::RegisterDebuggerPage, OpenDebugger, FPulseDebuggerPage (Icon, OnSpawnWithContext) Pulse Debugger pages
FPulseDebuggerContext, Pulse::Editor::Style, SPulseDebugKeyValueTree, SPulseDebugSourceFilter, SPulseDebugSourceChip, SPulseDebugBadge, Pulse::Editor::MakeToolbarButton, AddObjectActions Building blocks for debugger pages (editor)
PULSE_LOG_OBJECT, PULSE_ENSURE_OBJECT Logging

Editor

Type Purpose
IPulseFoundationEditor::RegisterLevelMode, UnregisterLevelMode, GetLevelModes, OpenLevelMode, FPulseLevelMode Level editor modes of the plugins (Pulse window, Pulse.Mode)
UPulseEdMode, FPulseEdModeTool, FPulseEdModeFooter, FPulseEdModeMetric, IPulseLevelTool Level tools: mode base on the Interactive Tools Framework, palette, handles, footer, viewport overlay; tools add panel content and an overlay of their own (Editor kit)
Pulse::Editor::Kit::LevelTools::FUndoScope, FUndoInteraction, SetPropertyValue One undo step per action of a tool
Pulse::Editor::Kit::Views::RegisterView, UnregisterView, SetViewEnabled, FillViewsMenu, MakeGridAroundView, SampleGradient, GetCellCorners, IsInLegend, BuildView, FPulseViewportView, FPulseViewDrawing, FPulseViewContext Viewport views (Editor kit)
SPulsePreviewViewport stage and post process: arguments Exposure (EPulsePreviewExposure: Fixed, Game), Environment (EPulsePreviewEnvironment: Profile, Stage), LightMoods, InitialLightMood, OnOverridePostProcess (FOnPulsePreviewOverridePostProcess), OnLightMoodChanged (FOnPulsePreviewLightMoodChanged); SetExposure, GetExposure, GetEnvironment, AddLightMoods, GetLightMoods, SetLightMood, GetLightMood, SetSunElevation, GetStageSkyAtmosphere, GetStageVolumetricCloud, GetStageHeightFog, GetStageSun, GetStageSkyLight, GetStageFloor; FPulseLightMood, EPulseLightMoodPreset, Pulse::Editor::Kit::Stage::MakeLightMood, GetBuiltInLightMoods, AddLightMoods, FindLightMood, GetSunRotation, WithSunElevation Preview viewports for look editors: exposure and post process as in the game, a stage like a level (sky atmosphere, clouds, height fog, sun, real-time sky light, floor) lit by light moods (Editor kit)
SPulsePreviewViewport second viewport, compare key and camera: arguments SceneOf, bLinkCamera, bCompareKey, CompareKey, OnCompareChanged (FOnPulsePreviewCompareChanged), CameraMode (EPulsePreviewCameraMode: Orbit, Free), BookmarkKey; SharesSceneWith, SharesScene, IsRendering, LinkCamera, UnlinkCamera, SetCameraLink, GetCameraLink, IsCompareHeld, SetCompareHeld, GetCompareKey, SetCompareKey, GetUserCompareKey, SetUserCompareKey, SetCameraMode, GetCameraMode, GetViewTransform, SetViewTransform, GetCameraView, SetCameraView, GetBookmarkKey, GetBookmarks, AddBookmark, GoToBookmark, RemoveBookmark; FPulsePreviewCameraView, FPulsePreviewCameraLink, FPulsePreviewBookmark, Pulse::Editor::Kit::Camera::MakeView, GetTransform, SetBookmark, RemoveBookmark, FindBookmark, MakeBookmarkName, ToConfigLine, ParseConfigLine, LoadBookmarks, SaveBookmarks A second viewport on the scene of another (one world, its own post process, coupled cameras, no rendering while hidden), a held compare key, an orbit or free camera and camera bookmarks per owner (Editor kit)
SPulsePreviewViewport view modes and living world: arguments ViewMode, bLevelViewModes, ActorDrops (EPulsePreviewActorDrops: None, Blueprints, Assets), OnActorsChanged (FOnPulsePreviewActorsChanged), OnActorSelected (FOnPulsePreviewActorSelected); SetViewMode, GetViewMode, HasLevelViewModes, SetBufferVisualization, GetBufferVisualization, SetShowFlag, IsShowFlagOn, SetActorDrops, GetActorDrops, SpawnPreviewActor, SpawnPreviewActorFromAsset, SpawnDroppedAssets, RemovePreviewActor, RemoveAllPreviewActors, GetPreviewActors, GetSelectedPreviewActor, SetSelectedPreviewActor, GetStageWind; FPulseLightMood::WindStrength, WindSpeed; Pulse::Editor::Kit::View::ParseViewMode, GetViewModeId, FindShowFlag; Pulse::Editor::Kit::World::GetActorHandleGroup, MakeActorHandleId, IsActorHandleId, IsBlueprintAsset, TakesDrop, PlaceOnSurface, GetRowStep View modes and show flags of the level viewport (Buffer Visualization, the HDR histogram), a world that ticks (material time, wind, clouds, Niagara) and Content Browser assets spawned as actors that are selected, moved with the gizmo and deleted (Editor kit)
SPulseTransportBar, Pulse::Editor::Kit::Timeline::FormatTime, ParseTime, GetWindowStart Transport bar: play, pause, rewind, step, typed time, scrubbing, speeds (Editor kit)
SPulseTimeline, FPulseTimelineTrack, FPulseTimelineRange, FPulseTimelineMarker, FPulseTimeSpan, Pulse::Editor::Kit::Timeline::TimeToX, XToTime, GetRulerStep, FitView, MakeDragSpan Timeline: transport bar above a time ruler with tracks, markers, playhead and a loop span (Editor kit)
EPulseTimelineMarkerShape, EPulseTimelineItemPart, FPulseTimelineHit, Pulse::Editor::Kit::Timeline::MoveSpan, ResizeSpan, SnapTime, GetSnapTargets, HitTest, AssignLanes, GetRangeLanes, GetLaneCount, DragItem; events OnItemClicked, OnItemDragged, OnTrackContextMenu, OnDeleteItems of SPulseTimeline Editable items of the timeline: ranges and markers with an id are clicked and dragged (a range moves or one edge follows, snapped to an interval and to other items; overlapping ranges in lanes), a right click asks for a track menu, Delete removes the selected items; the owner writes the change (Editor kit)
FPulseBackgroundTask, FPulseBackgroundTaskContext, Pulse::Editor::Kit::Tasks::Start, IsRunning, Cancel, GetProgress, Wait Background tasks with progress, Cancel and the status bar (Editor kit)

Utilities

Type Purpose
FPulseHandle, UPulseHandleLibrary Handles
Pulse::Tags::GetLeafName, GetLeafDisplayName The last part of a tag, as text or as words (Tag helpers)
Pulse::Clock::GetNow The time of a clock, the world time without the clock subsystem (Clocks)
EPulseReplicationMode, Pulse::Replication::GetCondition, IsOwnerOnly, CanChangeMode, HasAuthorityOrNoOwner Which clients receive a component; whether a component may change its state here (Replication mode)
Pulse::Grid::GetCell3D, GetCellMin3D, GetCellCenter3D, HashCell3D Cube cells next to the X/Y cells of Pulse::Grid (Grid)
Pulse::Grid::Mix32, Combine, HashText, PickWeighted Stable 32-bit seeds, a stable text hash and a pick by weight (Grid)
FPulseInstancedStructSet, Pulse::Structs::* One instanced struct per type
Pulse::Loading::FLoadBundle, UPulseLoadAssetsAsyncAction Async loading
UPulseDeveloperSettings Settings base class
Pulse::Settings::AreSettingsPagesEnabled Whether the settings show as one page per plugin (Utilities)
Pulse::Editor::Settings::ShowSettings, GetSettingsLocation, GetSettingsPages, IsOnSettingsPage, IsSettingChanged, CountChangedSettings Settings pages: open the block of a class, its place as text, the pages, changed values (editor only)
Pulse::AutoComponents::MakeComponentName, HasFixedName The fixed name of automatic components (Pulse_<Class>_0)
Pulse::AutoComponents::AddToActor, FindOrAddToActor (also FindOrAddToActor<T>) A component added the way automatic components are; the one an actor has, else one added that way (Workflow)
Pulse::Testing::FTestWorld, SpawnTestPlayer (also SpawnTestPlayer(World, Name)), SetTestPlayerId, FTestNetId, SpawnTestGameState, FTestObjects, FMessageRelayAccess (Receive, SetSendHook), SetTuningNumber, SetTuningValue, RemoveTuning Spec helpers
Pulse::Validation::AddIssue, GetIssuePath, MakeElementPath Problems of IsDataValid with the path of their value (editor only; the config workshop shows them on the node)
Pulse::Validation::IsPluginExample, ShareIdScope Whether a package is example content of a plugin (/<Plugin>/Examples/...); checks for unique ids compare project assets and plugin examples only among themselves (editor only)

Console

Command Purpose
Pulse.Debugger [Page] Opens the Pulse Debugger (editor)
Pulse.Mode [Mode] [Tool] Opens a level editor mode of a Pulse plugin (editor)
Pulse.Views [Id\|none] [on\|off] Switches viewport views (editor, PIE windows)
PulseDebugProviders Lists the snapshot providers of the world
PulseDebugDump [Category] Prints snapshots to the log
Pulse.Debug.Mark <Text> Writes a marker into the timeline of every running world
PulseDebugReportTest [slow] Publishes a test report (Pulse Debugger > Reports)
PulseDebugTimelineTest [Count] Records test events and spans into the timeline of the world
PulseMessageSend <Channel> Sends a message without payload
PulseMessageListeners Lists the listeners per channel

PulseFoundation plugin documentation.

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