Enum EntityCommand 

pub enum EntityCommand {
    Spawn(GlobalEntity),
    SpawnWithComponents(GlobalEntity, Vec<ComponentKind>),
    Despawn(GlobalEntity),
    InsertComponent(GlobalEntity, ComponentKind),
    RemoveComponent(GlobalEntity, ComponentKind),
    Publish(Option<SubCommandId>, GlobalEntity),
    Unpublish(Option<SubCommandId>, GlobalEntity),
    EnableDelegation(Option<SubCommandId>, GlobalEntity),
    DisableDelegation(Option<SubCommandId>, GlobalEntity),
    SetAuthority(Option<SubCommandId>, GlobalEntity, EntityAuthStatus),
    RequestAuthority(Option<SubCommandId>, GlobalEntity),
    ReleaseAuthority(Option<SubCommandId>, GlobalEntity),
    EnableDelegationResponse(Option<SubCommandId>, GlobalEntity),
    MigrateResponse(Option<SubCommandId>, GlobalEntity, RemoteEntity, HostEntity),
}

Wire command syncing entity lifecycle and authority transitions from host to remote.

Variants

Spawn(GlobalEntity)

Spawn an entity with no initial components.

SpawnWithComponents(GlobalEntity, Vec<ComponentKind>)

Spawn an entity pre-loaded with the listed component kinds.

Despawn(GlobalEntity)

Despawn an existing entity.

InsertComponent(GlobalEntity, ComponentKind)

Insert a component onto an existing entity.

RemoveComponent(GlobalEntity, ComponentKind)

Remove a component from an existing entity.

Publish(Option<SubCommandId>, GlobalEntity)

Publish a delegated entity so it becomes visible to other users.

Unpublish(Option<SubCommandId>, GlobalEntity)

Retract a previously published entity.

EnableDelegation(Option<SubCommandId>, GlobalEntity)

Enable client-authority delegation for an entity.

DisableDelegation(Option<SubCommandId>, GlobalEntity)

Revoke client-authority delegation (server only).

SetAuthority(Option<SubCommandId>, GlobalEntity, EntityAuthStatus)

Update the authority status for a delegated entity (server only).

RequestAuthority(Option<SubCommandId>, GlobalEntity)

Client requests authority over a delegated entity.

ReleaseAuthority(Option<SubCommandId>, GlobalEntity)

Client releases previously held authority.

EnableDelegationResponse(Option<SubCommandId>, GlobalEntity)

Client acknowledges that delegation has been enabled.

MigrateResponse(Option<SubCommandId>, GlobalEntity, RemoteEntity, HostEntity)

Server notifies that an entity has migrated from remote to host (subid, global, old_remote, new_host).

Implementations

impl EntityCommand

pub fn entity(&self) -> GlobalEntity

Returns the primary GlobalEntity this command targets.

pub fn component_kind(&self) -> Option<ComponentKind>

Returns the ComponentKind for insert/remove commands, or None for all other variants.

pub fn get_type(&self) -> EntityMessageType

Returns the EntityMessageType discriminant for this command.

pub fn is_valid_for_remote_entity(&self) -> bool

Returns true if this command can be applied to a remote (client-owned) entity.

Trait Implementations

impl Clone for EntityCommand

fn clone(&self) -> EntityCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntityCommand

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

Formats the value using the given formatter.

impl PartialEq for EntityCommand

fn eq(&self, other: &EntityCommand) -> 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 Eq for EntityCommand

impl StructuralPartialEq for EntityCommand