avian_pickup 0.3.0

A plugin for implementing picking up dynamic rigid bodies in Avian physics for the Bevy engine.Modeled after Half Life 2's gravity gun.
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
134
135
136
137
138

#![allow(clippy::too_many_arguments, clippy::type_complexity)]
#![warn(missing_docs)]
#![doc = include_str!("../readme.md")]

use avian3d::prelude::*;
use bevy_app::prelude::*;
use bevy_ecs::prelude::*;

pub mod actor;
mod cooldown;
pub mod input;
mod interaction;
mod math;
pub mod output;
pub mod prop;
mod rng;
mod verb;

pub use rng::*;
/// Everything you need to get started with Avian Pickup.
pub mod prelude {
    pub(crate) use super::{
        HandleVerbSystem,
        cooldown::prelude::*,
        prop::{NonPickupMass, prelude::*},
    };
    pub use crate::{
        AvianPickupPlugin, AvianPickupSystem, actor::prelude::*, input::prelude::*,
        output::prelude::*,
    };
    pub(crate) use avian3d::prelude::*;
    pub(crate) use bevy_app::prelude::*;
    pub(crate) use bevy_ecs::prelude::*;
    pub(crate) use bevy_log::prelude::*;
    pub(crate) use bevy_math::prelude::*;
    pub(crate) use bevy_reflect::prelude::*;
    pub(crate) use bevy_transform::prelude::*;
    pub(crate) use bevy_utils::prelude::*;
}

/// The Avian Pickup plugin. Add this after the Avian Physics plugins to enable
/// pickup functionality. Uses the same [`Schedule`]` as Avian.
///
/// # Example
///
/// ```no_run
/// # use avian3d::prelude::*;
/// # use avian_pickup::prelude::*;
/// # use bevy::prelude::*;
///
/// App::new().add_plugins((
///     DefaultPlugins,
///     PhysicsPlugins::default(),
///     AvianPickupPlugin::default(),
/// ));
/// ```
#[derive(Default)]
#[non_exhaustive]
pub struct AvianPickupPlugin;

impl Plugin for AvianPickupPlugin {
    fn build(&self, app: &mut App) {
        let physics_schedule = app.get_schedule(PhysicsSchedule);
        if physics_schedule.is_none() {
            panic!(
                "Failed to build `AvianPickupPlugin`:\
                Avian's `PhysicsSchedule` was not found. Make sure to add Avian's plugins *before* `AvianPickupPlugin`.\
                This usually done by adding `PhysicsPlugins` to your `App`."
            )
        }

        app.configure_sets(
            PhysicsSchedule,
            (
                AvianPickupSystem::First,
                AvianPickupSystem::HandleVerb,
                AvianPickupSystem::ResetIdle,
                AvianPickupSystem::TickTimers,
                AvianPickupSystem::Last,
            )
                .chain()
                .before(PhysicsStepSystems::First),
        )
        .configure_sets(
            PhysicsSchedule,
            (
                HandleVerbSystem::Pull,
                HandleVerbSystem::Hold,
                HandleVerbSystem::Drop,
                HandleVerbSystem::Throw,
            )
                .chain()
                .in_set(AvianPickupSystem::HandleVerb),
        );

        app.add_plugins((
            input::plugin,
            output::plugin,
            actor::plugin,
            interaction::plugin,
            cooldown::plugin,
            prop::plugin,
            verb::plugin,
            rng::plugin,
        ));
    }
}

/// Set enum for the systems added by [`AvianPickupPlugin`].
/// Use this to order your systems relative to the ones used by Avian Pickup.
/// This is run in Avian's [`PhysicsStepSet::First`] and scheduled under [`PhysicsSchedule`].
#[derive(Debug, Hash, PartialEq, Eq, Clone, SystemSet)]
pub enum AvianPickupSystem {
    /// Runs at the start of the [`AvianPickupSystem`]. Empty by default.
    First,
    /// Adds forces to an object held by
    /// [`AvianPickupActorState::Holding`](crate::prelude::AvianPickupActorState::Holding)
    /// in order to keep it in place in front of the
    /// [`AvianPickupActor`](crate::prelude::AvianPickupActor).
    HandleVerb,
    /// Resets the
    /// [`AvianPickupActorState`](crate::prelude::AvianPickupActorState) to
    /// [`AvianPickupActorState::Idle`](crate::prelude::AvianPickupActorState::Idle)
    /// if needed
    ResetIdle,
    /// Advances internal cooldown timers.
    TickTimers,
    /// Runs at the end of the [`AvianPickupSystem`]. Empty by default.
    Last,
}

#[derive(Debug, Hash, PartialEq, Eq, Clone, SystemSet)]
pub(crate) enum HandleVerbSystem {
    Pull,
    Hold,
    Drop,
    Throw,
}