Navigation
API > API/Plugins > API/Plugins/PCG
| Name | UPCGSettingsInterface |
| Type | class |
| Header File | /Engine/Plugins/PCG/Source/PCG/Public/PCGSettings.h |
| Include Path | #include "PCGSettings.h" |
Syntax
UCLASS (MinimalAPI, Abstract)
class UPCGSettingsInterface : public UPCGData
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UPCGData → UPCGSettingsInterface
Derived Classes
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| TypeInfo | FPCGDataTypeInfoSettings | PCGSettings.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bBreakDebugger | bool | If a debugger is attached, a breakpoint will be triggered in the execution code to enable debugging. | PCGSettings.h |
|
| bDebug | bool | PCGSettings.h |
|
|
| bDisplayDebuggingProperties | bool | This can be set false by inheriting nodes to hide the debugging properties. | PCGSettings.h |
|
| bEnabled | bool | PCGSettings.h |
|
|
| bIsInspecting | bool | Whether the Inspect feature is active on the node corresponding to this settings. | PCGSettings.h | |
| bNodeToolActive | bool | Whether the respective viewport tool (if any) is actively running in the viewport. | PCGSettings.h | |
| DebugSettings | FPCGDebugVisualizationSettings | PCGSettings.h |
|
|
| OnSettingsChangedDelegate | FOnPCGSettingsChanged | PCGSettings.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bMarkedForManualEditing | bool | Saved to the graph asset so viewport editing markers survive across sessions. | PCGSettings.h |
|
| bTemporaryManualEditingEnabled | bool | Set while the user is actively viewport-editing this node. | PCGSettings.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool IsInstance() |
PCGSettings.h | ||
bool IsMarkedForManualEditing() |
Whether this node is persistently marked for manual editing. | PCGSettings.h | |
bool IsTemporaryManualEditingEnabled() |
Whether this node has manual edit access in the viewport. | PCGSettings.h | |
bool SetDebugged
(
bool bInDebugged |
Dedicated method to change debug state because some nodes have more complex behavior on enable/disable (such as reroutes). | PCGSettings.h | |
void SetEnabled
(
bool bInEnabled |
Dedicated method to change enable state because some nodes have more complex behavior on enable/disable (such as subgraphs) | PCGSettings.h | |
void SetMarkedForManualEditing
(
bool bInMarked |
Marks the node for permanent access to manual edit in the viewport. | PCGSettings.h | |
void SetTemporaryManualEditingEnabled
(
bool bInEnabled |
Marks the node for a one-shot pass of manual edit in the viewport. | PCGSettings.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanBeDebugged() |
Whether this element supports Debug and Inspect features. | PCGSettings.h | |
virtual bool CanBeDisabled() |
Whether this element can be disabled. | PCGSettings.h | |
virtual UPCGSettings * GetSettings () |
PCGSettings.h | ||
virtual const UPCGSettings * GetSettings () |
PCGSettings.h |
Overridden from UPCGData
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EPCGDataType GetDataType() |
@todo_pcg To be deprecated when we switch to the new type | PCGSettings.h | |
virtual const FPCGDataTypeBaseId & GetDataTypeId() |
PCGSettings.h |