bevy_prank 0.8.0

Opinionated Unreal Engine inspired spectator camera 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

#![allow(clippy::type_complexity)]
#![doc = include_str!("../README.md")]

use self::three::{gizmo::Prank3dGizmoConfig, hud::Prank3dHudConfig, Prank3dPlugin};
use bevy::prelude::*;

pub mod prelude;
pub mod three;

/// Opinionated Unreal Engine inspired spectator camera for the Bevy game engine.
///
/// # Example
///
/// Add [`PrankPlugin`] to your app.
///
/// ```
/// # use bevy::prelude::*;
/// # use bevy_prank::prelude::*;
/// #
/// App::new()
///     .add_plugins((DefaultPlugins, PrankPlugin::default()))
///     .run();
/// ```
#[derive(Default)]
pub struct PrankPlugin(pub PrankConfig);

impl Plugin for PrankPlugin {
    fn build(&self, app: &mut App) {
        app.add_plugins(Prank3dPlugin)
            .insert_resource(self.0.clone());
    }
}

/// Configuration of [`PrankPlugin`].
///
/// # Example
///
/// ```
/// # use bevy::prelude::*;
/// # use bevy_prank::prelude::*;
/// #
/// App::new()
///     .add_plugins((
///         DefaultPlugins,
///         PrankPlugin(PrankConfig {
///             hud: None,
///            ..default()
///         }),
///     ))
///     .run();
/// ```
#[derive(Clone, Resource)]
pub struct PrankConfig {
    /// Three-dimensional hint gizmo configuration.
    ///
    /// Set `None` to disable.
    pub gizmo3d: Option<Prank3dGizmoConfig>,

    /// Three-dimensional camera HUD overlay configuration.
    ///
    /// Set `None` to disable.
    pub hud3d: Option<Prank3dHudConfig>,
}

impl Default for PrankConfig {
    fn default() -> Self {
        Self {
            gizmo3d: Some(Prank3dGizmoConfig::default()),
            hud3d: Some(Prank3dHudConfig::default()),
        }
    }
}