Struct MessageRegistry

pub struct MessageRegistry {
    pub serialize_fns_map: HashMap<MessageKind, ErasedSerializeFns, FixedHasher>,
    pub kind_map: TypeMapper<MessageKind>,
    /* private fields */
}

A Resource that will keep track of all the Messages that can be sent over the network. A Message is any type that is serializable and deserializable.

Adding Messages

You register messages by calling the add_message method directly on the App.

You can provide a NetworkDirection to specify if the message should be sent from the client to the server, from the server to the client, or both. Messages can be sent and receives if your Link entity contains the MessageSender<M> and MessageReceiver<M> components. Adding a NetworkDirection simply registers the sender/receiver components as a required components, but you can also just add and remove them manually.

#[derive(Serialize, Deserialize)]
struct MyMessage;

fn add_messages(app: &mut App) {
  app.add_message::<MyMessage>()
    .add_direction(NetworkDirection::ServerToClient);
}

Customizing Message behaviour

There are some cases where you might want to define additional behaviour for a message. For example, if the message contains Entities, you need to specify how those en entities will be mapped from the remote world to the local world.

Provided that your type implements MapEntities, you can extend the protocol to support this behaviour, by calling the add_map_entities method.

#[derive(Serialize, Deserialize, Clone)]
struct MyMessage(Entity);

impl MapEntities for MyMessage {
   fn map_entities<M: EntityMapper>(&mut self, entity_map: &mut M) {
       self.0 = entity_map.get_mapped(self.0);
   }
}

fn add_messages(app: &mut App) {
  app.add_message::<MyMessage>()
      .add_map_entities();
}

Fields

serialize_fns_map: HashMap<MessageKind, ErasedSerializeFns, FixedHasher>

kind_map: TypeMapper<MessageKind>

Implementations

impl MessageRegistry

pub fn finish(&mut self) -> u64

Trait Implementations

impl Clone for MessageRegistry

fn clone(&self) -> MessageRegistry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageRegistry

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

Formats the value using the given formatter.

impl Default for MessageRegistry

fn default() -> MessageRegistry

Returns the “default value” for a type.

impl TypePath for MessageRegistry

where MessageRegistry: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Resource for MessageRegistry

where MessageRegistry: Send + Sync + 'static,