Voxel Tools

https://voxel-tools.readthedocs.io/en/latest/
Admin
Voxel Tools is a C++ module for creating volumetric worlds in Godot Engine, featuring procedural...
Tokens:105,084
Snippets:1,084
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Setup from Template

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelInstanceLibraryMultiMeshItem

Method to set up the instancer from a template node.

```APIDOC
## void setup_from_template( Node node )

### Description
_(This method has no documentation)_

### Method
POST

### Endpoint
/voxel-instancer/setup-template

### Parameters
#### Request Body
- **node** (Node) - Required - The template node to set up from.
```

--------------------------------

### Setup Custom Generator in Terrain Scene

Source: https://voxel-tools.readthedocs.io/en/latest/scripting

A GDScript example for setting up a custom generator in a VoxelTerrain node. This script preloads a custom generator script and assigns it to the terrain's generator property in the _ready function.

```gdscript
extends Node # Or whatever your root node is
const MyGenerator = preload("my_generator.gd")

# Get the terrain
@onready var terrain = $VoxelTerrain

func _ready():
    terrain.generator = MyGenerator.new()

```

--------------------------------

### VSCode Debugging Configuration

Source: https://voxel-tools.readthedocs.io/en/latest/development

Example launch configuration for debugging the Godot editor on Windows using VSCode.

```json
{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "(Windows) Launch",
            "type": "cppvsdbg", // For MSVC
            //"type": "cppdbg", // For GDB
            "request": "launch",
            "program": "${workspaceFolder}/bin/godot.windows.editor.dev.x86_64.exe", // Dev build (old target=debug)
            //"program": "${workspaceFolder}/bin/godot.windows.editor.x86_64.exe", // Non-dev build (old target=release_debug)
            "args": [
                "-v", // Verbose output

                //"-e", // Editor mode

                //"--debug-collisions",

                // Run a specific scene
                //"local_tests/sqlite/test_sqlite.tscn",
                //"local_tests/texturing/test_textured_terrain.tscn"
                //"local_tests/texturing/test_texturing.tscn"
            ],
            "stopAtEntry": false,
            "cwd": "D:/PROJETS/INFO/GODOT/Games/SolarSystem/Project",
            "environment": [],
            "visualizerFile": "${workspaceFolder}/modules/voxel/misc/voxel.natvis"
        }
    ]
}
```

--------------------------------

### Client: Setup VoxelTerrainMultiplayerSynchronizer

Source: https://voxel-tools.readthedocs.io/en/latest/multiplayer

On the client, add a `VoxelTerrainMultiplayerSynchronizer` as a child of `VoxelTerrain`. Ensure it has the same name as its server counterpart for proper synchronization.

```gdscript
# Assuming VoxelTerrain is the parent node
var synchronizer = VoxelTerrainMultiplayerSynchronizer.new()
add_child(synchronizer)
# Ensure its name matches the server's synchronizer
```

--------------------------------

### Region File Structure Example

Source: https://voxel-tools.readthedocs.io/en/latest/specs/region_format_v2

Illustrates the directory structure for a region save, including meta files and LOD folders containing region files.

```text
world/
    meta.vxrm
    regions/
        lod0/
            r.0.0.0.vxr
            r.1.6.0.vxr
            r.32.-2.-6.vxr
            ...
        lod1/
            ...
        lod2/
            ...
        ...
```

--------------------------------

### Mesh Handling

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelInstanceLibraryMultiMeshItem

Methods for getting and setting meshes for different LOD levels.

```APIDOC
## Mesh get_mesh( int mesh_lod_index )

### Description
_(This method has no documentation)_

### Method
GET

### Endpoint
/voxel-instancer/mesh/{mesh_lod_index}

### Parameters
#### Path Parameters
- **mesh_lod_index** (int) - Required - The index of the mesh LOD to retrieve.
```

```APIDOC
## void set_mesh( Mesh mesh, int mesh_lod_index )

### Description
_(This method has no documentation)_

### Method
POST

### Endpoint
/voxel-instancer/mesh/{mesh_lod_index}

### Parameters
#### Path Parameters
- **mesh_lod_index** (int) - Required - The index of the mesh LOD to set.
#### Request Body
- **mesh** (Mesh) - Required - The mesh to set.
```

--------------------------------

### Indicate used channels in VoxelGeneratorMultipassCB

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelGeneratorMultipassCB

Example of how to return a bitmask indicating which voxel channels are utilized by the generator.

```gdscript
(1 << channel1) | (1 << channel2)
```

--------------------------------

### Get Model ID with Single Attribute

Source: https://voxel-tools.readthedocs.io/en/latest/blocky_terrain

A faster shortcut to get a model ID when the type has only one attribute.

```gdscript
var model_id := library.get_model_index_single_attribute(&"log", VoxelBlockyAttributeAxis.AXIS_Z)
```

--------------------------------

### Build Voxel Tools as GDExtension (Windows)

Source: https://voxel-tools.readthedocs.io/en/latest/development

Use this command to compile Voxel Tools as a GDExtension library on Windows for an unoptimized debug build. Ensure GodotCpp is correctly linked.

```bash
scons platform=windows target=debug -j4
```

--------------------------------

### Voxel Metadata Operations

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelBuffer

Methods for getting and setting metadata associated with voxels and the buffer itself.

```APIDOC
## GET /websites/voxel-tools_readthedocs_io_en/get_voxel_metadata

### Description
Gets the metadata attached to a specific voxel in this buffer.

### Method
GET

### Endpoint
/websites/voxel-tools_readthedocs_io_en/get_voxel_metadata

### Parameters
#### Path Parameters
- **pos** (Vector3i) - Required - The position of the voxel.

### Response
#### Success Response (200)
- **metadata** (Variant) - The metadata attached to the voxel.

## POST /websites/voxel-tools_readthedocs_io_en/set_block_metadata

### Description
Sets arbitrary data on this buffer. Old data is replaced. Note, this is separate storage from per-voxel metadata. If this VoxelBuffer is saved, this metadata will also be saved along voxels, so make sure the data supports serialization (i.e you can't put nodes or arbitrary objects in it).

### Method
POST

### Endpoint
/websites/voxel-tools_readthedocs_io_en/set_block_metadata

### Parameters
#### Request Body
- **meta** (Variant) - Required - The arbitrary data to set as buffer metadata.

## POST /websites/voxel-tools_readthedocs_io_en/set_voxel_metadata

### Description
Attaches arbitrary data on a specific voxel. Old data is replaced. Passing `null` will erase metadata. If this VoxelBuffer is saved, this metadata will also be saved along voxels, so make sure the data supports serialization (i.e you can't put nodes or arbitrary objects in it).

### Method
POST

### Endpoint
/websites/voxel-tools_readthedocs_io_en/set_voxel_metadata

### Parameters
#### Path Parameters
- **pos** (Vector3i) - Required - The position of the voxel.
#### Request Body
- **value** (Variant) - Required - The arbitrary data to attach to the voxel. Pass `null` to erase metadata.
```

--------------------------------

### Configure VSCode for Voxel Module Pretty Printing

Source: https://voxel-tools.readthedocs.io/en/latest/development

Replace the `visualizerFile` path in `launch.json` to point to the voxel module's natvis file for pretty printing its specific container types.

```json
            "visualizerFile": "${workspaceFolder}/modules/voxel/misc/voxel.natvis"

```

--------------------------------

### VoxelEngine - Thread Management

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelEngine

Methods to get and set the number of threads used by the ThreadedTaskRunner.

```APIDOC
## GET VoxelEngine/get_thread_count

### Description
Returns the number of threads currently used internally by the `ThreadedTaskRunner`.

### Method
GET

### Endpoint
/VoxelEngine/get_thread_count

### Parameters
None

### Response
#### Success Response (200)
- **int** - The number of threads currently in use.

## POST VoxelEngine/set_thread_count

### Description
Sets the number of threads to be used internally by the `ThreadedTaskRunner`. Setting this can cause lagging, and it might take some time until the number of threads actually matches the given value.

### Method
POST

### Endpoint
/VoxelEngine/set_thread_count

### Parameters
#### Request Body
- **count** (int) - Required - The desired number of threads.

### Request Example
```json
{
  "count": 8
}
```

### Response
#### Success Response (200)
- **void** - Operation successful.

```

--------------------------------

### Generate Graph Nodes Documentation (Script)

Source: https://voxel-tools.readthedocs.io/en/latest/development

Execute this script from the `doc/tools/` directory to generate Markdown and C++ documentation from the `doc/graph_nodes.xml` file.

```bash
graph_nodes_doc.py
```

--------------------------------

### Get Voxel Engine Patch Version

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelEngine

Returns the patch version number of the voxel engine.

```gdscript
int get_version_patch ( ) const
```

--------------------------------

### Generate API Documentation

Source: https://voxel-tools.readthedocs.io/en/latest/development

Run this Python script to convert XML API definition files into Markdown format for the documentation website. Ensure you are in the correct directory.

```python
python build.py -a
```

--------------------------------

### Get Voxel Engine Minor Version

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelEngine

Returns the minor version number of the voxel engine.

```gdscript
int get_version_minor ( ) const
```

--------------------------------

### Configure VSCode for Godot Pretty Printing

Source: https://voxel-tools.readthedocs.io/en/latest/development

Add the `visualizerFile` setting to your `launch.json` in VSCode to enable pretty printing for Godot's container types. This requires the cpp-tools extension.

```json
            "visualizerFile": "${workspaceFolder}/platform/windows/godot.natvis"

```

--------------------------------

### Get Voxel Engine Major Version

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelEngine

Returns the major version number of the voxel engine.

```gdscript
int get_version_major ( ) const
```

--------------------------------

### Get Voxel Engine Edition

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelEngine

Returns the edition of the voxel engine, which is either 'module' or 'extension'.

```gdscript
String get_version_edition ( ) const
```

--------------------------------

### Server: Create VoxelViewer for Player

Source: https://voxel-tools.readthedocs.io/en/latest/multiplayer

When a player joins, create a `VoxelViewer` for them. Assign its `network_peer_id` and enable `requires_data_block_notifications`. Optionally, turn off `require_visuals` for remote players.

```gdscript
var viewer = VoxelViewer.new()
viewer.network_peer_id = player_id
viewer.requires_data_block_notifications = true
# viewer.require_visuals = false # Optional
```

--------------------------------

### Get Voxel Engine Version Status

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelEngine

Retrieves the version status of the voxel engine, which can be 'dev' or 'release'.

```gdscript
String get_version_status ( ) const
```

--------------------------------

### Build Voxel Tools for Web

Source: https://voxel-tools.readthedocs.io/en/latest/development

Compile Voxel Tools for web builds using Emscripten. Ensure the Emscripten version matches Godot's export template. Additional arguments may be required.

```bash
scons platform=web [etc...]
```

--------------------------------

### VoxelGeneratorMultipassCB Class Overview

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelGeneratorMultipassCB

Provides an overview of the VoxelGeneratorMultipassCB class, its inheritance, experimental status, and core functionality.

```APIDOC
## VoxelGeneratorMultipassCB

### Description
Scriptable generator working on columns of blocks and multiple passes. This generator can be implemented with a script to generate terrain in columns of blocks instead of only block by block. It allows to use multiple passes, where every pass can access results of the previous ones, and allowing access to neighbor columns. The height of columns is not infinite, but it is possible to define what generates above and below, using a single-pass per-block fallback. It may only be used with VoxelTerrain.

**Warning**: This class is marked as experimental. It is subject to likely change or possible removal in future versions. Use at your own discretion.

### Inheritance
Inherits: VoxelGenerator
```

--------------------------------

### Get Voxel Engine Git Hash

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelEngine

Retrieves the Git hash used to compile the voxel engine.

```gdscript
String get_version_git_hash ( ) const
```

--------------------------------

### VoxelTerrain Methods

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelTerrain

This section details the methods available for interacting with the VoxelTerrain, including their return types, signatures, and descriptions.

```APIDOC
## VoxelTerrain Methods

### Methods

- **_on_area_edited** (void) - `_on_area_edited ( Vector3i area_origin, Vector3i area_size ) virtual`
  _(This method has no documentation)_

- **_on_data_block_entered** (void) - `_on_data_block_entered ( VoxelDataBlockEnterInfo info ) virtual`
  _(This method has no documentation)_

- **data_block_to_voxel** (Vector3i) - `data_block_to_voxel ( Vector3i block_pos ) const`
  _(This method has no documentation)_

- **debug_get_draw_flag** (bool) - `debug_get_draw_flag ( DebugDrawFlag flag_index ) const`
  _(This method has no documentation)_

- **debug_set_draw_flag** (void) - `debug_set_draw_flag ( DebugDrawFlag flag_index, bool enabled )`
  _(This method has no documentation)_

- **get_data_block_size** (int) - `get_data_block_size ( ) const`
  _(This method has no documentation)_

- **get_statistics** (Dictionary) - `get_statistics ( ) const`
  _(This method has no documentation)_

- **get_viewer_network_peer_ids_in_area** (PackedInt32Array) - `get_viewer_network_peer_ids_in_area ( Vector3i area_origin, Vector3i area_size ) const`
  _(This method has no documentation)_

- **get_voxel_tool** (VoxelTool) - `get_voxel_tool ( )`
  _(This method has no documentation)_

- **has_data_block** (bool) - `has_data_block ( Vector3i block_position ) const`
  _(This method has no documentation)_

- **is_area_meshed** (bool) - `is_area_meshed ( AABB area_in_voxels ) const`
  _(This method has no documentation)_

- **save_block** (void) - `save_block ( Vector3i position )`
  _(This method has no documentation)_

- **save_modified_blocks** (VoxelSaveCompletionTracker) - `save_modified_blocks ( )`
  _(This method has no documentation)_

- **try_set_block_data** (bool) - `try_set_block_data ( Vector3i position, VoxelBuffer voxels )`
  _(This method has no documentation)_

- **voxel_to_data_block** (Vector3i) - `voxel_to_data_block ( Vector3 voxel_pos ) const`
  _(This method has no documentation)_
```

--------------------------------

### Get Voxel Engine Thread Count

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelEngine

Returns the number of threads currently used internally by the ThreadedTaskRunner.

```gdscript
int get_thread_count ( ) const
```

--------------------------------

### VoxelGeneratorMultipassCB Methods

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelGeneratorMultipassCB

Lists and describes the methods available in the VoxelGeneratorMultipassCB class.

```APIDOC
## Methods

### `_generate_block_fallback(out_buffer: VoxelBuffer, origin_in_voxels: Vector3i)`
- **Return**: void
- **Description**: Called for every block to generate above or below the column-based region. For example, you can decide to generate air above, and bedrock below.

### `_generate_pass(voxel_tool: VoxelToolMultipassGenerator, pass_index: int)`
- **Return**: void
- **Description**: Called once per pass for every column of blocks. The passed `voxel_tool` must be used to get information about the area to generate, and fill/edit this area with voxels. Important: do not keep this object in a member variable for later re-use. You can only use it in the current call to this method. You may use `pass_index` to do something different in each pass. For example, 0 could be base ground with Perlin noise, 1 could plant trees and other structures.

### `_get_used_channels_mask() const`
- **Return**: int
- **Description**: Use this to indicate which channels your generator will use. It returns a bitmask, so for example, you may provide information like this: `(1 << channel1) | (1 << channel2)`.

### `debug_generate_test_column(column_position_blocks: Vector2i)`
- **Return**: VoxelBuffer[]
- **Description**: Testing method that will fully generate all blocks of a specific column and returns them. This function doesn't use any threads and doesn't use the internal cache, so it will be very slow. However, it allows to test or debug your script more easily, using an isolated scene for example.

### `get_pass_extent_blocks(pass_index: int) const`
- **Return**: int
- **Description**: Gets how many blocks a pass can access around it (note: a block is 16x16x16 voxels by default).

### `set_pass_extent_blocks(pass_index: int, extent: int)`
- **Return**: void
- **Description**: Sets how many blocks a pass can access around columns when they generate (note: a block is 16x16x16 voxels by default). By design, the first pass is not allowed to access neighbors, so it will remain 0. Following passes are designed to access at least 1 block away. Such passes don't support 0 because it would be the same as simply putting your logic in a previous pass. Increasing extent will also increase the cost of the generator, both in memory and processing time, so it should be balanced with caution.
```

--------------------------------

### Get Default Model ID

Source: https://voxel-tools.readthedocs.io/en/latest/blocky_terrain

Retrieve the default model ID for a type when it has no attributes or you want its default state.

```gdscript
var model_id := library.get_model_index_default(&"leaves")
```

--------------------------------

### VoxelBlockyLibrary - Methods

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelBlockyLibrary

Methods for interacting with the VoxelBlockyLibrary, such as adding or retrieving models.

```APIDOC
## VoxelBlockyLibrary Methods

### `add_model`

- **Return**: int
- **Signature**: `add_model(VoxelBlockyModel model)`
- **Description**: Adds a model to the library. Returns its index, which will be the value of voxels representing it.
```

```APIDOC
### `get_model`

- **Return**: VoxelBlockyModel
- **Signature**: `get_model(int index) const`
- **Description**: Gets a model from its index.
```

```APIDOC
### `get_model_index_from_resource_name`

- **Return**: int
- **Signature**: `get_model_index_from_resource_name(String name) const`
- **Description**: Finds the index of the first model having the specified resource name. If not found, returns `null`.
```

--------------------------------

### Color Management API

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelColorPalette

This section details the methods for interacting with the color palette, including getting and setting individual colors.

```APIDOC
## GET /api/colors/{index}

### Description
Retrieves the color at the specified index from the palette.

### Method
GET

### Endpoint
/api/colors/{index}

### Parameters
#### Path Parameters
- **index** (int) - Required - The index of the color to retrieve.

### Response
#### Success Response (200)
- **color** (Color) - The color value at the specified index.

#### Response Example
```json
{
  "color": {
    "r": 0.5,
    "g": 0.2,
    "b": 0.8,
    "a": 1.0
  }
}
```

## POST /api/colors/{index}

### Description
Sets the color at the specified index in the palette.

### Method
POST

### Endpoint
/api/colors/{index}

### Parameters
#### Path Parameters
- **index** (int) - Required - The index of the color to set.
#### Request Body
- **color** (Color) - Required - The new color value to set.

### Request Example
```json
{
  "color": {
    "r": 0.1,
    "g": 0.9,
    "b": 0.3,
    "a": 0.7
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### VoxelBlockyModelCube Methods

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelBlockyModelCube

This section details the available methods for interacting with the VoxelBlockyModelCube.

```APIDOC
## VoxelBlockyModelCube Methods

### get_tile

- **Return**: Vector2i
- **Signature**: get_tile ( Side side ) const
- **Description**: This method has no documentation.

### set_tile

- **Return**: void
- **Signature**: set_tile ( Side side, Vector2i position )
- **Description**: This method has no documentation.
```

--------------------------------

### Get Voxel Engine Version Vector

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelEngine

Returns the major, minor, and patch version numbers as a Vector3i, useful for comparisons.

```gdscript
Vector3i get_version_v ( ) const
```

--------------------------------

### Region Forest Filesystem Structure

Source: https://voxel-tools.readthedocs.io/en/latest/specs/region_format_v3

Illustrates the directory and file naming conventions for a region forest, including LOD folders and region files.

```text
world/
    meta.vxrm
    regions/
        lod0/
            r.0.0.0.vxr
            r.1.6.0.vxr
            r.32.-2.-6.vxr
            ...
        lod1/
            ...
        lod2/
            ...
        ...

```

--------------------------------

### Debug Print in Non-Godot C++

Source: https://voxel-tools.readthedocs.io/en/latest/development

Utilize `println` with `format` for formatted debug output in standard C++ environments. Include `util/io/log.h` and `util/string/format.h`.

```cpp
#include "util/io/log.h"
#include "util/string/format.h"

println(format("Hello {}, my age is {}", name, age));

```

--------------------------------

### VoxelAStarGrid3D Methods

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelAStarGrid3D

API methods for managing pathfinding on voxel terrain.

```APIDOC
## find_path

### Description
Calculates a path from a starting voxel position to a target voxel position.

### Parameters
- **from_position** (Vector3i) - Required - Starting voxel coordinate.
- **to_position** (Vector3i) - Required - Target voxel coordinate.

### Response
- **Vector3i[]** - A series of contiguous voxel positions representing the path, or an empty array if no path is found.

---

## find_path_async

### Description
Performs path calculation on a separate thread. Results are emitted via the async_search_completed signal.

### Parameters
- **from_position** (Vector3i) - Required - Starting voxel coordinate.
- **to_position** (Vector3i) - Required - Target voxel coordinate.

---

## set_region

### Description
Sets the maximum region limit for pathfinding in voxels.

### Parameters
- **box** (AABB) - Required - The region boundary.

---

## set_terrain

### Description
Sets the VoxelTerrain instance to be used for pathfinding searches.

### Parameters
- **terrain** (VoxelTerrain) - Required - The terrain object.

---

## is_running_async

### Description
Checks if an asynchronous path calculation is currently in progress.

### Response
- **bool** - True if a search is running, false otherwise.
```

--------------------------------

### Calculate Block Address

Source: https://voxel-tools.readthedocs.io/en/latest/specs/region_format_v2

Formula to determine the starting memory address of a block based on header size and sector indexing.

```text
header_size + first_sector_index * sector_size
```

--------------------------------

### CompressedData Structure

Source: https://voxel-tools.readthedocs.io/en/latest/specs/compressed_container

Defines the basic structure of a compressed data container, starting with a format byte followed by the data payload.

```plaintext
CompressedData
- uint8_t format
- data

```

--------------------------------

### VoxelVoxLoader - load_from_file

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelVoxLoader

Loads voxel data from the first model in a MagicaVoxel file into a VoxelBuffer. Supports loading color palettes and handles different buffer depths. Note the axis convention difference between MagicaVoxel and Godot.

```APIDOC
## VoxelVoxLoader.load_from_file

### Description
Loads voxels from the first model found in a vox file and stores it in a single VoxelBuffer. Other models that might be in the file are not loaded. Transform of the model is not considered.

Data will be stored in one channel of the provided buffer. 64-bit depth channel is not supported.

If palette is provided, it will also load the color palette from the file and voxels will be indices pointing into it. 8-bit channel depth is optimal (as MagicaVoxel voxels use 8-bit indices), but 16-bit and 32-bit are also supported.

If palette is not provided (null), the loader will attempt to store colors bit-packed directly into the voxels, according to the depth the provided buffer has (2-bit per component if 8-bit, 4-bit per component if 16-bit, 8-bit per component if 32-bit).

Returns an Error enum code to tell if loading succeeded or not.

Note: MagicaVoxel uses a different axis convention than Godot: X is right, Y is forwards and Z is up. Voxel coordinates will be the same when looked up in the buffer, but they mean different location in space.

### Method
static load_from_file

### Parameters
#### Path Parameters
- **fpath** (String) - Required - The file path to the .vox file.
- **voxels** (VoxelBuffer) - Required - The VoxelBuffer to store the loaded voxel data.
- **palette** (VoxelColorPalette) - Optional - The color palette to load from the file. If null, colors are bit-packed into voxels.
- **dst_channel** (ChannelId) - Optional - The destination channel in the VoxelBuffer to store the data. Defaults to CHANNEL_COLOR (2).

### Return
- **int** - An Error enum code indicating success or failure.
```

--------------------------------

### Get Model ID with Attributes

Source: https://voxel-tools.readthedocs.io/en/latest/blocky_terrain

Retrieve a model ID from a library using a type name and a dictionary of attributes. Dictionary keys are converted to strings.

```gdscript
var model_id := library.get_model_index_with_attributes(&"button",
    # Note that dictionary keys don't use `&`, because Godot converts StringName keys into String.
    {
        "direction": VoxelBlockyAttributeDirection.DIR_POSITIVE_X,
        "active": 1,
        "powered": 0
    })
```

--------------------------------

### Profile Entire Function

Source: https://voxel-tools.readthedocs.io/en/latest/development

Use ZN_PROFILE_SCOPE() at the beginning of a function to profile its entire execution time. Ensure 'util/profiling.h' is included.

```cpp
void some_function() {
    ZN_PROFILE_SCOPE();
    //...
}
```

--------------------------------

### VoxelBlockyType Class Reference

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelBlockyType

Overview of the VoxelBlockyType class, including its properties, methods, and constants.

```APIDOC
## VoxelBlockyType

### Description
Experimental resource class for defining voxel block types.

### Properties
- **_variant_models_data** (Array) - Default: []
- **attributes** (VoxelBlockyAttribute[]) - Default: []
- **base_model** (VoxelBlockyModel) - The base model for the block.
- **unique_name** (StringName) - Default: &"unnamed"

### Methods
- **get_rotation_attribute()** (VoxelBlockyAttribute) - Returns the rotation attribute.
- **set_variant_model(Array key, VoxelBlockyModel model)** (void) - Explicitly sets which model to use for a given combination of attributes (key).

### Constants
- **MAX_ATTRIBUTES** = 4
```

--------------------------------

### VoxelEngine - Get Statistics

Source: https://voxel-tools.readthedocs.io/en/latest/api/VoxelEngine

Retrieves debug information about shared voxel processing, including thread pool status, task counts, and memory pool usage.

```APIDOC
## GET VoxelEngine/get_stats

### Description
Gets debug information about shared voxel processing.

### Method
GET

### Endpoint
/VoxelEngine/get_stats

### Parameters
None

### Response
#### Success Response (200)
- **Dictionary** - Debug information about shared voxel processing.

#### Response Example
```json
{
    "thread_pools": {
        "general": {
            "tasks": 10,
            "active_threads": 2,
            "thread_count": 4,
            "task_names": ["meshing", "generation"]
        }
    },
    "tasks": {
        "streaming": 5,
        "meshing": 3,
        "generation": 2,
        "main_thread": 1,
        "gpu": 0
    },
    "memory_pools": {
        "voxel_used": 1024,
        "voxel_total": 2048,
        "block_count": 5000,
        "std_allocated": 4096,
        "std_deallocated": 2048,
        "std_current": 2048
    }
}
```
```

--------------------------------

### Meta Table Schema

Source: https://voxel-tools.readthedocs.io/en/latest/specs/sqlite_format_v1

Defines the structure of the `meta` table, which contains general information about the volume. This table should typically have only one row and remain unmodified after initial setup.

```plaintext
meta {
    - version: INTEGER
    - block_size_po2: INTEGER
    - coordinate_format: INTEGER
}

```

--------------------------------

### Pseudocode for XZ Caching Optimization

Source: https://voxel-tools.readthedocs.io/en/latest/performance

Illustrates a common optimization pattern where a computationally expensive operation dependent on only two axes is moved outside the innermost loop to avoid redundant calculations.

```pseudocode
for z in size_z:
    for x in size_x:
        for y in size_y:
            set_voxel(x, y, z, noise2d(x, z) + y)

```

```pseudocode
for z in size_z:
    for x in size_x:
        n = noise2d(x, z)
        for y in size_y:
            set_voxel(x, y, z, n + y)

```
Tokens:
Raw