Overrides for no-path in autonavigation for `bevy_input_focus` #22634

kumaryash6352 · 2026-01-21T20:43:59Z

Objective

Addresses bevy_input_focus: Ability to manually set “no navigation in a given direction” for an entity #22378 .

Solution

Turn NavNeighbors from storing an array of Option<Entity> to an array of NavNeighbor, an enum with 3 values: Unset (no explicitly set thing in this direction), Blocked (assume there is nothing in this direction to path to), and Neighbor(Entity).

Testing

Changes tested using a new test, test_respects_set_blocks, and manually using the directional_navigation_override example. Each button on second page is restricted to left/right movement, as up/down are blocked.

Showcase

I'm not quite sure how to showcase this, as it's a very input-oriented feature and the feature working means that nothing happens.

Changes navigation to use a 3-state enum, distinguishing between "unset" neighbors, "explicitly removed" neighbors, and "known" neighbors. Unset neighbors can be overwritten by auto nav building, while explicitly removed slots cannot.

Documents surprising behavior when inputting a diagonal direction (ie. `NorthWest`) when one of the components are blocked (ie. `North`)

ickshonpe · 2026-01-21T20:51:55Z

crates/bevy_input_focus/src/directional_navigation.rs

+pub enum NavNeighbor {
+    /// No neighbor explicitly set.
+    #[default]
+    Unset,


Doesn't this mean that it will be left to be determined automatically, so maybe Auto would be clearer?

Renamed to Auto in latest commit.

ickshonpe · 2026-01-21T20:53:07Z

crates/bevy_input_focus/src/directional_navigation.rs

+    /// Do not find a neighbor.
+    Blocked,
+    /// The neighbor is known and set.
+    Neighbor(Entity),


NavNeighbor::Neighbor seems a bit redundant, maybe NavNeighbor::Set(Entity)?

Renamed to Set in latest commit.

ickshonpe · 2026-01-21T20:57:09Z

crates/bevy_input_focus/src/directional_navigation.rs

            .set(direction, b);
    }

+    /// Adds an edge blocking automatic naviation from an entity in a direction.


Suggested change

/// Adds an edge blocking automatic naviation from an entity in a direction.

/// Adds an edge blocking automatic navigation from an entity in a direction.

Thanks for catching that, fixed typo in latest commit.

kfc35

Overall, this looks great. I just have small wording fixes / nits. Thank you for your work!

kfc35 · 2026-01-23T16:09:57Z

crates/bevy_input_focus/src/directional_navigation.rs

+    /// Adds an edge blocking automatic navigation from an entity in a direction.
+    /// Any existing edge from A in the provided direction will be overwritten.
+    ///
+    /// The reverse block will not be added, so navigation will only be possible from other entities


This sentence sounds a little unclear

Suggested change

/// The reverse block will not be added, so navigation will only be possible from other entities

/// The reverse block will not be added, so navigation will still be possible from other entities

/// to the provided entity in the [`CompassOctant::opposite`] direction

kfc35 · 2026-01-23T16:11:36Z

crates/bevy_input_focus/src/directional_navigation.rs

        self.add_edge(b, a, direction.opposite());
    }

+    // TODO: not quite sure if this is necessary


I think this is OK to provide; it is small enough to include

kfc35 · 2026-01-23T16:11:56Z

crates/bevy_input_focus/src/directional_navigation.rs

    }

+    // TODO: not quite sure if this is necessary
+    /// Adds a symmetrical edge between two entities in the navigation map.


Suggested change

/// Adds a symmetrical edge between two entities in the navigation map.

/// Adds a symmetrical blocking edge between two entities in the navigation map.

kfc35 · 2026-01-23T16:12:18Z

crates/bevy_input_focus/src/directional_navigation.rs


+    // TODO: not quite sure if this is necessary
+    /// Adds a symmetrical edge between two entities in the navigation map.
+    /// The A -> B path will use the provided direction, while B -> A will use the [`CompassOctant::opposite`] variant.


Suggested change

/// The A -> B path will use the provided direction, while B -> A will use the [`CompassOctant::opposite`] variant.

/// The blocking A -> B path will use the provided direction, while B -> A will use the [`CompassOctant::opposite`] variant.

kfc35 · 2026-01-23T16:14:04Z

crates/bevy_input_focus/src/directional_navigation.rs

    ///
    /// If the entity is not in the map, [`None`] will be returned.
-    /// Note that the set of neighbors is not guaranteed to be non-empty though!
+    /// Note that the set of neighbors may be the default value!


By “default value” do you mean the EMPTY value?

kfc35 · 2026-01-23T16:14:36Z

crates/bevy_input_focus/src/directional_navigation.rs

        direction: CompassOctant,
    },
+    /// Navigation explicitly blocked in the requested direction.
+    #[error("Naviation explicitly blocked from {current_focus} in the {direction:?} direction.")]


Suggested change

#[error("Naviation explicitly blocked from {current_focus} in the {direction:?} direction.")]

#[error("Navigation explicitly blocked from {current_focus} in the {direction:?} direction.")]

kfc35 · 2026-01-23T16:21:38Z

examples/ui/navigation/directional_navigation_overrides.rs

        pages_entities[1][3],
        CompassOctant::SouthEast,
    );
+    // Add one-way blocking within the triangle page (Page 1) for down nav.


Suggested change

// Add one-way blocking within the triangle page (Page 1) for down nav.

// Add one-way blocking within the first grid page (Page 1) for down nav.

kfc35 · 2026-01-23T16:24:06Z

examples/ui/navigation/directional_navigation_overrides.rs

            .id();
        text_entities.push(footer_info);
    }
+    if page_num == 0 {


nit: instead of copying the if block, you can just have a variable that the Text is set to that is switched based on page_num i.e. something like (excuse the formatting)
let text = if page_num == 2 {
"Vertical Navigation has been manually overridden to be inverted! \ ^ moves down, and v (down) moves up.”, } else {
"Vertical movements disabled on each button, but you can still go to the next row by going off the right side.”
}

kfc35 · 2026-01-23T16:27:57Z

crates/bevy_input_focus/src/directional_navigation.rs

+
+        // Manually set a block from A to B
+        // A should NOT be able to nav East to B
+        // but SHOULD be able to nav South to C


can you add an assert for this? it seems like there should be an assert by the way this comment is written, but it isn’t right now

kumaryash6352 added 2 commits January 21, 2026 14:37

Document diagonal direction with blocked navigation edges

09f7532

Documents surprising behavior when inputting a diagonal direction (ie. `NorthWest`) when one of the components are blocked (ie. `North`)

ickshonpe reviewed Jan 21, 2026

View reviewed changes

kumaryash6352 added 3 commits January 21, 2026 15:15

Cleanup directional navigation for CI

ece19e7

Format test in directional_navigation.rs

4b5d576

Fix doc reference in directional_navigation.rs

642dde0

kfc35 self-requested a review January 22, 2026 02:10

kfc35 approved these changes Jan 23, 2026

View reviewed changes

	/// Adds an edge blocking automatic naviation from an entity in a direction.
	/// Adds an edge blocking automatic navigation from an entity in a direction.

	/// The reverse block will not be added, so navigation will only be possible from other entities
	/// The reverse block will not be added, so navigation will still be possible from other entities
	/// to the provided entity in the [`CompassOctant::opposite`] direction

	/// Adds a symmetrical edge between two entities in the navigation map.
	/// Adds a symmetrical blocking edge between two entities in the navigation map.

	/// The A -> B path will use the provided direction, while B -> A will use the [`CompassOctant::opposite`] variant.
	/// The blocking A -> B path will use the provided direction, while B -> A will use the [`CompassOctant::opposite`] variant.

	#[error("Naviation explicitly blocked from {current_focus} in the {direction:?} direction.")]
	#[error("Navigation explicitly blocked from {current_focus} in the {direction:?} direction.")]

	// Add one-way blocking within the triangle page (Page 1) for down nav.
	// Add one-way blocking within the first grid page (Page 1) for down nav.

Uh oh!

Overrides for no-path in autonavigation for bevy_input_focus #22634

Are you sure you want to change the base?

Overrides for no-path in autonavigation for bevy_input_focus #22634

Conversation

kumaryash6352 commented Jan 21, 2026

Objective

Solution

Testing

Showcase

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kfc35 left a comment

Choose a reason for hiding this comment

Uh oh!

kfc35 Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Overrides for no-path in autonavigation for `bevy_input_focus` #22634

Overrides for no-path in autonavigation for `bevy_input_focus` #22634

kfc35 Jan 23, 2026 •

edited

Loading