Message channels

Every channel the Pulse plugins broadcast on the message bus: its payload, where it is broadcast, what its context holds and what the amount means. The list comes from the channel register; Pulse.Messages.List prints the channels of the plugins enabled in your project (Console).

Reading the tables

  • Origin: Server messages are broadcast on the server and in standalone, Client messages on the machine of a local player. With Both every machine broadcasts its own; the section says which machines.
  • Context: each section names the fields its plugin fills; Notes add what differs per channel. Fields that are not named stay empty.
  • Amount: what Amount of the context holds. A channel without an amount of its own carries 1, so a message trigger that adds up values counts its messages.
  • An actor of a player is a pawn or controller with a player state, or a player state.

Pulse Foundation

Channel Payload Origin Amount Notes
Pulse.Message.Settings.Changed FPulseSettingChangedMessage Client 1 A player setting was written. Player: the controller of the local player; Tags: the setting.
Pulse.Message.Save.Started FPulseSaveStatusMessage Both 1 A save started (reported by the save system through UPulseSaveStatusSubsystem). Slot in the payload.
Pulse.Message.Save.Phase FPulseSaveStatusMessage Both 1 A save reached a phase (Collect, Write).
Pulse.Message.Save.Finished FPulseSaveStatusMessage Both 1 A save finished; bSuccess, Seconds.
Pulse.Message.Save.LoadStarted FPulseSaveStatusMessage Both 1 The game started loading (first hold of the load barrier).
Pulse.Message.Save.LoadFinished FPulseSaveStatusMessage Both 1 The game finished loading (last hold ended); bSuccess, Seconds.
Pulse.Message.Area.Entered FPulseAreaMessage (area id, area, tags) Both 1 A player entered a Pulse area with the function Messages: on the server for every player, with Where Everywhere (or Local) also on the machine of a local player. Player and Instigator: the pawn; Target: the actor of the area; Source: the area; Tags: its tags.
Pulse.Message.Area.Left FPulseAreaMessage (area id, area, tags) Both 1 A player left a Pulse area with the function Messages, or the area went (sent after it is removed). Context as Entered.
Pulse.Message.Request.Suspicious FPulseRequestSuspiciousMessage Server Times this player was reported Player: the controller; Tags: the last reason. PulseFoundation never kicks.
Pulse.Message.Request.Failed FPulseRequestFailedMessage Client 1 A request of a local player failed on the server or got no answer. Player: the controller of the local player; Tags: the reason.
Pulse.Message.Tuning.Changed FPulseTuningChangedMessage (source, player, removed, knobs, adjustments changed, their targets, difficulty changed, difficulty, generation) Both 1 A tuning source was set or removed or the difficulty changed: on the server when it happens, on a client when it arrives (catch-up Replication when it joins). Player: the player of a personal source; Tags: the knobs the change touches.
Pulse.Message.Loading.HoldChanged FPulseLoadingHoldMessage (change, hold, hold count, overall progress, text) Both 1 A loading hold of this machine was added, changed its progress (steps of 1 %) or text, or was removed. No actors in the context.
Pulse.Message.Phase.Changed FPulseGamePhaseMessage (from, to, seconds in the phase before) Both 1 The game phase of this machine changed (Boot, Menu, Loading, InGame or a sub-phase); not replicated, every machine sends its own. Tags: the new phase. No actors in the context.
Pulse.Message.Clock.Jumped FPulseClockMessage Both Seconds jumped The time of a clock jumped: the game time was set or loaded (a load: CatchUp = Load on the server), or the server time of a client caught up. Every machine broadcasts its own.
Pulse.Message.Clock.Paused FPulseClockMessage Both 1 The game clock stopped, on every machine.
Pulse.Message.Clock.Resumed FPulseClockMessage Both 1 The game clock runs again, on every machine.
Pulse.Message.Clock.RateChanged FPulseClockMessage Both The new rate The rate of the game clock changed, on every machine.
Pulse.Message.Clock.DayRateChanged FPulseClockMessage Both The new day rate The day rate of this machine changed (UPulseClockSubsystem::SetDayRate, day seconds per game clock second). Local: the calendar sets it on every machine, it is not replicated.
Pulse.Message.Sim.RecordAdded FPulseSimMessage (id, kind, location, game time) Server 1 A Pulse Sim record was added or loaded as a new one. No player; Source: the actor of the view that shows it, if any; Location: the record.
Pulse.Message.Sim.RecordRemoved FPulseSimMessage Server 1 A Pulse Sim record was removed. Context as Record Added (the kind is empty).
Pulse.Message.Sim.Event FPulseSimMessage (also the event) Server Amount of the notice A Pulse Sim record told that something happened (FPulseSimContext::Notify), also while nobody looks at it. Tags: the event; Source and Location as Record Added.
Pulse.Message.Attribute.Changed FPulseAttributeChangedMessage (owner, attribute, before, after, applied, max, cause, predicted) Both Applied (after - before) An attribute of a source changed: on the server after a change, a modifier, a max change rule or a load (CatchUp = Load); on a client from the values it received (cause Replication, catch-up Replication when it joins), at most once per frame and attribute; on a GAS client also predicted (bPredicted). Only sent while the channel has listeners; rates that run on their own send nothing (read the value, or wait with Wait For Attribute). Instigator, Source and Tags: of the change (costs add Pulse.CostKind.Attribute, rewards Pulse.RewardKind.Attribute); Target: the owner.
Pulse.Message.Attribute.Depleted FPulseAttributeEdgeMessage (owner, attribute, value, min, max) Server Applied of the change The value reached its minimum (health empty: combat decides what that means). Context of the change that caused it (a band modifier names its source key); a value loaded empty sends CatchUp = Load. To clients only through the message relay.
Pulse.Message.Attribute.Restored FPulseAttributeEdgeMessage Server Applied of the change The value left its minimum again; after a rate, one frame later at the earliest, so a listener of Depleted can pause the rate first. Context as Depleted.
Pulse.Message.Attribute.RangeChanged FPulseAttributeRangeMessage (owner, attribute, old band, new band, value, max) Server Applied of the change A pool entered another band or left every band (new band empty), e.g. Exhausted of the default stamina. Context as Depleted.

Pulse Gameplay

Interaction

Sent wherever the interaction ability runs: on the local player, and on the server as well for replicated interaction. Context: the interactor (the avatar of the ability, usually the pawn) is Player and Instigator, the actor interacted with is Target, the interactable component (else the actor) is Source, the tags of the interactable (GetInteractableTags, InteractableTags on the interactable components) are the Tags.

Channel Payload Origin Amount Notes
Pulse.Message.Interact.Started FPulseInteractMessage Both 1 An interaction started.
Pulse.Message.Interact.Completed FPulseInteractMessage Both 1 An interaction took effect.
Pulse.Message.Interact.Ended FPulseInteractMessage Both 1 An interaction ended, completed or cancelled.

Combat

Sent on the server, and on every machine while the combat component has bReplicateDamageEvents (default). Context: the combatant is Target, the attacker, healer or killer Instigator; Player is the instigator when it is an actor of a player, else the target when it is one.

Channel Payload Origin Amount Notes
Pulse.Message.Combat.Damaged FPulseCombatMessage Both Damage Tags: the damage type.
Pulse.Message.Combat.Healed FPulseCombatMessage Both Healing  
Pulse.Message.Combat.Died FPulseCombatMessage Both 1 Instigator: the killer.
Pulse.Message.Combat.Revived FPulseCombatMessage Both 1 No instigator.

Crafting

Context: the owner of the crafting component is Player and Instigator, the owner of the station Target (none without a station), the recipe Source.

Channel Payload Origin Amount Notes
Pulse.Message.Crafting.Queued FPulseCraftingMessage Server Rounds queued  
Pulse.Message.Crafting.Crafted FPulseCraftingMessage Server 1 One round crafted and handed out.
Pulse.Message.Crafting.Completed FPulseCraftingMessage Server Rounds of the job The job finished all its rounds.
Pulse.Message.Crafting.Cancelled FPulseCraftingMessage Server Rounds left  
Pulse.Message.Crafting.RecipeUnlocked FPulseCraftingMessage Server 1 No target.

Gathering

Context: the harvester is Player and Instigator, the resource node Target, its definition Source, the resource tags of the definition (Pulse.Gathering.Resource.*) the Tags.

Channel Payload Origin Amount Notes
Pulse.Message.Gathering.Harvested FPulseHarvestMessage Server Items given Source in the payload: interaction, hit or other.

Respawn

Context: the player’s controller is Player; the target is the pawn (died, respawned, downed, revived) or the death bag (dropped).

Channel Payload Origin Amount Notes
Pulse.Message.Respawn.Died FPulseRespawnDiedMessage Server 1 A player died: place, killer, cause (a gameplay tag of the game) and deaths so far. Instigator: the killer. The cause is also in the context Tags, so a message trigger or condition matches it without the payload. A death that a load brings back sends CatchUp = Load.
Pulse.Message.Respawn.Respawned FPulseRespawnedMessage Server 1 Point id, place, whether the player chose the point or the rule picked it, and whether the respawn was forced (ForceRespawn, round starts; also of a living player). Source: the actor of the point (none for a point without actor).
Pulse.Message.Respawn.BagDropped FPulseDeathBagMessage Server Stacks in the bag The bag, its owner (player id), team rights and expiry.
Pulse.Message.Respawn.Traveled FPulseRespawnedMessage Server 1 A living player travelled to a respawn point (point id, place).
Pulse.Message.Respawn.Downed FPulseDownedMessage Server Downs since the last respawn A player went down instead of dying (downed mode): place, who emptied the health (also the instigator), seconds until the bleed-out.
Pulse.Message.Respawn.Revived FPulseRevivedMessage Server 1 A downed player got up: the reviver (also the instigator), or healing from outside (bByHealing), the health share.
Pulse.Message.Respawn.PermanentDeath FPulseRespawnPermanentDeathMessage Server 1 A player died for good (permadeath): place, killer (also the instigator), cause (also in the context Tags), deaths. A permanent death that a load brings back sends CatchUp = Load. PulseRespawn deletes nothing; listeners (save bridge, character saves) remove saves or characters.

Inventory, equipment and item use

Inventory and equipment messages are sent on the authority and on clients that replicate the component. Context: the owner of the inventory is Target (and Player when it is an actor of a player), the item definition Source, its tags the Tags.

Channel Payload Origin Amount Notes
Pulse.Message.Inventory.ItemAdded FPulseInventoryItemMessage Both How many A new stack counts its stack (also on clients); items added to a stack count only on the authority.
Pulse.Message.Inventory.ItemRemoved FPulseInventoryItemMessage Both How many A whole stack counts its stack (also on clients); a part of a stack only on the authority.
Pulse.Message.Inventory.ItemChanged FPulseInventoryItemMessage Both Stack count Count, place or traits of a stack changed.
Pulse.Message.Inventory.ItemDropped FPulseInventoryItemMessage Server Items dropped The pickup is in the payload.
Pulse.Message.Inventory.Bought FPulseMerchantMessage Server Items bought The buyer is the player, the merchant the target, the item the source; the payload has offer and price.
Pulse.Message.Inventory.Sold FPulseMerchantMessage Server Items sold As for Bought.
Pulse.Message.Inventory.ItemSpoiled FPulseInventoryItemMessage Server Items spoiled A perishable stack spoiled and was replaced by its spoiled item or removed; the item is the stack as it was.
Pulse.Message.Inventory.OverloadChanged FPulseInventoryOverloadMessage Both Weight of the items The inventory became overloaded (it takes nothing more, nothing is taken away) or is no longer: its weight went over or under its limit, or the limit changed (Pulse.Tuning.Inventory.CarryWeight). Payload: the inventory, bOverloaded, Weight, MaxWeight. No source and no tags. A load or the first replication of a client sends it with Catch Up.
Pulse.Message.Inventory.Equipment.Equipped FPulseEquipmentMessage Both Stack count Context of the equipped item.
Pulse.Message.Inventory.Equipment.Unequipped FPulseEquipmentMessage Both Stack count  
Pulse.Message.Inventory.Equipment.ActiveSlotChanged FPulseEquipmentMessage Both Stack count Context of the new active item; an empty slot has no source and no tags (amount 1).
Pulse.Message.Inventory.ItemUsed FPulseItemUsedMessage Server 1 A use completed. Player and Instigator: the owner of the item user component.

Frontend

Context: the controller of the first local player is Player. The channel is sent on the machine of the player (module PulseFrontend, only with the frontend turned on). The phases of the frontend are game phases (Pulse.Message.Phase.Changed).

Channel Payload Origin Amount Notes
Pulse.Message.Frontend.EntrySelected FPulseFrontendEntryMessage Client 1 Entry id and menu (main or pause), before the action of the entry runs.

Map

Context: the controller of the local player is Player, the map Source. Sent on the machine of the player (module PulseMapUI).

Channel Payload Origin Amount Notes
Pulse.Message.Map.Opened FPulseMapMessage Client 1 The world map opened. Map in the payload.
Pulse.Message.Map.Closed FPulseMapMessage Client 1 The world map closed.

Locks

Context: who did it is Player and Instigator (empty for a script or a door that closed by itself), the door’s actor the Target, the door component the Source, the action in Tags (Pulse.Locks.Action.*; module PulseLocks).

Channel Payload Origin Amount Notes
Pulse.Message.Locks.DoorChanged FPulseDoorMessage Server 1 A door was opened, closed, locked, unlocked or picked; door, instigator, action and the state afterwards.

Pulse Save

Sent by the save game of the game (UPulseSaveGameSubsystem). No actors in the context; the slot is in the payload.

Channel Payload Origin Amount Notes
Pulse.Message.Save.SlotWritten FPulseSaveSlotMessage (slot, auto save reason) Server 1 The game was saved into a slot: by Save Game, or by an auto save of the session (AutoSaveReason: its reason).
Pulse.Message.Save.SlotLoaded FPulseSaveSlotMessage Server 1 A slot was loaded into the game.
Pulse.Message.Save.SlotDeleted FPulseSaveSlotMessage Both 1 A slot was deleted on this machine.

Pulse Quest

Sent on the authority and on the owning client of the quest manager. Context: the quest is Source and its tag in Tags; Player is the player of the host when it has exactly one (a player’s quest manager, a shared quest host with one player).

Channel Payload Origin Amount Notes
Pulse.Message.Quest.Started FPulseQuestMessage Both 1 Also when a quest is restored from a save game.
Pulse.Message.Quest.Finished FPulseQuestMessage Both 1 Succeeded, failed or stopped (Result).
Pulse.Message.Quest.ObjectiveFinished FPulseQuestObjectiveMessage Both 1 bSucceeded in the payload.
Pulse.Message.Quest.GameplayEvent FPulseQuestGameplayEvent Server Count (at least 1) One gameplay event that quests count (Gameplay Event objectives, Wait for Quest Event), sent by Send Quest Event and Broadcast Quest Event (UPulseQuestLibrary::SendQuestEvent, UPulseQuestLibrary::BroadcastQuestEvent, the StateTree task Broadcast Quest Event and the quest cheat, all through Pulse::Quest::SendQuestEvent) on the authority only; not replicated, nothing is sent on a client or without EventTag. Context differs from the other quest channels: Player: the player state of the instigator (else the instigator); Instigator, Target from the payload; Tags: the event tag and ContextTags. Payload: EventTag, Instigator, Target, Count, ContextTags, Payload (instanced struct, set only through Broadcast Quest Event, the full struct).

Pulse Dialog

Context: the controller of the initiator is Player, its pawn (else the controller) Instigator, the main speaker Target, the dialog Source with its tag in Tags, and FPulseDialogContextExtra (session, dialog) the Extra.

Channel Payload Origin Amount Notes
Pulse.Message.Dialog.Started FPulseDialogMessage Server 1 A dialog or cutscene started.
Pulse.Message.Dialog.Finished FPulseDialogMessage Server 1 Result in the payload.
Pulse.Message.Dialog.ChoiceSelected FPulseDialogMessage Server 1 Tags also hold the choice.
Pulse.Message.Dialog.VoiceStarted FPulseDialogVoiceLine Client 1 The voice over of a dialog line started for a local player (sent by its dialog player component, through the presenter). Own context: the owner of the player component (the controller) is Player, the speaker actor Instigator, the speaker role in Tags; no Extra. The payload carries session, line number, LineKey, speaker role and id, speaker actor, sound, the audio component of a sound asset (null for Pulse Sound events) and the duration: the hook for lip sync.
Pulse.Message.Dialog.VoiceFinished FPulseDialogVoiceLine Client 1 The voice over of a dialog line finished for a local player; context as VoiceStarted. bInterrupted when it was cut off (next line with bStopVoiceOnNextLine, end of the dialog, another session, end of the presenter).
Pulse.Message.Dialog.BarkRequest FPulseDialogBarkRequest Server 0 For bark add-ons (Pulse Dialog Barks plays it); Pulse Dialog does not react. Sent by Request Bark: the speaker is Target, the bark target Instigator, the occasion in Tags. An empty speaker in the payload means the context’s Target.
Pulse.Message.Dialog.BarkLine FPulseDialogBarkLine Client 0 A bark line reached a local player (its controller is Player, the speaker Instigator, the occasion in Tags); HUD bridges show it as a subtitle. Empty text: the bark stopped early.

Pulse Skill

Sent on the authority and on clients that replicate the skill component. Context: the owner of the skill component is Player.

Channel Payload Origin Amount Notes
Pulse.Message.Skill.RankChanged FPulseSkillRankChangedMessage Both New rank Source: the skill, Tags: its tag. Unlocked, refunded, reset, set or loaded.
Pulse.Message.Skill.PointsChanged FPulseSkillPointsChangedMessage Both Available points Tags: the point pool.
Pulse.Message.Skill.LevelChanged FPulseSkillLevelChangedMessage Both New level Source: the progression, Tags: its tag.
Pulse.Message.Skill.ExperienceGained FPulseSkillExperienceGainedMessage Both Experience gained Only added experience (not loaded or set); on the authority and the owning client. Source: the progression, Tags: its tag and the source of the experience.

Pulse Achievement

Sent on the authority and on clients that replicate the achievement component. Context: the owner of the component is Target (a player state, or the world actor of world achievements); Player is that player state, else the player state of the instigator; Instigator is the pawn of the instigator, else its player state (not on clients).

Channel Payload Origin Amount Notes
Pulse.Message.Achievement.Unlocked FPulseAchievementUnlockedMessage Both 1 Source: the achievement, Tags: its tag.
Pulse.Message.Achievement.CounterChanged FPulseAchievementCounterChangedMessage Both Change of the counter Tags: the counter. 0 on clients.

Pulse Online

Context: Player is the player the message is about: the controller of a local user, else the player state with the net id while that player is in the world.

Channel Payload Origin Amount Notes
Pulse.Message.Online.RequestCompleted FPulseOnlineRequestMessage Both 1 Where the request ran. Player: the controller it acts for (may be empty); Source: the request.
Pulse.Message.Online.User.LoginStateChanged FPulseOnlineUserLoginMessage Client 1 Source: the user.
Pulse.Message.Online.PlayerPartyChanged FPulseOnlinePlayerPartyMessage Both 1 Party id or leader flag of a player in a game session. On the server for every player, on a client for its own player. Player: the player state.
Pulse.Message.Online.Chat.Received FPulseOnlineChatReceivedMessage Client 1 Player: the first local controller; Instigator: the sender while it is in the world.
Pulse.Message.Online.Commerce.EntitlementsChanged FPulseOnlineCommerceMessage Client Entitlements  
Pulse.Message.Online.Commerce.Purchased FPulseOnlineCommerceMessage Client Items bought Only successful purchases. Source: the purchase request.
Pulse.Message.Online.RatingChanged FPulseOnlineRatingChangedMessage Server Change of the ordinal Source: the queue, Tags: its tag.
Pulse.Message.Online.Matchmaking.StateChanged FPulseOnlineMatchmakingMessage Client 1 Source: the ticket, Tags: the queue.
Pulse.Message.Online.Safety.BlockListChanged none Client 1 Player: the first local controller.
Pulse.Message.Online.Safety.PlayerReported FPulseOnlinePlayerReportMessage Client 1 Target: the reported player while it is in the world.
Pulse.Message.Online.Server.Message FPulseOnlineServerMessagePayload Client 1 Message of the day, admin message, command result, kick notice. Player: the first local controller.
Pulse.Message.Online.Connection.Changed FPulseOnlineConnectionMessage Client 1 Only when the state changes. Player: the first local controller.
Pulse.Message.Online.Stats.Updated FPulseOnlineStatsMessage Both Stats in the update Where the stats were read or written (bWritten).

Pulse Water

Sent on the authority. Context: the actor the message is about is Target (and Player when it is an actor of a player), the liquid at it is Source with its tags in Tags, its location the Location.

Channel Payload Origin Amount Notes
Pulse.Message.Water.EnteredWater FPulseWaterContactMessage Server Speed in cm/s A floating object came into the water.
Pulse.Message.Water.LeftWater FPulseWaterContactMessage Server Speed in cm/s No liquid.
Pulse.Message.Water.Submerged FPulseWaterContactMessage Server Speed in cm/s Completely under the surface.
Pulse.Message.Water.Surfaced FPulseWaterContactMessage Server Speed in cm/s Back up.
Pulse.Message.Water.BoatWrecked FPulseWaterBoatMessage Server 1 Instigator: who caused the last damage; Player: the instigator when it is an actor of a player, else the boat when a player possesses it. No liquid.
Pulse.Message.Water.BoatSunk FPulseWaterBoatMessage Server 1 Like BoatWrecked.
Pulse.Message.Water.WaveEvent FPulseWaterWaveMessage Server Height of the crests in cm Only Location: the origin of the ring.
Pulse.Message.Water.StartedSwimming FPulseWaterSwimMessage Server 1  
Pulse.Message.Water.StoppedSwimming FPulseWaterSwimMessage Server 1  
Pulse.Message.Water.HeadUnderWater FPulseWaterSwimMessage Server 1  
Pulse.Message.Water.HeadAboveWater FPulseWaterSwimMessage Server Seconds under water  

Pulse AI

Sent while bBroadcastMessages is on (Project Settings > Pulse > AI, default on). Context: the pawn of the agent is Instigator, the actor it reacts to Target (and Player when it is an actor of a player), its profile Source, its team in Tags, its location the Location.

Channel Payload Origin Amount Notes
Pulse.Message.AI.AwarenessChanged FPulseAIAwarenessMessage Server New level 0 unaware, 1 suspicious, 2 alert, 3 combat. Target: the strongest perceived actor.
Pulse.Message.AI.Alarm FPulseAIAlarmMessage Server Allies that heard it Target: the target of the alarm; Location: where it was raised.

The encounters of the bridge Pulse AI Combat Bridge (PulseAICombatBridge): the encounter is Target with its EncounterId in Tags, its location the Location; no player, instigator or source. The amount is the number of waves started.

Channel Payload Origin Amount Notes
Pulse.Message.AI.Encounter.Started FPulseAIEncounterMessage Server 0 Sent after wave 0 spawned (a player came close, or Start Encounter).
Pulse.Message.AI.Encounter.Wave FPulseAIEncounterMessage Server Number of the wave Sent after the wave spawned; counted from 1.
Pulse.Message.AI.Encounter.Cleared FPulseAIEncounterMessage Server Waves started Sent when every agent of the last wave is dead or gone.
Pulse.Message.AI.Encounter.Reset FPulseAIEncounterMessage Server 0 Sent when all players went far away, the respawn time after clearing ran out, Reset Encounter was called, or a load ended a running fight (then CatchUp = Load).

Pulse Build

Context: the actor that did it is Instigator (and Player when it is an actor of a player), the piece definition Source, the tags of the definition, of its tier and its category Tags, the location of the piece Location, the actor of the piece (else its cluster) Target.

Channel Payload Origin Amount Notes
Pulse.Message.Build.Placed FPulseBuildMessage Server 1 Instigator: the builder.
Pulse.Message.Build.Changed FPulseBuildMessage Server 1 Moved, upgraded, damaged, repaired or finished; comes before those messages.
Pulse.Message.Build.Completed FPulseBuildMessage Server 1 A construction site or an upgrade was finished.
Pulse.Message.Build.Upgraded FPulseBuildMessage Server New tier Only when the tier rises.
Pulse.Message.Build.Damaged FPulseBuildMessage Server Damage Not for the hit that destroys the piece.
Pulse.Message.Build.Repaired FPulseBuildMessage Server Health restored  
Pulse.Message.Build.Destroyed FPulseBuildMessage Server 1 By damage or decay; comes after Removed. Target: as for Removed.
Pulse.Message.Build.Removed FPulseBuildMessage Server 1 Target: the cluster that held the piece (none for actor pieces).
Pulse.Message.Build.Collapsed FPulseBuildCollapseMessage Server Pieces collapsed Module PulseBuildIntegrity. Source: the definition all pieces share (else none), Tags: those of all pieces, Location: their middle, no target.

Pulse Time

Sent on every machine: each computes the same clock. No player in the context.

Channel Payload Origin Amount Notes
Pulse.Message.Time.HourChanged FPulseTimeHourChangedMessage Both The hour, 0 to 23 Also once after the clock was set, skipped or loaded.
Pulse.Message.Time.DayChanged FPulseTimeDayChangedMessage Both Days since the first day, 1 for the first  
Pulse.Message.Time.SeasonChanged FPulseTimeSeasonChangedMessage Both 1 Tags: the new season.
Pulse.Message.Time.WeatherChanged FPulseTimeWeatherChangedMessage Both 1 Source: the weather state, Tags: its tag.
Pulse.Message.Time.Rested FPulseTimeRestedMessage Server Hours skipped Player, Target: the player who rested.
Pulse.Message.Time.RestStarted FPulseTimeRestedMessage Server Hours to skip A player fell asleep for a rest (tag Pulse.Time.State.Sleeping), the clocks jump next. One per sleeper; Player, Target: the sleeper.
Pulse.Message.Time.RestEnded FPulseTimeRestedMessage Server Hours skipped The clocks of a rest jumped and the player woke up. One per sleeper; Player, Target: the sleeper. Rested follows once the rest is done.
Pulse.Message.Time.Scheduled FPulseTimeScheduledMessage Both 1 Tags: the event. Daily events on every machine (bServerOnly: server), events of ScheduleAt on the server.

Pulse Time Regions

Add-on of Pulse Time. Deterministic on every machine, nothing replicated: each machine sends its own messages.

Channel Payload Origin Amount Notes
Pulse.Message.TimeRegions.WeatherChanged FPulseTimeRegionWeatherChangedMessage Both 1 Another weather began in the sequence of a weather region (without blending). Source: the weather state; Tags: the area tags of the region and the tag of the state. Payload: area id, sequence key, state, previous state. After a jump of the clock at most one per region; catch up Load after a load, Replication when a client receives the clock.
Pulse.Message.TimeRegions.ViewWeatherChanged FPulseTimeViewWeatherChangedMessage Client 1 Another weather leads at the camera of the first local player (regions blended into the weather of the world). Source: the state; Tags: its tag. Payload: state, previous state, blended values.

Pulse Faction

Player: the actor with the faction component when it is a player (else it is the target), Source: the faction definition, Tags: the faction tag.

Channel Payload Origin Amount Notes
Pulse.Message.Faction.ReputationChanged FPulseFactionReputationChangedMessage Server The change Only within the limits; a reward passes its context on.
Pulse.Message.Faction.RankChanged FPulseFactionRankChangedMessage Server The new rank index After ReputationChanged; bUp for a higher rank.
Pulse.Message.Faction.Joined FPulseFactionMembershipMessage Server 1 Players and NPCs (Start Factions too).
Pulse.Message.Faction.Left FPulseFactionMembershipMessage Server 1 Also when loading drops a membership.
Pulse.Message.Faction.RelationChanged FPulseFactionRelationChangedMessage Server 1 Tags: both factions. No player.

Pulse Faction Territory

Add-on of Pulse Faction. Context: the definition of the (new) owner is Source, the actor of the first loaded area of the territory Target and its center Location, the territory and the owner are in the tags. The server sends when it decides, clients when the replication arrives (a client that joins later with CatchUp = Replication); a load sends with CatchUp = Load. Exactly once per change and machine.

Channel Payload Origin Amount Notes
Pulse.Message.FactionTerritory.OwnerChanged FPulseFactionTerritoryMessage Both Influence of the new owner Another faction owns a territory, or it became neutral (empty owner). Payload: territory, owner, previous owner, contested, influence per faction.
Pulse.Message.FactionTerritory.ContestedChanged FPulseFactionTerritoryMessage Both Influence of the owner A territory became contested (players of two factions against each other inside) or is no longer contested. Payload as for OwnerChanged (previous owner = owner).

Pulse Codex

Player: the player state with the codex component, Source: the entry asset, Tags: the entry tag and its category.

Channel Payload Origin Amount Notes
Pulse.Message.Codex.Unlocked FPulseCodexEntryMessage Server 1 Through the API, a trigger, a discovery volume or a cheat; a trigger passes the context of its message on. Not for entries unlocked from the start.
Pulse.Message.Codex.Read FPulseCodexEntryMessage Server 1 The first time the player opens the entry.

Pulse Sound

Player: the pawn of the first local player (its controller without a pawn), Target: the actor of the ambience area, Source: the profile, Tags: the bed.

Channel Payload Origin Amount Notes
Pulse.Message.Sound.AmbienceChanged FPulseSoundAmbienceMessage Client 1 The listener of the first local player is in another ambience area (a Pulse area with the function Ambience), or its area plays another bed. Area, area id and bed empty outside every ambience area.
Pulse.Sound.Example.Event.ButtonPressed none Server 1 Only the example map: a player stepped on the bell button. Player and Instigator: the pawn, Target: the button.

Pulse World

Sent on the machine where the chunk changed: every machine loads its own chunks. Target: the chunk actor (empty for backends without actors), Source: the world definition, Location: the center of the chunk on the ground. No player in the context.

Channel Payload Origin Amount Notes
Pulse.Message.World.ChunkLoaded FPulseWorldChunkMessage Both 1 A chunk became active, also when it woke from sleep. Off with bSendChunkMessages.
Pulse.Message.World.ChunkUnloaded FPulseWorldChunkMessage Both 1 A chunk fell asleep or was removed.

Pulse Survival

Add-on of Pulse Gameplay. Hunger and thirst are attributes (Pulse.Stat.Hunger, Pulse.Stat.Thirst): on the server their bands come on Pulse.Message.Attribute.RangeChanged (Pulse Foundation, payload FPulseAttributeRangeMessage) with the attribute and the new band (Pulse.Survival.Band.*). Context of the own channel: Player and Target: the owner of the attribute source (pawn or player state of the local player), Instigator and Source of the change; a load or the first replication carries its catch-up.

Channel Payload Origin Amount Notes
Pulse.Message.Survival.BandChanged FPulseSurvivalBandMessage Client The value now Hunger, thirst or another band attribute (registered by add-ons and kits with RegisterBandAttribute) of a local player entered another band, on the machine of that player (clients too). Payload: attribute, old and new band (empty for none), value, max and bWorse (deeper than before). The warnings of the Set Up step Warnings are notification rules on it.

Pulse Combat Shooter

Add-on of Pulse Gameplay (shooter weapons). Context: Player and Instigator: the shooter (pawn), Amount: the rounds loaded.

Channel Payload Origin Amount Notes
Pulse.Message.CombatShooter.Reloaded FPulseShooterReloadedMessage Server Rounds loaded A reload of a shooter weapon ended. Payload: shooter, weapon tag, rounds loaded, rounds now in the magazine.

Pulse Combat Action

Add-on of Pulse Gameplay (parry, dodge, poise, stagger and counter). Payload FPulseCombatActionMessage (actor, other, reason, amount, duration). Context: Player: the actor (who parries, dodges, is staggered or counters), Instigator: the other, Amount: the damage of the hit, Tags: the reason.

Channel Payload Origin Amount Notes
Pulse.Message.CombatAction.ParryStarted FPulseCombatActionMessage Server 0 A parry started. Actor: the parrying combatant.
Pulse.Message.CombatAction.Parried FPulseCombatActionMessage Server Hit damage A hit landed in the parry window. Actor: the defender, Other: the attacker.
Pulse.Message.CombatAction.DodgeStarted FPulseCombatActionMessage Server 0 A dodge started. Actor: the dodging combatant.
Pulse.Message.CombatAction.Dodged FPulseCombatActionMessage Server Hit damage A hit landed in the invulnerability frames. Actor: the dodging combatant, Other: the attacker.
Pulse.Message.CombatAction.Staggered FPulseCombatActionMessage Server 0 A stagger started. Actor: the staggered combatant, Other: the instigator, Reason: Pulse.CombatAction.StaggerReason.* (Parried, PoiseBroken, Manual), Duration: seconds of the stagger.
Pulse.Message.CombatAction.StaggerEnded FPulseCombatActionMessage Server 0 A stagger ended. Actor: the staggered combatant.
Pulse.Message.CombatAction.CounterOpened FPulseCombatActionMessage Server 0 A counter window opened. Actor: the countering combatant, Other: the target, Duration: seconds of the window.
Pulse.Message.CombatAction.CounterHit FPulseCombatActionMessage Server Hit damage A counter hit landed. Actor: the countering combatant, Other: the target.

Pulse Combat Elements

Add-on of Pulse Gameplay (elemental build-up, stacks and status effects). Payload FPulseElementMessage. Context as Pulse.Message.Combat.*: Target, Instigator, Player, Amount: the stacks, Tags: the element and the damage type.

Channel Payload Origin Amount Notes
Pulse.Message.CombatElements.Applied FPulseElementMessage Server Stacks An element took hold on a target (its first stack). Payload: target, instigator, element, stacks, old stacks, seconds remaining.
Pulse.Message.CombatElements.StacksChanged FPulseElementMessage Server Stacks The stacks of an element on a target changed.
Pulse.Message.CombatElements.Expired FPulseElementMessage Server Stacks An element on a target ended; EndReason: Expired, Removed or Died.

Pulse Ping

Context: the sender’s controller is Player, the pinged actor the Target, the ping type in Tags (module PulsePing, add-on of Pulse Gameplay).

Channel Payload Origin Amount Notes
Pulse.Message.Ping.Sent FPulsePing Server Receivers Sender id and name, team, type, place and end on the server clock; sent after the rate limit and the team filter.

Pulse Farming

Add-on of PulseGameplay. Context: the player of the action is Player and Instigator (empty for the events of Pulse Sim: stage, waiting, withered), the bed actor Target while it is loaded, the crop Source, the crop tags and the stage tag the Tags, the place of the bed Location; events of a record that came from a save carry CatchUp = Load.

Channel Payload Origin Amount Notes
Pulse.Message.Farming.Planted FPulseFarmingCropMessage Server 1 A plant was sown into a farm bed. Payload: record id, crop, stage, ripe, harvests, location.
Pulse.Message.Farming.Watered FPulseFarmingCropMessage Server Water added A bed was watered (watering can, Water Area, a script); no player without a waterer.
Pulse.Message.Farming.StageReached FPulseFarmingCropMessage Server The stage A plant reached a stage (an event of Pulse Sim, also while the bed is unloaded); ripe in the payload.
Pulse.Message.Farming.Waiting FPulseFarmingCropMessage Server Stage it waits to enter The conditions of the next stage failed; sent once until the plant grows on.
Pulse.Message.Farming.Harvested FPulseFarmingCropMessage Server Items given A plant was harvested; the harvests in the payload count this one.
Pulse.Message.Farming.Withered FPulseFarmingCropMessage Server The stage A plant withered (dry too long) or rotted (ripe too long).
Pulse.Message.Farming.Cleared FPulseFarmingCropMessage Server Items given A bed was cleared; a withered plant gives its withered yield.

Pulse Dialog Barks

Add-on of Pulse Dialog. Instigator: the speaker, Target: the bark target (also Player when it is a player), Source: the bark set, Tags: the occasion (Pulse.Barks.Occasion.* or a tag of the game).

Channel Payload Origin Amount Notes
Pulse.Message.Barks.Played FPulseHeardBark Server Players who hear it A speaker barked: the line, the speaker, priority and end time.

Pulse Skill Perk Draft

Add-on of Pulse Skill. Context: the owner of the draft component is Player, the pool is Source; messages sent while save data is applied carry CatchUp = Load, offers that reach a client with its replication carry the replication catch-up.

Channel Payload Origin Amount Notes
Pulse.Message.SkillPerkDraft.Offered FPulseSkillPerkOfferedMessage Both Number of choices A player got an offer to pick from: shown or rerolled (server), or arrived (owning client). Tags: the skills offered. Payload: offer id, pool, choices, reroll number, source of the offer, offers still waiting.
Pulse.Message.SkillPerkDraft.Picked FPulseSkillPerkPickedMessage Server New rank A player picked a perk of an offer. Tags: the skill. Payload: skill, new rank, pool, offer id, source of the offer.

Pulse Camera Strategy

Add-on of Pulse Camera. No channels of its own: the strategy component has native and Blueprint events instead (On Zoom Step Changed); the camera is local.

Pulse Camera Cinematic

Add-on of Pulse Camera. Messages of a sequence are local to the machine of the player; Play reaches every machine through the message relay of the game state.

Channel Payload Origin Amount Notes
Pulse.Message.CameraCinematic.Play FPulseCameraCinematicPlayMessage Server 0 A server started a sequence for every player (Play Camera Shots For All, triggers with Server Only), relayed to all machines. Payload: the shot list (soft) and the server time of the start; each local player checks the viewers of the list and plays; messages older than Max Start Delay are dropped.
Pulse.Message.CameraCinematic.Started FPulseCameraCinematicShotMessage Client -1 A sequence started for a local player. Player: its pawn; Source: the shot list.
Pulse.Message.CameraCinematic.ShotStarted FPulseCameraCinematicShotMessage Client Index of the shot A shot started. Player: the pawn; Source: the shot list; Tags: the shot event of the shot.
Pulse.Message.CameraCinematic.Finished FPulseCameraCinematicFinishedMessage Client Index of the last shot A sequence ended. Payload: the list, the reason (Finished, Skipped, Interrupted) and the last shot.

Pulse Sound Surfaces

Add-on of Pulse Sound. No channels of its own: each play request of Pulse Sound carries FPulseSoundSurfaceHit in its payload (physical material, ending, speed).

Pulse Shaders

Context: the amount (Amount) as in the table; no player (shaders are local to the machine).

Channel Payload Origin Amount Notes
Pulse.Message.Shaders.WarmupStarted FPulseShaderWarmupMessage Client Open PSO compiles plus warmup set assets Shaders are prepared: why (first start, machine changed, requested, loading, none for background).
Pulse.Message.Shaders.WarmupFinished FPulseShaderWarmupMessage Client PSO compiles and warmup set assets done Preparing ended: seconds, and whether it stopped at the longest wait.
Pulse.Message.Shaders.Hitch FPulseShaderHitchMessage Client 1 A PSO was created while drawing and the frame waited (development builds): milliseconds, resource, pass, precache status.

Pulse Traversal

Context: player and target = the character, tags = the action, location = the edge, amount = height of the edge above the feet. Sent on the authority.

Channel Payload Origin Amount Notes
Pulse.Message.Traversal.ActionStarted FPulseTraversalActionMessage Server Height of the edge A mantle, vault, grab or climb up started.
Pulse.Message.Traversal.ActionFinished FPulseTraversalActionMessage Server Height of the edge The action ended; Phase Hanging after a grab.
Pulse.Message.Traversal.Dropped FPulseTraversalActionMessage Server Height of the edge The character let go of an edge.

Pulse Nav

Messages of the guide of a local player: on the player’s own machine only (routes of players never go to the server). Context: player = the pawn, source = the guide component, target = the destination actor (if any), location = the destination, amount = the length of the route (cm). Payload FPulseNavGuideMessage: destination, length, reason (Destination, DestinationMoved, Deviated) and the result of the search.

Channel Payload Origin Amount Notes
Pulse.Message.Nav.Guide.Started FPulseNavGuideMessage Client Length of the route The first route to a new destination arrived.
Pulse.Message.Nav.Guide.Rerouted FPulseNavGuideMessage Client Length of the new route A new route after the player left the old one or the destination actor moved (Reason).
Pulse.Message.Nav.Guide.Arrived FPulseNavGuideMessage Client Length of the route The player reached the destination.
Pulse.Message.Nav.Guide.Partial FPulseNavGuideMessage Client Length of the route The player reached the end of a partial route; it is not continued.
Pulse.Message.Nav.Guide.Failed FPulseNavGuideMessage Client Length of the old route, 0 without one A search failed; Result holds the reason (Pulse.Nav.Failure.*). A failed new route keeps the old one.
Pulse.Message.Nav.Guide.Cleared FPulseNavGuideMessage Client Length of the route The destination was cleared.

Messages of travellers (Pulse Sim records of the kind Nav Traveler), on the server. Context: source = the actor that shows the traveller while its place is loaded (none while unloaded), location = its place, amount = 1. Payload FPulseNavTravelMessage: the traveller id, the stop and its route point, the place, the game time, the generation of its route and a result. The stop action Send Message sends on its own channel with the same payload.

Channel Payload Origin Amount Notes
Pulse.Message.Nav.TravelStarted FPulseNavTravelMessage Server 1 A traveller started (Start Travel, a Travel Route actor).
Pulse.Message.Nav.StopReached FPulseNavTravelMessage Server 1 A traveller reached a stop; its actions run next.
Pulse.Message.Nav.StopLeft FPulseNavTravelMessage Server 1 A traveller left a stop after its wait and its actions.
Pulse.Message.Nav.Arrived FPulseNavTravelMessage Server 1 A Once travel reached the end of its route; loops never arrive.
Pulse.Message.Nav.Stuck FPulseNavTravelMessage Server 1 No route from where its actor left it to the rest of its way; Result holds why. It rests.
Pulse.Message.Nav.ActionFailed FPulseNavTravelMessage Server 1 An action of a stop failed (Result); the traveller waits and tries all actions again after Retry Seconds.

Pulse Sim Graph

Messages of Send Message nodes of Sim Graphs, on the server. Context: player = the player of the message that started the signal (On Message), source = the graph asset, location = the place of the record of the graph, tags and amount of the node (1 by default). Payload FPulseSimGraphMessage: the record, the graph, the Event of the node, its value as a number, name and tag, more values by name. A node may send on any channel of the game with the same payload.

Channel Payload Origin Amount Notes
Pulse.Message.SimGraph.Message FPulseSimGraphMessage Server Amount of the node The default channel of Send Message.
Pulse.Message.SimGraph.Example.Attack FPulseSimGraphMessage Server 1 Example map: raiders attack the harbor (SG_HarborThreat); Value is the number of attacks, tag Pulse.SimGraph.Example.Harbor.
Pulse.Message.SimGraph.Example.ShipArrived FPulseSimGraphMessage Server 1 Example map: the trade ship docked (SG_TradeShip); the storehouses fill up. Value is the number of visits.
Pulse.Message.SimGraph.Example.StorehouseEmpty FPulseSimGraphMessage Server 1 Example map: a storehouse ran empty (SG_Storehouse); Record is the storehouse.

Pulse Factory

Messages of factory groups (Pulse Sim records of the kind Factory Group), on the server. Produced, GroupStalled and GroupRunning come while the place of the group is loaded (queues); unloaded groups (rates) send only GroupStalled and GroupRunning when their state changes. Context: player = the player state of the owner of the group (when it has one), source = the Pulse Factory Machine component (while it is loaded), location = the machine (the middle of the group for group messages), amount = the pieces made (Produced). Payload FPulseFactoryMessage: group, machine key, node, machine definition, item, amount, coverage and game time.

Channel Payload Origin Amount Notes
Pulse.Message.Factory.Produced FPulseFactoryMessage Server Pieces of the output A machine finished a run; one message per output.
Pulse.Message.Factory.GroupStalled FPulseFactoryMessage Server 0 A group came to rest: nothing happens in it until it is changed or a buffer gets room.
Pulse.Message.Factory.GroupRunning FPulseFactoryMessage Server 0 A group that was at rest runs again.
Pulse.Message.Factory.PowerChanged FPulseFactoryMessage Server 0 The covered share of a power network changed (Coverage; Machine is its first machine).
Pulse.Message.Factory.ResearchStarted FPulseFactoryResearchMessage Server 0 A factory research started for its owner (Research Scope): in its labs over time, or paid at once (bInstant). Payload: research, owner, state, game time; Source: the research tree, no machine and no location.
Pulse.Message.Factory.ResearchCompleted FPulseFactoryResearchMessage Server 0 A factory research is done for its owner; its unlocks work and its rewards were granted. Context as ResearchStarted.
Pulse.Message.Factory.TrainStuck FPulseFactoryTrainMessage Server 0 A factory train has waited at a signal longer than Train Stuck Seconds; once per wait (display only, nothing reroutes). Payload: train, line, signal, seconds waited, the trains holding the block (Holders), bDeadlock; Location: the train, no source.

Pulse Factory Gameplay Bridge

The bridge sends one alert per player who should hear it. The server sends it and relays it to the owning client with UPulseMessageRelayComponent::RelayToOwner; server listeners hear one message per recipient. Context: player = that player, location = the place of the alert. Payload FPulseFactoryGameplayAlert.

Channel Payload Origin Amount Notes
Pulse.Message.FactoryGameplay.Alert FPulseFactoryGameplayAlert Server, relayed to the owner 0 A factory alert for one player: a factory stopped or runs again, power low or restored, a research started or completed, a train stuck or in a deadlock.

Pulse Factory Build Bridge

The server sends a message when a belt, pipe or cable piece stays unconnected after the bridge resolved its ends, once per new reason. Context: player and instigator = who placed or changed the piece, location = the piece. Payload FPulseFactoryBuildLinkMessage: the piece, its factory key, its kind and the reason.

Channel Payload Origin Amount Notes
Pulse.Message.FactoryBuild.LinkFailed FPulseFactoryBuildLinkMessage Server 0 A belt, pipe or cable piece stays unconnected (for example a free end or no port in reach).

Pulse Character

The look component broadcasts on every machine (Both): the server when it sets a look (a request, a cheat, a reset or a save), each client when the look arrives. Player and Instigator: the owner of the look component (the player state, or the pawn of an NPC); Source: the component; Tags: the slots whose part changed; Catch Up: Join for the start look, Replication for the first look a client receives, Load while a save is applied.

Channel Payload Origin Amount Notes
Pulse.Message.Character.LookChanged FPulseCharacterLookMessage Both 1 The look of a character changed. Payload: the component, the new look and the look before (descriptions only: body type, part ids per slot, values, colors, tags). Builders that have not found their look component yet bind on it.
Pulse.Message.Character.ChoiceMade FPulseCharacterChoiceMessage Both 1 A character made a choice (an origin, a class), one message per choice. Payload: the choice component and the choice (group and option); Tags: the group and the option. The server sends it when it grants the choice (rewards once) and with Catch Up Load when a save restores it (nothing granted again), clients when it arrives (Replication for the first choices).

Pulse Difficulty

Sent on the server (and in standalone) by the difficulty subsystem of the world. Clients read the level through the tuning of Pulse Foundation (Pulse.Message.Tuning.Changed with bDifficultyChanged). Context: Tags: the level now; Catch Up Load while a save is applied.

Channel Payload Origin Amount Notes
Pulse.Message.Difficulty.Changed FPulseDifficultyChangedMessage Server Rank of the level The level of the world or its custom values changed. Payload: the level before (OldLevel) and now (NewLevel), Rank, bCustom (custom values on). Personal values of a player and timed rules do not send it.

Your own channels

Register your channels the same way (Pulse::Messages::RegisterChannel, see Channel register), fill the context with what you know and give single events the amount 1. Two senders of Pulse Foundation send any channel: the cheat PulseMessageSend <Channel> (empty payload and context) and the relay component, which passes on what it is given.


PulseFoundation plugin documentation.

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