1. Epic GamesDeveloper
  3. UPCGBlueprintHelpers

UPCGBlueprintHelpers

API > API/Plugins > API/Plugins/PCG

   
Name UPCGBlueprintHelpers
Type class
Header File /Engine/Plugins/PCG/Source/PCG/Public/Helpers/PCGBlueprintHelpers.h
Include Path #include "Helpers/PCGBlueprintHelpers.h"

Syntax

UCLASS (MinimalAPI)  
class UPCGBlueprintHelpers : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static int ComputeSeedFromPosition ( const FVector& InPosition
)

   Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Helpers"

static UPCGData * CreatePCGDataFromActor ( AActor* InActor,
bool bParseActor
)

   Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Helpers"
  • Meta=(ScriptMethod)

static UPCGData * DuplicateData ( const UPCGData* InData,
UPARAM(ref) FPCGContext& Context,
bool bInitializeMetadata
)

 Prefer using DuplicateDataWithContext Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Temporary"
  • Meta=(ScriptMethod)

static UPCGData * DuplicateDataWithContext ( const UPCGData* InData,
const FPCGBlueprintContextHandle& ContextHandle,
bool bInitializeMetadata
)

 Implementation note: Needs to be done outside of UPCGData because of circular dependency between PCGContext.h and PCGData.h. Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Data"
  • Meta=(ScriptMethod)

static bool FlushPCGCache ()

 Flush the cache, to be used if you have changed something PCG depends on at runtime. Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG"
  • Meta=(DisplayName="Flush PCG Cache")

static FBox GetActorBoundsPCG ( AActor* InActor,
bool bIgnorePCGCreatedComponents
)

   Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Helpers"
  • Meta=(ScriptMethod)

static UPCGData * GetActorData ( UPARAM(ref) FPCGContext& Context
)

 Prefer using GetActorDataWithContext Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Temporary"
  • Meta=(ScriptMethod)

static UPCGData * GetActorDataWithContext ( const FPCGBlueprintContextHandle& ContextHandle
)

   Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Helpers"
  • Meta=(ScriptMethod)

static FBox GetActorLocalBoundsPCG ( AActor* InActor,
bool bIgnorePCGCreatedComponents
)

   Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Helpers"
  • Meta=(ScriptMethod)

static UPCGComponent * GetComponent ( UPARAM(ref) FPCGContext& Context
)

 Prefer using GetComponentWithContext Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Temporary"
  • Meta=(ScriptMethod)

static UPCGComponent * GetComponentWithContext ( const FPCGBlueprintContextHandle& ContextHandle
)

   Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Helpers"
  • Meta=(ScriptMethod)

static FVector GetExtents ( const FPCGPoint& InPoint
)

   Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Points"
  • Meta=(ScriptMethod)

static UPCGData * GetInputData ( UPARAM(ref) FPCGContext& Context
)

 Prefer using GetInputDataWithContext Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Temporary"
  • Meta=(ScriptMethod)

static UPCGData * GetInputDataWithContext ( const FPCGBlueprintContextHandle& ContextHandle
)

   Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Helpers"
  • Meta=(ScriptMethod)

static TArray< FPCGLandscapeLayerWeight > GetInterpolatedPCGLandscapeLayerWeights ( UObject* WorldContextObject,
const FVector& Location
)

   Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Helpers"
  • Meta=(WorldContext="WorldContextObject")

static FVector GetLocalCenter ( const FPCGPoint& InPoint
)

   Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Points"
  • Meta=(ScriptMethod)

static UPCGComponent * GetOriginalComponent ( UPARAM(ref) FPCGContext& Context
)

 Prefer using GetOriginalComponentWithContext Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Temporary"
  • Meta=(ScriptMethod)

static UPCGComponent * GetOriginalComponentWithContext ( const FPCGBlueprintContextHandle& ContextHandle
)

   Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Helpers"
  • Meta=(ScriptMethod)

static FRandomStream GetRandomStreamFromPoint ( const FPCGPoint& InPoint,
const UPCGSettings* OptionalSettings,
const UPCGComponent* OptionalComponent
)

 Creates a random stream from a point's seed and settings/component's seed (optional) Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Helpers"
  • Meta=(ScriptMethod)

static FRandomStream GetRandomStreamFromTwoPoints ( const FPCGPoint& InPointA,
const FPCGPoint& InPointB,
const UPCGSettings* OptionalSettings,
const UPCGComponent* OptionalComponent
)

 Creates a random stream from using the random seeds from two points, as well as settings/component's seed (optional) Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Helpers"
  • Meta=(ScriptMethod)

static const UPCGSettings * GetSettings ( UPARAM(ref) FPCGContext& Context
)

 Prefer using GetSettingsWithContext Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Helpers"
  • Meta=(ScriptMethod)

static const UPCGSettings * GetSettingsWithContext ( const FPCGBlueprintContextHandle& ContextHandle
)

   Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Helpers"
  • Meta=(ScriptMethod)

static AActor * GetTargetActor ( UPARAM(ref) FPCGContext& Context,
UPCGSpatialData* SpatialData
)

 Prefer using GetTargetActorWithContext Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Temporary"
  • Meta=(ScriptMethod)

static AActor * GetTargetActorWithContext ( const FPCGBlueprintContextHandle& ContextHandle,
UPCGSpatialData* SpatialData
)

   Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Helpers"
  • Meta=(ScriptMethod)

static int64 GetTaskId ( UPARAM(ref) FPCGContext& Context
)

 Prefer using GetTaskIdWithContext Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Temporary"
  • Meta=(ScriptMethod)

static int64 GetTaskIdWithContext ( const FPCGBlueprintContextHandle& ContextHandle
)

   Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Helpers"
  • Meta=(ScriptMethod)

static FBox GetTransformedBounds ( const FPCGPoint& InPoint
)

   Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Points"
  • Meta=(ScriptMethod)

static void RefreshPCGRuntimeComponent ( UPCGComponent* InComponent,
const bool bFlushCache
)

 Refresh a component set to Generate At Runtime, if some parameters changed. Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Runtime"
  • Meta=(ScriptMethod, DisplayName="Refresh PCG Runtime Component")

static void SetExtents ( UPARAM(ref) FPCGPoint& InPoint,
const FVector& InExtents
)

   Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Points"
  • Meta=(ScriptMethod)

static void SetLocalCenter ( UPARAM(ref) FPCGPoint& InPoint,
const FVector& InLocalCenter
)

   Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Points"
  • Meta=(ScriptMethod)

static void SetSeedFromPosition ( UPARAM(ref) FPCGPoint& InPoint
)

   Helpers/PCGBlueprintHelpers.h
  • BlueprintCallable
  • Category="PCG|Helpers"

static void ThrowBlueprintException ( const FText& ErrorMessage
)

   Helpers/PCGBlueprintHelpers.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page