godot_voxel/doc/classes/VoxelStreamScript.xml
2021-01-31 16:24:26 +00:00

47 lines
1.5 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VoxelStreamScript" inherits="VoxelStream" version="3.2">
<brief_description>
Base class for custom streams defined with a script.
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="_emerge_block" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="out_buffer" type="VoxelBuffer">
Buffer in which to populate voxel data. It will never be [code]null[/code] and will have the requested size. It is only valid for this function, do not store it anywhere after the end.
</argument>
<argument index="1" name="origin_in_voxels" type="Vector3">
</argument>
<argument index="2" name="lod" type="int">
</argument>
<description>
</description>
</method>
<method name="_get_used_channels_mask" qualifiers="virtual">
<return type="int">
</return>
<description>
</description>
</method>
<method name="_immerge_block" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="buffer" type="VoxelBuffer">
Buffer of voxel data to save. It is allowed to keep a reference to it for caching purposes, as saved data will either be snapshots or only references left after removal of a volume.
</argument>
<argument index="1" name="origin_in_voxels" type="Vector3">
</argument>
<argument index="2" name="lod" type="int">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>