pub struct PlayerPlugin<V: VoxelType> { /* private fields */ }Expand description
Plugin that wires up the complete 6DOF player controller.
Registers PlayerConfig as an init resource, spawns the player camera
on Startup, and chains the three frame-update systems in the correct
dependency order every Update:
player_look → player_move → player_resolve_collision<V>player_cursor_system is added as a separate, un-chained Update system
so cursor events are processed independently of the movement pipeline.
All systems run unconditionally every frame. If your game requires state-gated player control (e.g., pausing during a menu), skip this plugin and register the systems manually:
App::new()
.add_systems(Startup, spawn_player)
.add_systems(Update,
(player_look, player_move::<DefaultVoxel>, player_resolve_collision::<DefaultVoxel>)
.chain()
.run_if(in_state(AppState::Playing)),
);The generic parameter V must match the VoxelType used by the loaded
Chunk entities so the collision system can read
solid-voxel data.
Implementations§
Source§impl<V: VoxelType> PlayerPlugin<V>
impl<V: VoxelType> PlayerPlugin<V>
Trait Implementations§
Source§impl<V: VoxelType> Default for PlayerPlugin<V>
impl<V: VoxelType> Default for PlayerPlugin<V>
impl<V: VoxelType> GameplayPlugin for PlayerPlugin<V>
Source§impl<V: VoxelType> Plugin for PlayerPlugin<V>
impl<V: VoxelType> Plugin for PlayerPlugin<V>
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 PlayerPlugin<V>
Auto Trait Implementations§
impl<V> Forget for PlayerPlugin<V>
impl<V> Freeze for PlayerPlugin<V>where
PhantomData<V>: Freeze,
impl<V> Move for PlayerPlugin<V>
impl<V> RefUnwindSafe for PlayerPlugin<V>where
PhantomData<V>: RefUnwindSafe,
impl<V> Send for PlayerPlugin<V>where
PhantomData<V>: Send,
impl<V> Sync for PlayerPlugin<V>where
PhantomData<V>: Sync,
impl<V> Unpin for PlayerPlugin<V>where
PhantomData<V>: Unpin,
impl<V> UnsafeUnpin for PlayerPlugin<V>where
PhantomData<V>: UnsafeUnpin,
impl<V> UnwindSafe for PlayerPlugin<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.