Navigation
API > API/Plugins > API/Plugins/PCG
A call stack, represented as an array of stack frames.
| Name | FPCGStack |
| Type | struct |
| Header File | /Engine/Plugins/PCG/Source/PCG/Public/Graph/PCGStackContext.h |
| Include Path | #include "Graph/PCGStackContext.h" |
Syntax
USTRUCT ()
struct FPCGStack
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Graph/PCGStackContext.h | |||
| Graph/PCGStackContext.h | |||
PRAGMA_DISABLE_DEPRECATION_WARNINGS FPCGStack () |
Disable deprecation warnings on the rule of 5 because of the Timer member. To be removed when that that member is removed. | Graph/PCGStackContext.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Timer | PCGUtils::FCallTime | Used to store node & hierarchy information | Graph/PCGStackContext.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| GraphExecutionTaskId | FPCGTaskId | Graph/PCGStackContext.h | ||
| StackFrames | TArray< FPCGStackFrame > | Graph/PCGStackContext.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool BeginsWith
(
const FPCGStack& Other |
Returns true if given stack is a prefix of this stack. | Graph/PCGStackContext.h | |
| Construct a string version of this stack. Postfixed by optional node/pin if provided. | Graph/PCGStackContext.h | ||
FPCGCrc GetCrc() |
Graph/PCGStackContext.h | ||
const UPCGNode * GetCurrentFrameNode() |
If current frame (top of stack) corresponds to a node returns that node, otherwise returns null. | Graph/PCGStackContext.h | |
FPCGTaskId GetGraphExecutionTaskId() |
Returns root graph execution id | Graph/PCGStackContext.h | |
const UPCGGraph * GetGraphForCurrentFrame() |
Gets the graph from the graph frame closest to the top of the stack (most recent), or null if no such graph present. | Graph/PCGStackContext.h | |
const UPCGGraph * GetNearestDynamicSubgraphForCurrentFrame() |
Walks up the stack to find nearest dynamic subgraph frame and if found returns the graph. | Graph/PCGStackContext.h | |
const UPCGGraph * GetNearestNonInlinedGraphForCurrentFrame() |
Walks up the stack to find the nearest non-inlined graph (either dynamic subgraph or the top graph). | Graph/PCGStackContext.h | |
const UPCGNode * GetNodeForCurrentFrame() |
Gets the node from the node frame closest to the top of the stack (most recent), or null if no such node present. | Graph/PCGStackContext.h | |
uint32 GetNumGraphLevels() |
Returns how many graphs the stack contains (top level graph stacks will return 1). | Graph/PCGStackContext.h | |
const UPCGComponent * GetRootComponent() |
Component given by first stack frame. | Graph/PCGStackContext.h | |
const UPCGGraph * GetRootGraph
(
int32* OutRootFrameIndex |
First (top) graph frame in stack (or null if no graph frames present). | Graph/PCGStackContext.h | |
const IPCGGraphExecutionSource * GetRootSource() |
Execution source given by first stack frame. | Graph/PCGStackContext.h | |
const TArray< FPCGStackFrame > & GetStackFrames() |
Graph/PCGStackContext.h | ||
TArray< FPCGStackFrame > & GetStackFramesMutable() |
Graph/PCGStackContext.h | ||
bool HasObject
(
const UObject* InObject |
Stack has a frame corresponding to the given object. | Graph/PCGStackContext.h | |
bool IsCurrentFrameInRootGraph() |
Returns true if this stack is the top level/root graph, rather than in a subgraph. | Graph/PCGStackContext.h | |
void PopFrame() |
Pop frame from the stack. | Graph/PCGStackContext.h | |
| Graph/PCGStackContext.h | |||
void PushFrame
(
const FPCGStackFrame& Frame |
Push frame onto top of stack. | Graph/PCGStackContext.h | |
void PushFrame
(
int32 FrameLoopIndex |
Graph/PCGStackContext.h | ||
| Graph/PCGStackContext.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FPCGStack& Other |
Graph/PCGStackContext.h | ||
| Graph/PCGStackContext.h | |||
| Graph/PCGStackContext.h | |||
bool operator==
(
const FPCGStack& Other |
Graph/PCGStackContext.h |