Skip to main content

ComponentProvenance

Enum ComponentProvenance 

Source
pub enum ComponentProvenance {
    Authored,
    ToolAuthored,
    Derived,
    Runtime,
}
Expand description

Who is allowed to write a component — the axis orthogonal to SemanticDomain.

SemanticDomain answers which subsystem consumes this data and drives change epochs, page grouping and Flow gating. It deliberately says nothing about authorship: Transform and GlobalTransform are both Spatial, yet one is written by a human and the other is recomputed every frame by transform_propagation. Collider and PhysicsDebugData are both Physics, yet one is an input and the other is debug output.

Without this axis the same intent gets re-encoded ad hoc at every site that needs it — which component to offer in “Add Component”, which to copy when duplicating an entity, which to write to a scene file. Each such list is hand-maintained, so none of them covers components defined outside this crate.

The four variants encode two independent bits:

variantoffered to the authorcopied on duplicate
Authoredyesyes
ToolAuthorednoyes
Derivednono
Runtimenono

Persistence stays a separate question, governed by #[component(no_serializable)] and #[component(skip)] — a ToolAuthored component such as Prefab must persist even though nobody adds it by hand.

Variants§

§

Authored

Written by a human through the editor or by game code. Belongs in a scene file, survives duplication, and is offered in “Add Component”. This is the default for any component that does not say otherwise.

§

ToolAuthored

Written by a tool action rather than by hand — Prefab, whose source is set by “instantiate prefab”. It persists and must survive duplication, but adding an empty one by hand is meaningless, so it is not offered in the menu.

§

Derived

Recomputed by the engine from Authored state — GlobalTransform from Transform + Parent, or the HandleComponent<Gpu*> projections from their asset handles. A duplicate must not carry a copy: the engine regenerates it, and a stale copy would be wrong until it did.

§

Runtime

Per-run transient state that no one authors and nothing recomputes from authored data — PhysicsDebugData. Never offered, never copied.

Implementations§

Source§

impl ComponentProvenance

Source

pub const fn is_hand_authorable(self) -> bool

Whether the editor should offer this component in “+ Add Component”.

Only Authored qualifies: everything else is written by the engine or by a tool action.

Source

pub const fn is_copied_on_duplicate(self) -> bool

Whether duplicating an entity should copy this component verbatim.

Derived and Runtime are excluded because the engine produces them: copying would install a stale value that the next tick overwrites at best, and that reads as corrupt state at worst.

Trait Implementations§

Source§

impl Clone for ComponentProvenance

Source§

fn clone(&self) -> ComponentProvenance

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ComponentProvenance

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ComponentProvenance

Source§

fn default() -> ComponentProvenance

Returns the “default value” for a type. Read more
Source§

impl Hash for ComponentProvenance

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ComponentProvenance

Source§

fn eq(&self, other: &ComponentProvenance) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for ComponentProvenance

Source§

impl Eq for ComponentProvenance

Source§

impl StructuralPartialEq for ComponentProvenance

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> AppLifecycle for T
where T: ?Sized,

§

fn on_start(&mut self, ctx: &mut dyn AppContext)

Called once after the backend is up but before the first update. Apps install their theme / fonts here.
§

fn on_exit(&mut self)

Called once when the window is closing. Persist state here.
§

impl<T> AsAny for T
where T: Any,

§

fn as_any(&self) -> &(dyn Any + 'static)

Returns a reference to the inner value as &dyn Any.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.