Zylann/godot_voxel
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot_voxel/doc/source/api/VoxelGenerator.md
Marc Gilleron d5a69003c3 Add missing classes and run doctool (doctool has issues though) 
VoxelGeneratorHeightmap.height_range is wrong in the doc.
VoxelTool lost all default values in doc.
These are likely Godot bugs...
2021-11-06 02:04:16 +00:00

1.8 KiB
Raw Blame History

VoxelGenerator

Inherits: Resource

Base class to all voxel procedural generators. If you want to define a custom one with a script, this is the class you should extend from. All implementations must be thread safe.

Methods:

Return Signature
void generate_block ( VoxelBuffer out_buffer, Vector3 origin_in_voxels, int lod )

Method Descriptions

Generates a block of voxels within the specified world area.

out_buffer: Buffer in which voxel data will be generated. It should not be null and should be given the requested size. Do not keep a reference on it after the call.

origin_in_voxels: Coordinates of the lower corner of the box to generate, relative to LOD0.

lod: Level of detail index to use for this block. Some generators might not support LOD, in which case it can be left 0.

Generated on Nov 06, 2021