VoxelViewer

Inherits: Node3D

Attach this as a child node of characters, so the voxel world will know where to load blocks around them.

If no viewer is present in the world, nothing will generate.

Description:

The voxel world uses the position and options of all the VoxelViewer nodes to determine where to load blocks, and prioritize updates. For example, a voxel placed 100 units away from a player will have much lower priority than the modifications that player is doing when digging in front of them.

Properties:

Type Name Default
bool enabled_in_editor false
bool requires_collisions true
bool requires_data_block_notifications false
bool requires_visuals true
int view_distance 128

Methods:

Return Signature
int get_network_peer_id ( ) const
void set_network_peer_id ( int id )

Property Descriptions

  • bool enabled_in_editor = false

Sets whether this viewer will cause loading to occur in the editor. This is mainly intented for testing purposes.

Note that streaming in editor can also be turned off on terrains.

  • bool requires_collisions = true

If set to true, the engine will generate classic collision shapes around this viewer.

  • bool requires_data_block_notifications = false

  • bool requires_visuals = true

If set to true, the engine will generate meshes around this viewer. This may be enabled for the local player.

  • int view_distance = 128

How far should voxels generate around this viewer.

Method Descriptions

  • int get_network_peer_id( )

  • void set_network_peer_id( int id )

Generated on Mar 24, 2024