pub struct PlacementInputPlugin<V: VoxelType> { /* private fields */ }Expand description
Convenience plugin that wires mouse input to the placement API automatically.
PlacementInputPlugin<V> adds a single Update system that:
- Advances the placement cooldown timer every frame via
tick_placement. - Raycasts from the active
Camera3d(max6.0world units) on a right mouse button press. - Calls
try_place_voxelwith the block type derived from the activecrate::items::HotbarStateslot:V::from_byte(selected + 1). (Slot 0 → byte 1, slot 1 → byte 2, …)
§Prerequisites
PlacementPlugin must be added before this plugin so that the
required resources (PlacementState, PlacementConfig) and message
channels (VoxelPlaced) are already registered.
crate::items::HotbarPlugin must also be added for hotbar slot selection.
§Example
use bevy::prelude::*;
use voxel_framework::{VoxelPlugin, generator::{GeneratorPlugin, GeneratorResource}};
use voxel_framework::world::placement::PlacementInputPlugin;
use voxel_framework::voxel::DefaultTerrainVoxel;
App::new()
.add_plugins(DefaultPlugins)
.add_plugins(VoxelPlugin::<DefaultTerrainVoxel>::new())
.add_plugins(PlacementInputPlugin::<DefaultTerrainVoxel>::new())
.run();Implementations§
Source§impl<V: VoxelType> PlacementInputPlugin<V>
impl<V: VoxelType> PlacementInputPlugin<V>
Sourcepub fn new() -> Self
pub fn new() -> Self
Creates a new PlacementInputPlugin for voxel type V.
Trait Implementations§
impl<V: VoxelType> ConveniencePlugin for PlacementInputPlugin<V>
Available on crate feature
items only.Source§impl<V: VoxelType> Default for PlacementInputPlugin<V>
Available on crate feature items only.
impl<V: VoxelType> Default for PlacementInputPlugin<V>
Available on crate feature
items only.Source§impl<V: VoxelType> Plugin for PlacementInputPlugin<V>
Available on crate feature items only.
impl<V: VoxelType> Plugin for PlacementInputPlugin<V>
Available on crate feature
items only.Source§fn ready(&self, _app: &App) -> bool
fn ready(&self, _app: &App) -> bool
Has the plugin finished its setup? This can be useful for plugins that need something
asynchronous to happen before they can finish their setup, like the initialization of a renderer.
Once the plugin is ready,
finish should be called.Source§fn finish(&self, _app: &mut App)
fn finish(&self, _app: &mut App)
Finish adding this plugin to the
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)
Runs after all plugins are built and finished, but before the app schedule is executed.
This can be useful if you have some resource that other plugins need during their build step,
but after build you want to remove it and send it to another thread.
impl<V: VoxelType> VoxelFrameworkPlugin for PlacementInputPlugin<V>
Available on crate feature
items only.Auto Trait Implementations§
impl<V> Forget for PlacementInputPlugin<V>
impl<V> Freeze for PlacementInputPlugin<V>where
PhantomData<V>: Freeze,
impl<V> Move for PlacementInputPlugin<V>
impl<V> RefUnwindSafe for PlacementInputPlugin<V>where
PhantomData<V>: RefUnwindSafe,
impl<V> Send for PlacementInputPlugin<V>where
PhantomData<V>: Send,
impl<V> Sync for PlacementInputPlugin<V>where
PhantomData<V>: Sync,
impl<V> Unpin for PlacementInputPlugin<V>where
PhantomData<V>: Unpin,
impl<V> UnsafeUnpin for PlacementInputPlugin<V>where
PhantomData<V>: UnsafeUnpin,
impl<V> UnwindSafe for PlacementInputPlugin<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
Return the
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
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
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>
Converts
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>
Converts
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)
Converts
&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)
Converts
&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> ⓘ
Converts
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> ⓘ
Converts
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 moreSource§impl<T> IntoResult<T> for T
impl<T> IntoResult<T> for T
Source§fn into_result(self) -> Result<T, RunSystemError>
fn into_result(self) -> Result<T, RunSystemError>
Converts this type into the system output type.