Crate bevy_hierarchy

bevy_hierarchy can be used to define hierarchies of entities.

Most commonly, these hierarchies are used for inheriting Transform values from the Parent to its Children.

Structs

• AddChild
  Command that adds a child to an entity
• AncestorIter
  An Iterator of Entitys over the ancestors of an Entity.
• ChildBuilder
  Struct for building children onto an entity
• Children
  Contains references to the child entities of this entity.
• ClearChildren
  Command that clear all children from an entity.
• DescendantIter
  An Iterator of Entitys over the descendants of an Entity.
• DespawnChildrenRecursive
  Despawns the given entity’s children recursively
• DespawnRecursive
  Despawns the given entity and all its children recursively
• HierarchyPlugin
  The base plugin for handling Parent and Children components
• InsertChildren
  Command that inserts a child at a given index of a parent’s children, shifting following children back
• Parent
  Holds a reference to the parent entity of this entity. This component should only be present on entities that actually have a parent entity.
• PushChildren
  Command that pushes children to the end of the entity’s Children.
• RemoveChildren
  Command that removes children from an entity, and removes that child’s parent.
• RemoveParent
  Command that removes the parent of an entity, and removes that entity from the parent’s Children.
• ReplaceChildren
  Command that clear all children from an entity. And replace with the given children.
• ReportHierarchyIssue
  When enabled, runs check_hierarchy_component_has_valid_parent<T>.
• ValidParentCheckPlugin
  Print a warning for each Entity with a T component whose parent doesn’t have a T component.
• WorldChildBuilder
  Struct for adding children to an entity directly through the World for use in exclusive systems

Enums

• HierarchyEvent
  An Event that is fired whenever there is a change in the world’s hierarchy.

Traits

• BuildChildren
  Trait defining how to build children
• BuildWorldChildren
  Trait that defines adding children to an entity directly through the World
• DespawnRecursiveExt
  Trait that holds functions for despawning recursively down the transform hierarchy
• HierarchyQueryExt
  An extension trait for Query that adds hierarchy related methods.

Functions

• check_hierarchy_component_has_valid_parent
  System to print a warning for each Entity with a T component which parent hasn’t a T component.
• despawn_with_children_recursive
  Function for despawning an entity and all its children
• on_hierarchy_reports_enabled
  Run criteria that only allows running when ReportHierarchyIssue<T> is enabled.