1. Epic GamesDeveloper
  3. UWaveFunctionCollapseSubsystem

UWaveFunctionCollapseSubsystem

API > API/Plugins > API/Plugins/WaveFunctionCollapse

Inheritance Hierarchy

References

   
Module WaveFunctionCollapse
Header /Engine/Plugins/Experimental/WaveFunctionCollapse/Source/WaveFunctionCollapse/Public/WaveFunctionCollapseSubsystem.h
Include #include "WaveFunctionCollapseSubsystem.h"

Syntax

UCLASS&40;&41;  
class UWaveFunctionCollapseSubsystem : public UEditorSubsystem

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bUseEmptyBorder  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FRotator Orientation  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FVector OriginLocation  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FIntVector Resolution  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TMap< FIntVector, FWaveFunctionCollapseOption > StarterOptions  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TObjectPtr< UWaveFunctionCollapseModel > WFCModel  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category AActor *

Collapse ( int32 TryCount,
int32 RandomSeed
)

 Solve a grid using a WFC model. If successful, spawn an actor.
Public function UFunction BlueprintCallable, Category 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
Public function UFunction BlueprintCallable, Category 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
Public function UFunction BlueprintCallable, Category 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
Public function UFunction BlueprintCallable, Category bool

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

 Recursive Observation and Propagation cycle
Public function UFunction BlueprintCallable, Category 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
Public function UFunction BlueprintCallable, Category 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page