From 696c00641f35ce79dc0588373281c62141d42646 Mon Sep 17 00:00:00 2001 From: UkoeHB <37489173+UkoeHB@users.noreply.github.com> Date: Thu, 28 Nov 2024 11:31:03 -0600 Subject: [PATCH] Improve ZIndex docs (#16536) # Objective - In 0.14, ZIndex and GlobalZIndex where split from a shared enum into separate components. There have been a few people confused by the behavior of ZIndex when they really needed GlobalZIndex. ## Solution - Update ZIndex docs to improve discoverability of GlobalZIndex. --------- Co-authored-by: Benjamin Brienen --- crates/bevy_ui/src/ui_node.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/crates/bevy_ui/src/ui_node.rs b/crates/bevy_ui/src/ui_node.rs index 704b1d0b03..6877dd3118 100644 --- a/crates/bevy_ui/src/ui_node.rs +++ b/crates/bevy_ui/src/ui_node.rs @@ -2063,13 +2063,16 @@ pub struct CalculatedClip { /// Indicates that this [`Node`] entity's front-to-back ordering is not controlled solely /// by its location in the UI hierarchy. A node with a higher z-index will appear on top -/// of other nodes with a lower z-index. +/// of sibling nodes with a lower z-index. /// /// UI nodes that have the same z-index will appear according to the order in which they /// appear in the UI hierarchy. In such a case, the last node to be added to its parent /// will appear in front of its siblings. /// /// Nodes without this component will be treated as if they had a value of [`ZIndex(0)`]. +/// +/// Use [`GlobalZIndex`] if you need to order separate UI hierarchies or nodes that are +/// not siblings in a given UI hierarchy. #[derive(Component, Copy, Clone, Debug, Default, PartialEq, Eq, Reflect)] #[reflect(Component, Default, Debug, PartialEq)] pub struct ZIndex(pub i32);