Struct bevy_vox_scene::VoxelSceneHookBundle

pub struct VoxelSceneHookBundle {
    pub scene: Handle<VoxelScene>,
    pub hook: VoxelSceneHook,
    pub transform: Transform,
    pub visibility: Visibility,
}

A component bundle for spawning Voxel Scenes, with a VoxelSceneHook.

The root of the spawned scene will be the entity that has this bundle. In addition to the standard components bevy uses to organise and render pbr meshes, spawned entities will also have VoxelLayer and VoxelModelInstance components added. The VoxelSceneHook allows you to modify entities spawned within the hierarchy. A typical use-case would be adding additional components based on an entity’s [bevy::core::Name] or VoxelLayer.

VoxelSceneHookBundle {
    scene: assets.load("study.vox#tank"),
    hook: VoxelSceneHook::new(move |entity, commands| {
        let Some(name) = entity.get::<Name>() else { return };
        match name.as_str() {
            "tank/goldfish" | "tank/tetra" => {
                commands.insert(Fish);
            }
            _ => {},
        }
    }),
    ..default()
};

Fields

scene: Handle<VoxelScene>

A handle to a VoxelScene, typically loaded from a “.vox” file via the [bevy::asset::AssetServer]. This Entity will become the root of the spawned Voxel Scene.

hook: VoxelSceneHook

A VoxelSceneHook allows you to specify a closure that will be run for each Entity spawned in the scene graph.

transform: Transform

The transform of the scene root. This will override whatever the root transform is in the Magica Voxel scene.

visibility: Visibility

The visibility of the scene root. This will override whatever the root visibility is in the Magical Voxel scene.

Trait Implementations

impl Default for VoxelSceneHookBundle

fn default() -> VoxelSceneHookBundle

Returns the “default value” for a type.

impl Bundle for VoxelSceneHookBundle

impl DynamicBundle for VoxelSceneHookBundle