pub struct VoxelPlugin<V: VoxelType = DefaultVoxel> { /* private fields */ }Expand description
Quick-start convenience bundle for demos and prototypes.
VoxelPlugin<V> composes VoxelCorePlugin<V> with selected presentation
and gameplay defaults. It is useful for examples, demos, and early
prototyping, but it is not the architectural definition of the full
framework. Production games should treat it as a convenience bundle and
switch to explicit catalog plugins when they need finer control.
The generic parameter V selects the voxel type. Defaults to
DefaultVoxel — VoxelPlugin::default() produces an asteroid-palette
world, VoxelPlugin::<DefaultTerrainVoxel>::new() produces a terrain world.
§Included beyond VoxelCorePlugin
| Plugin | Responsibility |
|---|---|
FragmentPlugin | Floating voxel debris entities ejected on mining |
SkyboxPlugin | Procedural starfield and skybox rendering |
SfxPlugin | Positional audio effects for mining and placement |
HotbarPlugin | Player hotbar, item switching, and held-item state |
UiPlugin | Crosshair, loading screen, and HUD overlays |
§Generator not included
generator::GeneratorPlugin is intentionally excluded because it requires
the caller to supply a concrete generator::GeneratorResource. Always add
it separately:
use bevy::prelude::*;
use voxel_framework::{VoxelPlugin, generator::{GeneratorPlugin, GeneratorResource}};
use voxel_framework::generator::terrain::{TerrainConfig, TerrainGenerator};
use voxel_framework::voxel::DefaultTerrainVoxel;
use std::sync::Arc;
App::new()
.add_plugins(DefaultPlugins)
.add_plugins(VoxelPlugin::<DefaultTerrainVoxel>::new())
.add_plugins(GeneratorPlugin::<DefaultTerrainVoxel>::new())
.insert_resource(GeneratorResource::<DefaultTerrainVoxel> {
generator: Arc::new(TerrainGenerator::new(TerrainConfig::default())),
})
.run();§See also
VoxelCorePlugin— narrower compatibility/convenience bundle.prelude— commonly used re-exports for convenience imports.
Implementations§
Source§impl<V: VoxelType> VoxelPlugin<V>
impl<V: VoxelType> VoxelPlugin<V>
Sourcepub fn new() -> Self
pub fn new() -> Self
Creates a new VoxelPlugin for voxel type V.
Trait Implementations§
impl<V: VoxelType> ConveniencePlugin for VoxelPlugin<V>
Source§impl<V: VoxelType> Default for VoxelPlugin<V>
impl<V: VoxelType> Default for VoxelPlugin<V>
Source§impl<V: VoxelType> Plugin for VoxelPlugin<V>
impl<V: VoxelType> Plugin for VoxelPlugin<V>
Source§fn ready(&self, _app: &App) -> bool
fn ready(&self, _app: &App) -> bool
finish should be called.Source§fn finish(&self, _app: &mut App)
fn finish(&self, _app: &mut App)
App, once all plugins registered are ready. This can
be useful for plugins that depends on another plugin asynchronous setup, like the renderer.Source§fn cleanup(&self, _app: &mut App)
fn cleanup(&self, _app: &mut App)
impl<V: VoxelType> VoxelFrameworkPlugin for VoxelPlugin<V>
Auto Trait Implementations§
impl<V> Freeze for VoxelPlugin<V>where
PhantomData<V>: Freeze,
impl<V> RefUnwindSafe for VoxelPlugin<V>where
PhantomData<V>: RefUnwindSafe,
impl<V> Send for VoxelPlugin<V>where
PhantomData<V>: Send,
impl<V> Sync for VoxelPlugin<V>where
PhantomData<V>: Sync,
impl<V> Unpin for VoxelPlugin<V>where
PhantomData<V>: Unpin,
impl<V> UnsafeUnpin for VoxelPlugin<V>where
PhantomData<V>: UnsafeUnpin,
impl<V> UnwindSafe for VoxelPlugin<V>where
PhantomData<V>: UnwindSafe,
Blanket Implementations§
Source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
Source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
T ShaderType for self. When used in AsBindGroup
derives, it is safe to assume that all images in self exist.Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<T> ConditionalSend for Twhere
T: Send,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be
downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further
downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
impl<S, T> Duplex<S> for Twhere
T: FromSample<S> + ToSample<S>,
Source§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
Source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
Source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates Self using default().
Source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
Source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more