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.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]