Struct TnuaObstacleRadar

pub struct TnuaObstacleRadar {
    pub radius: Float,
    pub height: Float,
    /* private fields */
}

Add this to a character entity to detect obstacles around it.

Obstacles can be used for environment movement actions like climbing and wall-jumping.

This component stores rather limited data - only the detected entities and nothing about their form or position. See TnuaRadarLens in the main Tnua crate, which wraps this with a TnuaSpatialExt to provide many helper methods for running more queries on the detected obstacles.

Fields

radius: Float

The radius of the radar’s cylinder.

height: Float

The height of the radar’s cylinder.

Implementations

impl TnuaObstacleRadar

pub fn new(radius: Float, height: Float) -> Self

pub fn pre_marking_update( &mut self, tracked_entity: Entity, tracked_position: Vector3, up_direction: Dir3, )

Physics integration crates must call this each frame before they start calling mark_seen, and feed it some general information about the character entity.

pub fn mark_seen(&mut self, entity: Entity)

Physics integration crates should call this for each detected entity during each frame, after invoking pre_marking_update.

pub fn tracked_entity(&self) -> Entity

Get the character entity who owns the radar (not the detected obstacle entities!)

pub fn tracked_position(&self) -> Vector3

Get the position of the character who owns the radar (not the detected obstacle’s positions!)

pub fn up_direction(&self) -> Dir3

Get the direction considered up.

pub fn iter_blips(&self) -> impl '_ + Iterator<Item = Entity>

Iterate over all the blip entities.

pub fn has_blip(&self, entity: Entity) -> bool

Check if a particular entity has been detected this frame.

Trait Implementations

impl Component for TnuaObstacleRadar

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_required_components( requiree: ComponentId, components: &mut Components, storages: &mut Storages, required_components: &mut RequiredComponents, inheritance_depth: u16, )

Registers required components.

fn register_component_hooks(hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.