Struct amethyst_editor_sync::SerializableEntity

pub struct SerializableEntity(pub Entity);

Helper type that wraps an Entity to provide serialization support.

Entity does not directly implement Serialize because it rarely makes sense to serialize an entity directly. Specs encourages users to treat entities as a collection of components, and to only serialize component data while letting the entity be implicit. For the purposes of the editor, though, we would like to be able to reason about entities directly. SerializableEntity acts as a minimal wrapper around Entity that provides serialization support. You can use it in your components instead of Entity so that you can #[derive(Serialize)] for your component type and display it in the editor.

Note that SerializableEntity does not support deserialization. A robust solution for component deserialization is more complex than what is necessary for the editor at this point. Users interested in full deserialization of entities should have a look at the saveload functionality in specs.

Methods

impl SerializableEntity

pub fn new(entity: Entity) -> Self

Creates a new SerializableEntity from an Entity.

pub fn id(&self) -> u32

Gets the ID of the entity.

pub fn gen(&self) -> Generation

Gets the generation of the entity.

Trait Implementations

impl Copy for SerializableEntity

impl From<Entity> for SerializableEntity

fn from(from: Entity) -> Self

Performs the conversion.

impl From<SerializableEntity> for Entity

fn from(from: SerializableEntity) -> Self

Performs the conversion.

impl Clone for SerializableEntity

fn clone(&self) -> SerializableEntity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SerializableEntity

fn fmt(&self, formatter: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Serialize for SerializableEntity

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.