bevy-tnua 0.32.0

A floating character controller for Bevy
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

use bevy::platform::collections::HashMap;
use bevy::prelude::*;
use bevy_tnua_physics_integration_layer::obstacle_radar::TnuaObstacleRadar;

use crate::TnuaScheme;
use crate::controller::TnuaActionFlowStatus;
use crate::prelude::TnuaController;

/// Helper for keeping track on entities the character was just interacting with, so that it won't
/// immediately interact with again after the action is finished.
///
/// For example - this can be use to avoid climbing again on a ladder immediately after dropping
/// from it.
#[derive(Component)]
pub struct TnuaBlipReuseAvoidance<S: TnuaScheme> {
    current_entity: Option<Entity>,
    entities_to_avoid: HashMap<Entity, S::ActionDiscriminant>,
}

impl<S: TnuaScheme> Default for TnuaBlipReuseAvoidance<S> {
    fn default() -> Self {
        Self {
            current_entity: None,
            entities_to_avoid: Default::default(),
        }
    }
}

/// Must be implemented by control schemes that want to use [`TnuaBlipReuseAvoidance`] or
pub trait TnuaHasTargetEntity: TnuaScheme {
    /// The entity used by the given action.
    ///
    /// Note that entities are not part of the actions themselves - they are part of the payloads.
    /// It's up to user code to define them in the control scheme for the relevant actions and to
    /// pass then when feeding these actions.
    fn target_entity(action_state: &Self::ActionState) -> Option<Entity>;
}

impl<S> TnuaBlipReuseAvoidance<S>
where
    S: TnuaScheme + TnuaHasTargetEntity,
{
    /// Call this every frame.
    pub fn update(&mut self, controller: &TnuaController<S>, radar: &TnuaObstacleRadar) {
        let current_entity = controller
            .current_action
            .as_ref()
            .and_then(S::target_entity);

        if current_entity != self.current_entity
            && let Some(old_entity) = self.current_entity.as_ref()
            && let TnuaActionFlowStatus::ActionEnded(action_discriminant)
            | TnuaActionFlowStatus::Cancelled {
                old: action_discriminant,
                new: _,
            } = controller.action_flow_status()
        {
            self.entities_to_avoid
                .insert(*old_entity, *action_discriminant);
        }

        self.entities_to_avoid
            .retain(|entity, _| radar.has_blip(*entity));

        self.current_entity = current_entity;
    }

    /// Returns true the entity was already interacted with and the character did not move away
    /// from it yet.
    pub fn should_avoid(&self, entity: Entity) -> bool {
        self.entities_to_avoid.contains_key(&entity)
    }
}