pub struct PlayerConfig {
pub spawn_position: Vec3,
pub speed: f32,
pub sensitivity: f32,
pub roll_speed: f32,
pub look_at: Vec3,
pub fov_degrees: f32,
pub mode: PlayerMode,
pub snap_roll_duration_secs: f32,
pub snap_roll_easing: SnapRollEasing,
}Expand description
Startup configuration for spawn_player.
Insert this resource before PlayerPlugin (or before the Startup
schedule runs) to override any default. Fields are consumed once by
spawn_player; changing the resource after spawn has no effect.
§Example
use bevy::prelude::*;
use voxel_framework::player::PlayerConfig;
App::new()
.insert_resource(PlayerConfig {
spawn_position: Vec3::new(0.0, 50.0, 150.0),
speed: 8.0,
fov_degrees: 80.0,
..Default::default()
});§Default values
| Field | Default |
|---|---|
spawn_position | (0.0, 0.0, 30.0) |
speed | 4.0 wu/s |
sensitivity | 1.0 (unitless multiplier) |
roll_speed | 1.5 rad/s |
look_at | Vec3::ZERO |
fov_degrees | 90.0 |
Fields§
§spawn_position: Vec3World-space position at which the player entity is spawned.
speed: f32Maximum flight speed in world units per second. Copied into
Player::speed on spawn.
sensitivity: f32Mouse sensitivity multiplier (dimensionless). Copied into
Player::sensitivity on spawn. 1.0 = default “Minecraft-like” feel;
see MOUSE_SCALE for the underlying rad/px rate.
roll_speed: f32Roll angular speed in radians per second. Copied into
Player::roll_speed on spawn.
look_at: Vec3World-space point the camera looks toward immediately after spawning. Only affects the initial orientation; the player can look anywhere afterwards via mouse input.
fov_degrees: f32Vertical field-of-view in degrees. Valid range: 50.0–120.0.
Converted to radians and stored in the PerspectiveProjection on
spawn; runtime changes must be made directly on the Projection
component (e.g., via the Settings menu).
mode: PlayerModeMovement model used by the player systems.
Defaults to PlayerMode::FreeFlightSixDof for backwards compatibility.
Set to PlayerMode::Grounded for gravity-based gameplay.
snap_roll_duration_secs: f32Duration in seconds for a single snap-roll step animation (one hop to
the next world-aligned up candidate).
Copied into Player::snap_roll_duration on spawn. Default: 0.5.
snap_roll_easing: SnapRollEasingEasing curve for snap-roll animations.
Copied into Player::snap_roll_easing on spawn.
Trait Implementations§
Source§impl Clone for PlayerConfig
impl Clone for PlayerConfig
Source§impl Debug for PlayerConfig
impl Debug for PlayerConfig
Source§impl Default for PlayerConfig
impl Default for PlayerConfig
impl Resource for PlayerConfig
Auto Trait Implementations§
impl Forget for PlayerConfig
impl Freeze for PlayerConfig
impl Move for PlayerConfig
impl RefUnwindSafe for PlayerConfig
impl Send for PlayerConfig
impl Sync for PlayerConfig
impl Unpin for PlayerConfig
impl UnsafeUnpin for PlayerConfig
impl UnwindSafe for PlayerConfig
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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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