bevy_fpc 0.1.3

First person controller plugin for the Bevy game-engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

//! First-person-controller plugin for the [Bevy](https://bevyengine.org) game-engine.
//!
//! The controller benefits from the features offered by the [`rapier character controller`](https://rapier.rs/docs/user_guides/bevy_plugin/character_controller).
//!
//! Plugins initialization:
//!
//! ```rust
//! // Require the `bevy_rapier3d` crate
//! # use bevy_fpc::FpcPlugin;
//! # use bevy::prelude::*;
//! # use bevy_rapier3d::prelude::*;
//! App::new()
//! 	.add_plugins(RapierPhysicsPlugin::<NoUserData>::default())
//! 	.add_plugins(FpcPlugin);
//! ```
//!
//! Spawn and embody an `fpc` entity:
//!
//! ```rust
//! # use bevy_fpc::{FpcBundle, Player};
//! # use bevy::prelude::{Commands};
//! # fn init(mut commands: Commands) {
//! commands.spawn(FpcBundle::default()).insert(Player);
//! # }
//! ```
//!
//! Custom configuration:
//!
//! ```rust
//! # use bevy_fpc::{FpcConfiguration, LINEAR_AZERTY_LAYOUT};
//! # use bevy::prelude::{App, Commands};
//! # let mut app = App::new();
//! app.insert_resource(FpcConfiguration{
//!   keyboard_linear_inputs: LINEAR_AZERTY_LAYOUT,
//!   ..Default::default()
//! });
//! ```
//!
//! # Features
//!
//! - [`bevy_fpc`](https://docs.rs/bevy_fpc) main crate / API
//! - [`bevy_fpc_core`](https://docs.rs/bevy_fpc_core) add minimal features to the controller (walking and looking)
//! - [`bevy_fpc_sprint`](https://docs.rs/bevy_fpc_sprint) (default) add sprinting capability to the controller

use bevy::prelude::*;
use bevy_fpc_core::{
    angular::{apply_motion, free_cursor, handle_request, lock_cursor, VisionMotionTarget},
    incarnation::embody,
    linear::{handle_movements, Gravity},
};
use bevy_rapier3d::prelude::*;

// API
pub use bevy_fpc_core::{
    angular::AngularState,
    config::{FpcConfiguration, KeyboardLinearInputs, LINEAR_AZERTY_LAYOUT, LINEAR_QWERTY_LAYOUT},
    linear::WalkSpeed,
    Player,
};
#[cfg(feature = "bevy_fpc_sprint")]
pub use bevy_fpc_sprint::{FpcSprintConfiguration, SprintRate};

/// The `bevy_fpc` structure implementing the bevy `Plugin` trait.
/// This plugin require the `bevy_rapier3d` plugin.
/// ```
/// # use bevy_fpc::FpcPlugin;
/// # use bevy::prelude::*;
/// # use bevy_rapier3d::prelude::*;
/// App::new()
/// .add_plugins(RapierPhysicsPlugin::<NoUserData>::default())
/// .add_plugins(FpcPlugin);
/// ```
pub struct FpcPlugin;
impl Plugin for FpcPlugin {
    fn build(&self, app: &mut bevy::prelude::App) {
        app.init_resource::<FpcConfiguration>()
            .init_state::<AngularState>()
            .add_systems(
                Update,
                (
                    handle_request.run_if(in_state(AngularState::Enabled)),
                    apply_motion,
                )
                    .chain(),
            )
            .add_systems(OnEnter(AngularState::Enabled), lock_cursor)
            .add_systems(OnExit(AngularState::Enabled), free_cursor)
            .add_systems(Update, (handle_movements, embody));

        #[cfg(feature = "bevy_fpc_sprint")]
        app.init_resource::<bevy_fpc_sprint::FpcSprintConfiguration>()
            .add_systems(Update, bevy_fpc_sprint::handle_sprint);
    }
}

/// Fpc marker
#[derive(Component, Default)]
pub struct Fpc;

/// Bundle containing all neccessary components for the base of a first person controller entity.
#[derive(Bundle)]
pub struct FpcBundle {
    pub fpc: Fpc,
    pub body: RigidBody,
    pub ccd: Ccd,
    pub collider: Collider,
    pub controller: KinematicCharacterController,
    pub controller_output: KinematicCharacterControllerOutput,
    pub vmt: VisionMotionTarget,
    pub walk_speed: WalkSpeed,
    pub spatial: SpatialBundle,
    #[cfg(feature = "bevy_fpc_sprint")]
    pub sprint_rate: bevy_fpc_sprint::SprintRate,
    pub gravity: Gravity,
}
impl Default for FpcBundle {
    fn default() -> Self {
        Self {
            fpc: Fpc,
            body: RigidBody::KinematicPositionBased,
            ccd: Ccd::enabled(),
            collider: Collider::capsule_y(0.5, 0.25),
            controller: KinematicCharacterController::default(),
            controller_output: KinematicCharacterControllerOutput::default(),
            spatial: SpatialBundle::default(),
            vmt: VisionMotionTarget::default(),
            walk_speed: WalkSpeed::default(),
            #[cfg(feature = "bevy_fpc_sprint")]
            sprint_rate: bevy_fpc_sprint::SprintRate::default(),
            gravity: Gravity(0.0),
        }
    }
}