1. Epic GamesDeveloper
  3. UWaveFunctionCollapseSubsystem

UWaveFunctionCollapseSubsystem

API > API/Plugins > API/Plugins/WaveFunctionCollapse

   
Name UWaveFunctionCollapseSubsystem
Type class
Header File /Engine/Plugins/Experimental/WaveFunctionCollapse/Source/WaveFunctionCollapse/Public/WaveFunctionCollapseSubsystem.h
Include Path #include "WaveFunctionCollapseSubsystem.h"

Syntax

UCLASS ()  
class UWaveFunctionCollapseSubsystem : public UEditorSubsystem

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bUseEmptyBorder bool   WaveFunctionCollapseSubsystem.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="WFCSettings"
Orientation FRotator   WaveFunctionCollapseSubsystem.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="WFCSettings"
OriginLocation FVector   WaveFunctionCollapseSubsystem.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="WFCSettings"
Resolution FIntVector   WaveFunctionCollapseSubsystem.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="WFCSettings"
StarterOptions TMap< FIntVector, FWaveFunctionCollapseOption >   WaveFunctionCollapseSubsystem.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="WFCSettings"
WFCModel TObjectPtr< UWaveFunctionCollapseModel >   WaveFunctionCollapseSubsystem.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="WFCSettings"

Functions

Public

Name Remarks Include Path Unreal Specifiers

AActor * Collapse ( int32 TryCount,
int32 RandomSeed
)

 Solve a grid using a WFC model. If successful, spawn an actor. WaveFunctionCollapseSubsystem.h
  • BlueprintCallable
  • Category="WFCFunctions"

void DeriveGridFromTransformBounds ( const TArray< FTransform >& Transforms
)

 Derive grid from the bounds of an array of transforms Assumptions: -Transforms can only represent a single grid -Sets empty starter option if there is a valid grid position with no transform -Orientation is determined by the yaw of the first transform in the array WaveFunctionCollapseSubsystem.h
  • BlueprintCallable
  • Category="WFCFunctions"

void DeriveGridFromTransforms ( const TArray< FTransform >& Transforms
)

 Derive grid from an array of transforms Assumptions: -Every transform represents the center point of a tile position -Sets empty starter option if there is a valid grid position with no transform -Orientation is determined by the yaw of the first transform in the array WaveFunctionCollapseSubsystem.h
  • BlueprintCallable
  • Category="WFCFunctions"

void InitializeWFC ( TArray< FWaveFunctionCollapseTile >& Tiles,
TArray< int32 >& RemainingTiles
)

 Initialize WFC process which sets up Tiles and RemainingTiles arrays Pre-populates Tiles with StarterOptions, BorderOptions and InitialTiles WaveFunctionCollapseSubsystem.h
  • BlueprintCallable
  • Category="WFCFunctions"

bool ObservationPropagation ( TArray< FWaveFunctionCollapseTile >& Tiles,
TArray< int32 >& RemainingTiles,
TMap< int32, FWaveFunctionCollapseQueueElement >& ObservationQueue,
int32 RandomSeed
)

 Recursive Observation and Propagation cycle WaveFunctionCollapseSubsystem.h
  • BlueprintCallable
  • Category="WFCFunctions"

bool Observe ( TArray< FWaveFunctionCollapseTile >& Tiles,
TArray< int32 >& RemainingTiles,
TMap< int32, FWaveFunctionCollapseQueueElement >& ObservationQueue,
int32 RandomSeed
)

 Observation phase: This process randomly selects one tile from minimum entropy tiles then randomly selects a valid option for that tile WaveFunctionCollapseSubsystem.h
  • BlueprintCallable
  • Category="WFCFunctions"

bool Propagate ( TArray< FWaveFunctionCollapseTile >& Tiles,
TArray< int32 >& RemainingTiles,
TMap< int32, FWaveFunctionCollapseQueueElement >& ObservationQueue,
int32& PropagationCount
)

 Propagation phase: This process checks if the selection made during the observation is valid by checking constraint validity with neighboring tiles. WaveFunctionCollapseSubsystem.h
  • BlueprintCallable
  • Category="WFCFunctions"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page