Blueprint and C++ API reference

Blueprint categories are Pulse|Skill|.... Functions marked authority do nothing (or return false) on clients.

UPulseSkillComponent

Queries

Blueprint node C++ Description
Get Skill Rank GetSkillRank(Skill) Rank, 0 if locked.
Is Skill Unlocked IsSkillUnlocked(Skill) Rank ≥ 1.
Get Skill States K2_GetSkillStates() / GetSkillStates() All unlocked skills with ranks.
Find Skill FindSkill(Skill, OutTree) Definition and tree of a skill.
Find Skill Tree FindSkillTree(TreeTag) Tree of the component by tag.
Can Unlock Skill CanUnlockSkill(Skill) Would the next rank unlock? FPulseResult: success, or the reason and its text.
Can Refund Skill CanRefundSkill(Skill) Would the highest rank refund? FPulseResult.
Get Skill Points GetSkillPoints(PointTag) Available points.
Get Spent Skill Points GetSpentSkillPoints(PointTag) Spent points.
Get Points Spent In Tree GetPointsSpentInTree(Tree, PointTag) Points the unlocked ranks of a tree cost.
Get Ability System Component GetAbilitySystemComponent() Where the grants go.
Make Context MakeContext(Skill, Tree, Rank) Skill context of the conditions, costs, rewards and grants of a rank (Pulse::Skill::MakeContext turns it into the Pulse context).

Requests (client or authority)

Blueprint node C++ Description
Try Unlock Skill TryUnlockSkill(Skill) Unlock the next rank.
Try Refund Skill TryRefundSkill(Skill) Refund the highest rank.
Try Reset Tree TryResetTree(TreeTag) Respec a tree (clients need the setting).
Try Reset All Skills TryResetAllSkills() Respec everything (clients need the setting).
Request Skill Change (async node, UPulseSkillRequestAsyncAction) RequestSkillChange(Request, Callback) Any of the four (FPulseSkillRequest: action and tag) and wait for the result: On Success / On Failure with the FPulseResult.

Authority

Blueprint node C++ Description
Unlock Skill UnlockSkill(Skill) Check, pay, raise rank, give the rewards, apply grants; returns the FPulseResult.
Refund Skill RefundSkill(Skill) Refund the highest rank; returns the FPulseResult.
Reset Tree ResetTree(TreeTag, bRefundCosts) Set the skills of a tree to rank 0.
Reset All Skills ResetAllSkills(bRefundCosts) Set all skills to rank 0.
Set Skill Rank SetSkillRank(Skill, Rank) Set a rank without conditions, costs and rewards.
Add Skill Tree / Remove Skill Tree AddSkillTree(Tree) / RemoveSkillTree(Tree) Change the available trees.
Add Skill Points AddSkillPoints(PointTag, Amount) Add or remove available points.
Spend Skill Points / Refund Skill Points SpendSkillPoints / RefundSkillPoints Move points between available and spent.
Clear Skill State ClearSkillState() Remove all ranks, points and progression states.
Reapply Grants ReapplyGrants() Remove and apply all grants again.

Progression

See Progression. An empty progression tag means the default progression.

Blueprint node C++ Description
Find Progression FindProgression(ProgressionTag) Progression asset of the component.
Get Experience / Get Level GetExperience(ProgressionTag) / GetLevel(ProgressionTag) Current values (start level without state).
Get Experience For Level GetExperienceForLevel(ProgressionTag, Level) Total experience a level needs.
Get Level Progress GetLevelProgress(ProgressionTag) 0 to 1 towards the next level.
Is Max Level IsMaxLevel(ProgressionTag) No more levels can be gained.
Apply Experience Modifiers ApplyExperienceModifiers(ProgressionTag, Amount, SourceTag) Experience after the modifiers, without giving it.
Get Progression States K2_GetProgressionStates() / GetProgressionStates() Experience and level of all progressions with state.
Make Progression Context MakeProgressionContext(Progression, Level, SourceTag) Context for rewards and modifiers.
Add Experience (authority) AddExperience(ProgressionTag, Amount, SourceTag, bApplyModifiers) Give experience, raise levels, give rewards.
Set Level (authority) SetLevel(ProgressionTag, Level, bGiveRewards) Set a level directly.
Add Progression / Remove Progression (authority) AddProgression(Progression) / RemoveProgression(Progression) Change the progressions.

Ability system

Blueprint node C++ Description
Find Ability System Component FindAbilitySystemComponent() Overridable lookup (BlueprintNativeEvent).
Set Ability System Component SetAbilitySystemComponent(ASC) Move the grants to another ability system.
Refresh Ability System RefreshAbilitySystem() Look up the ability system again.

Save

Blueprint node C++ Description
Export Save Data ExportSaveData(OutData) State as FPulseSkillSaveData.
Import Save Data ImportSaveData(Data, OutReport) Replace the state; false for data of a newer version.
Save To Bytes SaveToBytes(OutBytes) State as bytes.
Load From Bytes LoadFromBytes(Bytes, OutReport) Replace the state from bytes.
Is Loading Save Data IsLoadingSaveData() True while a load applies its state (its events and messages come then).

Free functions: Pulse::Skill::SaveDataToBytes, Pulse::Skill::LoadDataFromBytes; checking save data without a component: Rules (C++).

Events

OnSkillRankChanged, OnSkillPointsChanged, OnRequestFailed (component, skill, FPulseResult), OnSkillTreesChanged, OnSkillStateChanged, OnAbilitySystemChanged, OnExperienceChanged, OnLevelChanged, each with a ...Native counterpart. See Skill component.

Rules (C++)

Pure functions in Pulse::Skill, without a world and without a component (game thread). See Core concepts.

Function Header Description
FindRank(Skills, Skill), FindEntryRank(Entries, Skill) Rules/PulseSkillRules.h Rank in a list of skill states or saved entries, 0 if none.
FindSkillInTrees(Trees, Skill, OutTree), FindTreeByTag(Trees, TreeTag) Rules/PulseSkillRules.h The first tree that has a skill; a tree by its tag.
FindMissingPrerequisite(Node, GetRank) Rules/PulseSkillRules.h First prerequisite of a node that is not met.
FindBlockingDependent(Trees, Skill, CurrentRank, GetRank) Rules/PulseSkillRules.h The unlocked skill (of any tree) that blocks a refund.
GetPointsSpentInTree(Tree, PointTag, GetRank) Rules/PulseSkillRules.h Skill points the unlocked ranks of a tree cost.
PlanUnlock(Trees, Skill, GetRank, RewardedRank, Owner) Rules/PulseSkillRules.h Unlock plan without the lists (tag, tree, highest rank, prerequisites).
CheckUnlockLists(Plan, State) Rules/PulseSkillRules.h Conditions, then costs of a plan’s rank; against a state view or the component of the context.
CheckUnlock(Trees, Skill, GetRank, RewardedRank, Owner), CheckUnlock(State, Skill, Owner) Rules/PulseSkillRules.h Everything CanUnlockSkill checks, with a component or against a state.
PlanRefund(Trees, Skill, GetRank, Owner), PlanRefund(State, Skill, Owner) Rules/PulseSkillRules.h Everything CanRefundSkill checks.
GetContextState(Context) Conditions/PulseSkillConditions.h The state view the skill entries of a context read, or null (also for a kept copy after its check).
FindProgressionByTag(Progressions, Tag), GetStartLevel(Progressions, Tag) Rules/PulseSkillProgressionRules.h A progression by tag; the level of a progression without state.
ApplyExperienceModifiers(Progression, Context, Amount) Rules/PulseSkillProgressionRules.h Experience after the modifiers.
CapExperience(Progression, Experience, Amount) Rules/PulseSkillProgressionRules.h Experience after adding, capped at the highest level, never lower.
NextLevelUp(Progression, Experience, Level) Rules/PulseSkillProgressionRules.h The next level the experience reaches, or unset.
GetExperienceForSetLevel(Progression, Level, Experience), NextSetLevelStep(Progression, Experience, Level, Target) Rules/PulseSkillProgressionRules.h The steps of SetLevel.
IsAtLevelCap(Progression, Level), GetLevelProgress(Progression, Experience, Level) Rules/PulseSkillProgressionRules.h Level queries.
BuildLoadState(Data, Trees, Progressions) Rules/PulseSkillLoadState.h Checked, clamped and migrated save data (FPulseSkillLoadPlan), false for a newer version.
CaptureState(Skills, Points, Progress, RewardedRanks) Rules/PulseSkillLoadState.h Live state as save data (what ExportSaveData writes).
DiffState(Old, New, Progressions) Rules/PulseSkillLoadState.h What differs between two states (FPulseSkillStateDiff).

UPulseSkillProgression

Blueprint node C++ Description
Get Experience For Level GetExperienceForLevel(Level) Total experience a level needs (MAX_int32 if it cannot be reached).
Get Level For Experience GetLevelForExperience(Experience) Level a total experience reaches.
Is Max Level IsMaxLevel(Level) Whether a level is the highest one.
Get Max Experience GetMaxExperience() Experience of the highest level.
Clamp Level ClampLevel(Level) Clamp between start and highest level.
Get Reward Descriptions GetRewardDescriptions(Level) Lines of the rewards of a level.

UPulseSkillDefinition

Blueprint node C++ Description
Get Max Rank GetMaxRank() Number of ranks.
Get Rank K2_GetRank(Rank, OutRank) / FindRank(Rank) Data of a rank (1-based).
— GetGrantsForRank(Rank, OutGrants) Grants that apply at a rank.

UPulseSkillTree

Blueprint node C++ Description
Find Node K2_FindNode(Skill, OutNode) / FindNode(Skill) Node of a skill.
Find Skill FindSkill(Skill) Skill asset of the tree.
Contains Skill ContainsSkill(Skill) Whether the tree has the skill.
Get Skill Tags GetSkillTags() Tags of all skills.
— GetDependentNodes(Skill, OutNodes) Nodes that need a skill.
— RebuildNodeMap() Rebuild the lookup after changing Nodes at runtime.

Extension base classes

Class Functions (BlueprintNativeEvent)
UPulseSkillGrant Apply(Context, Handles), Remove(Context, Handles), UpdateLevel(Context, Handles), GetDescription(), RequiresAbilitySystem(), NeedsReapply(Context, Handles)
UPulseSkillLevelCurve GetExperienceForLevel(Progression, Level)
UPulseSkillExperienceModifier GetMultiplier(Context), GetDescription()

Conditions, costs and rewards of ranks and level rewards are Pulse Foundation types (FPulseCondition, FPulseCost, FPulseReward); see Conditions, costs, rewards and grants.

Conditions, costs and rewards

Conditions/PulseSkillConditions.h:

Type Kind
FPulseCondition_SkillRank, FPulseCondition_SkillLevel, FPulseCondition_SkillTreePoints Conditions (category Skills); attributes: FPulseCondition_Attribute of Pulse Foundation
FPulseCost_SkillPoints Costs; attributes: FPulseCost_Attribute of Pulse Foundation
FPulseReward_SkillPoints, FPulseReward_Experience, FPulseReward_SkillTree, FPulseReward_SkillRank Rewards
FPulseSkillLevelRewardEntry Level filter (FromLevel, ToLevel, EveryNLevels, AppliesToLevel) and Rewards of a progression
C++ Description
Pulse::Skill::MakeContext(SkillContext) The Pulse context of a rank: owner as player, avatar as instigator, skill as source, its tag, the rank as amount, the skill context as extra data.
Pulse::Skill::MakeProgressionContext(ProgressionContext) The Pulse context of a level reward: owner, progression as source, level as amount, source tag.
Pulse::Skill::GetContextSkillComponent(Context) The skill component of a context (extra data, else the player’s).
Pulse::Skill::MakeConditionFailure(Conditions, Context), MakeCostFailure(Costs, Context) The failed FPulseResult of conditions that do not pass and of costs that cannot be paid.
Pulse::Skill::MakeFailure(Reason, Skill, Other, Rank) A failed FPulseResult with FPulseSkillFailureDetails for the placeholders of the reason text.
Pulse::Skill::MakeUnlockExchange(Plan), MakeUnlockResult(Plan, Result) The unlock of a plan as an FPulseExchange (conditions, costs, FPulseSkillExchangeStep_Rank, rewards; indices in Pulse::Skill::UnlockStep), and the skill result of its result (Rules/PulseSkillExchange.h).
FPulseSkillEventHold(Component) Holds the events of a skill component while it lives; they fire in their order when the outermost hold ends (HoldEvents / ReleaseEvents).

UPulseSkillLibrary

Blueprint node C++ Description
Get Skill Component GetSkillComponent(Actor) Component of a pawn, controller, player state or actor.
Get Rank Cost Descriptions GetRankCostDescriptions(Skill, Rank) Lines of the costs of a rank.
Get Rank Condition Descriptions GetRankConditionDescriptions(Skill, Rank) Lines of the conditions of a rank (was Get Rank Requirement Descriptions).
Get Rank Reward Descriptions GetRankRewardDescriptions(Skill, Rank) Lines of the rewards of a rank.
Add Experience AddExperience(Actor, ProgressionTag, Amount, SourceTag) Experience for the skill component of an actor (authority).

IPulseSkillOwnerInterface

Blueprint node C++ Description
Get Skill Component Execute_GetSkillComponent(Object) Returns the skill component of the actor.

PulseSkillUI widgets

See UI widgets.

Class Blueprint nodes
UPulseSkillMenuWidget Set Skill Component, Get Skill View Model, Select Tree, Get Selected Tree Tag, Set Tree Style
UPulseSkillTreeWidget Set Tree View Model, Set Skill Component, Set Tree Style, Set Layout, Find Node Widget, Get Node Widgets, Get Selected Node, Rebuild Tree, Center On Node, Fit To View, Set Zoom, Get Zoom
UPulseSkillNodeWidget Set Node View Model, Get Skill Tag, Get Node State, Set Tree Style, Get Owning Tree, Request Unlock, Request Refund
UPulseSkillNodeDetailsWidget Set Node View Model, Set Tree Style
UPulseSkillConnectionsWidget Set Connections, Get Connections, Set Connection Style
UPulseSkillTreeTabButton Set Tree View Model
UPulseSkillTreeLayout Compute Layout, Get Flow Direction (BlueprintNativeEvent); UPulseSkillTreeLayout_Layered, UPulseSkillTreeLayout_EditorPosition
UPulseSkillTreeStyle Get Node State Style, Format Rank
UPulseSkillUILibrary Open Skill Menu, Close Skill Menu, Toggle Skill Menu, Find Skill Menu (UI presenter, menu layer)

Theme roles and helpers (C++): Style/PulseSkillUITheme.h, namespace Pulse::Skill::UI (Tags::Button_Node*, Tags::Color_Node*, Tags::Color_Connection*, Tags::Brush_TreeBackground, GetNodeButtonRole, GetNodeIconTint, ApplyTextRole, WithThemeColors).

UI types: FPulseSkillNodeStateStyle, FPulseSkillConnectionStyle, FPulseSkillConnection, EPulseSkillConnectionState, EPulseSkillConnectionShape, EPulseSkillLayoutDirection, EPulseSkillLayoutAlignment.

Types

Type Description
FPulseSkillContext Component, ability system, owner, skill, tree, rank; StateView (C++ only, the state the skill entries read instead of the component).
FPulseSkillFailureDetails Details of a failed skill result: Skill, Other (another skill or what is missing) and Rank, the placeholders of the reason texts.
FPulseSkillRequest, EPulseSkillRequestAction A request of a client: the action (Unlock, Refund, ResetTree, ResetAll) and the skill or tree.
FPulseSkillPrerequisite Skill and MinRank of a tree node prerequisite.
FPulseSkillGrantHandles Ability spec handles, effect handles, loose tags, objects, attribute modifier keys and their actor of one grant.
FPulseSkillState Skill tag and rank (replicated).
FPulseSkillPointState Point tag, available and spent (replicated).
FPulseSkillProgressionState Progression tag, experience and level (replicated).
FPulseSkillProgressionContext Component, ability system, owner, progression, level, source tag.
FPulseSkillSaveData, FPulseSkillImportReport Save data and load report.
Pulse::Skill::FStateView (C++) A state as plain data (save data) with its trees and progressions, read by the rules and the skill entries. Valid while its data lives; never kept.
FPulseSkillRankPlan (C++) One planned rank step (unlock or refund): skill, tree path (TreePath, unique per tree) and tag, old and new rank, expected rewards, Result (success or why not), skill context.
FPulseSkillLoadPlan (C++) Result of BuildLoadState: accepted, the state to write, the report.
FPulseSkillStateDiff, FPulseSkillRankChange, FPulseSkillPointChange, FPulseSkillProgressChange (C++) Result of DiffState: ranks, pools and progressions that differ (not the rewarded ranks).
FPulseSkillRankChangedMessage, FPulseSkillPointsChangedMessage, FPulseSkillLevelChangedMessage, FPulseSkillExperienceGainedMessage Payloads of the message bus channels Pulse.Message.Skill.*.
EPulseReplicationMode (Pulse Foundation) Who receives the skill state: Default (the owning client), OwnerOnly, Everyone.

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