ReadVoxels

Function of:

Description:

Returns a certain region of smooth terrain in table format. Both of the returned arrays have an additional Size property, a datatype/Vector3.

Parameters

Name	Type	Default	Description
Name region	Type Region3	Default	Summary Target region to write to. Must be aligned to the voxel grid. Will throw an error if region is too large.
Name resolution	Type float	Default	Summary Voxel resolution. Must be 4.

Returns

Return Type	Summary
Return Type Tuple	Summary Returns raw voxel data as two 3D arrays. `materials` - 3D array of `Enum/Material` from the target area. Also contains a Size field, equal to the dimensions of the nested arrays. `occupancies` - 3D array of occupancy values from the target area. Also contains a Size field, equal to the dimensions of the nested arrays.

Code Samples

Terrain:ReadVoxels() Code Example

			
				Terrain:ReadVoxels() Code Example

				Expected Output
			
				Expand
				
			local function printRegion(terrain, region)
    local materials, occupancies = terrain:ReadVoxels(region, 4)
 
    local size = materials.Size -- Same as occupancies.Size
 
    for x = 1, size.X, 1 do
        for y = 1, size.Y, 1 do
            for z = 1, size.Z, 1 do
                print(("(%2i, %2i, %2i): %.2f %s"):format(x, y, z, occupancies[x][y][z], materials[x][y][z].Name))
            end
        end
    end
end
		
				Copy Code
			
				Light Theme

ReadVoxels

Parameters

region

resolution

Returns

Tuple

Code Samples

Terrain:ReadVoxels() Code Example