Struct YoleckEntityRef 

pub struct YoleckEntityRef { /* private fields */ }

A reference to another Yoleck entity, stored by UUID for persistence.

This allows one entity to reference another entity in a way that survives saving and loading. The reference is stored as a UUID in the level file, which gets resolved to an actual Entity at runtime.

Requirements

Important: Only entities with .with_uuid() can be referenced. When defining entity types that should be referenceable, make sure to add .with_uuid() to the entity type:

app.add_yoleck_entity_type({
    YoleckEntityType::new("Planet")
        .with_uuid()  // Required for entity references!
        // ... other configuration
});

Editor Features

In the editor, entity references can be set using:

• Dropdown menu to select from available entities
• Drag and drop from the entity list (only entities with UUID can be dragged)
• Viewport click selection using the 🎯 button

Usage

Add a YoleckEntityRef field to your component with the entity_ref attribute to filter by entity type:

#[derive(Component, YoleckComponent, YoleckAutoEdit, Serialize, Deserialize, Clone, PartialEq, Default)]
struct LaserPointer {
    #[yoleck(entity_ref = "Planet")]
    target: YoleckEntityRef,
}

Implementations

impl YoleckEntityRef

pub fn new() -> Self

pub fn from_uuid(uuid: Uuid) -> Self

pub fn is_some(&self) -> bool

pub fn is_none(&self) -> bool

pub fn entity(&self) -> Option<Entity>

pub fn uuid(&self) -> Option<Uuid>

pub fn clear(&mut self)

pub fn set(&mut self, uuid: Uuid)

pub fn resolve( &mut self, registry: &YoleckUuidRegistry, ) -> Result<(), YoleckEntityRefCannotBeResolved>

Trait Implementations

impl Clone for YoleckEntityRef

fn clone(&self) -> YoleckEntityRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for YoleckEntityRef

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

Formats the value using the given formatter.

impl Default for YoleckEntityRef

fn default() -> YoleckEntityRef

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for YoleckEntityRef

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for YoleckEntityRef

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for YoleckEntityRef

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for YoleckEntityRef

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl YoleckAutoEdit for YoleckEntityRef

fn auto_edit(value: &mut Self, ui: &mut Ui)

fn auto_edit_field_impl( value: &mut Self, ui: &mut Ui, label: &str, attrs: &FieldAttrs, )

Internal implementation for field rendering with label Types can override this to customize behavior based on attributes

fn auto_edit_with_label_and_attrs( value: &mut Self, ui: &mut Ui, label: &str, attrs: &FieldAttrs, )

Auto-edit with field-level attributes (label, tooltip, range, etc.) Default implementation wraps auto_edit with label and common decorations

impl Eq for YoleckEntityRef

impl StructuralPartialEq for YoleckEntityRef