Skip to content

Blueprint API

This page lists all the blueprint functions available in the plugin

Updated 2021-01-30 05:10:17.367206

Tools

Asset Tools

Add Disable Edits Box

Image

Add a disable edits box to the world

Add Disable Edits Box Async

Image

Add a disable edits box to the world

Runs asynchronously

Create Data Asset from World Section

Image

Create Data Asset from World Section

Import Asset

Image

Add a voxel asset to the world: can be a data asset (eg imported from a mesh), or a graph asset

Will not provide the Previous Generator, so won't work with graphs that use it!

Unlike ImportAssetAsReference, this one copies the asset data into the world. Can be expensive for large assets. Use this if your asset is relatively small

Import Asset as Reference

Image

Add a voxel asset to the world: can be a data asset (eg imported from a mesh), or a graph asset

Cheap, unless there are edited voxels in the zone the asset is imported in

Will provide the PreviousGenerator to voxel graphs

Import Asset as Reference Async

Image

Add a voxel asset to the world: can be a data asset (eg imported from a mesh), or a graph asset

Cheap, unless there are edited voxels in the zone the asset is imported in

Will provide the PreviousGenerator to voxel graphs

Runs asynchronously

Import Asset Async

Image

Add a voxel asset to the world: can be a data asset (eg imported from a mesh), or a graph asset

Will not provide the Previous Generator, so won't work with graphs that use it!

Unlike ImportAssetAsReference, this one copies the asset data into the world. Can be expensive for large assets. Use this if your asset is relatively small

Import Data Asset Fast

Image

Specialization of ImportAsset for data assets with no scale nor rotation

Import Data Asset Fast Async

Image

Specialization of ImportAsset for data assets with no scale nor rotation

Import Modifier Asset

Image

Add a voxel modifier asset to the world. Should be a graph asset.

Unlike ImportAsset, this WILL provide the Previous Generator to the graph, so you can access the existing voxel value

Unlike ImportAssetAsReference, this one copies the asset data into the world. Can be expensive for large assets. Use this if your asset is relatively small

Import Modifier Asset Async

Image

Add a voxel asset to the world: can be a data asset (eg imported from a mesh), or a graph asset

Will not provide the Previous Generator, so won't work with graphs that use it!

Unlike ImportAssetAsReference, this one copies the asset data into the world. Can be expensive for large assets. Use this if your asset is relatively small

Invert Data Asset

Image

Invert Data Asset

Set Data Asset Material

Image

Set Data Asset Material

Box Tools

Add Box

Image

Add a box shape

See: AddBox, AddBoxAsync and FVoxelBoxToolsImpl::AddBox

Add Box Async

Image

Add a box shape

Runs asynchronously in a background thread

See: AddBox, AddBoxAsync and FVoxelBoxToolsImpl::AddBox

Remove Box

Image

Remove a box shape

See: RemoveBox, RemoveBoxAsync and FVoxelBoxToolsImpl::RemoveBox

Remove Box Async

Image

Remove a box shape

Runs asynchronously in a background thread

See: RemoveBox, RemoveBoxAsync and FVoxelBoxToolsImpl::RemoveBox

Set Material Box

Image

Paint a box shape

See: SetMaterialBox, SetMaterialBoxAsync and FVoxelBoxToolsImpl::SetMaterialBox

Set Material Box Async

Image

Paint a box shape

Runs asynchronously in a background thread

See: SetMaterialBox, SetMaterialBoxAsync and FVoxelBoxToolsImpl::SetMaterialBox

Set Value Box

Image

Set the density in a box

See: SetValueBox, SetValueBoxAsync and FVoxelBoxToolsImpl::SetValueBox

Set Value Box Async

Image

Set the density in a box

Runs asynchronously in a background thread

See: SetValueBox, SetValueBoxAsync and FVoxelBoxToolsImpl::SetValueBox

Cubic

Get Cubic Voxel Position from Hit

Image

Use bSelectVoxelOutside to choose which voxel to select, between the two sides of the face hit

Get Cubic Voxel Value

Image

Get Cubic Voxel Value

Set Cubic Voxel Value

Image

Set Cubic Voxel Value

Data

Clear Unused Materials

Image

Remove materials that do not affect the surface. Same visual result but will lead to better compression.

Digging will look different.

Clear Unused Materials Async

Image

Remove materials that do not affect the surface. Same visual result but will lead to better compression.

Digging will look different.

Find Closest Non Empty Voxel

Image

Finds the closest voxel to Position that is not empty

This is useful to do edits, or to query the material at a position

Find Closest Non Empty Voxel Async

Image

Finds the closest voxel to Position that is not empty

This is useful to do edits, or to query the material at a position

Get Compressed Save

Image

Get a save of the world and compress it

Get Compressed Save Async

Image

Get a save of the world and compress it

Get Interpolated Density

Image

Get the density at Position

Get Material

Image

Get the material at Position

Get Material Async

Image

Get the material at Position

Get Save

Image

Get a save of the world

Get Save Async

Image

Get a save of the world

Get Density

Image

Get the density at Position

Get Density Async

Image

Get the density at Position

Get Voxels Value and Material

Image

Read a large number of voxels at a time

Get Voxels Value and Material Async

Image

Read a large number of voxels at a time, asynchronously

Load from Compressed Save

Image

Load from a compressed save

Load from Save

Image

Load from a save

Round Voxels

Image

Round voxels that don't have an impact on the surface. Same visual result but will lead to better compression

Round Voxels Async

Image

Round voxels that don't have an impact on the surface. Same visual result but will lead to better compression

Set Material

Image

Set the material at Position

Set Material Async

Image

Set the material at Position

Set Density

Image

Set the density at Position

Set Density Async

Image

Set the density at Position

Level Tools

Level

Image

Stamps a cylinder, to quickly level parts of the world

If additive, will stamp a smooth cylinder above Position. Else will remove one below Position

See: Level, LevelAsync and FVoxelLevelToolsImpl::Level

Level Async

Image

Stamps a cylinder, to quickly level parts of the world

If additive, will stamp a smooth cylinder above Position. Else will remove one below Position

Runs asynchronously in a background thread

See: Level, LevelAsync and FVoxelLevelToolsImpl::Level

Mesh Importer

Convert Mesh to Voxels

Image

Convert Mesh to Voxels

Convert Mesh to Voxels No Materials

Image

Convert Mesh to Voxels No Materials

Create Mesh Data from Static Mesh

Image

Create Mesh Data from Static Mesh

Create Texture from Material

Image

Create Texture from Material

Projection Tools

Create Surface Voxels from Hits

Image

For some surface tools you'll need to use CreateSurfaceVoxelsFromHitsWithExactValues instead

Create Surface Voxels from Hits with Exact Values

Image

Will store the voxel values

Find Projection Voxels

Image

Find voxels using linetraces

Find Projection Voxels Async

Image

Find voxels using linetraces, asynchronously

Get Hits Average Normal

Image

Get Hits Average Normal

Get Hits Average Position

Image

Get Hits Average Position

Get Hits Positions

Image

Get Hits Positions

Sphere Tools

Add Sphere

Image

Add a sphere

See: AddSphere, AddSphereAsync and FVoxelSphereToolsImpl::AddSphere

Add Sphere Async

Image

Add a sphere

Runs asynchronously in a background thread

See: AddSphere, AddSphereAsync and FVoxelSphereToolsImpl::AddSphere

Apply Kernel Sphere

Image

Apply a 3x3x3 kernel

See: ApplyKernelSphere, ApplyKernelSphereAsync and FVoxelSphereToolsImpl::ApplyKernelSphere

Apply Kernel Sphere Async

Image

Apply a 3x3x3 kernel

Runs asynchronously in a background thread

See: ApplyKernelSphere, ApplyKernelSphereAsync and FVoxelSphereToolsImpl::ApplyKernelSphere

Apply Material Kernel Sphere

Image

Apply a 3x3x3 kernel to the materials

See: ApplyMaterialKernelSphere, ApplyMaterialKernelSphereAsync and FVoxelSphereToolsImpl::ApplyMaterialKernelSphere

Apply Material Kernel Sphere Async

Image

Apply a 3x3x3 kernel to the materials

Runs asynchronously in a background thread

See: ApplyMaterialKernelSphere, ApplyMaterialKernelSphereAsync and FVoxelSphereToolsImpl::ApplyMaterialKernelSphere

Remove Sphere

Image

Remove a sphere

See: RemoveSphere, RemoveSphereAsync and FVoxelSphereToolsImpl::RemoveSphere

Remove Sphere Async

Image

Remove a sphere

Runs asynchronously in a background thread

See: RemoveSphere, RemoveSphereAsync and FVoxelSphereToolsImpl::RemoveSphere

Remove Sphere with Durability

Image

Removes all the voxels in a sphere, if their single index is contained in Internal (Min <= Index <= Max)

Mainly intended for the cubic mode

See: RemoveSphereWithDurability, RemoveSphereWithDurabilityAsync and FVoxelSphereToolsImpl::RemoveSphereWithDurability

Remove Sphere with Durability Async

Image

Removes all the voxels in a sphere, if their single index is contained in Internal (Min <= Index <= Max)

Mainly intended for the cubic mode

Runs asynchronously in a background thread

See: RemoveSphereWithDurability, RemoveSphereWithDurabilityAsync and FVoxelSphereToolsImpl::RemoveSphereWithDurability

Revert Sphere

Image

Reverts the voxels inside a sphere shape to a previous frame in the undo history.

Can be used to "paint" the undo history

NOTE: Does not work with bMultiThreaded and does not fill ModifiedValues!

See: RevertSphere, RevertSphereAsync and FVoxelSphereToolsImpl::RevertSphere

Revert Sphere Async

Image

Reverts the voxels inside a sphere shape to a previous frame in the undo history.

Can be used to "paint" the undo history

NOTE: Does not work with bMultiThreaded and does not fill ModifiedValues!

Runs asynchronously in a background thread

See: RevertSphere, RevertSphereAsync and FVoxelSphereToolsImpl::RevertSphere

Revert Sphere to Generator

Image

Reverts the voxels inside a sphere shape to their generator value

NOTE: Does not work with bMultiThreaded and does not fill ModifiedValues!

See: RevertSphereToGenerator, RevertSphereToGeneratorAsync and FVoxelSphereToolsImpl::RevertSphereToGenerator

Revert Sphere to Generator Async

Image

Reverts the voxels inside a sphere shape to their generator value

NOTE: Does not work with bMultiThreaded and does not fill ModifiedValues!

Runs asynchronously in a background thread

See: RevertSphereToGenerator, RevertSphereToGeneratorAsync and FVoxelSphereToolsImpl::RevertSphereToGenerator

Set Material Sphere

Image

Paint material in a sphere shape

See: SetMaterialSphere, SetMaterialSphereAsync and FVoxelSphereToolsImpl::SetMaterialSphere

Set Material Sphere Async

Image

Paint material in a sphere shape

Runs asynchronously in a background thread

See: SetMaterialSphere, SetMaterialSphereAsync and FVoxelSphereToolsImpl::SetMaterialSphere

Set Value Sphere

Image

Set the density in a sphere

See: SetValueSphere, SetValueSphereAsync and FVoxelSphereToolsImpl::SetValueSphere

Set Value Sphere Async

Image

Set the density in a sphere

Runs asynchronously in a background thread

See: SetValueSphere, SetValueSphereAsync and FVoxelSphereToolsImpl::SetValueSphere

Smooth Material Sphere

Image

Smooth materials in a sphere

See: SmoothMaterialSphere, SmoothMaterialSphereAsync and FVoxelSphereToolsImpl::SmoothMaterialSphere

Smooth Material Sphere Async

Image

Smooth materials in a sphere

Runs asynchronously in a background thread

See: SmoothMaterialSphere, SmoothMaterialSphereAsync and FVoxelSphereToolsImpl::SmoothMaterialSphere

Smooth Sphere

Image

Smooth a sphere

See: SmoothSphere, SmoothSphereAsync and FVoxelSphereToolsImpl::SmoothSphere

Smooth Sphere Async

Image

Smooth a sphere

Runs asynchronously in a background thread

See: SmoothSphere, SmoothSphereAsync and FVoxelSphereToolsImpl::SmoothSphere

Trim Sphere

Image

Trim tool: used to quickly flatten large portions of the world

Best results are obtained when Position and Normal are averages: use FindProjectionVoxels to do some linetraces, and then GetAveragePosition/Normal on the result

This ensures the tool usage is relatively smooth.

Works by stamping a shape into the world (if bAdditive = false, the stamp is destructive: voxels are removed instead)

The shape is the smooth union of a sphere SDF and a plane SDF. The smoothness of the union is controlled by the Falloff parameter.

See: TrimSphere, TrimSphereAsync and FVoxelSphereToolsImpl::TrimSphere

Trim Sphere Async

Image

Trim tool: used to quickly flatten large portions of the world

Best results are obtained when Position and Normal are averages: use FindProjectionVoxels to do some linetraces, and then GetAveragePosition/Normal on the result

This ensures the tool usage is relatively smooth.

Works by stamping a shape into the world (if bAdditive = false, the stamp is destructive: voxels are removed instead)

The shape is the smooth union of a sphere SDF and a plane SDF. The smoothness of the union is controlled by the Falloff parameter.

Runs asynchronously in a background thread

See: TrimSphere, TrimSphereAsync and FVoxelSphereToolsImpl::TrimSphere

Surface Edit Tools

Edit Voxel Materials

Image

Apply paint material to the processed voxels, using the processed strengths

See: ApplyStack, AddToStack

See: EditVoxelMaterials, EditVoxelMaterialsAsync and FVoxelSurfaceEditToolsImpl::EditVoxelMaterials

Edit Voxel Materials Async

Image

Apply paint material to the processed voxels, using the processed strengths

Runs asynchronously in a background thread

See: ApplyStack, AddToStack

See: EditVoxelMaterials, EditVoxelMaterialsAsync and FVoxelSurfaceEditToolsImpl::EditVoxelMaterials

Edit Voxel Values

Image

Apply processed voxels strengths to the voxel values

See: ApplyStack, AddToStack

See: EditVoxelValues, EditVoxelValuesAsync and FVoxelSurfaceEditToolsImpl::EditVoxelValues

Edit Voxel Values Async

Image

Apply processed voxels strengths to the voxel values

Runs asynchronously in a background thread

See: ApplyStack, AddToStack

See: EditVoxelValues, EditVoxelValuesAsync and FVoxelSurfaceEditToolsImpl::EditVoxelValues

Propagate Voxel Materials

Image

Propagate the materials of the voxels, so that the new surface is painted correctly

Must be called BEFORE EditVoxelValues!

See: ApplyStack, AddToStack

See: PropagateVoxelMaterials, PropagateVoxelMaterialsAsync and FVoxelSurfaceEditToolsImpl::PropagateVoxelMaterials

Propagate Voxel Materials Async

Image

Propagate the materials of the voxels, so that the new surface is painted correctly

Must be called BEFORE EditVoxelValues!

Runs asynchronously in a background thread

See: ApplyStack, AddToStack

See: PropagateVoxelMaterials, PropagateVoxelMaterialsAsync and FVoxelSurfaceEditToolsImpl::PropagateVoxelMaterials

Surface Tools

Add to Stack

Image

Add to Stack

Apply Constant Strength

Image

Apply a constant strength to the surface voxels

Apply Falloff

Image

Apply a falloff to surface voxels, based on their distance from a point.

Apply Flatten

Image

Make surface voxels go towards a plane

Important: if bExactDistanceField = true, this node should be called last! Modifying strengths after it will result

in glitchy behavior

Apply Stack

Image

Apply Stack

Apply Stack Async

Image

Apply Stack Async

Apply Strength Curve

Image

Apply a strength curve to surface voxels, based on their distance from a point:

Strength = Curve.SampleAt(Distance(Voxel.Position, Center) / Radius)

Apply Strength Mask

Image

Apply a strength mask to surface voxels, based on their position projected onto a plane

Apply Terrace

Image

Apply terracing

Debug Surface Voxels

Image

Debug Surface Voxels

Find Surface Voxels

Image

Find voxels that are on the surface. Faster than FindSurfaceVoxelsFromDistanceField, but the values won't be exact distances

Find Surface Voxels 2D

Image

Find voxels that are on the surface. Only keep the one with the surface right above them that are facing up. If 2 surface voxels have the same X Y, will only keep the one with the higher Z

Find Surface Voxels 2DAsync

Image

Find voxels that are on the surface. Only keep the one with the surface right above them that are facing up. If 2 surface voxels have the same X Y, will only keep the one with the higher Z

Find Surface Voxels Async

Image

Find voxels that are on the surface. Faster than FindSurfaceVoxelsFromDistanceField, but the values won't be exact distances

Find Surface Voxels from Distance Field

Image

Find voxels that are on the surface using an exact computation of the distance field using the GPU

Get Bounds

Image

Get Bounds

Get Strength Mask Scale

Image

Compute the scale for ApplyStrengthMask from a wanted size

Tick Data

Deproject

Image

Deproject

Get Axis

Image

Get Axis

Get Ray Direction

Image

Get Ray Direction

Get Ray Origin

Image

Get Ray Origin

Is Alternative Mode

Image

Is Alternative Mode

Is Key Down

Image

Is Key Down

Base

Get Modified Voxel Materials Bounds

Image

Get Modified Voxel Materials Bounds

Get Modified Voxel Values Bounds

Image

Get Modified Voxel Values Bounds

Nodes

Apply

Image

Apply

Disable Tool

Image

Call this to delete any tool preview actors

Enable Tool

Image

Call this to do some initial setup

Will be called in the first tool tick if you don't

Get Tool Name

Image

Get Tool Name

Get Voxel World

Image

Get Voxel World

AdvancedTick

Image

K2 Advanced Tick

SimpleTick

Image

Tick the tool

Make Tool Axes

Image

Make Tool Axes

Make Tool Keys

Image

Make Tool Keys

Make Voxel Tool

Image

Make Voxel Tool

Make Voxel Tool Tick Data

Image

Make Voxel Tool Tick Data

Create Default Tools

Image

If bLoadBlueprints is true, all the blueprints inheriting from VoxelTool will be force loaded

If false, tools whose blueprints are not loaded won't show up

Get Active Tool

Image

Get Active Tool

Get Tools

Image

Get Tools

Get Shared Config

Image

K2 Get Shared Config

Set Active Tool

Image

Set Active Tool

Set Active Tool by Class

Image

Set Active Tool by Class

Set Active Tool by Name

Image

Set Active Tool by Name

Utilities

Add Neighbors to Set

Image

Add Neighbors to Set

Get Render Bounds Overlapping Data Bounds

Image

eg if you want to cache all the data that's going to be used by render chunks when updating the world

Make Int Box from Global Position and Radius

Image

Make IntBox from global position and radius

Math

Int Vector

IntVector + IntVector

Image

Add Int Vector Int Vector

IntVector / int

Image

Divide Int Vector Int

Get Max

Image

Get Max Intvector

Get Min

Image

Get Min Intvector

int * IntVector

Image

Multiply Int Int Vector

IntVector * int

Image

Multiply Int Vector Int

IntVector * IntVector

Image

Multiply Int Vector Int Vector

IntVector - IntVector

Image

Substract Int Vector Int Vector

Voxel Int Box

Add Box

Image

Add Box

Add Point

Image

Add Point

Apply Transform

Image

Apply Transform

Break Int Box

Image

Breaks an Int Box

Break Int Box with Validity

Image

Break Int Box with Validity

Center

Image

Will move the box so that GetCenter = 0,0,0. Will extend it if its size is odd

Contains

Image

Contains

Equal (VoxelIntBox)

Image

Equal Equal Int Box Int Box

Extend

Image

Extend

Extend Int Vector

Image

Extend Int Vector

Get Center

Image

Get Center

Get Corners

Image

Get Corners

Get Size

Image

Get Size

Infinite Box

Image

Infinite Box

Intersect

Image

Intersect

Is Int Vector Inside Box

Image

Is Int Vector Inside Box

Is Valid

Image

Is Valid

Is Vector Inside Box

Image

Is Vector Inside Box

Make Box from Local Position and Radius

Image

From -Radius(included) to Radius(excluded)

Make Box from Position and Radius

Image

Make Box from Position and Radius

Make Int Box

Image

Makes an Int Box. Min must be <= to Max

Make Int Box from Points

Image

Make Int Box from Points

Make Int Box with Validity

Image

Make Int Box with Validity

NotEqual (VoxelIntBox)

Image

Not Equal Int Box Int Box

Overlap

Image

Overlap

Remove Translation

Image

Remove Translation

Scale

Image

Scale

Translate Box

Image

Translate Box

Random

Get Halton 1D

Image

Get Halton 1D

Get Halton 2D

Image

Get Halton 2D

Get Halton 3D

Image

Get Halton 3D

Get Unit Vector from Random

Image

Generates a random position on the unit sphere, given some random input between 0 and 1

Make Halton Stream

Image

Make Halton Stream

Reset Halton Stream

Image

Reset Halton Stream

Render

Apply LOD Settings

Image

Call this after changing the voxel world LODs setting while created

Apply New Materials

Image

Call this after changing a voxel world VoxelMaterial/MaterialCollection to apply it

Get Task Count

Image

Number of processing tasks not finished

Is Voxel World Foliage Loading

Image

Returns true if there are still foliage tasks queued

Is Voxel World Mesh Loading

Image

Returns true if there are still mesh tasks queued

Recreate

Image

Call this to recreate the voxel world entirely, optionally keeping data intact by saving it

Recreate Render

Image

Call this to recreate the voxel world rendering entirely, keeping data intact

Recreate Spawners

Image

Call this to recreate the voxel world spawners

Update All

Image

Update all the chunks

Update Bounds

Image

Update the chunks overlapping Bounds.

Update Position

Image

Update the chunks overlapping Position

Materials

Apply Paint Material

Image

Apply a Paint Material to a Voxel Material

Create RGB Paint Material

Image

Create from color

Create Five Way Blend Paint Material

Image

Create paint material for 5 way blend

Create Multi Index Paint Material

Image

Create for multi index

Create Multi Index Raw Paint Material

Image

Create for multi index, setting the data directly

Create Multi Index Wetness Paint Material

Image

Create for multi index wetness

Create Single Index Paint Material

Image

Create for single index

Create UV Paint Material

Image

Create UV paint

Get Color

Image

Get Color

Get Multi Index

Image

If SortByStrength is true, Index 0 will have the highest strength, Index 1 the second highest etc

Get Raw Material

Image

Get Raw Material

Get Single Index

Image

Get Single Index

Get UV

Image

Get UV

Make Color Material

Image

Make Color Material

Make Material Mask

Image

Make Material Mask

Make Raw Material

Image

Make Raw Material

Make Single Index Material

Image

Make Single Index Material

Collisions

Are Collisions Enabled

Image

Returns whether voxel collisions are enabled at Position

Are Voxel Collisions Frozen

Image

Are Voxel Collisions Frozen

Set Voxel Collisions Frozen

Image

Set Voxel Collisions Frozen

Proc Gen

Bind Voxel Chunk Events

Image

Bind Voxel Chunk Events

Bind Voxel Generation Event

Image

Bind Voxel Generation Event

Data

Cache

Cache Materials

Image

Cache the materials in the bounds

Cache Materials Async

Image

Cache the materials in the bounds

Cache Values

Image

Cache the values in the bounds

Cache Values Async

Image

Cache the values in the bounds

Clear Cached Materials

Image

Clear Cached Materials

Clear Cached Materials Async

Image

Clear Cached Materials Async

Clear Cached Values

Image

Clear Cached Values

Clear Cached Values Async

Image

Clear Cached Values Async

Save

Compress Voxel Save

Image

Compress Voxel Save

Decompress Voxel Save

Image

Decompress Voxel Save

Nodes

Clear All Data

Image

Clear all the data in the world, including items/assets

Clear Dirty Data

Image

Clear all the edited data in the world, excluding items/assets

Clear Material Data

Image

Clear all the material data in the world

Clear Value Data

Image

Clear all the value data in the world

Get Bounds

Image

Bounds of this world

Get Float Output

Image

Get a custom float output value

Get Int Output

Image

Get a custom int32 output value

Get Normal

Image

Get the normal at Position using the density gradient. May differ from the mesh normal

Has Material Data

Image

Has Material Data

Has Value Data

Image

Has Value Data

Scale Data

Image

Scale the voxel world data. Will recreate the voxel world!

Check for Single Materials

Image

Check for Single Materials

Check for Single Materials Async

Image

Check for Single Materials Async

Check for Single Values

Image

Check for Single Values

Check for Single Values Async

Image

Check for Single Values Async

Check if Same as Generator

Image

Will undirty the chunks identical to the generator

Check if Same as Generator Async

Image

Will undirty the chunks identical to the generator

Compress Into Heightmap

Image

If the voxel generator is a heightmap or if an heightmap asset is provided,

will update the heightmap to the max Z surface in the voxel world

Will not edit the data: RoundToGenerator should be called after for best results

Round to Generator

Image

Will revert the values who don't have a voxel neighbor with a different sign from the generator value

Will ignore items when computing generator values

Round to Generator Async

Image

Will revert the values who don't have a voxel neighbor with a different sign from the generator value

Will ignore items when computing generator values

Set Box as Dirty

Image

Set Box as Dirty

Set Box as Dirty Async

Image

Set Box as Dirty Async

Undo Redo

Clear Frames

Image

Clear all the frames. bEnableUndoRedo must be true

Get History Position

Image

Get the current history position

Redo

Image

Redo last undone frame. bEnableUndoRedo must be true, and SaveFrame must have been called after any edits

Save Frame

Image

Save the edits since the last call to SaveFrame/Undo/Redo and clear the redo stack. bEnableUndoRedo must be true

Undo

Image

Undo last frame. bEnableUndoRedo must be true, and SaveFrame must have been called after any edits

Texture Pool

Compact Voxel Texture Pool

Image

Will compact the texture pool used by the greedy mesher, reducing fragmentation & memory usage

See: stat VoxelTexturePool

Voxel Texture

Create or Update Texture from Voxel Color Texture

Image

Will create Texture if null, and set it

Returns Texture for convenience

Texture will have the following config:

Pixel format: PF_B8G8R8A8

Compression settings: TC_VectorDisplacementmap

SRGB: false

Filter: TF_Bilinear

Create or Update Texture from Voxel Float Texture

Image

Will create Texture if null, and set it

Returns Texture for convenience

Texture will have the following config:

Pixel format: PF_R32_FLOAT

Compression settings: TC_HDR

SRGB: false

Filter: TF_Bilinear

Create Texture from Voxel Color Texture

Image

Same as CreateOrUpdateTextureFromVoxelFloatTexture with nullptr in input

Texture will have the following config:

Pixel format: PF_B8G8R8A8

Compression settings: TC_VectorDisplacementmap

SRGB: false

Filter: TF_Bilinear

Create Texture from Voxel Float Texture

Image

Same as CreateOrUpdateTextureFromVoxelFloatTexture with nullptr in input

Texture will have the following config:

Pixel format: PF_R32_FLOAT

Compression settings: TC_HDR

SRGB: false

Filter: TF_Bilinear

Create Voxel Color Texture from Voxel Float Texture

Image

Creates a voxel color texture by putting a float texture into a specific channel

Create Voxel Float Texture from Texture Channel

Image

Creates a voxel float texture from the color channel of a texture

Get Voxel Color Texture Size

Image

Get Voxel Color Texture Size

Get Voxel Float Texture Size

Image

Get Voxel Float Texture Size

Is Voxel Color Texture Valid

Image

Is Voxel Color Texture Valid

Is Voxel Float Texture Valid

Image

Is Voxel Float Texture Valid

Maximum

Image

Apply the photoshop Maximum filter

Set each pixel to the max value in a radius Radius

Minimum

Image

Apply the photoshop Minimum filter

Set each pixel to the min value in a radius Radius

Tool Rendering

Create Tool Rendering

Image

Create Tool Rendering

Destroy Tool Rendering

Image

Destroy Tool Rendering

Is Valid Ref

Image

Is Valid Ref

Set Tool Rendering Bounds

Image

Bounds: In world space

Set Tool Rendering Enabled

Image

Set Tool Rendering Enabled

Set Tool Rendering Material

Image

Set Tool Rendering Material

Helpers

Get All Voxel Worlds Containing Position

Image

Iterate all voxel worlds in the scene, and return all the ones that contains Position

Get All Voxel Worlds Overlapping Actor

Image

Iterate all voxel worlds in the scene, and return all the ones that overlaps the actor bounding box

Get All Voxel Worlds Overlapping Box

Image

Iterate all voxel worlds in the scene, and return all the ones that overlaps Box

Get Voxel World Containing Position

Image

Iterate all voxel worlds in the scene, and return the first one that contains Position

Get Voxel World Overlapping Actor

Image

Iterate all voxel worlds in the scene, and return the first one that overlaps the actor bounding box

Get Voxel World Overlapping Box

Image

Iterate all voxel worlds in the scene, and return the first one that overlaps Box

Transform Global Box to Voxel Box

Image

Transform a box in global space to voxel space

Transform Voxel Box to Global Box

Image

Transform a box in voxel space to global space

Memory

Get Estimated Collisions Memory Usage in MB

Image

Returns the memory used by positions and indices buffers in this voxel world

Should give a rough estimate of how much memory is used for physics

Get Memory Usage in MB

Image

Get the current memory usage of different parts of the plugin

Get Peak Memory Usage in MB

Image

Get the peak memory usage of different parts of the plugin

Log Memory Stats

Image

Log Memory Stats

Get Data Memory Usage in MB

Image

Get Data Memory Usage in MB

Threads

Get Number Of Voxel Threads

Image

Get Number Of Voxel Threads

Set Number Of Voxel Threads

Image

Number of threads allocated for the voxel background processing. Setting it too high may impact performance

The threads are shared across all voxel worlds

Can be set using voxel.threading.NumThreads

Voxel Interval

Contains

Image

Interval Contains Float

Contains

Image

Interval Contains Int 32

Spawners

Mark Spawners Dirty

Image

Mark spawners as dirty so that they don't get trash if they go out of scope

Regenerate Spawners

Image

IVoxelFoliageInterface helpers

// Regenerate spawners in an aera

Coordinates

Recompute Component Positions

Image

Update the voxel component positions

Get Neighboring Positions

Image

Get the 8 neighbors in voxel space of GlobalPosition

World Position to Voxel

Image

Convert position from world space to voxel space

World Bounds to Voxel

Image

K2 Global to Local Bounds

World Position to Voxel Float

Image

K2 Global to Local Float

Voxel Position to World

Image

Convert position from voxel space to world space

Voxel Bounds to World

Image

K2 Local to Global Bounds

Voxel Position to World Float

Image

K2 Local to Global Float

Add Event

Voxel Placeable Item Manager

Event On Clear

Image

On Clear

Event On Generate

Image

On Generate

Voxel

Event Init Chunk

Image

Init Chunk

Nodes

Event Initialize Collection

Image

Initialize Collection

Event AddItemToWorld

Image

K2 Add Item to World

Event AddItemToWorld

Image

K2 Add Item to World

Event Tick

Image

Called first, before DoEdit and UpdateRender

Note: Tick is a BlueprintImplementableEvent. The native Tick will always be called before.

Event UpdateRender

Image

Might not always be called - if you want to compute things for the frame, use Tick

Cooking

Cook Voxel Data

Image

Cook collision meshes and save the result to VoxelCookedData

Can then be loaded using LoadCookedVoxelData

Useful for servers

Cook Voxel Data with Save

Image

Cook collision meshes and save the result to VoxelCookedData

Can then be loaded using LoadCookedVoxelData

Useful for servers

Load Cooked Voxel Data

Image

Loads collision cooked with CookVoxelData

The voxel world must not be created: it won't ever be created, collision meshes will be loaded directly

Note: Only the voxel world collision settings will be applied

Useful for servers

Make Voxel Cooking Settings from Voxel World

Image

Make Voxel Cooking Settings from Voxel World

Data Asset

Get Bounds

Image

Get Bounds

Get Size

Image

Get Size

Voxel Data Item Actor

Schedule Refresh

Image

Schedule Refresh

Debug

Debug Voxels Inside Bounds

Image

Debug Voxels Inside Bounds

Draw Data Octree

Image

Draw Data Octree

Draw Debug Int Box

Image

Draw Debug Int Box

Erosion

Get Sediment Texture

Image

Get Sediment Texture

Get Terrain Height Texture

Image

Get Terrain Height Texture

Get Water Height Texture

Image

Get Water Height Texture

Initialize

Image

Initialize

Is Initialized

Image

Is Initialized

Step

Image

Step

Generators

Is Valid

Image

Is Valid

Create Color Texture from Generator

Image

Creates a color texture by reading a color output from a generator

Create Color Texture from Generator Async

Image

Creates a color texture by reading a color output from a generator, asynchronously

Create Float Texture from Generator

Image

Creates a float texture by reading a float output from a generator

Create Float Texture from Generator Async

Image

Creates a float texture by reading a float output from a generator, asynchronously

Is Valid

Image

Is Valid Generator Picker

Is Valid

Image

Is Valid Transformable Generator Picker

Make Generator Instance

Image

Creates a new generator instance. Consider using VoxelWorld->GetGeneratorCache()->MakeGeneratorInstance instead

Make Generator Picker from Class

Image

See: MakeGeneratorPickerFromObject

Make Generator Picker from Object

Image

See: MakeGeneratorPickerFromClass, MakeTransformableGeneratorPickerFromObject

Make Transformable Generator Instance

Image

Creates a new transformable generator instance. Consider using VoxelWorld->GetGeneratorCache()->MakeTransformableGeneratorInstance instead

Make Transformable Generator Picker from Class

Image

See: MakeTransformableGeneratorPickerFromObject, MakeGeneratorPickerFromClass

Make Transformable Generator Picker from Object

Image

See: MakeTransformableGeneratorPickerFromClass, MakeGeneratorPickerFromObject

Set Generator Parameter

Image

Set a voxel generator parameter

Set Transformable Generator Parameter

Image

Set a voxel generator parameter

Is Valid

Image

Is Valid

Heightmap Asset

Get Height

Image

Get Height

Get Width

Image

Get Width

Voxel Helpers

Create Proc Mesh Plane

Image

Create Proc Mesh Plane

Invoker

Refresh All Voxel Invokers

Image

Refresh All Voxel Invokers

Material Collection

Get Index Material

Image

Get Index Material

Get Material Index

Image

Get the material index from a material or a layer name

Get Materials

Image

Used by paint material customization. Some materials might be null.

Multiplayer

Tcp

Connect to Server

Image

Connect to a TCP server

Start Server

Image

Start a TCP server

Nodes

Create Multiplayer Interface Instance

Image

Create Multiplayer Interface Instance

Get Multiplayer Interface Instance

Image

Get Multiplayer Interface Instance

Voxel Placeable Item Manager

Add Data Item

Image

Do not call this directly: call the respective Add Data Item instead!

Draw Debug Line

Image

Draws a line in the world & in the voxel graph preview

Draw Debug Point

Image

Draws a point in the world & in the voxel graph preview

Get Generator Cache

Image

Get Generator Cache

Placeable Items

Add Worms

Image

Add Worms

Test

Read Values

Image

Read Values

Test Values

Image

Test Values

Tool

Transform

Get Tool Direction

Image

Get Tool Direction

Get Tool Normal

Image

Get Tool Normal

Get Tool Position

Image

Get Tool Position

Get Tool Preview Position

Image

Get Tool Preview Position

Render

Set Tool Overlay Bounds

Image

Set Tool Overlay Bounds

Update Tool Mesh

Image

Note: Material will not be updated if the mesh did not change

Nodes

Can Edit

Image

Can Edit

Get Bounds to Cache

Image

Will also debug them

Get Delta Time

Image

Delta time accounting for the skipped frame waiting for updates

Get Last Frame Tick Data

Image

Get Last Frame Tick Data

Get Mouse Movement Size

Image

Get Mouse Movement Size

Get Tick Data

Image

Get Tick Data

Get Value After Axis Input

Image

Get Value After Axis Input

Last Frame Can Edit

Image

Last Frame Can Edit

Voxel Tool Library

Update Sphere Overlay Material

Image

Update Sphere Overlay Material

General

Create World

Image

Create World

Destroy World

Image

Destroy World

Get Generator Cache

Image

The generator cache allows to reuse generator objects

This is required for DataItemActors to allow for smaller update when moving them

Get Generator Init

Image

Used to init generators

Is Created

Image

Is this world created?

Is Loaded

Image

Has the VoxelRenderer finished loading?

Set Generator Class

Image

Set Generator Class

Set Generator Object

Image

Set Generator Object

Collision

Set Collision Response to Channel

Image

Can be called at runtime

World Size

Set Render Octree Chunk Size

Image

Set Render Octree Chunk Size

Set Render Octree Depth

Image

Set Render Octree Depth

Set World Size

Image

Set World Size

Nodes

Is Voxel Plugin Pro

Image

Is Voxel Plugin Pro

Number Of Cores

Image

Returns the number of cores the CPU has. Ignores hyperthreading unless -usehyperthreading is passed as a command line argument.

Raise Error

Image

Raise Error

Raise Info

Image

Raise Info

Raise Warning

Image

Raise Warning

Make Generator Instance

Image

Creates (or reuse if possible) a new generator instance

Among other things, this is required for DataItemActors to reuse generators, which allows for smaller update when moving them

Make Transformable Generator Instance

Image

Creates (or reuse if possible) a new generator instance

Among other things, this is required for DataItemActors to reuse generators, which allows for smaller update when moving them

Apply Voxel Size

Image

Apply Voxel Size

Set Scene

Image

Set Scene

Apply Voxel Physics

Image

Apply voxel physics in a section of the voxel world by removing floating parts

Make Voxel Line Trace Parameters

Image

Make voxel line trace parameters