VoxelTerrain

public bool AutomaticLoadingEnabled { get; set; }

If turned off, the terrain will no longer automatically load blocks around viewers locally. This may be used in multiplayer scenarios, when the terrain is client-side, because blocks will be sent by the server instead.

public Aabb Bounds { get; set; }

Defines the bounds within which the terrain is allowed to have voxels. If an infinite world generator is used, blocks will only generate within this region. Everything outside will be left empty. If any dimension of the new bounds is larger than 512 and VoxelTerrain.MaxViewDistance is larger than 512, then VoxelTerrain.MaxViewDistance will be clamped to 512. This measure is to avoid crashing due to a potential huge amount of chunks that would load.

public bool GenerateCollisions { get; set; }

Enables the generation of collision shapes using the classic physics engine. Use this feature if you need realistic or non-trivial collisions or physics. Note 1: you also need VoxelViewer to request collisions, otherwise they won't generate. Note 2: If you need simple Minecraft/AABB physics, you can use VoxelBoxMover which may perform better in blocky worlds.

public int MaxViewDistance { get; set; }

Sets the maximum distance this terrain can support. If a VoxelViewer requests more, it will be clamped.

public uint MeshBlockSize { get; set; }

Sets how many voxels across meshes of the terrain span. Voxel chunks are stored in cubic chunks of 16x16x16 voxels, and by default meshes of the terrain match that size. But you can set this to 32 so meshes will span 2x2x2 voxel chunks. This is a performance tradeoff. Higher mesh size may speed up rendering, at the cost of slower mesh updates. Values other than 16 and 32 are not supported. Note: this setting also affects VoxelInstancer chunks.

public bool UseGpuGeneration { get; set; }

Enables GPU block generation, which can speed it up. This is only valid for generators that support it. Vulkan is required.

public Vector3I DataBlockToVoxel(Vector3I blockPos);

Converts data block coordinates into voxel coordinates. Voxel coordinates of a block correspond to its lowest corner.

public Reckfell.Collections.Dictionary GetStatistics();

Gets debug information about how much time is spent processing the terrain. The returned dictionary has the following structure:

{
    "time_detect_required_blocks": int,
    "time_request_blocks_to_load": int,
    "time_process_load_responses": int,
    "time_request_blocks_to_update": int,
    "time_process_update_responses": int,
    "remaining_main_thread_blocks": int,
    "dropped_block_loads": int,
    "dropped_block_meshs": int,
    "updated_blocks": int
}

public bool IsAreaMeshed(Aabb areaInVoxels);

Returns true if the area has been processed by meshing. It does not mean the area actually contains a mesh. Returns false if the area has not been processed by meshing (therefore it is unknown whethere there should be a mesh here or not). When streaming terrain, this can be used to determine if an area has fully "loaded", in case the game relies meshes or mesh colliders.

public void SaveBlock(Vector3I position);

Forces a specific block to be saved. Note 1: this will only have an effect if the stream setup on this terrain supports saving. Note 2: saving is asynchronous and won't block the game. the save may complete only a short time after you call this method.

public VoxelSaveCompletionTracker SaveModifiedBlocks();

Forces all modified blocks to be saved. Note 1: this will only have an effect if the stream setup on this terrain supports saving. Note 2: saving is asynchronous and won't block the game. the save may complete only a short time after you call this method. Use the returned tracker object to know when saving has completed. However, saves occurring after calling this method won't be tracked by this object. Note that blocks getting unloaded as the viewer moves around can also trigger saving tasks, independently from this function.

public event VoxelTerrain.BlockLoadedEventHandler BlockLoaded;

Emitted when a new data block is loaded from stream. This can happen before the mesh or collider becomes available.

public event VoxelTerrain.BlockUnloadedEventHandler BlockUnloaded;

Emitted when a data block is unloaded due to being outside view distance.

public event VoxelTerrain.MeshBlockEnteredEventHandler MeshBlockEntered;

Emitted when a mesh block receives its first update since it was added in the range of viewers. This is regardless of the mesh being empty or not. It tracks changes of the same state obtained with VoxelTerrain.IsAreaMeshed.

public event VoxelTerrain.MeshBlockExitedEventHandler MeshBlockExited;

Emitted when a mesh block gets unloaded. It is the counterpart of VoxelTerrain.MeshBlockEntered.