pub struct MiningInputPlugin<V: VoxelType, I: ItemType> { /* private fields */ }Expand description
Convenience plugin that wires mouse input to the mining API automatically.
MiningInputPlugin<V, I> adds two Update systems:
hotbar_to_tool_system— reads the active hotbar slot fromInventory<I>and updatesToolStatswith the slot’s tool level and speed each frame.mining_input_system— raycasts from the activeCamera3d(max6.0world units). While the left mouse button is held and the ray hits a solid voxel whosecrate::voxel::VoxelType::mining_levelis satisfied by the currentToolStats::tool_level, callstick_miningto accumulate break progress. When the button is released (or no voxel is hit, or the tool level is too low), callsstop_mining.
§Prerequisites
MiningPlugin must be added before this plugin so that the required
resources (MiningState, MiningConfig) and message channels
(VoxelBroken, MiningProgress) are already registered.
A player entity with crate::items::inventory::ContainerComponent<I> and
crate::items::inventory::PrimaryContainer must be present (typically spawned
in a Startup system).
§Example
use bevy::prelude::*;
use voxel_framework::{VoxelPlugin, generator::{GeneratorPlugin, GeneratorResource}};
use voxel_framework::world::mining::MiningInputPlugin;
use voxel_framework::voxel::DefaultTerrainVoxel;
use voxel_framework::items::DefaultItem;
App::new()
.add_plugins(DefaultPlugins)
.add_plugins(VoxelPlugin::<DefaultTerrainVoxel>::new())
.add_plugins(MiningInputPlugin::<DefaultTerrainVoxel, DefaultItem>::new())
.run();Implementations§
Source§impl<V: VoxelType, I: ItemType> MiningInputPlugin<V, I>
impl<V: VoxelType, I: ItemType> MiningInputPlugin<V, I>
Sourcepub fn new() -> Self
pub fn new() -> Self
Creates a new MiningInputPlugin for voxel type V and item type I.
Trait Implementations§
impl<V: VoxelType, I: ItemType> ConveniencePlugin for MiningInputPlugin<V, I>
Available on crate feature
items only.Source§impl<V: VoxelType, I: ItemType> Default for MiningInputPlugin<V, I>
Available on crate feature items only.
impl<V: VoxelType, I: ItemType> Default for MiningInputPlugin<V, I>
Available on crate feature
items only.Source§impl<V: VoxelType, I: ItemType> Plugin for MiningInputPlugin<V, I>
Available on crate feature items only.
impl<V: VoxelType, I: ItemType> Plugin for MiningInputPlugin<V, I>
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, I: ItemType> VoxelFrameworkPlugin for MiningInputPlugin<V, I>
Available on crate feature
items only.Auto Trait Implementations§
impl<V, I> Freeze for MiningInputPlugin<V, I>
impl<V, I> RefUnwindSafe for MiningInputPlugin<V, I>
impl<V, I> Send for MiningInputPlugin<V, I>
impl<V, I> Sync for MiningInputPlugin<V, I>
impl<V, I> Unpin for MiningInputPlugin<V, I>
impl<V, I> UnsafeUnpin for MiningInputPlugin<V, I>
impl<V, I> UnwindSafe for MiningInputPlugin<V, I>
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<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.