Struct Project

pub struct Project;

Top level component in the hierarchy used by DungeonRS to identify components that relate to the map the user is editing. In short, only components under this Project component will be considered when saving/loading a map or exporting.

This allows editing tools to spawn additional components (like Gizmo’s, temporary stamps, …) without having them accidentally included in any export or persistence operations.

This distinction also allows a (minor) performance increase since queries can be run on a subset of the ECS hierarchy rather than all components available.

Implementations

impl Project

pub fn new(name: impl Into<Cow<'static, str>>) -> impl Bundle

Generates a new [Bundle] with a project to indicate the start of a hierarchy under which the map (often referred to as ‘project’, hence the name) will be set.

Arguments

• name - The human-friendly name of the project, entirely unrelated to the filename. This is mostly used in the user interface.

Examples

Here’s how to spawn a simple Project named “Roadside Inn”

    commands.spawn(Project::new("Roadside Inn"));

Trait Implementations

impl Component for Project

where Self: Send + Sync + 'static,

Required Components: [Transform], [Visibility].

A component’s Required Components are inserted whenever it is inserted. Note that this will also insert the required components of the required components, recursively, in depth-first order.

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

A constant indicating the storage type used for this component.

type Mutability = Immutable

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, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

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 register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

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

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]