Skip to content

Commit

Permalink
Update markdown API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Zylann committed Feb 24, 2024
1 parent 0e9da7a commit 9c7b4f4
Show file tree
Hide file tree
Showing 70 changed files with 156 additions and 83 deletions.
2 changes: 1 addition & 1 deletion doc/source/api/FastNoise2.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,4 +189,4 @@ Gets which SIMD level was detected by the library. This gives an indication of p

This method must be called after you change properties, so they can take effect.

_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelAStarGrid3D.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,4 @@ Return
- [void](#)<span id="i_set_terrain"></span> **set_terrain**( [VoxelTerrain](VoxelTerrain.md) terrain )


_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelBlockSerializer.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,4 @@ Stores the data of a [VoxelBuffer](VoxelBuffer.md) into a [PackedByteArray](http

Stores the data of a [VoxelBuffer](VoxelBuffer.md) into a [StreamPeer](https://docs.godotengine.org/en/stable/classes/class_streampeer.html). Returns the number of written bytes.

_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelBlockyAttribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ Return
- [bool](https://docs.godotengine.org/en/stable/classes/class_bool.html)<span id="i_is_rotation"></span> **is_rotation**( )


_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelBlockyAttributeAxis.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ enum **Axis**:
- [int](https://docs.godotengine.org/en/stable/classes/class_int.html)<span id="i_from_vec3"></span> **from_vec3**( [Vector3](https://docs.godotengine.org/en/stable/classes/class_vector3.html) v )


_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelBlockyAttributeCustom.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ Return | Signature
- [void](#)<span id="i_set_value_name"></span> **set_value_name**( [int](https://docs.godotengine.org/en/stable/classes/class_int.html) value, [StringName](https://docs.godotengine.org/en/stable/classes/class_stringname.html) value_name )


_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelBlockyAttributeDirection.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ enum **Direction**:
- [int](https://docs.godotengine.org/en/stable/classes/class_int.html)<span id="i_from_vec3"></span> **from_vec3**( [Vector3](https://docs.godotengine.org/en/stable/classes/class_vector3.html) v )


_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelBlockyAttributeRotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Type | Name | Default
- [bool](https://docs.godotengine.org/en/stable/classes/class_bool.html)<span id="i_horizontal_only"></span> **horizontal_only** = false


_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelBlockyLibrary.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,4 @@ Finds the index of the first model having the specified resource name. If not fo

Finds the index of the first model having the specified resource name. If not found, returns `null`.

_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelBlockyLibraryBase.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ Gets a list of all distinct materials found in all models of the library.

Note, if at least one non-empty model has no material, there will be one `null` entry in this list to represent "The default material".

_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelBlockyModel.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,4 +106,4 @@ Sets a material override for a specific surface of the model. It allows to use t

Enables or disables mesh-based collision on a specific surface. It allows a model to have solid parts and others where players can pass through.

_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelBlockyModelCube.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ If you are not using an atlas and every side uses the same full texture, use (1,
- [void](#)<span id="i_set_tile"></span> **set_tile**( [int](https://docs.godotengine.org/en/stable/classes/class_int.html) side, [Vector2i](https://docs.godotengine.org/en/stable/classes/class_vector2i.html) position )


_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelBlockyModelEmpty.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Explicitely represents an empty model.

This can be used for the default air model (at index 0), but may also be useful if you want to define a model that has no visuals, but still has collision or other attributes different than air.

_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelBlockyModelMesh.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ Orthogonal rotation applied to the mesh when baking. Values are taken from the s

([GridMap](https://docs.godotengine.org/en/stable/classes/class_gridmap.html) provides a conversion method from [Basis](https://docs.godotengine.org/en/stable/classes/class_basis.html), unfortunately it is not a static method so it requires a [GridMap](https://docs.godotengine.org/en/stable/classes/class_gridmap.html) instance to exist. A helper method could be added in the future if requested)

_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelBlockyType.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ Return | Signature
- [void](#)<span id="i_set_variant_model"></span> **set_variant_model**( [Array](https://docs.godotengine.org/en/stable/classes/class_array.html) _unnamed_arg0, [VoxelBlockyModel](VoxelBlockyModel.md) _unnamed_arg1 )


_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelBlockyTypeLibrary.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@ Return
- [PackedStringArray](https://docs.godotengine.org/en/stable/classes/class_packedstringarray.html)<span id="i_serialize_id_map_to_string_array"></span> **serialize_id_map_to_string_array**( )


_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelBoxMover.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@ Sets the maximum height that can be climbed like "stairs".

When enabled, [VoxelBoxMover.get_motion](VoxelBoxMover.md#i_get_motion) will attempt to climb up small steps. This allows to implement Minecraft-like stairs.

_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
9 changes: 6 additions & 3 deletions doc/source/api/VoxelBuffer.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Return
[void](#) | [copy_channel_from_area](#i_copy_channel_from_area) ( [VoxelBuffer](VoxelBuffer.md) other, [Vector3i](https://docs.godotengine.org/en/stable/classes/class_vector3i.html) src_min, [Vector3i](https://docs.godotengine.org/en/stable/classes/class_vector3i.html) src_max, [Vector3i](https://docs.godotengine.org/en/stable/classes/class_vector3i.html) dst_min, [int](https://docs.godotengine.org/en/stable/classes/class_int.html) channel )
[void](#) | [copy_voxel_metadata_in_area](#i_copy_voxel_metadata_in_area) ( [VoxelBuffer](VoxelBuffer.md) src_buffer, [Vector3i](https://docs.godotengine.org/en/stable/classes/class_vector3i.html) src_min_pos, [Vector3i](https://docs.godotengine.org/en/stable/classes/class_vector3i.html) src_max_pos, [Vector3i](https://docs.godotengine.org/en/stable/classes/class_vector3i.html) dst_min_pos )
[void](#) | [create](#i_create) ( [int](https://docs.godotengine.org/en/stable/classes/class_int.html) sx, [int](https://docs.godotengine.org/en/stable/classes/class_int.html) sy, [int](https://docs.godotengine.org/en/stable/classes/class_int.html) sz )
[Array](https://docs.godotengine.org/en/stable/classes/class_array.html) | [debug_print_sdf_y_slices](#i_debug_print_sdf_y_slices) ( [float](https://docs.godotengine.org/en/stable/classes/class_float.html) scale ) const
[Image[]](https://docs.godotengine.org/en/stable/classes/class_image[].html) | [debug_print_sdf_y_slices](#i_debug_print_sdf_y_slices) ( [float](https://docs.godotengine.org/en/stable/classes/class_float.html) scale=1.0 ) const
[void](#) | [downscale_to](#i_downscale_to) ( [VoxelBuffer](VoxelBuffer.md) dst, [Vector3i](https://docs.godotengine.org/en/stable/classes/class_vector3i.html) src_min, [Vector3i](https://docs.godotengine.org/en/stable/classes/class_vector3i.html) src_max, [Vector3i](https://docs.godotengine.org/en/stable/classes/class_vector3i.html) dst_min ) const
[void](#) | [fill](#i_fill) ( [int](https://docs.godotengine.org/en/stable/classes/class_int.html) value, [int](https://docs.godotengine.org/en/stable/classes/class_int.html) channel=0 )
[void](#) | [fill_area](#i_fill_area) ( [int](https://docs.godotengine.org/en/stable/classes/class_int.html) value, [Vector3i](https://docs.godotengine.org/en/stable/classes/class_vector3i.html) min, [Vector3i](https://docs.godotengine.org/en/stable/classes/class_vector3i.html) max, [int](https://docs.godotengine.org/en/stable/classes/class_int.html) channel=0 )
Expand Down Expand Up @@ -128,8 +128,11 @@ Copying across the same buffer to overlapping areas is not supported. You may us

Clears the buffer and gives it the specified size.

- [Array](https://docs.godotengine.org/en/stable/classes/class_array.html)<span id="i_debug_print_sdf_y_slices"></span> **debug_print_sdf_y_slices**( [float](https://docs.godotengine.org/en/stable/classes/class_float.html) scale )
- [Image[]](https://docs.godotengine.org/en/stable/classes/class_image[].html)<span id="i_debug_print_sdf_y_slices"></span> **debug_print_sdf_y_slices**( [float](https://docs.godotengine.org/en/stable/classes/class_float.html) scale=1.0 )

Renders the contents of the SDF channel into images where blue gradients are negative values (below surface) and yellow gradients are positive (above surface). Each image corresponds to an XZ slice of the buffer.

The `scale` parameter can be used to change contrast of images by scaling the SDF.

- [void](#)<span id="i_downscale_to"></span> **downscale_to**( [VoxelBuffer](VoxelBuffer.md) dst, [Vector3i](https://docs.godotengine.org/en/stable/classes/class_vector3i.html) src_min, [Vector3i](https://docs.godotengine.org/en/stable/classes/class_vector3i.html) src_max, [Vector3i](https://docs.godotengine.org/en/stable/classes/class_vector3i.html) dst_min )

Expand Down Expand Up @@ -230,4 +233,4 @@ If this [VoxelBuffer](VoxelBuffer.md) is saved, this metadata will also be saved
- [void](#)<span id="i_set_voxel_v"></span> **set_voxel_v**( [int](https://docs.godotengine.org/en/stable/classes/class_int.html) value, [Vector3i](https://docs.godotengine.org/en/stable/classes/class_vector3i.html) pos, [int](https://docs.godotengine.org/en/stable/classes/class_int.html) channel=0 )


_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelColorPalette.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ Return | Sign
- [void](#)<span id="i_set_color"></span> **set_color**( [int](https://docs.godotengine.org/en/stable/classes/class_int.html) index, [Color](https://docs.godotengine.org/en/stable/classes/class_color.html) color )


_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelDataBlockEnterInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ Gets the position of the data block, in data block coordinates (voxel coordinate

Gets access to the voxels in the block.

_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelEngine.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ The returned dictionary has the following structure:
}
```

_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
4 changes: 2 additions & 2 deletions doc/source/api/VoxelGenerator.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ Return | Signature

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 have a non-empty size. Do not keep a reference on it after the call. Note: this buffer can have any non-empty size, but some assumptions can be made depending on which terrain node you're using. [VoxelTerrain](VoxelTerrain.md) will always request blocks of size 16x16x16, but [VoxelLodTerrain](VoxelLodTerrain.md) can request blocks of different sizes.
`out_buffer`: Buffer in which voxel data will be generated. It must not be `null` and must have a non-empty size.

`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. At LOD 0, each cell of the passed buffer spans 1 space unit. At LOD 1, 2 units. At LOD 2, 4 units, and so on.

_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelGeneratorFlat.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ Altitude of the ground.

If [VoxelGeneratorFlat.channel](VoxelGeneratorFlat.md#i_channel) is set to [VoxelBuffer.CHANNEL_TYPE](VoxelBuffer.md#i_CHANNEL_TYPE), this value will be used to fill ground voxels.

_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelGeneratorGraph.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,4 +130,4 @@ The node ID will be -1 if the error is not about a particular node.
- [VoxelGraphFunction](VoxelGraphFunction.md)<span id="i_get_main_function"></span> **get_main_function**( )


_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelGeneratorHeightmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ Minimum height where the surface will generate.

Scale applied to the signed distance field. This is useful when smooth voxels are used, to reduce blockyness over large distances.

_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelGeneratorImage.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ Type | Name | Default
- [Image](https://docs.godotengine.org/en/stable/classes/class_image.html)<span id="i_image"></span> **image**


_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelGeneratorMultipassCB.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,4 +96,4 @@ Following passes are designed to access at least 1 block away. Such passes don't

Increasing extent will also increase the cost of the generator, both in memory and processing time, so it should be balanced with caution.

_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelGeneratorNoise.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ Base of the shape. Everything below it will be filled with ground.

Noise used as density function. It is required for the generator to work.

_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelGeneratorNoise2D.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ By default, a linear curve from 0 to 1 is used.

Noise used to produce the heightmap. It is required for the generator to work.

_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
4 changes: 2 additions & 2 deletions doc/source/api/VoxelGeneratorScript.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Return | Signatur

- [void](#)<span id="i__generate_block"></span> **_generate_block**( [VoxelBuffer](VoxelBuffer.md) out_buffer, [Vector3i](https://docs.godotengine.org/en/stable/classes/class_vector3i.html) origin_in_voxels, [int](https://docs.godotengine.org/en/stable/classes/class_int.html) lod )

`out_buffer`: Buffer in which to populate voxel data. It will never be `null` and will have the requested size. It is only valid for this function, do not store it anywhere after the end.
`out_buffer`: Buffer in which to populate voxel data. It will never be `null` and will have the requested size. It is only valid for this function, do not store it anywhere after the end. Note: this buffer can have any non-empty size, but some assumptions can be made depending on which terrain node you're using. [VoxelTerrain](VoxelTerrain.md) will always request blocks of size 16x16x16, but [VoxelLodTerrain](VoxelLodTerrain.md) can request blocks of different sizes.

`origin_in_voxels`: Coordinates of the lower corner of the box to generate, relative to LOD0. The size of the box is known from `out_buffer`.

Expand All @@ -31,4 +31,4 @@ Return | Signatur

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)`

_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelGeneratorWaves.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ Type | Name | Default
- [Vector2](https://docs.godotengine.org/en/stable/classes/class_vector2.html)<span id="i_pattern_size"></span> **pattern_size** = Vector2(30, 30)


_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelGraphFunction.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,4 +248,4 @@ Sets a custom name for a node.
- [void](#)<span id="i_set_node_param_null"></span> **set_node_param_null**( [int](https://docs.godotengine.org/en/stable/classes/class_int.html) node_id, [int](https://docs.godotengine.org/en/stable/classes/class_int.html) param_index )


_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelInstanceComponent.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ This node gets attached to scene items instanced by [VoxelInstancer](VoxelInstan

[VoxelInstancer](VoxelInstancer.md) internally adds this node to instanced scenes, so it can track when they get destroyed or removed from the scene tree.

_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelInstanceGenerator.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,4 +144,4 @@ If 1, they will completely align with whichever direction is considered "up".

This depends on [VoxelInstancer.up_mode](VoxelInstancer.md#i_up_mode).

_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelInstanceLibrary.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ Return
- [void](#)<span id="i_remove_item"></span> **remove_item**( [int](https://docs.godotengine.org/en/stable/classes/class_int.html) id )


_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelInstanceLibraryItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ Type | Name | Default
- [bool](https://docs.godotengine.org/en/stable/classes/class_bool.html)<span id="i_persistent"></span> **persistent** = false


_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelInstanceLibraryMultiMeshItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,4 +124,4 @@ Sets the list of group names that will be added to collider nodes generated for
- [void](#)<span id="i_setup_from_template"></span> **setup_from_template**( [Node](https://docs.godotengine.org/en/stable/classes/class_node.html) node )


_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelInstanceLibrarySceneItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ Type | Name | Default
- [PackedScene](https://docs.godotengine.org/en/stable/classes/class_packedscene.html)<span id="i_scene"></span> **scene**


_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelInstancer.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,4 @@ enum **DebugDrawFlag**:
- [void](#)<span id="i_debug_set_draw_flag"></span> **debug_set_draw_flag**( [int](https://docs.godotengine.org/en/stable/classes/class_int.html) flag, [bool](https://docs.godotengine.org/en/stable/classes/class_bool.html) enabled )


_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
2 changes: 1 addition & 1 deletion doc/source/api/VoxelInstancerRigidBody.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ Return | Signatur

Gets the ID of the item in the instancer's [VoxelInstanceLibrary](VoxelInstanceLibrary.md) that was used to create the instance having this collider.

_Generated on Dec 31, 2023_
_Generated on Feb 24, 2024_
Loading

0 comments on commit 9c7b4f4

Please sign in to comment.