Trait Component

Source

pub trait Component:
    Sized
    + Send
    + Debug
    + 'static {
    const NAME: &'static str;

    // Provided methods
    fn from_baked(_bytes: &[u8]) -> Result<Self, CnResult> { ... }
    fn inject_locator(&mut self, _locator: PayloadLocator) { ... }
    fn inject_name(&mut self, _id: AssetId) { ... }
}

Expand description

Component – pure serializable data, no behavior. The runtime-facing surface only: a component loads from its baked blob bytes and receives its injected identity/payload hooks. All authoring metadata (origin, payload kind, reference fields, args schema, validators) lives in the build-side registry (concinnity-world), derived from the for_each_component! metadata blocks.

Required Associated Constants§

Source

const NAME: &'static str

The registry name a world authors this component under.

Provided Methods§

Source

fn from_baked(_bytes: &[u8]) -> Result<Self, CnResult>

Reconstruct this component from a blob record, whose bytes are the serialized runtime component (cook already ran the asset -> component translation). The default rejects: runtime-only components are never stored in a blob, so only loadable types provide an implementation.

Source

fn inject_locator(&mut self, _locator: PayloadLocator)

Called after construction to inject the payload locator from the blob def. Only meaningful for components with a compiled payload. The default implementation does nothing (correct for most components).

Source

fn inject_name(&mut self, _id: AssetId)

Called after construction to inject the asset’s identity from the blob def. Only meaningful for components that look themselves up by id at runtime. The default implementation does nothing.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Component

Trait Component Copy item path

Required Associated Constants§

const NAME: &'static str

Provided Methods§

fn from_baked(_bytes: &[u8]) -> Result<Self, CnResult>

fn inject_locator(&mut self, _locator: PayloadLocator)

fn inject_name(&mut self, _id: AssetId)

Dyn Compatibility§

Implementors§

impl Component for Animation

const NAME: &'static str = "Animation"

impl Component for AnimationGraph

const NAME: &'static str = "AnimationGraph"

impl Component for AnimationParams

const NAME: &'static str = "AnimationParams"

impl Component for AppConfig

const NAME: &'static str = "AppConfig"

impl Component for AudioCue

const NAME: &'static str = "AudioCue"

impl Component for AudioEmitter

const NAME: &'static str = "AudioEmitter"

impl Component for AudioOcclusionProbe

const NAME: &'static str = "AudioOcclusionProbe"

impl Component for Behavior

const NAME: &'static str = "Behavior"

impl Component for BlockType

const NAME: &'static str = "BlockType"

impl Component for BodyDynamics

const NAME: &'static str = "BodyDynamics"

impl Component for Camera3D

const NAME: &'static str = "Camera3D"

impl Component for CameraProbe

const NAME: &'static str = "CameraProbe"

impl Component for CharacterRig

const NAME: &'static str = "CharacterRig"

impl Component for CharacterShape

const NAME: &'static str = "CharacterShape"

impl Component for Children

const NAME: &'static str = "Children"

impl Component for Collider

const NAME: &'static str = "Collider"

impl Component for DebugHud

const NAME: &'static str = "DebugHud"

impl Component for Decal

const NAME: &'static str = "Decal"

impl Component for DirectionalLight

const NAME: &'static str = "DirectionalLight"

impl Component for File

const NAME: &'static str = "File"

impl Component for FpsCounter

const NAME: &'static str = "FpsCounter"

impl Component for FrameInput

const NAME: &'static str = "FrameInput"

impl Component for GlassPanel

const NAME: &'static str = "GlassPanel"

impl Component for GlobalTransform

const NAME: &'static str = "GlobalTransform"

impl Component for GraphicsConfig

const NAME: &'static str = "GraphicsConfig"

impl Component for GroundProbes

const NAME: &'static str = "GroundProbes"

impl Component for Held

const NAME: &'static str = "Held"

impl Component for Hidden

const NAME: &'static str = "Hidden"

impl Component for HitRegion

const NAME: &'static str = "HitRegion"

impl Component for InstancedProp

const NAME: &'static str = "InstancedProp"

impl Component for Interactable

const NAME: &'static str = "Interactable"

impl Component for KeyBinding

const NAME: &'static str = "KeyBinding"

impl Component for LayoutContainer

const NAME: &'static str = "LayoutContainer"

impl Component for Lifetime

const NAME: &'static str = "Lifetime"

impl Component for LoadingOverlay

const NAME: &'static str = "LoadingOverlay"

Trait Component