← Back to Documentation Index

---

VoxyBPFLibrary Blueprint Function Reference

This document provides an overview of the Blueprint-exposed functions in UVoxyBPFLibrary. These functions are designed to be used within Unreal Engine Blueprints to interact with Voxy assets and components.

VoxySettingVoxelSize

Returns: int

• Gets the current voxel size from plugin settings.

VoxyCreateRuntimeVoxyAssetActor

Parameters:

• UObject* Owner
• FVector Position
• FIntVector Size

Returns: AVoxyAssetActor*

Creates a runtime Voxy asset actor at the specified position and size.

VoxyCreateRuntimeVoxyAsset

Parameters:

• UObject* Owner
• FIntVector Size

Returns: UVoxyAsset*

Creates a runtime Voxy asset with the given size.

VoxyGetAllVoxyMeshComponents

Parameters:

• UObject* Owner

Returns: TArray<UVoxyMeshComponent*>
Returns all Voxy mesh components in the same world as the owner.

VoxyUpdateMesh

Parameters:

• UVoxyMeshComponent* Component

Updates the mesh data and synchronizes with the render thread.

VoxyClearVoxels

Parameters:

• UVoxyMeshComponent* Component

Clears all voxels in the component's asset.

VoxyUpdateCollisionAsync

Parameters:

• UVoxyMeshComponent* Component

Updates collision asynchronously using GPU readback.

VoxyUpdateCollision

Parameters:

• UVoxyMeshComponent* Component

Updates collision synchronously on the CPU.

VoxyUpdateCollisionBatch

Parameters:

• TArray<UVoxyMeshComponent*> Components

Batch updates collision for multiple components asynchronously.

VoxyAddVoxel

Parameters:

• UVoxyMeshComponent* Component
• FVector Position
• int BrushSize
• EVoxyShapeType::Type Shape
• uint8 ColorIndex
• bool IsLocal

Adds a voxel at the specified position in World or Local space.

VoxyGetVoxelList

Parameters:

• const UVoxyMeshComponent* Component

Returns: TArray<FVoxyVoxel>
Returns a list of all voxels in the component.

VoxyGetVoxelListOfColorIndex

Parameters:

• const UVoxyMeshComponent* Component
• uint8 ColorIndex

Returns: TArray<FVoxyVoxel>
Returns voxels with the specified color index.

VoxyGetColorIndex

Parameters:

• UVoxyMeshComponent* Component
• FVector Position
• bool IsLocal

Returns: uint8
Gets the Voxel color index at a position in world or local space.

VoxyGetColor

Parameters:

• UVoxyMeshComponent* Component
• FVector Position
• bool IsLocal

Returns: uint8
Gets the Voxel color at a position in world or local space.

VoxyAddVoxelBulk

Parameters:

• UVoxyMeshComponent* Component
• TArray<FVector> Positions
• uint8 ColorIndex
• bool IsLocal

Adds multiple voxels at the given position in world or local space.

VoxyUpdateVoxyMeshFromData

Parameters:

• UVoxyMeshComponent* Component

Resets and updates the mesh from asset data.

VoxyRemoveVoxel

Parameters:

• UVoxyMeshComponent* Component
• FVector Position
• int BrushSize
• EVoxyShapeType::Type Shape
• bool IsLocal

Removes a voxel at the given position in world or local space.

VoxyRemoveVoxelButThisColor

Parameters:

• UVoxyMeshComponent* Component
• FVector Position
• int BrushSize
• EVoxyShapeType::Type Shape
• TArray<uint8> ColorList
• bool IsLocal

Removes voxels at the given position in world or local space except those with specified colors.

VoxyDestroyVoxels

Parameters:

• UVoxyMeshComponent* Component
• FVector Position
• int BrushSize
• EVoxyShapeType::Type Shape
• bool IsLocal

Destroys voxels at the given position in world or local space.

VoxyRayCast

Parameters:

• UVoxyMeshComponent* Component
• FVector RayOrigin
• FVector RayDirection

Returns: FVoxyHitResult
Performs a raycast against the component's voxels.

VoxyReload

Parameters:

• UVoxyMeshComponent* Component

• Reloads and updates the mesh from asset data.

VoxyPlayRaisingUp

Parameters:

• UVoxyMeshComponent* Component
• FVector MinBound
• FVector MaxBound

Plays the raising up animation in the specified bounds.

VoxyPlaySandFall

Parameters:

• UVoxyMeshComponent* Component

Plays the sand fall animation.

VoxySandFallAfterVoxelDestroyed

Parameters:

• UVoxyMeshComponent* Component

Plays sand fall after voxel destruction.

VoxyApplyHeightMap

Parameters:

• UVoxyMeshComponent* Component
• UTexture* HeightMap
• TArray<uint8> ColorList
• float Offset
• float Scale

Applies a height map to the mesh.

VoxyApplySmooth

Parameters:

• UVoxyMeshComponent* Component
• float Erosion
• float Smoothness

Applies smoothing to the mesh.

VoxyApplyNoise

Parameters:

• UVoxyMeshComponent* Component
• FVector Scale
• FVector Offset
• float Threshold
• FIntVector MinBound
• FIntVector MaxBound
• int Seed
• int Octave
• TArray<uint8> ColorList
• bool Additive

Applies Perlin noise to the mesh.

Notes

• All functions check for valid component and asset pointers before performing operations.
• Many functions mark the mesh as dirty to trigger updates in the engine.
• Some functions operate asynchronously for performance.

For more details, see the source file: Source/Voxy/Private/VoxyBPFLibrary.cpp.